emo/openrc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

man/openrc-run.8: Clarify documentation on dependencies and keywords

Browse Source 
Provide an example of using the -containers keyword and clarify
documentation on some of the dependency functions.
This commit is contained in:
William Hubbs 2015-12-03 17:37:38 -06:00
parent 627e925463
commit b810473e4f
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
man/openrc-run.8
View File

@ -166,23 +166,25 @@ will start and stop it in the right order in relation to other services.
As it's a function it can be very flexible, see the example below. As it's a function it can be very flexible, see the example below.
Here is a list of the functions you can use in a Here is a list of the functions you can use in a
.Ic depend .Ic depend
function. You simply pass the names of the services to it to add to that function. You simply pass the names of the services you want to add to
dependency type, or prefix it with ! to remove it. that dependency type to the function, or prefix the names with ! to
remove them from the dependencies.
.Bl -tag -width "RC_DEFAULTLEVEL" .Bl -tag -width "RC_DEFAULTLEVEL"
.It Ic need .It Ic need
The service will refuse to start until needed services have started and it The service will refuse to start until needed services have started and it
will refuse to stop until any services that need it have stopped. will refuse to stop until any services that need it have stopped.
.It Ic use .It Ic use
The service will attempt to start any services we use that have been added The service will attempt to start any services it uses that have been added
to the runlevel. to the runlevel.
.It Ic want .It Ic want
The service will attempt to start any services we want. The service will attempt to start any services it wants, regardless of
whether they have been added to the runlevel.
.It Ic after .It Ic after
The service will start after these services and stop before these services. The service will start after these services and stop before these services.
.It Ic before .It Ic before
The service will start before these services and stop after these services. The service will start before these services and stop after these services.
.It Ic provide .It Ic provide
We provide this virtual service. For example, named provides dns. The service provides this virtual service. For example, named provides dns.
Virtual services take precedence over real services, so it is highly Virtual services take precedence over real services, so it is highly
recommended that you do not have a real service that has the same name recommended that you do not have a real service that has the same name
as a virtual service. as a virtual service.
@ -471,6 +473,9 @@ rc_net_tap1_provide="!net"
# It's also possible to negate keywords. This is mainly useful for prefix # It's also possible to negate keywords. This is mainly useful for prefix
# users testing OpenRC. # users testing OpenRC.
rc_keyword="!-prefix" rc_keyword="!-prefix"
# This can also be used to block a script from runining in all
# containers except one or two
rc_keyword="!-containers !-docker"
.Ed .Ed
.Sh EXAMPLES .Sh EXAMPLES
.Pp .Pp