freebsd-nq/usr.sbin/watch/watch.8

.\"
.\" @(#)watch.8		1.1 (FreeBSD) 2/17/95
.\" $FreeBSD$
.\"
.Dd February 17, 1995
.Dt WATCH 8
.Os
.Sh NAME
.Nm watch
.Nd snoop on another tty line
.Sh SYNOPSIS
.Nm
.Op Fl ciotnW
.Op Ar tty
.\"  watch [-ciotnW] [<tty name>]
.Sh DESCRIPTION
.Nm Watch
allows the superuser to examine all data coming through a specified tty.
.Nm Watch
writes to standard output.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl c
Reconnect on close.  If the tty observed by
.Nm
is closed,  automatically reattach to the same tty.
If this option is not specified,
.Nm
will request a new tty if running in interactive mode or exit if running
without a controlling tty.
.It Fl i
Force interactive mode.
Interactive mode is a default if
.Nm
is started from a tty.
If output is redirected to a file, interactive mode can still be requested
by specifying this option.
.It Fl o
Reconnect on overflow.
The behavior of
.Nm
if the observed tty overflows is similar to the behavior if the observed tty
is closed.
For more info see
.Xr snp 4 .
.It Fl t
Print the date and time when observation of a given tty is started.
.It Fl n
Disable the ability to switch the watched tty interactively.  This disables
both change requests made with <control-X> as well as automatic prompting
when the current tty is closed or overflows.  In all cases where a prompt
would be displayed,
.Nm
will exit.  The reconnect flags are unaffected by
this option.
.It Fl W
Allow write access to observed tty.
.It Ar tty
Tty may be specified as an tty-style device, such as a pseudo tty device,
a virtual console, or a serial line, etc.
Names may be preceded by
.Pa /dev/ .
.El
.Sh OPERATION
While running in interactive mode, all user input is discarded except for:
.Pp
.Bl -tag -width "XXXX" -compact
.It Sy "<control-G>"
Exit
.Nm .
.It Sy "<control-W>"
Clear screen.
.It Sy "<control-X>"
Change attached tty.
.El
.Sh RESTRICTIONS
Only the superuser can run
.Nm .
.Sh SEE ALSO
.Xr pty 4 ,
.Xr sio 4 ,
.Xr snp 4
.Sh BUGS
No terminal emulation is performed.
All user output is reproduced as-is.
.Sh AUTHORS
.An Ugen J.S. Antsilevich Aq ugen@NetVision.net.il
.Sh HISTORY
.Nm Watch
first appeared in
.Fx 2.1 .
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`.\"`
			`.\" @(#)watch.8 1.1 (FreeBSD) 2/17/95`
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`.\" $FreeBSD$`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`.\"`
			`.Dd February 17, 1995`
Watch fresh-made manpage.. 1995-02-17 16:40:32 +00:00			`.Dt WATCH 8`
			`.Os`
			`.Sh NAME`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`.Nm watch`
			`.Nd snoop on another tty line`
Fix a bunch of spelling errors in a bunch of man pages. 1996-01-30 13:52:50 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Fix a typo in the man page (the "-n" flag was added to the synopsis in a comment). 1996-12-02 16:21:20 +00:00			`.Op Fl ciotnW`
``tty'' is not required parameter 1999-10-30 14:52:24 +00:00			`.Op Ar tty`
I have added a '-n' flag to the watch(8) command. This option disables the ability to interactively select a new tty. I have also removed a check for uid == 0 because it gets in the way of using suid mode based access control. Watch (8)is only runnable by root, so this does not really change things much. Closes PR#2131 Submitted-By: adrian@virginia.edu 1996-12-02 12:32:46 +00:00			`.\" watch [-ciotnW] [<tty name>]`
Watch fresh-made manpage.. 1995-02-17 16:40:32 +00:00			`.Sh DESCRIPTION`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`.Nm Watch`
			`allows the superuser to examine all data coming through a specified tty.`
			`.Nm Watch`
			`writes to standard output.`
			`.Pp`
			`The options are as follows:`
Use err(3). 1997-10-27 12:21:10 +00:00			`.Bl -tag -width indent`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`.It Fl c`
			`Reconnect on close. If the tty observed by`
Use err(3). 1997-10-27 12:21:10 +00:00			`.Nm`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`is closed, automatically reattach to the same tty.`
			`If this option is not specified,`
