man/openrc-run.8: update variable documentation

- document command_args_background and command_user.r
- clarify documentation for command_background

This fixes #78.
This commit is contained in:
William Hubbs 2016-09-13 14:02:10 -05:00
parent 8a8032478a
commit a4e0d675e1

View File

@ -125,15 +125,31 @@ if no start or stop function is defined by the service.
.It Ar command_args .It Ar command_args
List of arguments to pass to the daemon when starting via List of arguments to pass to the daemon when starting via
.Nm start-stop-daemon . .Nm start-stop-daemon .
.It Ar command_args_background
This variable should be used if the daemon you are starting with
.Xr start-stop-daemon 8
runs in the foreground by default but has its own command line options
to request that it background and write a pid file. It should be set to
those options. It should not be used at the same time as
command_background, because command_background requests that
.Xr start-stop-daemon 8
go into the background before executing the daemon.
.It Ar command_args_foreground .It Ar command_args_foreground
List of arguments to pass to the daemon when starting via List of arguments to pass to the daemon when starting via
.Nm supervise-daemon . .Nm supervise-daemon .
to force the daemon to stay in the foreground to force the daemon to stay in the foreground
.It Ar command_background .It Ar command_background
Set this to "true", "yes" or "1" (case-insensitive) to force the daemon into Set this to "true", "yes" or "1" (case-insensitive) if you want
the background. This implies the "--make-pidfile" and "--pidfile" option of
.Xr start-stop-daemon 8 .Xr start-stop-daemon 8
so the pidfile variable must be set. to force the daemon into the background. This forces the
"--make-pidfile" and "--pidfile" options, so the pidfile variable must be set.
.It Ar command_user
If the daemon does not support changing to a different user id, you can
use this to change the user id before
.Xr start-stop-daemon 8
or
.Xr supervise-daemon 8
launches the daemon
.It Ar chroot .It Ar chroot
.Xr start-stop-daemon 8 .Xr start-stop-daemon 8
and and