[gentoo-commits] proj/openrc:master commit in: man/

["William Hubbs" <williamh@gentoo.org>]

commit:     a4e0d675e13f07bf880da10a4d602983a556264d
Author:     William Hubbs <w.d.hubbs <AT> gmail <DOT> com>
AuthorDate: Tue Sep 13 19:02:10 2016 +0000
Commit:     William Hubbs <williamh <AT> gentoo <DOT> org>
CommitDate: Tue Sep 13 19:02:10 2016 +0000
URL:        https://gitweb.gentoo.org/proj/openrc.git/commit/?id=a4e0d675

man/openrc-run.8: update variable documentation

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

This fixes #78.

 man/openrc-run.8 | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

diff --git a/man/openrc-run.8 b/man/openrc-run.8
index 3d78d98..6e3b9dc 100644
--- a/man/openrc-run.8
+++ b/man/openrc-run.8
@@ -125,15 +125,31 @@ if no start or stop function is defined by the service.
 .It Ar command_args
 List of arguments to pass to the daemon when starting via
 .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
 List of arguments to pass to the daemon when starting via
 .Nm supervise-daemon .
 to force the daemon to stay in the foreground
 .It Ar command_background
-Set this to "true", "yes" or "1" (case-insensitive) to force the daemon into
-the background. This implies the "--make-pidfile" and "--pidfile" option of
+Set this to "true", "yes" or "1" (case-insensitive) if you want 
+.Xr start-stop-daemon 8
+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
-so the pidfile variable must be set.
+or
+.Xr supervise-daemon 8
+launches the daemon
 .It Ar chroot
 .Xr start-stop-daemon 8
 and