Use err(3). 1997-10-27 12:21:10 +00:00			`.Nm`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`will request a new tty if running in interactive mode or exit if running`
			`without a controlling tty.`
			`.It Fl i`
			`Force interactive mode.`
			`Interactive mode is a default if`
Use err(3). 1997-10-27 12:21:10 +00:00			`.Nm`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`is started from a tty.`
			`If output is redirected to a file, interactive mode can still be requested`
			`by specifying this option.`
			`.It Fl o`
			`Reconnect on overflow.`
Fix a bunch of spelling errors in a bunch of man pages. 1996-01-30 13:52:50 +00:00			`The behavior of`
Use err(3). 1997-10-27 12:21:10 +00:00			`.Nm`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`if the observed tty overflows is similar to the behavior if the observed tty`
			`is closed.`
			`For more info see`
			`.Xr snp 4 .`
			`.It Fl t`
			`Print the date and time when observation of a given tty is started.`
I have added a '-n' flag to the watch(8) command. This option disables the ability to interactively select a new tty. I have also removed a check for uid == 0 because it gets in the way of using suid mode based access control. Watch (8)is only runnable by root, so this does not really change things much. Closes PR#2131 Submitted-By: adrian@virginia.edu 1996-12-02 12:32:46 +00:00			`.It Fl n`
			`Disable the ability to switch the watched tty interactively. This disables`
			`both change requests made with <control-X> as well as automatic prompting`
			`when the current tty is closed or overflows. In all cases where a prompt`
Replace an instance of the "watch" word with the ".Nm" macro: it is used to specify the command name. 2001-05-04 23:27:30 +00:00			`would be displayed,`
			`.Nm`
			`will exit. The reconnect flags are unaffected by`
I have added a '-n' flag to the watch(8) command. This option disables the ability to interactively select a new tty. I have also removed a check for uid == 0 because it gets in the way of using suid mode based access control. Watch (8)is only runnable by root, so this does not really change things much. Closes PR#2131 Submitted-By: adrian@virginia.edu 1996-12-02 12:32:46 +00:00			`this option.`
same 1995-02-27 19:48:19 +00:00			`.It Fl W`
			`Allow write access to observed tty.`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`.It Ar tty`
Update to use new calling conventions 1995-02-25 20:14:31 +00:00			`Tty may be specified as an tty-style device, such as a pseudo tty device,`
			`a virtual console, or a serial line, etc.`
Add missing .El. -Wall cleaning. 2000-01-23 20:27:32 +00:00			`Names may be preceded by`
			`.Pa /dev/ .`
			`.El`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`.Sh OPERATION`
			`While running in interactive mode, all user input is discarded except for:`
			`.Pp`
			`.Bl -tag -width "XXXX" -compact`
Remove breakage of 1.8.2.2, choose slightly better character for quit. 1996-12-30 09:01:50 +00:00			`.It Sy "<control-G>"`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`Exit`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm .`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`.It Sy "<control-W>"`
			`Clear screen.`
			`.It Sy "<control-X>"`
			`Change attached tty.`
Add missing .El. -Wall cleaning. 2000-01-23 20:27:32 +00:00			`.El`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`.Sh RESTRICTIONS`
			`Only the superuser can run`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm .`
Watch fresh-made manpage.. 1995-02-17 16:40:32 +00:00			`.Sh SEE ALSO`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`.Xr pty 4 ,`
Sort cross references. 1997-01-20 00:03:00 +00:00			`.Xr sio 4 ,`
			`.Xr snp 4`
Watch fresh-made manpage.. 1995-02-17 16:40:32 +00:00			`.Sh BUGS`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`No terminal emulation is performed.`
			`All user output is reproduced as-is.`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-23 08:31:20 +00:00			`.Sh AUTHORS`
Use err(3). 1997-10-27 12:21:10 +00:00			`.An Ugen J.S. Antsilevich Aq ugen@NetVision.net.il`
Watch fresh-made manpage.. 1995-02-17 16:40:32 +00:00			`.Sh HISTORY`
Rewrite manual page to use mandoc correctly and fix english grammar. 1995-02-22 23:47:51 +00:00			`.Nm Watch`
Use the .Fx macro where appropriate. 1996-08-23 00:57:08 +00:00			`first appeared in`
			`.Fx 2.1 .`