docs: mention long options in man watch.1
This patch also changed a little the manual page structure, and wording. Signed-off-by: Sami Kerola <kerolasa@iki.fi>
This commit is contained in:
parent
3fc07c1068
commit
2cf4e8e03a
160
watch.1
160
watch.1
@ -1,42 +1,29 @@
|
|||||||
.TH WATCH 1 "2010 Mar 01" " " "Linux User's Manual"
|
.TH WATCH "1" "June 2011" "procps-ng" "User Commands"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
watch \- execute a program periodically, showing output fullscreen
|
watch \- execute a program periodically, showing output fullscreen
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.na
|
|
||||||
.B watch
|
.B watch
|
||||||
.RB [ \-bdehpvtx ]
|
[\fIoptions\fR] \fIcommand\fR
|
||||||
.RB [ \-n
|
|
||||||
.IR seconds ]
|
|
||||||
.RB [ \-\-beep ]
|
|
||||||
.RB [ \-\-color ]
|
|
||||||
.RB [ \-\-differences[=\fIcumulative\fP]]
|
|
||||||
.RB [ \-\-errexit ]
|
|
||||||
.RB [ \-\-exec ]
|
|
||||||
.RB [ \-\-help ]
|
|
||||||
.RB [ \-\-interval=\fIseconds\fP]
|
|
||||||
.RB [ \-\-no\-title ]
|
|
||||||
.RB [ \-\-precise ]
|
|
||||||
.RB [ \-\-version ]
|
|
||||||
.I command
|
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.B watch
|
.B watch
|
||||||
runs
|
runs
|
||||||
.I command
|
.I command
|
||||||
repeatedly, displaying its output and errors (the first screenfull). This
|
repeatedly, displaying its output and errors (the first screenfull). This
|
||||||
allows you to
|
allows you to watch the program output change over time. By default, the
|
||||||
watch the program output change over time. By default, the program is run
|
program is run every 2 seconds.
|
||||||
every 2 seconds; use
|
.B watch
|
||||||
.B \-n
|
will run until interrupted.
|
||||||
or
|
.SH OPTIONS
|
||||||
.B \-\-interval
|
.TP
|
||||||
to specify a different interval. Normally, this interval is interpreted
|
\fB\-f\fR, \fB\-\-differences\fR
|
||||||
as the amout of time between the completion of one run of
|
Highlight the differences between successive updates.
|
||||||
.I command
|
.TP
|
||||||
and the beginning of the next run. However, with the
|
\fB\-n\fR, \fB\-\-interval\fR \fIseconds\fR
|
||||||
.I \-p
|
Specify update interval. The command will not allow quicker than 0.1 second
|
||||||
or
|
interval, in which the smaller values are converted.
|
||||||
.I \-\-precise
|
.TP
|
||||||
option, you can make
|
\fB\-p\fR, \fB\-\-precise\fR
|
||||||
|
Make
|
||||||
.BR watch
|
.BR watch
|
||||||
attempt to run
|
attempt to run
|
||||||
.I command
|
.I command
|
||||||
@ -44,54 +31,37 @@ every
|
|||||||
.I interval
|
.I interval
|
||||||
seconds. Try it with
|
seconds. Try it with
|
||||||
.B ntptime
|
.B ntptime
|
||||||
and notice how the fractional seconds stays
|
and notice how the fractional seconds stays (nearly) the same, as opposed to
|
||||||
(nearly) the same, as opposed to normal mode where they continuously
|
normal mode where they continuously increase.
|
||||||
increase.
|
.TP
|
||||||
.PP
|
\fB\-t\fR, \fB\-\-no\-title\fR
|
||||||
The
|
Turn off the header showing the interval, command, and current time at the
|
||||||
.B \-d
|
top of the display, as well as the following blank line.
|
||||||
or
|
.TP
|
||||||
.B \-\-differences
|
\fB\-b\fR, \fB\-\-beep\fR
|
||||||
flag will highlight the differences between successive updates. Using
|
Beep if command has a non-zero exit.
|
||||||
.B \-\-differences=\fIcumulative\fP
|
.TP
|
||||||
makes highlighting "sticky", presenting a running display of all
|
\fB\-e\fR, \fB\-\-errexit\fR
|
||||||
positions that have ever changed. The
|
Exit on a command error.
|
||||||
.B \-t
|
.TP
|
||||||
or
|
\fB\-c\fR, \fB\-\-color\fR
|
||||||
.B \-\-no\-title
|
Interpret ANSI color sequences.
|
||||||
option turns off the header showing the interval, command, and current
|
.TP
|
||||||
time at the top of the display, as well as the following blank line. The
|
\fB\-x\fR, \fB\-\-exec\fR
|
||||||
.I \-b
|
|
||||||
or
|
|
||||||
.I \-\-beep
|
|
||||||
option causes the command to beep if it has a non-zero exit.
|
|
||||||
.PP
|
|
||||||
.B watch
|
|
||||||
will normally run until interrupted. If you want
|
|
||||||
.B watch
|
|
||||||
to exit on an error from the program running use the
|
|
||||||
.I \-e
|
|
||||||
or
|
|
||||||
.I \-\-errexit
|
|
||||||
options, which will cause
|
|
||||||
.B watch
|
|
||||||
to exit if the return value from the program is non-zero.
|
|
||||||
.PP
|
|
||||||
By default \fBwatch\fR will normally not pass escape characters, however
|
|
||||||
if you use the \fI\-\-c\fR or \fI\-\-color\fR option, then
|
|
||||||
\fBwatch\fR will interpret ANSI color sequences for the foreground.
|
|
||||||
|
|
||||||
.SH NOTE
|
|
||||||
Note that
|
|
||||||
.I command
|
.I command
|
||||||
is given to "sh \-c"
|
is given to
|
||||||
|
.B sh \-c
|
||||||
which means that you may need to use extra quoting to get the desired effect.
|
which means that you may need to use extra quoting to get the desired effect.
|
||||||
You can disable this with the
|
This with the \-\-exec option, which passes the command to
|
||||||
.I -x
|
.BR exec (2)
|
||||||
or
|
instead.
|
||||||
.I --exec
|
.TP
|
||||||
option, which passes the command to exec(2) instead.
|
\fB\-h\fR, \fB\-\-help\fR
|
||||||
.PP
|
Display help text and exit.
|
||||||
|
.TP
|
||||||
|
\fB\-v\fR, \fB\-\-version\fR
|
||||||
|
Display version information and exit.
|
||||||
|
.SH NOTE
|
||||||
Note that POSIX option processing is used (i.e., option processing stops at
|
Note that POSIX option processing is used (i.e., option processing stops at
|
||||||
the first non\-option argument). This means that flags after
|
the first non\-option argument). This means that flags after
|
||||||
.I command
|
.I command
|
||||||
@ -108,7 +78,7 @@ To watch the contents of a directory change, you could use
|
|||||||
.IP
|
.IP
|
||||||
watch \-d ls \-l
|
watch \-d ls \-l
|
||||||
.PP
|
.PP
|
||||||
If you're only interested in files owned by user joe, you might use
|
If you're only interested in files owned by user joe, you might use
|
||||||
.IP
|
.IP
|
||||||
watch \-d 'ls \-l | fgrep joe'
|
watch \-d 'ls \-l | fgrep joe'
|
||||||
.PP
|
.PP
|
||||||
@ -150,14 +120,14 @@ display at all.
|
|||||||
.PP
|
.PP
|
||||||
Combining Characters never count as different in
|
Combining Characters never count as different in
|
||||||
.I \-\-differences
|
.I \-\-differences
|
||||||
mode. Only the base character counts.
|
mode. Only the base character counts.
|
||||||
.PP
|
.PP
|
||||||
Blank lines directly after a line which ends in the last column do not
|
Blank lines directly after a line which ends in the last column do not
|
||||||
display.
|
display.
|
||||||
.PP
|
.PP
|
||||||
.I \-\-precise
|
.I \-\-precise
|
||||||
mode doesn't yet have advanced temporal distortion technology to
|
mode doesn't yet have advanced temporal distortion technology to compensate
|
||||||
compensate for a
|
for a
|
||||||
.I command
|
.I command
|
||||||
that takes more than
|
that takes more than
|
||||||
.I interval
|
.I interval
|
||||||
@ -173,12 +143,26 @@ taking ages on a DNS lookup).
|
|||||||
.SH AUTHORS
|
.SH AUTHORS
|
||||||
The original
|
The original
|
||||||
.B watch
|
.B watch
|
||||||
was written by Tony Rems <rembo@unisoft.com> in 1991, with mods and
|
was written by
|
||||||
|
.UR rembo\@\:unisoft.\:com
|
||||||
|
Tony Rems
|
||||||
|
.UE
|
||||||
|
in 1991, with mods and
|
||||||
corrections by Francois Pinard. It was reworked and new features added by
|
corrections by Francois Pinard. It was reworked and new features added by
|
||||||
Mike Coleman <mkc@acm.org> in 1999. The beep, exec, and error handling
|
.UR mkc\@\:acm.\:org
|
||||||
features were added by Morty Abzug <morty@frakir.org> in 2008.
|
Mike Coleman
|
||||||
On a not so dark and stormy morning
|
.UE
|
||||||
in March of 2003, Anthony DeRobertis <asd@suespammers.org> got sick of
|
in 1999. The beep, exec, and error handling features were added by
|
||||||
his watches that should update every minute eventually updating many
|
.UR morty\@\:frakir.\:org
|
||||||
seconds after the minute started, and added microsecond precision.
|
Morty Abzug
|
||||||
Unicode support was added in 2009 by Jarrod Lowe <procps@rrod.net>.
|
.UE
|
||||||
|
in 2008. On a not so dark and stormy morning in March of 2003,
|
||||||
|
.UR asd\@\:suespammers.\:org
|
||||||
|
Anthony DeRobertis
|
||||||
|
.UE
|
||||||
|
got sick of his watches that should update every minute eventually updating
|
||||||
|
many seconds after the minute started, and added microsecond precision.
|
||||||
|
Unicode support was added in 2009 by
|
||||||
|
.UR procps\@\:rrod.\:net
|
||||||
|
Jarrod Lowe
|
||||||
|
.UE
|
||||||
|
Loading…
x
Reference in New Issue
Block a user