Document inotifywait

This commit is contained in:
Dianne Skoll
2022-07-03 19:47:06 -04:00
parent a8f1228fb7
commit 4824b07ec8

View File

@@ -18,13 +18,13 @@ as well as the tcllib extension. It also requires a \fBwish\fR
binary. If you are using Tcl/Tk 8.5, you may also need either the Img binary. If you are using Tcl/Tk 8.5, you may also need either the Img
or the tkpng extension to handle PNG images. or the tkpng extension to handle PNG images.
.SH OPTIONS .SH COMMAND-LINE OPTIONS
\fBTkRemind\fR itself has no options. However, it passes certain options \fBTkRemind\fR itself has no command-line options. However, it passes
on to \fBRemind\fR. The options it passes are certain options on to \fBRemind\fR. The options it passes are
\fB\-b\fR, \fB\-g\fR, \fB\-x\fR, \fB\-i\fR and \fB\-m\fR. \fB\-b\fR, \fB\-g\fR, \fB\-x\fR, \fB\-i\fR and \fB\-m\fR. See the
See the \fBRemind\fR man page for details about the options. \fBRemind\fR man page for details about the options. Note that
Note that \fBTkRemind\fR will respect the \fB\-m\fR and \fBTkRemind\fR will respect the \fB\-m\fR and \fB\-b1\fR options and
\fB\-b1\fR options and adjust its appearance accordingly. adjust its appearance accordingly.
\fIRead_file\fR is the file from which \fBTkRemind\fR reads reminders. \fIRead_file\fR is the file from which \fBTkRemind\fR reads reminders.
It is in standard \fBRemind\fR format. \fIWrite_file\fR is the file It is in standard \fBRemind\fR format. \fIWrite_file\fR is the file
@@ -299,6 +299,19 @@ Next Month
.B Home .B Home
Today Today
.SH IMMEDIATE UPDATES
If you are running \fBTkRemind\fR on Linux and have the
\fBinotifywait\fR program installed (part of the \fBinotify-tools\fR
or similar package), then \fBTkRemind\fR redraws the calendar window
\fIimmediately\fR if \fB$HOME/.reminders\fR changes (or, if it is a
directory, any files in that directory change.)
.PP
This lets \fBTkRemind\fR react immediately to hand-edited reminders or
to reminder files that are imported from another calendar system (for example,
you may have a cron job that periodically imports your Google Calendar
entries into Remind format.)
.SH ODDS AND ENDS .SH ODDS AND ENDS
\fBTkRemind\fR performs some basic consistency checks when you add or \fBTkRemind\fR performs some basic consistency checks when you add or
preview a reminder. However, if you edit a reminder in the previewer, preview a reminder. However, if you edit a reminder in the previewer,