lib/daemon.man

   1 The following options are valid on POSIX based platforms.
   2 .TP
   3 \fB\-\-pidfile\fR[\fB=\fIpidfile\fR]
   4 Causes a file (by default, \fB\*(PN.pid\fR) to be created indicating
   5 the PID of the running process.  If the \fIpidfile\fR argument is not
   6 specified, or
   7 if it does not begin with \fB/\fR, then it is created in
   8 \fB@RUNDIR@\fR.
   9 .IP
  10 If \fB\-\-pidfile\fR is not specified, no pidfile is created.
  11 .
  12 .TP
  13 \fB\-\-overwrite\-pidfile\fR
  14 By default, when \fB\-\-pidfile\fR is specified and the specified pidfile
  15 already exists and is locked by a running process, \fB\*(PN\fR refuses
  16 to start.  Specify \fB\-\-overwrite\-pidfile\fR to cause it to instead
  17 overwrite the pidfile.
  18 .IP
  19 When \fB\-\-pidfile\fR is not specified, this option has no effect.
  20 .
  21 .TP
  22 \fB\-\-detach\fR
  23 Causes \fB\*(PN\fR to detach itself from the foreground session and
  24 run as a background process. \*(DD
  25 .
  26 .TP
  27 \fB\-\-monitor\fR
  28 Creates an additional process to monitor the \fB\*(PN\fR daemon.  If
  29 the daemon dies due to a signal that indicates a programming error
  30 (\fBSIGABRT\fR, \fBSIGALRM\fR, \fBSIGBUS\fR, \fBSIGFPE\fR,
  31 \fBSIGILL\fR, \fBSIGPIPE\fR, \fBSIGSEGV\fR, \fBSIGXCPU\fR, or
  32 \fBSIGXFSZ\fR) then the monitor process starts a new copy of it.  If
  33 the daemon dies or exits for another reason, the monitor process exits.
  34 .IP
  35 This option is normally used with \fB\-\-detach\fR, but it also
  36 functions without it.
  37 .
  38 .TP
  39 \fB\-\-no\-chdir\fR
  40 By default, when \fB\-\-detach\fR is specified, \fB\*(PN\fR
  41 changes its current working directory to the root directory after it
  42 detaches.  Otherwise, invoking \fB\*(PN\fR from a carelessly chosen
  43 directory would prevent the administrator from unmounting the file
  44 system that holds that directory.
  45 .IP
  46 Specifying \fB\-\-no\-chdir\fR suppresses this behavior, preventing
  47 \fB\*(PN\fR from changing its current working directory.  This may be
  48 useful for collecting core files, since it is common behavior to write
  49 core dumps into the current working directory and the root directory
  50 is not a good directory to use.
  51 .IP
  52 This option has no effect when \fB\-\-detach\fR is not specified.
  53 .
  54 .TP
  55 \fB\-\-user\fR
  56 Causes \fB\*(PN\fR to run as a non root user specified in "user:group", thus
  57 dropping all root privileges. Short forms "user" and ":group" are also
  58 allowed, with current user or group are assumed respectively. Only daemons
  59 started by the root user accepts this argument.
  60 .IP
  61 On Linux, daemons will be granted CAP_IPC_LOCK and CAP_NET_BIND_SERVICES
  62 before dropping root privileges. Daemons interact with datapath,
  63 such as ovs-vswitchd, will be granted two additional capabilities, namely
  64 CAP_NET_ADMIN and CAP_NET_RAW.
  65 .IP
  66 On Windows, this option is not currently supported. For security reasons,
  67 specifying this option will cause the daemon process not to start.