lib/daemon: support --user option for all OVS daemon

[cascardo/ovs.git] / lib / daemon.man

diff --git a/lib/daemon.man b/lib/daemon.man
index c239377..039a0c4 100644 (file)
--- a/lib/daemon.man
+++ b/lib/daemon.man
@@ -1,47 +1,67 @@
+The following options are valid on POSIX based platforms.
 .TP
-\fB--pidfile\fR[\fB=\fIpidfile\fR]
+\fB\-\-pidfile\fR[\fB=\fIpidfile\fR]
 Causes a file (by default, \fB\*(PN.pid\fR) to be created indicating
-the PID of the running process.  If \fIpidfile\fR is not specified, or
+the PID of the running process.  If the \fIpidfile\fR argument is not
+specified, or
 if it does not begin with \fB/\fR, then it is created in
 \fB@RUNDIR@\fR.
-
+.IP
+If \fB\-\-pidfile\fR is not specified, no pidfile is created.
+.
 .TP
-\fB--overwrite-pidfile\fR
-By default, when \fB--pidfile\fR is specified and the specified pidfile 
+\fB\-\-overwrite\-pidfile\fR
+By default, when \fB\-\-pidfile\fR is specified and the specified pidfile 
 already exists and is locked by a running process, \fB\*(PN\fR refuses 
-to start.  Specify \fB--overwrite-pidfile\fR to cause it to instead 
+to start.  Specify \fB\-\-overwrite\-pidfile\fR to cause it to instead 
 overwrite the pidfile.
-
-When \fB--pidfile\fR is not specified, this option has no effect.
-
+.IP
+When \fB\-\-pidfile\fR is not specified, this option has no effect.
+.
 .TP
-\fB--detach\fR
+\fB\-\-detach\fR
 Causes \fB\*(PN\fR to detach itself from the foreground session and
-run as a background process.
-
+run as a background process. \*(DD
+.
 .TP
-\fB--monitor\fR
+\fB\-\-monitor\fR
 Creates an additional process to monitor the \fB\*(PN\fR daemon.  If
 the daemon dies due to a signal that indicates a programming error
-(e.g. \fBSIGSEGV\fR, \fBSIGABRT\fR), then the monitor process starts a
-new copy of it.  If the daemon die or exits for another reason, the
-monitor process exits.
+(\fBSIGABRT\fR, \fBSIGALRM\fR, \fBSIGBUS\fR, \fBSIGFPE\fR,
+\fBSIGILL\fR, \fBSIGPIPE\fR, \fBSIGSEGV\fR, \fBSIGXCPU\fR, or
+\fBSIGXFSZ\fR) then the monitor process starts a new copy of it.  If
+the daemon dies or exits for another reason, the monitor process exits.
 .IP
-This option is normally used with \fB--detach\fR, but it also
+This option is normally used with \fB\-\-detach\fR, but it also
 functions without it.
-
+.
 .TP
-\fB--no-chdir\fR
-By default, when \fB--detach\fR is specified, \fB\*(PN\fR 
+\fB\-\-no\-chdir\fR
+By default, when \fB\-\-detach\fR is specified, \fB\*(PN\fR 
 changes its current working directory to the root directory after it 
 detaches.  Otherwise, invoking \fB\*(PN\fR from a carelessly chosen 
 directory would prevent the administrator from unmounting the file 
 system that holds that directory.
 .IP
-Specifying \fB--no-chdir\fR suppresses this behavior, preventing
+Specifying \fB\-\-no\-chdir\fR suppresses this behavior, preventing
 \fB\*(PN\fR from changing its current working directory.  This may be 
 useful for collecting core files, since it is common behavior to write 
 core dumps into the current working directory and the root directory 
 is not a good directory to use.
 .IP
-This option has no effect when \fB--detach\fR is not specified.
+This option has no effect when \fB\-\-detach\fR is not specified.
+.
+.TP
+\fB\-\-user\fR
+Causes \fB\*(PN\fR to run as a non root user specified in "user:group", thus
+dropping all root privileges. Short forms "user" and ":group" are also
+allowed, with current user or group are assumed respectively. Only daemons
+started by the root user accepts this argument.
+.IP
+On Linux, daemons will be granted CAP_IPC_LOCK and CAP_NET_BIND_SERVICES
+before dropping root privileges. Daemons interact with datapath,
+such as ovs-vswitchd, will be granted two additional capabilities, namely
+CAP_NET_ADMIN and CAP_NET_RAW.
+.IP
+On Windows, this option is not currently supported. For security reasons,
+specifying this option will cause the daemon process not to start.