Tweak daemon mode documentation.

This commit is contained in:
Dianne Skoll
2024-04-01 08:39:24 -04:00
parent 60417d68a7
commit 21d5e8a095

View File

@@ -366,7 +366,7 @@ You use both \fB\-k\fR\fIcmd1\fR and \fB\-k:\fR\fIcmd2\fR to use different
commands for queued versus non-queued reminders. commands for queued versus non-queued reminders.
.RE .RE
.TP .TP
\fB\-z\fR[\fIn\fR] Runs \fBRemind\fR in the daemon mode. If \fIn\fR \fB\-z\fR[\fIn\fR] Runs \fBRemind\fR in "daemon mode". If \fIn\fR
is supplied, it specifies how often (in minutes) \fBRemind\fR should is supplied, it specifies how often (in minutes) \fBRemind\fR should
wake up to check if the reminder script has been changed. \fIN\fR wake up to check if the reminder script has been changed. \fIN\fR
defaults to 1, and can range from 1 to 60. Note that the use of the defaults to 1, and can range from 1 to 60. Note that the use of the
@@ -2399,9 +2399,9 @@ Universal Time Coordinated in the \fB$MinsFromUTC\fR system variable.
If non-zero, then the \fB\-c\fR option was supplied on the command line. If non-zero, then the \fB\-c\fR option was supplied on the command line.
.TP .TP
.B $Daemon (read-only) .B $Daemon (read-only)
If the daemon mode \fB\-z\fR was invoked, contains the number of If "daemon mode" \fB\-z\fR was invoked, contains the number of
minutes between wakeups. If not running in daemon mode, contains minutes between wakeups. If not running in daemon mode, contains
0. 0. In server mode (either \fB-z0\fR or \fB-zj\fR), contains -1.
.TP .TP
.B $DateSep .B $DateSep
This variable can be set only to "/" or "-". It holds the character This variable can be set only to "/" or "-". It holds the character
@@ -5085,21 +5085,25 @@ structuring comments in your PostScript code.
.PP .PP
.SH DAEMON MODE .SH DAEMON MODE
.PP .PP
If you use the \fB\-z\fR command-line option, \fBRemind\fR runs in the If you use the \fB\-z\fR command-line option, \fBRemind\fR runs in
"daemon" mode. In this mode, no "normal" reminders are issued. "daemon mode". In this mode, no "normal" reminders are issued.
Instead, only timed reminders are collected and queued, and are then Instead, only timed reminders are collected and queued, and are then
issued whenever they reach their trigger time. issued whenever they reach their trigger time.
.PP .PP
In addition, \fBRemind\fR wakes up every few minutes to check the modification In addition, \fBRemind\fR wakes up every few minutes to check the
date on the reminder script (the filename supplied on the command line.) modification date on the reminder script (the filename supplied on the
If \fBRemind\fR detects that the script has changed, it re-executes itself command line.) If \fBRemind\fR detects that the script has changed,
in daemon mode, and interprets the changed script. it re-executes itself in daemon mode, and interprets the changed
script. If \fBRemind\fR was compiled with support for
\fBinotify\fR(7), then if the command-line reminder script is really a
directory, \fBRemind\fR also re-executes itself if any of the files in
the directory is changed.
.PP .PP
In daemon mode, \fBRemind\fR also re-reads the remind script when it In daemon mode, \fBRemind\fR also re-reads the remind script when it
detects that the system date has changed. detects that the system date has changed.
.PP .PP
In daemon mode, \fBRemind\fR acts as if the \fB\-f\fR option had been used, In daemon mode, \fBRemind\fR acts as if the \fB\-f\fR option had been used,
so to run in the daemon mode in the background, use: so to run in daemon mode in the background, use:
.PP .PP
.nf .nf
remind \-z .reminders & remind \-z .reminders &