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

Update supervise-daemon man page

Browse Source
This commit is contained in:
William Hubbs 2018-12-03 13:08:25 -06:00
parent ac42e81a64
commit eeba6df476
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
man/supervise-daemon.8
View File

@ -16,6 +16,7 @@
.Nd starts a daemon and restarts it if it crashes .Nd starts a daemon and restarts it if it crashes
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
servicename
.Fl a , -healthcheck-timer .Fl a , -healthcheck-timer
.Ar seconds .Ar seconds
.Fl A , -healthcheck-delay .Fl A , -healthcheck-delay
@ -53,11 +54,13 @@
.Op Fl - .Op Fl -
.Op Ar arguments .Op Ar arguments
.Nm .Nm
servicename
.Fl K , -stop .Fl K , -stop
.Ar daemon .Ar daemon
.Fl r , -chroot .Fl r , -chroot
.Ar chrootpath .Ar chrootpath
.Nm .Nm
servicename
.Fl s , -signal .Fl s , -signal
.Ar signal .Ar signal
.Fl r , -chroot .Fl r , -chroot
@ -67,6 +70,8 @@
provides a consistent method of starting, stopping and restarting provides a consistent method of starting, stopping and restarting
daemons. If daemons. If
.Fl K , -stop .Fl K , -stop
or
.Fl s , -signal
is not provided, then we assume we are starting the daemon. is not provided, then we assume we are starting the daemon.
.Nm .Nm
only works with daemons which do not fork. If your daemon has options to only works with daemons which do not fork. If your daemon has options to
@ -128,6 +133,10 @@ If this option is not given, the default is SIGTERM/5.
.It Fl r , -chroot Ar path .It Fl r , -chroot Ar path
chroot to this directory before starting the daemon. All other paths, such chroot to this directory before starting the daemon. All other paths, such
as the path to the daemon and chdir should be relative to the chroot. as the path to the daemon and chdir should be relative to the chroot.
.It Fl , -signal Ar signal
Instruct a supervisor to signal the process it is supervising. The
process to communicate with is determined by the name of the service
taken from the RC_SVCNAME environment variable.
.It Fl u , -user Ar user .It Fl u , -user Ar user
Start the daemon as the specified user. Start the daemon as the specified user.
.It Fl 1 , -stdout Ar logfile .It Fl 1 , -stdout Ar logfile
@ -161,6 +170,11 @@ make sure the settings mmake sense. For example, a respawn period of 5
seconds with a respawn max of 10 and a respawn delay of 1 second leads seconds with a respawn max of 10 and a respawn delay of 1 second leads
to infinite respawning since there can never be 10 respawns within 5 to infinite respawning since there can never be 10 respawns within 5
seconds. seconds.
.Sh NOTE
Invoking supervise-daemon requires both the RC_SVCNAME environment
variable to be set and the name of the service as the first argument on
the command line, so it is best to invoke it inside a service script
rather than manually.
.Sh SEE ALSO .Sh SEE ALSO
.Xr chdir 2 , .Xr chdir 2 ,
.Xr chroot 2 , .Xr chroot 2 ,