summaryrefslogtreecommitdiffabout
Side-by-side diff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--src/genrc.836
1 files changed, 18 insertions, 18 deletions
diff --git a/src/genrc.8 b/src/genrc.8
index ed077bf..0fdfa54 100644
--- a/src/genrc.8
+++ b/src/genrc.8
@@ -10,13 +10,13 @@
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with genrc. If not, see <http://www.gnu.org/licenses/>.
-.TH GENRC 8 "July 11, 2019" "GENRC" "Genrc User Manual"
+.TH GENRC 8 "September 13, 2019" "GENRC" "Genrc User Manual"
.SH NAME
genrc \- generic system initialization script helper
.SH SYNOPSIS
.nh
.na
\fBgenrc\fR\
@@ -83,21 +83,21 @@ word (in the shell sense) from \fICOMMAND\fR is used.
.PP
If \fB\-\-program\fR is given, but \fB\-\-command\fR is not, its value
will be used as the command to run.
.PP
The program operation modes are:
.SS start
-If given \fBstart\fR argument, \fBgenrc\fR runs the supplier
+If given this argument, \fBgenrc\fR runs the supplied
command. Before, it checks if the program is not already running and
refuses to start its second copy if so.
.PP
It is supposed that the program to be run will detach from the
-controlling terminal and continue running in the background (i.e. it
+controlling terminal and will continue running in the background (i.e. it
is a \fIdaemon\fR, in UNIX sense). If it is not the case, use the
\fB\-\-sentinel\fR option. With this option, \fBgenrc\fR will start
-the command and will become daemon itself, controlling the execution
+the command and become a daemon itself, controlling the execution
of the program. It will exit when the command terminates. So long as
the command runs, \fBgenrc\fR will pipe its standard output and error
to syslog facility \fBdaemon\fR. The standard output will be logged
with the priority \fBinfo\fR and the error with the priority
\fBerr\fR.
.PP
@@ -110,14 +110,14 @@ terminates. Unless the \fB\-\-pid\-from\fR option is given,
In sentinel mode, it is possible to restart the program if it
terminates with a specific exit code or on a specific signal. This is
controlled by the \fB\-\-restart\-on\-exit\fR and
\fB\-\-restart\-on\-signal\fR options. Use this feature to ensure the
service provided by the program won't get terminated because of
hitting a bug or encountering an unforeseen external condition. For
-example, the following two options will ensure that the program will
-be terminated only if it exits with status 0 or it is terminated by
+example, the following two options make sure that the program will
+be terminated only if it exits with status 0 or is delivered the
SIGTERM or SIGQUIT signal:
.EX
--restart-on-exit='!0' --restart-on-signal='!TERM,QUIT'
.EE
.PP
If restarts are requested, \fBgenrc\fR will control how often it has
@@ -131,42 +131,42 @@ file during that interval. If the \fBSIGHUP\fR signal is delivered
during the sleep interval, the sleep will be broken prematurely and
the program restarted again.
.SS status
In \fBstatus\fR mode \fBgenrc\fR verifies if the \fICOMMAND\fR is
already running and outputs its status on the standard output. To this
effect, it uses an abstraction called \fIPID source\fR, which allows
-it to determine the PID of the program by its name of command line.
+it to determine the PID of the program.
.PP
The default PID source is the Linux \fB/proc\fR filesystem (or, if it
is not available, the output of \fBps -ef\fR), which is scanned for
-the name of the program (given by \fB\-\-program\fR or
+the name of the program (as given by \fB\-\-program\fR or
\fB\-\-command\fR options).
.PP
The source to use can be supplied with the \fB\-\-pid\-from\fR option
-(or the \fB\-\-pidfile option, which is equivalent to
+(or the \fB\-\-pidfile\R option, which is equivalent to
\fB\-\-pid\-from=FILE:\fR). See the section \fBPID SOURCES\fR for a
detailed discussion of available sources.
.SS stop
In the \fBstop\fR mode \fBgenrc\fR stops the command by sending it
-\fBSIGTERM\fR (or another signal as supplied with the
+\fBSIGTERM\fR (or another signal, as supplied with the
\fB\-\-signal\-stop\fR option). If the PID source returns multiple
PIDs, by default only parent PID is selected. However, \fBgenrc\fR can
be instructed to signal all PIDs instead (see the \fBa\fR flag in the
description of \fBPROC\fR or \fBPS\fR PID source).
.PP
After sending the signal, the program will wait for all processes to
-terminate. It will report error if they don't terminate within 5
+terminate. It will report an error if they don't terminate within 5
seconds. This timeout can be changed using the \fB\-\-timeout\fR
option.
.SS restart
Restarts the program. It is equivalent to running
.B genrc stop
immediately followed by
.BR "genrc start" .
.SS reload
-Attempt to reload (or reconfigure) the program by sending it the
+Attempts to reload (or reconfigure) the program by sending it the
\fBSIGHUP\fR signal (or another signal, as given with the
\fB\-\-signal\-reload\fR option). The \fB\-\-no\-reload\fR or
\fB\-\-signal\-reload=0\fR option disables this behavior, making
this mode equivalent to
.BR "genrc restart" .
.SH EXAMPLE
@@ -205,13 +205,13 @@ Display a short help list.
.TP
\fB\-g\fR, \fB\-\-group=\fIGROUP\fR[,\fIGROUP\fR...]
Run program with this \fIGROUP\fR privileges. If the argument is a
list of groups, the first group becomes the principal, and the
rest of them supplementary groups. Each \fIGROUP\fR is either a group
name or a numeric group number prefixed with a plus sign. Whatever
-notation is used, it must exist in the system group database.
+notation is used, the groups must exist in the system group database.
See also the \fB\-\-user\fR option.
.TP
\fB\-\-no\-reload\fR
Makes \fBreload\fR equivalent to \fBrestart\fR.
.TP
@@ -319,20 +319,20 @@ META1 configuration file.
.B PATH
Configuration specified as fully-qualified keyword-value pairs
(similar to \fB.Xdefaults\fR).
.RE
.TP
\fBGREP:\fIFILE\fB:s/\fIRX\fB/\fIREPL\fB/[\fIFLAGS\fR][\fB;\fR...]
-Grep for the first line in \fIFILE\fR that matches \fIRX\fR. If found, process
-replace the matched portion according to \fIREPL\fR and \fIFLAGS\fR. Use
+Grep for the first line in \fIFILE\fR that matches \fIRX\fR. If found,
+modify the matched portion according to \fIREPL\fR and \fIFLAGS\fR. Use
the resulting string as PID. More sed expressions can be supplied,
separated with semicolons.
.TP
\fBPROC\fR[\fB:\fR[\fIEXE\fR][\fB:\fIFLAGS\fR]]
Look for matching program in \fB/proc/\fIPID\fB/*\fR. If \fIEXE\fR is
-not supplied or empty, program name from \fB\-\-program\fR will be
+not supplied or empty, the program name from \fB\-\-program\fR will be
used. \fIFLAGS\fR are:
.RS
.TP
.B e
exact match
.TP
@@ -355,13 +355,13 @@ match entire command line
match real executable name (instead of argv0)
.TP
.B a
signal all matching PIDs
.RE
.TP
-\fBPS:\fR[\fB:\fR[\fIEXE\fR][:\fIFLAGS\fR]]
+\fBPS\fR[\fB:\fR[\fIEXE\fR][:\fIFLAGS\fR]]
Look for matching program in the output of \fBps \-ef\fR. \fIEXE\fR
and \fIFLAGS\fR are as described above.
.SH ENVIRONMENT
Influential environment variables and corresponding options:
.sp
.nf
@@ -379,13 +379,13 @@ Influential environment variables and corresponding options:
.fi
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
Report bugs to <gray@gnu.org>.
.SH COPYRIGHT
-Copyright \(co 2018 Sergey Poznyakoff
+Copyright \(co 2018, 2019 Sergey Poznyakoff
.br
.na
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
.br
.ad
This is free software: you are free to change and redistribute it.

Return to:

Send suggestions and report system problems to the System administrator.