commit 17d042f613da17a0461301ac11bce0e5ea73edb7
parent e406b110d302fe4a2f378882d4762ff96f5b477b
Author: Natasha Kerensikova <natacha@instinctive.eu>
Date: Tue, 20 Oct 2015 19:45:09 +0200
Various fixes to the man pages
Thanks a lot to @frgm for the thorough review, it was a pleasant surprise.
Diffstat:
2 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/filewatcherd.8 b/filewatcherd.8
@@ -11,7 +11,7 @@
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-.Dd October 19, 2015
+.Dd October 20, 2015
.Dt FILEWATCHERD 8
.Os
.Sh NAME
@@ -32,17 +32,16 @@ and does not depend on anything outside of FreeBSD base.
.Ar watchtab
describes which paths and what events to watch, and commands to run
when triggered.
-.Sh OPTIONS
-The following options are supported by
-.Nm :
+.Pp
+The options are as follows:
.Bl -tag -width "foo"
-.It Fl d , Cm --foreground
+.It Fl d , Fl Fl foreground
Don't fork to background and log to stderr.
-.It Fl h , Cm --help
+.It Fl h , Fl Fl help
Display help text.
-.It Fl w Ar delay_ms , Cm --wait Ar delay_ms
+.It Fl w Ar delay_ms , Fl Fl wait Ar delay_ms
Wait that number of milliseconds after
-.Ar watchtag
+.Ar watchtab
changes before reloading it.
.El
.Sh SEE ALSO
diff --git a/watchtab.5 b/watchtab.5
@@ -11,7 +11,7 @@
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-.Dd October 19, 2015
+.Dd October 20, 2015
.Dt WATCHTAB 5
.Os
.Sh NAME
@@ -67,7 +67,7 @@ The format of a
command is a tabulation-separated sequence of fields, interpreted as follow:
.Bl -tag -width command
.It path
-Path of the file to watch
+Path of the file to watch.
.It events
Set of events which trigger the command. It can either be a single
star-sign (*), or a punctuation-separated list of names among:
@@ -88,6 +88,7 @@ Path of a directory in which to chroot before running the command.
.It command
The command to run.
.El
+.Pp
When less than 6 fields are given in a command line, the
.Va chroot
value is considered omitted, and chroot will be performed.
@@ -99,6 +100,6 @@ When less than 4 fields are given, the
value is considered as zero.
It is an error to provide less than 3 fields.
.Sh SEE ALSO
-.Xr crontab 5
+.Xr kqueue 2 ,
+.Xr crontab 5 ,
.Xr filewatcherd 8
-.Xr kqueue 2
