From 05c781429d9712a6bfe8b9a198aeaf3454f1b8af Mon Sep 17 00:00:00 2001 From: aaron Date: Sat, 11 Mar 2000 21:40:02 +0000 Subject: [PATCH] Various cleanups and standardizations. --- usr.bin/arch/arch.1 | 6 +- usr.bin/du/du.1 | 4 +- usr.bin/hexdump/hexdump.1 | 4 +- usr.bin/hexdump/od.1 | 3 +- usr.bin/make/make.1 | 8 +- usr.bin/rdist/rdist.1 | 6 +- usr.bin/sed/sed.1 | 4 +- usr.bin/skeyaudit/skeyaudit.1 | 13 +- usr.bin/skeyinfo/skeyinfo.1 | 18 +- usr.bin/soelim/soelim.1 | 14 +- usr.bin/sort/sort.1 | 70 ++--- usr.bin/split/split.1 | 16 +- usr.bin/ssh/ssh.1 | 496 ++++++++++++++++++++------------- usr.bin/strings/strings.1 | 5 +- usr.bin/su/su.1 | 36 +-- usr.bin/systat/systat.1 | 150 ++++++---- usr.bin/tail/tail.1 | 34 ++- usr.bin/talk/talk.1 | 29 +- usr.bin/tcopy/tcopy.1 | 19 +- usr.bin/telnet/telnet.1 | 216 +++++++------- usr.bin/tftp/tftp.1 | 12 +- usr.bin/time/time.1 | 7 +- usr.bin/tip/tip.1 | 95 ++++--- usr.bin/tn3270/tn3270/tn3270.1 | 32 ++- usr.bin/top/top.1 | 162 ++++++----- usr.bin/touch/touch.1 | 18 +- usr.bin/tput/tput.1 | 5 +- usr.bin/tr/tr.1 | 34 +-- usr.bin/true/true.1 | 3 +- usr.bin/tset/tset.1 | 85 +++--- usr.bin/tsort/tsort.1 | 9 +- usr.bin/tty/tty.1 | 18 +- usr.bin/ul/ul.1 | 17 +- usr.bin/uname/uname.1 | 3 +- usr.bin/unifdef/unifdef.1 | 45 +-- usr.bin/uniq/uniq.1 | 16 +- 36 files changed, 989 insertions(+), 723 deletions(-) diff --git a/usr.bin/arch/arch.1 b/usr.bin/arch/arch.1 index 1e08ad58898..d6f3b744564 100644 --- a/usr.bin/arch/arch.1 +++ b/usr.bin/arch/arch.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: arch.1,v 1.5 2000/03/04 21:12:00 aaron Exp $ +.\" $OpenBSD: arch.1,v 1.6 2000/03/11 21:40:07 aaron Exp $ .\" .\" Copyright (c) 1994 SigmaSoft, Th. Lockert .\" All rights reserved. @@ -28,7 +28,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: arch.1,v 1.5 2000/03/04 21:12:00 aaron Exp $ +.\" $OpenBSD: arch.1,v 1.6 2000/03/11 21:40:07 aaron Exp $ .\" .Dd June 22, 1996 .Dt ARCH 1 @@ -67,7 +67,7 @@ are as follows: Display the kernel architecture instead of application architecture. .It Fl s -Display the chosen architecture in a short form, i.e. without the +Display the chosen architecture in a short form, i.e., without the operating system prefixed. .El .Pp diff --git a/usr.bin/du/du.1 b/usr.bin/du/du.1 index e9474ff72ce..8644e938b4a 100644 --- a/usr.bin/du/du.1 +++ b/usr.bin/du/du.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: du.1,v 1.12 2000/03/05 20:34:12 aaron Exp $ +.\" $OpenBSD: du.1,v 1.13 2000/03/11 21:40:07 aaron Exp $ .\" $NetBSD: du.1,v 1.6 1996/10/18 07:20:31 thorpej Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -75,7 +75,7 @@ By default, .Nm displays the number of blocks as returned by the .Xr stat 2 -system call, i.e. 512-byte blocks. +system call, i.e., 512-byte blocks. If the .Fl k flag is specified, the number displayed is the number of 1024-byte diff --git a/usr.bin/hexdump/hexdump.1 b/usr.bin/hexdump/hexdump.1 index 4cbe7a96b50..a86b80afba6 100644 --- a/usr.bin/hexdump/hexdump.1 +++ b/usr.bin/hexdump/hexdump.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hexdump.1,v 1.10 2000/03/07 21:11:10 aaron Exp $ +.\" $OpenBSD: hexdump.1,v 1.11 2000/03/11 21:40:07 aaron Exp $ .\" Copyright (c) 1989, 1990 The Regents of the University of California. .\" All rights reserved. .\" @@ -297,7 +297,7 @@ If, as a result of the specification of the .Fl n option or end-of-file being reached, input data only partially satisfies a format string, the input block is zero-padded sufficiently -to display all available data (i.e. any format units overlapping the +to display all available data (i.e., any format units overlapping the end of data will display some number of the zero bytes). .Pp Further output by such format strings is replaced by an equivalent diff --git a/usr.bin/hexdump/od.1 b/usr.bin/hexdump/od.1 index a7970de3a13..957905d2b0a 100644 --- a/usr.bin/hexdump/od.1 +++ b/usr.bin/hexdump/od.1 @@ -1,4 +1,5 @@ -.\" $OpenBSD: od.1,v 1.7 2000/03/07 21:11:10 aaron Exp $ +.\" $OpenBSD: od.1,v 1.8 2000/03/11 21:40:07 aaron Exp $ +.\" .\" Copyright (c) 1990 The Regents of the University of California. .\" All rights reserved. .\" diff --git a/usr.bin/make/make.1 b/usr.bin/make/make.1 index e6cb5703023..bcf40e103e2 100644 --- a/usr.bin/make/make.1 +++ b/usr.bin/make/make.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: make.1,v 1.28 2000/03/10 19:07:21 aaron Exp $ +.\" $OpenBSD: make.1,v 1.29 2000/03/11 21:40:07 aaron Exp $ .\" $NetBSD: make.1,v 1.18 1997/03/10 21:19:53 christos Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -318,7 +318,7 @@ Append the value to the current value of the variable. .It Ic \&?= Assign the value to the variable if it is not already defined. .It Ic \&:= -Assign with expansion, i.e. expand the value before assigning it +Assign with expansion, i.e., expand the value before assigning it to the variable. Normally, expansion is not done until the variable is referenced. .It Ic \&!= @@ -435,7 +435,7 @@ variables: .It Va \&$ A single dollar sign .Ql \&$ , -i.e. +i.e., .Ql \&$$ expands to a single dollar sign. @@ -1016,7 +1016,7 @@ Loops are not being detected and targets that form loops will be silently ignored. .El .Sh "SPECIAL TARGETS" -Special targets may not be included with other targets, i.e. they must be +Special targets may not be included with other targets, i.e., they must be the only target specified. .Bl -tag -width Ic .BEGIN .It Ic .BEGIN diff --git a/usr.bin/rdist/rdist.1 b/usr.bin/rdist/rdist.1 index 37afa652f6e..d091221f79c 100644 --- a/usr.bin/rdist/rdist.1 +++ b/usr.bin/rdist/rdist.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rdist.1,v 1.10 2000/03/04 22:19:26 aaron Exp $ +.\" $OpenBSD: rdist.1,v 1.11 2000/03/11 21:40:07 aaron Exp $ .\" .\" Copyright (c) 1983 Regents of the University of California. .\" All rights reserved. @@ -472,7 +472,7 @@ The .I rsh-path may be a colon separated list of possible pathnames. In this case, the first component of the path to exist is used. -i.e. +i.e., .B "/usr/ucb/rsh:/usr/bin/remsh", .B /usr/bsd/rsh. .TP @@ -854,7 +854,7 @@ If the basename of a file (the last component in the pathname) is ".", then .B rdist assumes the remote (destination) name is a directory. -i.e. +i.e., .B /tmp/. means that .B /tmp diff --git a/usr.bin/sed/sed.1 b/usr.bin/sed/sed.1 index 4adaec6da28..8f36ba500cc 100644 --- a/usr.bin/sed/sed.1 +++ b/usr.bin/sed/sed.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sed.1,v 1.12 2000/03/10 20:17:52 aaron Exp $ +.\" $OpenBSD: sed.1,v 1.13 2000/03/11 21:40:08 aaron Exp $ .\" .\" Copyright (c) 1992, 1993 .\" The Regents of the University of California. All rights reserved. @@ -188,7 +188,7 @@ One special feature of .Nm regular expressions is that they can default to the last regular expression used. -If a regular expression is empty, i.e. just the delimiter characters +If a regular expression is empty, i.e., just the delimiter characters are specified, the last regular expression encountered is used instead. The last regular expression is defined as the last regular expression used as part of an address or substitute command, and at run-time, not diff --git a/usr.bin/skeyaudit/skeyaudit.1 b/usr.bin/skeyaudit/skeyaudit.1 index f87cee2562a..782f1a3e763 100644 --- a/usr.bin/skeyaudit/skeyaudit.1 +++ b/usr.bin/skeyaudit/skeyaudit.1 @@ -1,5 +1,4 @@ -.\" $OpenBSD: skeyaudit.1,v 1.5 2000/03/05 00:28:58 aaron Exp $ -.\" +.\" $OpenBSD: skeyaudit.1,v 1.6 2000/03/11 21:40:02 aaron Exp $ .\" .Dd 22 July 1997 .Dt SKEYAUDIT 1 @@ -27,15 +26,15 @@ The options are as follows: .It Fl a Check all keys in .Pa /etc/skeykeys . -This option is only available to the super user and +This option is only available to the superuser and is useful to run regularly via .Xr cron 8 . .It Fl i -Interactive mode. Don't send mail, just print to standard output. +Interactive mode. +Don't send mail, just print to the standard output. .It Fl l Ar limit -The limit used to determine whether or not a user should -be notified. The default is to notify if there are fewer -than 12 keys left. +The limit used to determine whether or not a user should be notified. +The default is to notify if there are fewer than 12 keys left. .Sh FILES .Bl -tag -width /etc/skeykeys -compact .It Pa /etc/skeykeys diff --git a/usr.bin/skeyinfo/skeyinfo.1 b/usr.bin/skeyinfo/skeyinfo.1 index f7f60bf1db7..7e1d4f29528 100644 --- a/usr.bin/skeyinfo/skeyinfo.1 +++ b/usr.bin/skeyinfo/skeyinfo.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: skeyinfo.1,v 1.2 1998/09/27 16:57:53 aaron Exp $ +.\" $OpenBSD: skeyinfo.1,v 1.3 2000/03/11 21:40:02 aaron Exp $ .\" .Dd 22 July 1997 .Dt SKEYINFO 1 @@ -11,14 +11,18 @@ .Op Fl v .Op Ar user .Sh DESCRIPTION -.Nm skeyinfo +.Nm prints out the next S/Key challenge for the specified user or for the -current user if no user is specified. If the -.Fl v -flag is given, the hash algorithm is printed as well. -.Sh EXAMPLE +current user if no user is specified. +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl v +Print the hash algorithm as well. +.El +.Sh EXAMPLES % skey -n `skeyinfo` | lpr -.sp +.Pp This would print out a list of S/Key passwords for use over an untrusted network (perhaps for use at a conference). .Sh SEE ALSO diff --git a/usr.bin/soelim/soelim.1 b/usr.bin/soelim/soelim.1 index ae0207bff4e..efe08dec471 100644 --- a/usr.bin/soelim/soelim.1 +++ b/usr.bin/soelim/soelim.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: soelim.1,v 1.4 1999/06/05 01:21:40 aaron Exp $ +.\" $OpenBSD: soelim.1,v 1.5 2000/03/11 21:40:02 aaron Exp $ .\" $NetBSD: soelim.1,v 1.3 1994/12/21 08:11:24 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -44,7 +44,7 @@ .Nm soelim .Op Ar file ... .Sh DESCRIPTION -.Nm soelim +.Nm reads the specified files or the standard input and performs the textual inclusion implied by the .Xr nroff 1 @@ -59,20 +59,20 @@ do not normally do this; it allows the placement of individual tables in separate files to be run as a part of a large document. .Pp An argument consisting of a single minus -.Ql Fl +.Pq Ql - is taken to be a file name corresponding to the standard input. .Pp -Note that inclusion can be suppressed by using +Inclusion can be suppressed by using .Ql \e' instead of .Ql \e. , -i.e. +i.e., .Pp .Dl \'so /usr/lib/tmac.s .Pp A sample usage of -.Nm soelim +.Nm would be .Pp .Bd -literal -offset indent -compact @@ -82,7 +82,7 @@ soelim exum?.n \&| tbl \&| nroff \-ms \&| col \&| lpr .Xr colcrt 1 , .Xr more 1 .Sh BUGS -The format of the source commands must involve no strangeness \- +The format of the source commands must involve no strangeness; exactly one blank must precede and no blanks follow the file name. .Sh HISTORY The diff --git a/usr.bin/sort/sort.1 b/usr.bin/sort/sort.1 index b9e9c4849bf..56087733953 100644 --- a/usr.bin/sort/sort.1 +++ b/usr.bin/sort/sort.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sort.1,v 1.7 2000/03/05 00:28:55 aaron Exp $ +.\" $OpenBSD: sort.1,v 1.8 2000/03/11 21:40:03 aaron Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -57,13 +57,13 @@ .Ar ... .Sh DESCRIPTION The -.Nm sort +.Nm utility sorts text files by lines. Comparisons are based on one or more sort keys extracted -from each line of input, and are performed -lexicographically. By default, if keys are not given, -.Nm sort +from each line of input, and are performed lexicographically. +By default, if keys are not given, +.Nm regards each input line as a single field. .Pp The options are as follows: @@ -71,12 +71,12 @@ The options are as follows: .It Fl c Check that the single input file is sorted. If the file is not sorted, -.Nm sort +.Nm produces the appropriate error messages and exits with code 1; otherwise, -.Nm sort +.Nm returns 0. -.Nm sort +.Nm .Fl c produces no output, except the error messages on .Em stderr . @@ -92,8 +92,8 @@ can be the same as one of the input files. .It Fl T Ar dir Use .Ar dir -as the directory for temporary files. The default is the contents -of the environment variable +as the directory for temporary files. +The default is the contents of the environment variable .Ev TMPDIR or .Pa /var/tmp @@ -148,8 +148,8 @@ option.) .It Fl r Reverse the sense of comparisons. .It Fl H -Use a merge sort instead of a radix sort. This option should be -used for files larger than 60Mb. +Use a merge sort instead of a radix sort. +This options should be used for files larger than 60Mb. .El .Pp The treatment of field separators can be altered using these @@ -179,7 +179,8 @@ option has no effect unless key fields are specified. .It Fl t Ar char .Ar char -is used as the field separator character. The initial +is used as the field separator character. +The initial .Ar char is not considered to be part of a field when determining key offsets. @@ -248,7 +249,8 @@ considered to be part of the first field. Fields are specified by the .Fl k Ar field1[,field2] -argument. A missing +argument. +A missing .Ar field2 argument defaults to the end of a line. .Pp @@ -342,8 +344,23 @@ option is still supported, except for which has no .Fl k equivalent. +.Pp +The +.Nm +utility shall exit with one of the following values: +.Pp +.Bl -tag -width flag -compact +.It 0 +Normal behavior. +.It 1 +On disorder (or non-uniqueness) with the +.Fl c +option. +.It 2 +An error occurred. +.El .Sh ENVIRONMENT -If the following environment variable exists, it is utilized by +The following environment variables affect the execution of .Nm sort : .Bl -tag -width Fl .It Ev TMPDIR @@ -368,32 +385,19 @@ already exists .Xr comm 1 , .Xr join 1 , .Xr uniq 1 -.Sh RETURN VALUES -.Nm sort -exits with one of the following values: -.Pp -.Bl -tag -width flag -compact -.It 0 -Normal behavior. -.It 1 -On disorder (or non-uniqueness) with the -.Fl c -option. -.It 2 -An error occurred. .Sh BUGS Lines longer than 65522 characters are discarded and processing continues. To sort files larger than 60Mb, use -.Nm sort +.Nm .Fl H ; files larger than 704Mb must be sorted in smaller pieces, then merged. To protect data -.Nm sort +.Nm .Fl o calls link and unlink, and thus fails in protected directories. .Sh HISTORY A -.Nm sort +.Nm command appeared in .At v6 . .Sh NOTES @@ -408,9 +412,9 @@ argument of the .Fl k option should be used whenever possible. Similarly, -.Nm sort +.Nm .Fl k1f is equivalent to -.Nm sort +.Nm .Fl f and may take twice as long. diff --git a/usr.bin/split/split.1 b/usr.bin/split/split.1 index c851d477323..e7ea9ac72a7 100644 --- a/usr.bin/split/split.1 +++ b/usr.bin/split/split.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: split.1,v 1.4 1999/06/05 01:21:41 aaron Exp $ +.\" $OpenBSD: split.1,v 1.5 2000/03/11 21:40:03 aaron Exp $ .\" $NetBSD: split.1,v 1.5 1994/12/21 08:20:35 jtc Exp $ .\" .\" Copyright (c) 1990, 1991, 1993, 1994 @@ -48,7 +48,7 @@ .Op Ar file Op Ar name .Sh DESCRIPTION The -.Nm split +.Nm utility reads the given .Ar file (or standard input if no file is specified) @@ -61,12 +61,12 @@ Create smaller files .Ar byte_count bytes in length. If -.Dq Li k +.Sq k is appended to the number, the file is split into .Ar byte_count kilobyte pieces. If -.Dq Li m +.Sq m is appended to the number, the file is split into .Ar byte_count megabyte pieces. @@ -92,17 +92,17 @@ If a second additional argument is specified, it is used as a prefix for the names of the files into which the file is split. In this case, each file into which the file is split is named by the prefix followed by a lexically ordered suffix in the range of -.Dq Li aa-zz . +.Dq aa-zz . .Pp If the .Ar name argument is not specified, the file is split into lexically ordered files named in the range of -.Dq Li xaa-zzz . +.Dq xaa-zzz . .Sh BUGS For historical reasons, if you specify .Ar name , -.Nm split +.Nm can only create 676 separate files. The default naming convention allows 2028 separate files. @@ -112,6 +112,6 @@ The maximum line length for matching patterns is 65536. .Xr re_format 7 . .Sh HISTORY A -.Nm split +.Nm command appeared in .At v6 . diff --git a/usr.bin/ssh/ssh.1 b/usr.bin/ssh/ssh.1 index 1751b66110c..68f1a889f83 100644 --- a/usr.bin/ssh/ssh.1 +++ b/usr.bin/ssh/ssh.1 @@ -9,7 +9,7 @@ .\" .\" Created: Sat Apr 22 21:55:14 1995 ylo .\" -.\" $Id: ssh.1,v 1.39 2000/03/04 07:07:05 djm Exp $ +.\" $Id: ssh.1,v 1.40 2000/03/11 21:40:03 aaron Exp $ .\" .Dd September 25, 1999 .Dt SSH 1 @@ -52,9 +52,11 @@ .Sh DESCRIPTION .Nm (Secure Shell) is a program for logging into a remote machine and for -executing commands on a remote machine. It is intended to replace +executing commands on a remote machine. +It is intended to replace rlogin and rsh, and provide secure encrypted communications between -two untrusted hosts over an insecure network. X11 connections and +two untrusted hosts over an insecure network. +X11 connections and arbitrary TCP/IP ports can also be forwarded over the secure channel. .Pp .Nm @@ -76,15 +78,16 @@ or exists in the user's home directory on the remote machine and contains a line containing the name of the client machine and the name of the user on that machine, the user is -permitted to log in. This form of authentication alone is normally not +permitted to log in. +This form of authentication alone is normally not allowed by the server because it is not secure. .Pp The second (and primary) authentication method is the .Pa rhosts or .Pa hosts.equiv -method combined with RSA-based host authentication. It -means that if the login would be permitted by +method combined with RSA-based host authentication. +It means that if the login would be permitted by .Pa \&.rhosts , .Pa \&.shosts , .Pa /etc/hosts.equiv , @@ -97,10 +100,10 @@ and .Pa $HOME/.ssh/known_hosts in the .Sx FILES -section), only then login is -permitted. This authentication method closes security holes due to IP -spoofing, DNS spoofing and routing spoofing. [Note to the -administrator: +section), only then login is permitted. +This authentication method closes security holes due to IP +spoofing, DNS spoofing and routing spoofing. +[Note to the administrator: .Pa /etc/hosts.equiv , .Pa \&.rhosts , and the rlogin/rsh protocol in general, are inherently insecure and should be @@ -112,34 +115,39 @@ supports RSA based authentication. The scheme is based on public-key cryptography: there are cryptosystems where encryption and decryption are done using separate keys, and it is not possible to derive the decryption key from the encryption key. -RSA is one such system. The idea is that each user creates a public/private -key pair for authentication purposes. The -server knows the public key, and only the user knows the private key. +RSA is one such system. +The idea is that each user creates a public/private +key pair for authentication purposes. +The server knows the public key, and only the user knows the private key. The file .Pa $HOME/.ssh/authorized_keys lists the public keys that are permitted for logging -in. When the user logs in, the +in. +When the user logs in, the .Nm program tells the server which key pair it would like to use for -authentication. The server checks if this key is permitted, and if +authentication. +The server checks if this key is permitted, and if so, sends the user (actually the .Nm program running on behalf of the user) a challenge, a random number, -encrypted by the user's public key. The challenge can only be -decrypted using the proper private key. The user's client then decrypts the +encrypted by the user's public key. +The challenge can only be +decrypted using the proper private key. +The user's client then decrypts the challenge using the private key, proving that he/she knows the private key but without disclosing it to the server. .Pp .Nm -implements the RSA authentication protocol automatically. The user -creates his/her RSA key pair by running +implements the RSA authentication protocol automatically. +The user creates his/her RSA key pair by running .Xr ssh-keygen 1 . This stores the private key in .Pa \&.ssh/identity and the public key in .Pa \&.ssh/identity.pub -in the user's home directory. The user should then -copy the +in the user's home directory. +The user should then copy the .Pa identity.pub to .Pa \&.ssh/authorized_keys @@ -148,24 +156,28 @@ in his/her home directory on the remote machine (the file corresponds to the conventional .Pa \&.rhosts file, and has one key -per line, though the lines can be very long). After this, the user -can log in without giving the password. RSA authentication is much +per line, though the lines can be very long). +After this, the user can log in without giving the password. +RSA authentication is much more secure than rhosts authentication. .Pp The most convenient way to use RSA authentication may be with an -authentication agent. See +authentication agent. +See .Xr ssh-agent 1 for more information. .Pp If other authentication methods fail, .Nm -prompts the user for a password. The password is sent to the remote +prompts the user for a password. +The password is sent to the remote host for checking; however, since all communications are encrypted, the password cannot be seen by someone listening on the network. .Pp When the user's identity has been accepted by the server, the server either executes the given command, or logs into the machine and gives -the user a normal shell on the remote machine. All communication with +the user a normal shell on the remote machine. +All communication with the remote command or shell will be automatically encrypted. .Pp If a pseudo-terminal has been allocated (normal login session), the @@ -182,19 +194,22 @@ the session blocks waiting for forwarded X11 or TCP/IP connections to terminate, it can be backgrounded with .Ic ~& (this should not be used while the user shell is active, as it can cause the -shell to hang). All available escapes can be listed with +shell to hang). +All available escapes can be listed with .Ic ~? . .Pp A single tilde character can be sent as .Ic ~~ (or by following the tilde by a character other than those described above). The escape character must always follow a newline to be interpreted as -special. The escape character can be changed in configuration files -or on the command line. +special. +The escape character can be changed in configuration files +or on the command line. .Pp If no pseudo tty has been allocated, the session is transparent and can be used to reliably transfer binary -data. On most systems, setting the escape character to +data. +On most systems, setting the escape character to .Dq none will also make the session transparent even if a tty is used. .Pp @@ -210,7 +225,8 @@ environment variable is set), the connection to the X11 display is automatically forwarded to the remote side in such a way that any X11 programs started from the shell (or command) will go through the encrypted channel, and the connection to the real X server will be made -from the local machine. The user should not manually set +from the local machine. +The user should not manually set .Ev DISPLAY . Forwarding of X11 connections can be configured on the command line or in configuration files. @@ -220,7 +236,8 @@ The value set by .Nm will point to the server machine, but with a display number greater -than zero. This is normal, and happens because +than zero. +This is normal, and happens because .Nm creates a .Dq proxy @@ -232,7 +249,8 @@ will also automatically set up Xauthority data on the server machine. For this purpose, it will generate a random authorization cookie, store it in Xauthority on the server, and verify that any forwarded connections carry this cookie and replace it by the real cookie when -the connection is opened. The real authentication cookie is never +the connection is opened. +The real authentication cookie is never sent to the server machine (and no cookies are sent in the plain). .Pp If the user is using an authentication agent, the connection to the agent @@ -240,25 +258,29 @@ is automatically forwarded to the remote side unless disabled on command line or in a configuration file. .Pp Forwarding of arbitrary TCP/IP connections over the secure channel can -be specified either on command line or in a configuration file. One -possible application of TCP/IP forwarding is a secure connection to an +be specified either on command line or in a configuration file. +One possible application of TCP/IP forwarding is a secure connection to an electronic purse; another is going trough firewalls. .Pp .Nm automatically maintains and checks a database containing RSA-based -identifications for all hosts it has ever been used with. The -database is stored in +identifications for all hosts it has ever been used with. +The database is stored in .Pa \&.ssh/known_hosts -in the user's home directory. Additionally, the file +in the user's home directory. +Additionally, the file .Pa /etc/ssh_known_hosts -is automatically checked for known hosts. Any new hosts are -automatically added to the user's file. If a host's identification +is automatically checked for known hosts. +Any new hosts are automatically added to the user's file. +If a host's identification ever changes, .Nm warns about this and disables password authentication to prevent a -trojan horse from getting the user's password. Another purpose of +trojan horse from getting the user's password. +Another purpose of this mechanism is to prevent man-in-the-middle attacks which could -otherwise be used to circumvent the encryption. The +otherwise be used to circumvent the encryption. +The .Cm StrictHostKeyChecking option (see below) can be used to prevent logins to machines whose host key is not known or has changed. @@ -270,7 +292,8 @@ also be specified on a per-host basis in the configuration file. .It Fl c Ar blowfish|3des Selects the cipher to use for encrypting the session. .Ar 3des -is used by default. It is believed to be secure. +is used by default. +It is believed to be secure. .Ar 3des (triple-des) is an encrypt-decrypt-encrypt triple with three different keys. It is presumably more secure than the @@ -278,26 +301,28 @@ It is presumably more secure than the cipher which is no longer supported in ssh. .Ar blowfish is a fast block cipher, it appears very secure and is much faster than -.Ar 3des . +.Ar 3des . .It Fl e Ar ch|^ch|none Sets the escape character for sessions with a pty (default: .Ql ~ ) . -The escape character is only recognized at the beginning of a line. The -escape character followed by a dot +The escape character is only recognized at the beginning of a line. +The escape character followed by a dot .Pq Ql \&. closes the connection, followed by control-Z suspends the connection, and followed by itself sends the -escape character once. Setting the character to +escape character once. +Setting the character to .Dq none disables any escapes and makes the session fully transparent. .It Fl f Requests .Nm -to go to background just before command execution. This is useful -if +to go to background just before command execution. +This is useful if .Nm is going to ask for passwords or passphrases, but the user -wants it in the background. This implies +wants it in the background. +This implies .Fl n . The recommended way to start X11 programs at a remote site is with something like @@ -306,11 +331,13 @@ something like Allows remote hosts to connect to local forwarded ports. .It Fl i Ar identity_file Selects the file from which the identity (private key) for -RSA authentication is read. Default is +RSA authentication is read. +Default is .Pa \&.ssh/identity -in the user's home directory. Identity files may also be specified on -a per-host basis in the configuration file. It is possible to have -multiple +in the user's home directory. +Identity files may also be specified on +a per-host basis in the configuration file. +It is possible to have multiple .Fl i options (and multiple identities specified in configuration files). @@ -318,16 +345,17 @@ configuration files). Disables forwarding of Kerberos tickets and AFS tokens. This may also be specified on a per-host basis in the configuration file. .It Fl l Ar login_name -Specifies the user to log in as on the remote machine. This may also -be specified on a per-host basis in the configuration file. +Specifies the user to log in as on the remote machine. +This also may be specified on a per-host basis in the configuration file. .It Fl n Redirects stdin from .Pa /dev/null (actually, prevents reading from stdin). This must be used when .Nm -is run in the background. A common trick is to use this to run X11 -programs in a remote machine. For example, +is run in the background. +A common trick is to use this to run X11 programs on a remote machine. +For example, .Ic ssh -n shadows.cs.hut.fi emacs & will start an emacs on shadows.cs.hut.fi, and the X11 connection will be automatically forwarded over an encrypted channel. @@ -342,10 +370,11 @@ option.) .It Fl o Ar option Can be used to give options in the format used in the config file. This is useful for specifying options for which there is no separate -command-line flag. The option has the same format as a line in the -configuration file. +command-line flag. +The option has the same format as a line in the configuration file. .It Fl p Ar port -Port to connect to on the remote host. This can be specified on a +Port to connect to on the remote host. +This can be specified on a per-host basis in the configuration file. .It Fl P Use a non-privileged port for outgoing connections. @@ -356,35 +385,40 @@ Note that this option turns off and .Cm RhostsRSAAuthentication . .It Fl q -Quiet mode. Causes all warning and diagnostic messages to be -suppressed. Only fatal errors are displayed. +Quiet mode. +Causes all warning and diagnostic messages to be suppressed. +Only fatal errors are displayed. .It Fl t -Force pseudo-tty allocation. This can be used to execute arbitary -screen-based programs on a remote machine, which can be very useful -e.g. when implementing menu services. +Force pseudo-tty allocation. +This can be used to execute arbitary +screen-based programs on a remote machine, which can be very useful, +e.g., when implementing menu services. .It Fl v -Verbose mode. Causes +Verbose mode. +Causes .Nm -to print debugging messages about its progress. This is helpful in +to print debugging messages about its progress. +This is helpful in debugging connection, authentication, and configuration problems. The verbose mode is also used to display .Xr skey 1 challenges, if the user entered "s/key" as password. .It Fl x -Disables X11 forwarding. This can also be specified on a per-host -basis in a configuration file. +Disables X11 forwarding. +This can also be specified on a per-host basis in a configuration file. .It Fl X Enables X11 forwarding. .It Fl C Requests compression of all data (including stdin, stdout, stderr, and -data for forwarded X11 and TCP/IP connections). The compression -algorithm is the same used by +data for forwarded X11 and TCP/IP connections). +The compression algorithm is the same used by .Xr gzip 1 , and the .Dq level can be controlled by the .Cm CompressionLevel -option (see below). Compression is desirable on modem lines and other +option (see below). +Compression is desirable on modem lines and other slow connections, but will only slow down things on fast networks. The default value can be set on a host-by-host basis in the configuration files; see the @@ -392,8 +426,8 @@ configuration files; see the option below. .It Fl L Ar port:host:hostport Specifies that the given port on the local (client) host is to be -forwarded to the given host and port on the remote side. This works -by allocating a socket to listen to +forwarded to the given host and port on the remote side. +This works by allocating a socket to listen to .Ar port on the local side, and whenever a connection is made to this port, the connection is forwarded over the secure channel, and a connection is @@ -401,14 +435,15 @@ made to .Ar host port .Ar hostport -from the remote machine. Port forwardings can also be specified in the -configuration file. Only root can forward privileged ports. +from the remote machine. +Port forwardings can also be specified in the configuration file. +Only root can forward privileged ports. IPv6 addresses can be specified with an alternative syntax: .Ar port/host/hostport .It Fl R Ar port:host:hostport Specifies that the given port on the remote (server) host is to be -forwarded to the given host and port on the local side. This works -by allocating a socket to listen to +forwarded to the given host and port on the local side. +This works by allocating a socket to listen to .Ar port on the remote side, and whenever a connection is made to this port, the connection is forwarded over the secure channel, and a connection is @@ -416,8 +451,9 @@ made to .Ar host port .Ar hostport -from the local machine. Port forwardings can also be specified in the -configuration file. Privileged ports can be forwarded only when +from the local machine. +Port forwardings can also be specified in the configuration file. +Privileged ports can be forwarded only when logging in as root on the remote machine. .It Fl 4 Forces @@ -436,10 +472,12 @@ command line options, user's configuration file and system-wide configuration file .Pq Pa /etc/ssh_config . For each parameter, the first obtained value -will be used. The configuration files contain sections bracketed by -"Host" specifications, and that section is only applied for hosts that -match one of the patterns given in the specification. The matched -host name is the one given on the command line. +will be used. +The configuration files contain sections bracketed by +.Dq Host +specifications, and that section is only applied for hosts that +match one of the patterns given in the specification. +The matched host name is the one given on the command line. .Pp Since the first obtained value for each parameter is used, more host-specific declarations should be given near the beginning of the @@ -466,10 +504,12 @@ given after the keyword. and .Ql ? can be used as wildcards in the -patterns. A single +patterns. +A single .Ql \&* as a pattern can be used to provide global -defaults for all hosts. The host is the +defaults for all hosts. +The host is the .Ar hostname argument given on the command line (i.e., the name is not converted to a canonicalized host name before matching). @@ -482,9 +522,10 @@ or .It Cm BatchMode If set to .Dq yes , -passphrase/password querying will be disabled. This -option is useful in scripts and other batch jobs where you have no -user to supply the password. The argument must be +passphrase/password querying will be disabled. +This option is useful in scripts and other batch jobs where you have no +user to supply the password. +The argument must be .Dq yes or .Dq no . @@ -498,33 +539,37 @@ If the option is set to .Dq no , the check will not be executed. .It Cm Cipher -Specifies the cipher to use for encrypting the session. Currently, +Specifies the cipher to use for encrypting the session. +Currently, .Dq blowfish , and .Dq 3des -are supported. The default is +are supported. +The default is .Dq 3des . .It Cm Compression -Specifies whether to use compression. The argument must be +Specifies whether to use compression. +The argument must be .Dq yes or .Dq no . .It Cm CompressionLevel -Specifies the compression level to use if compression is enable. The -argument must be an integer from 1 (fast) to 9 (slow, best). The -default level is 6, which is good for most applications. The meaning -of the values is the same as in +Specifies the compression level to use if compression is enable. +The argument must be an integer from 1 (fast) to 9 (slow, best). +The default level is 6, which is good for most applications. +The meaning of the values is the same as in .Xr gzip 1 . .It Cm ConnectionAttempts Specifies the number of tries (one per second) to make before falling -back to rsh or exiting. The argument must be an integer. This may be -useful in scripts if the connection sometimes fails. +back to rsh or exiting. +The argument must be an integer. +This may be useful in scripts if the connection sometimes fails. .It Cm EscapeChar Sets the escape character (default: .Ql ~ ) . The escape character can also -be set on the command line. The argument should be a single -character, +be set on the command line. +The argument should be a single character, .Ql ^ followed by a letter, or .Dq none @@ -539,13 +584,15 @@ fails due to a connection refused error (there is no listening on the remote host), .Xr rsh 1 should automatically be used instead (after a suitable warning about -the session being unencrypted). The argument must be +the session being unencrypted). +The argument must be .Dq yes or .Dq no . .It Cm ForwardAgent Specifies whether the connection to the authentication agent (if any) -will be forwarded to the remote machine. The argument must be +will be forwarded to the remote machine. +The argument must be .Dq yes or .Dq no . @@ -553,7 +600,8 @@ or Specifies whether X11 connections will be automatically redirected over the secure channel and .Ev DISPLAY -set. The argument must be +set. +The argument must be .Dq yes or .Dq no . @@ -572,10 +620,10 @@ The default is Specifies a file to use instead of .Pa /etc/ssh_known_hosts . .It Cm HostName -Specifies the real host name to log into. This can be used to specify -nicnames or abbreviations for hosts. Default is the name given on the -command line. Numeric IP addresses are also permitted (both on the -command line and in +Specifies the real host name to log into. +This can be used to specify nicknames or abbreviations for hosts. +Default is the name given on the command line. +Numeric IP addresses are also permitted (both on the command line and in .Cm HostName specifications). .It Cm IdentityFile @@ -584,22 +632,26 @@ is read (default .Pa .ssh/identity in the user's home directory). Additionally, any identities represented by the authentication agent -will be used for authentication. The file name may use the tilde -syntax to refer to a user's home directory. It is possible to have +will be used for authentication. +The file name may use the tilde +syntax to refer to a user's home directory. +It is possible to have multiple identity files specified in configuration files; all these identities will be tried in sequence. .It Cm KeepAlive Specifies whether the system should send keepalive messages to the -other side. If they are sent, death of the connection or crash of one -of the machines will be properly noticed. However, this means that +other side. +If they are sent, death of the connection or crash of one +of the machines will be properly noticed. +However, this means that connections will die if the route is down temporarily, and some people find it annoying. .Pp The default is .Dq yes (to send keepalives), and the client will notice -if the network goes down or the remote host dies. This is important -in scripts, and many users want it too. +if the network goes down or the remote host dies. +This is important in scripts, and many users want it too. .Pp To disable keepalives, the value should be set to .Dq no @@ -619,11 +671,12 @@ or .Dq no . .It Cm LocalForward Specifies that a TCP/IP port on the local machine be forwarded over -the secure channel to given host:port from the remote machine. The -first argument must be a port number, and the second must be -host:port. Multiple forwardings may be specified, and additional -forwardings can be given on the command line. Only the root can -forward privileged ports. +the secure channel to given host:port from the remote machine. +The first argument must be a port number, and the second must be +host:port. +Multiple forwardings may be specified, and additional +forwardings can be given on the command line. +Only the superuser can forward privileged ports. .It Cm LogLevel Gives the verbosity level that is used when logging messages from .Nm ssh . @@ -634,25 +687,33 @@ The default is INFO. Specifies the number of password prompts before giving up. The argument to this keyword must be an integer. Default is 3. .It Cm PasswordAuthentication -Specifies whether to use password authentication. The argument to -this keyword must be +Specifies whether to use password authentication. +The argument to this keyword must be .Dq yes or .Dq no . .It Cm Port -Specifies the port number to connect on the remote host. Default is -22. +Specifies the port number to connect on the remote host. +Default is 22. .It Cm ProxyCommand -Specifies the command to use to connect to the server. The command -string extends to the end of the line, and is executed with /bin/sh. -In the command string, %h will be substituted by the host name to -connect and %p by the port. The command can be basically anything, -and should read from its stdin and write to its stdout. It should -eventually connect an +Specifies the command to use to connect to the server. +The command +string extends to the end of the line, and is executed with +.Pa /bin/sh . +In the command string, +.Ql %h +will be substituted by the host name to +connect and +.Ql %p +by the port. +The command can be basically anything, +and should read from its standard input and write to its standard output. +It should eventually connect an .Xr sshd 8 server running on some machine, or execute .Ic sshd -i -somewhere. Host key management will be done using the +somewhere. +Host key management will be done using the HostName of the host being connected (defaulting to the name typed by the user). Note that @@ -661,32 +722,37 @@ is not available for connects with a proxy command. .Pp .It Cm RemoteForward Specifies that a TCP/IP port on the remote machine be forwarded over -the secure channel to given host:port from the local machine. The -first argument must be a port number, and the second must be -host:port. Multiple forwardings may be specified, and additional -forwardings can be given on the command line. Only the root can -forward privileged ports. +the secure channel to given host:port from the local machine. +The first argument must be a port number, and the second must be +host:port. +Multiple forwardings may be specified, and additional +forwardings can be given on the command line. +Only the superuser can forward privileged ports. .It Cm RhostsAuthentication -Specifies whether to try rhosts based authentication. Note that this +Specifies whether to try rhosts based authentication. +Note that this declaration only affects the client side and has no effect whatsoever -on security. Disabling rhosts authentication may reduce +on security. +Disabling rhosts authentication may reduce authentication time on slow connections when rhosts authentication is -not used. Most servers do not permit RhostsAuthentication because it -is not secure (see RhostsRSAAuthentication). The argument to this -keyword must be +not used. +Most servers do not permit RhostsAuthentication because it +is not secure (see RhostsRSAAuthentication). +The argument to this keyword must be .Dq yes or .Dq no . .It Cm RhostsRSAAuthentication Specifies whether to try rhosts based authentication with RSA host -authentication. This is the primary authentication method for most -sites. The argument must be +authentication. +This is the primary authentication method for most sites. +The argument must be .Dq yes or .Dq no . .It Cm RSAAuthentication -Specifies whether to try RSA authentication. The argument to this -keyword must be +Specifies whether to try RSA authentication. +The argument to this keyword must be .Dq yes or .Dq no . @@ -696,8 +762,8 @@ running. .It Cm SkeyAuthentication Specifies whether to use .Xr skey 1 -authentication. The argument to -this keyword must be +authentication. +The argument to this keyword must be .Dq yes or .Dq no . @@ -709,16 +775,19 @@ If this flag is set to .Nm ssh will never automatically add host keys to the .Pa $HOME/.ssh/known_hosts -file, and refuses to connect hosts whose host key has changed. This -provides maximum protection against trojan horse attacks. However, it -can be somewhat annoying if you don't have good +file, and refuses to connect hosts whose host key has changed. +This provides maximum protection against trojan horse attacks. +However, it can be somewhat annoying if you don't have good .Pa /etc/ssh_known_hosts files installed and frequently -connect new hosts. Basically this option forces the user to manually -add any new hosts. Normally this option is disabled, and new hosts -will automatically be added to the known host files. The host keys of -known hosts will be verified automatically in either case. The -argument must be +connect new hosts. +Basically this option forces the user to manually +add any new hosts. +Normally this option is disabled, and new hosts +will automatically be added to the known host files. +The host keys of +known hosts will be verified automatically in either case. +The argument must be .Dq yes or .Dq no . @@ -737,23 +806,26 @@ turns off and .Cm RhostsRSAAuthentication . .It Cm User -Specifies the user to log in as. This can be useful if you have a -different user name in different machines. This saves the trouble of +Specifies the user to log in as. +This can be useful if you have a different user name on different machines. +This saves the trouble of having to remember to give the user name on the command line. .It Cm UserKnownHostsFile Specifies a file to use instead of .Pa $HOME/.ssh/known_hosts . .It Cm UseRsh -Specifies that rlogin/rsh should be used for this host. It is -possible that the host does not at all support the +Specifies that rlogin/rsh should be used for this host. +It is possible that the host does not at all support the .Nm -protocol. This causes +protocol. +This causes .Nm -to immediately exec +to immediately execute .Xr rsh 1 . All other options (except .Cm HostName ) -are ignored if this has been specified. The argument must be +are ignored if this has been specified. +The argument must be .Dq yes or .Dq no . @@ -764,15 +836,17 @@ will normally set the following environment variables: .It Ev DISPLAY The .Ev DISPLAY -variable indicates the location of the X11 server. It is -automatically set by +variable indicates the location of the X11 server. +It is automatically set by .Nm to point to a value of the form .Dq hostname:n where hostname indicates -the host where the shell runs, and n is an integer >= 1. Ssh uses -this special value to forward X11 connections over the secure -channel. The user should normally not set DISPLAY explicitly, as that +the host where the shell runs, and n is an integer >= 1. +.Nm +uses this special value to forward X11 connections over the secure +channel. +The user should normally not set DISPLAY explicitly, as that will render the X11 connection insecure (and will require the user to manually copy any required authorization cookies). .It Ev HOME @@ -783,7 +857,7 @@ Synonym for set for compatibility with systems that use this variable. .It Ev MAIL Set to point the user's mailbox. -.It Ev PATH +.It Ev PATH Set to the default .Ev PATH , as specified when compiling @@ -792,12 +866,14 @@ as specified when compiling indicates the path of a unix-domain socket used to communicate with the agent. .It Ev SSH_CLIENT -Identifies the client end of the connection. The variable contains +Identifies the client end of the connection. +The variable contains three space-separated values: client ip-address, client port number, and server port number. .It Ev SSH_TTY This is set to the name of the tty (path to the device) associated -with the current shell or command. If the current session has no tty, +with the current shell or command. +If the current session has no tty, this variable is not set. .It Ev TZ The timezone variable is set to indicate the present timezone if it @@ -823,7 +899,8 @@ in See .Xr sshd 8 . .It Pa $HOME/.ssh/identity -Contains the RSA authentication identity of the user. This file +Contains the RSA authentication identity of the user. +This file contains sensitive data and should be readable by the user but not accessible by others (read/write/execute). Note that @@ -834,39 +911,50 @@ generating the key; the passphrase will be used to encrypt the sensitive part of this file using 3DES. .It Pa $HOME/.ssh/identity.pub Contains the public key for authentication (public part of the -identity file in human-readable form). The contents of this file -should be added to +identity file in human-readable form). +The contents of this file should be added to .Pa $HOME/.ssh/authorized_keys on all machines -where you wish to log in using RSA authentication. This file is not -sensitive and can (but need not) be readable by anyone. This file is +where you wish to log in using RSA authentication. +This file is not +sensitive and can (but need not) be readable by anyone. +This file is never used automatically and is not necessary; it is only provided for the convenience of the user. .It Pa $HOME/.ssh/config -This is the per-user configuration file. The format of this file is -described above. This file is used by the +This is the per-user configuration file. +The format of this file is described above. +This file is used by the .Nm -client. This file does not usually contain any sensitive information, +client. +This file does not usually contain any sensitive information, but the recommended permissions are read/write for the user, and not accessible by others. .It Pa $HOME/.ssh/authorized_keys -Lists the RSA keys that can be used for logging in as this user. The -format of this file is described in the +Lists the RSA keys that can be used for logging in as this user. +The format of this file is described in the .Xr sshd 8 -manual page. In the simplest form the format is the same as the .pub +manual page. +In the simplest form the format is the same as the .pub identity files (that is, each line contains the number of bits in modulus, public exponent, modulus, and comment fields, separated by -spaces). This file is not highly sensitive, but the recommended +spaces). +This file is not highly sensitive, but the recommended permissions are read/write for the user, and not accessible by others. .It Pa /etc/ssh_known_hosts -Systemwide list of known host keys. This file should be prepared by the +Systemwide list of known host keys. +This file should be prepared by the system administrator to contain the public host keys of all machines in the -organization. This file should be world-readable. This file contains +organization. +This file should be world-readable. +This file contains public keys, one per line, in the following format (fields separated by spaces): system name, number of bits in modulus, public exponent, -modulus, and optional comment field. When different names are used +modulus, and optional comment field. +When different names are used for the same machine, all such names should be listed, separated by -commas. The format is described on the +commas. +The format is described on the .Xr sshd 8 manual page. .Pp @@ -878,32 +966,37 @@ does not convert the user-supplied name to a canonical name before checking the key, because someone with access to the name servers would then be able to fool host authentication. .It Pa /etc/ssh_config -Systemwide configuration file. This file provides defaults for those +Systemwide configuration file. +This file provides defaults for those values that are not specified in the user's configuration file, and -for those users who do not have a configuration file. This file must -be world-readable. +for those users who do not have a configuration file. +This file must be world-readable. .It Pa $HOME/.rhosts This file is used in .Pa \&.rhosts authentication to list the -host/user pairs that are permitted to log in. (Note that this file is +host/user pairs that are permitted to log in. +(Note that this file is also used by rlogin and rsh, which makes using this file insecure.) Each line of the file contains a host name (in the canonical form returned by name servers), and then a user name on that host, -separated by a space. One some machines this file may need to be +separated by a space. +One some machines this file may need to be world-readable if the user's home directory is on a NFS partition, because .Xr sshd 8 -reads it as root. Additionally, this file must be owned by the user, -and must not have write permissions for anyone else. The recommended +reads it as root. +Additionally, this file must be owned by the user, +and must not have write permissions for anyone else. +The recommended permission for most machines is read/write for the user, and not accessible by others. .Pp Note that by default .Xr sshd 8 will be installed so that it requires successful RSA host -authentication before permitting \s+2.\s0rhosts authentication. If your -server machine does not have the client's host key in +authentication before permitting \s+2.\s0rhosts authentication. +If your server machine does not have the client's host key in .Pa /etc/ssh_known_hosts , you can store it in .Pa $HOME/.ssh/known_hosts . @@ -923,14 +1016,18 @@ or .Xr rsh 1 . .It Pa /etc/hosts.equiv This file is used during -.Pa \&.rhosts authentication. It contains +.Pa \&.rhosts authentication. +It contains canonical hosts names, one per line (the full format is described on the .Xr sshd 8 -manual page). If the client host is found in this file, login is +manual page). +If the client host is found in this file, login is automatically permitted provided client and server user names are the -same. Additionally, successful RSA host authentication is normally -required. This file should only be writable by root. +same. +Additionally, successful RSA host authentication is normally +required. +This file should only be writable by root. .It Pa /etc/shosts.equiv This file is processed exactly as .Pa /etc/hosts.equiv . @@ -962,7 +1059,8 @@ is required for proper operation. .Sh AUTHOR OpenSSH is a derivative of the original (free) ssh 1.2.12 release by Tatu Ylonen, -but with bugs removed and newer features re-added. Rapidly after the +but with bugs removed and newer features re-added. +Rapidly after the 1.2.12 release, newer versions of the original ssh bore successively more restrictive licenses, and thus demand for a free version was born. This version of OpenSSH diff --git a/usr.bin/strings/strings.1 b/usr.bin/strings/strings.1 index d598dd403e4..718347e32bb 100644 --- a/usr.bin/strings/strings.1 +++ b/usr.bin/strings/strings.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: strings.1,v 1.5 2000/02/23 19:44:08 provos Exp $ +.\" $OpenBSD: strings.1,v 1.6 2000/03/11 21:40:03 aaron Exp $ .\" $NetBSD: strings.1,v 1.4 1994/12/10 11:54:28 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -79,7 +79,8 @@ instead of unlimited. .It Fl o Each string is preceded by its octal offset in the file. .It Fl t Ar radix -Each string is preceded by its offset in the file. The first character of +Each string is preceded by its offset in the file. +The first character of .Ar radix determines the radix of the offset: .Sq o diff --git a/usr.bin/su/su.1 b/usr.bin/su/su.1 index bbc267f50f0..7dde7c5e9b2 100644 --- a/usr.bin/su/su.1 +++ b/usr.bin/su/su.1 @@ -1,4 +1,5 @@ -.\" $OpenBSD: su.1,v 1.8 1999/06/05 01:21:41 aaron Exp $ +.\" $OpenBSD: su.1,v 1.9 2000/03/11 21:40:03 aaron Exp $ +.\" .\" Copyright (c) 1988, 1990 The Regents of the University of California. .\" All rights reserved. .\" @@ -146,10 +147,11 @@ overrides any previous ones. If the optional .Ar "shell arguments" are provided on the command line, they are passed to the login shell of -the target login. This allows it to pass arbitrary commands via -the +the target login. +This allows it to pass arbitrary commands via the .Fl c -option as understood by most shells. Note that +option as understood by most shells. +Note that .Fl c usually expects a single argument only; you have to quote it when passing multiple words. @@ -173,7 +175,7 @@ group, it is ignored, and anyone who knows the root password is permitted to to .Dq root . .Pp -By default (unless the prompt is reset by a startup file) the super-user +By default (unless the prompt is reset by a startup file) the superuser prompt is set to .Dq Sy \&# to remind one of its awesome power. @@ -194,20 +196,10 @@ single word. Pretend a login for user .Li foo . .El -.Sh SEE ALSO -.Xr csh 1 , -.Xr kerberos 1 , -.Xr kinit 1 , -.Xr login 1 , -.Xr sh 1 , -.Xr skey 1 , -.Xr group 5 , -.Xr passwd 5 , -.Xr environ 7 .Sh ENVIRONMENT -Environment variables used by +The following environment variables affect the execution of .Nm su : -.Bl -tag -width HOME +.Bl -tag -width LOGNAME .It Ev HOME Default home directory of real user ID unless modified as specified above. @@ -224,6 +216,16 @@ unless the user ID is 0 (root). Same as .Ev LOGNAME . .El +.Sh SEE ALSO +.Xr csh 1 , +.Xr kerberos 1 , +.Xr kinit 1 , +.Xr login 1 , +.Xr sh 1 , +.Xr skey 1 , +.Xr group 5 , +.Xr passwd 5 , +.Xr environ 7 .Sh HISTORY A .Nm diff --git a/usr.bin/systat/systat.1 b/usr.bin/systat/systat.1 index ca879f67eed..71921053909 100644 --- a/usr.bin/systat/systat.1 +++ b/usr.bin/systat/systat.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: systat.1,v 1.15 2000/03/06 03:17:39 aaron Exp $ +.\" $OpenBSD: systat.1,v 1.16 2000/03/11 21:40:03 aaron Exp $ .\" $NetBSD: systat.1,v 1.6 1996/05/10 23:16:39 thorpej Exp $ .\" .\" Copyright (c) 1985, 1990, 1993 @@ -56,16 +56,18 @@ using the curses screen display library, While .Nm is running the screen is usually divided into two windows (an exception -is the vmstat display which uses the entire screen). The -upper window depicts the current system load average. The -information displayed in the lower window may vary, depending on -user commands. The last line on the screen is reserved for user +is the vmstat display which uses the entire screen). +The upper window depicts the current system load average. +The information displayed in the lower window may vary, depending on +user commands. +The last line on the screen is reserved for user input and error messages. .Pp By default .Nm displays the processes getting the largest percentage of the processor -in the lower window. Other displays show swap space usage, disk +in the lower window. +Other displays show swap space usage, disk .Tn I/O statistics (a la .Xr iostat 8 ) , @@ -81,10 +83,10 @@ A .Dq global command interpreter processes all keyboard input. If this command interpreter fails to recognize a command, the -input line is passed to a per-display command interpreter. This -allows each display to have certain display-specific commands. +input line is passed to a per-display command interpreter. +This allows each display to have certain display-specific commands. .Pp -Command line options: +The options are as follows: .Bl -tag -width "refresh_interval" .It Fl M Ar core Extract values associated with the name list from @@ -112,8 +114,8 @@ full detail below. .It Ar refresh-interval The .Ar refresh-interval -specifies the screen refresh time interval in seconds. This is provided -for backwards compatibility, and overrides the +specifies the screen refresh time interval in seconds. +This is provided for backwards compatibility, and overrides the .Ar refresh-interval specified with the .Fl w @@ -136,7 +138,8 @@ Stop .Nm systat . .It Ic \&: Move the cursor to the command line and interpret the input -line typed as a command. While entering a command the +line typed as a command. +While entering a command the current character erase, word erase, and line kill characters may be used. .El @@ -156,7 +159,8 @@ Stop refreshing the screen. .Op Ic start .Op Ar number .Xc -Start (continue) refreshing the screen. If a second, numeric, +Start (continue) refreshing the screen. +If a second, numeric, argument is provided it is interpreted as a refresh interval (in seconds). Supplying only a number will set the refresh interval to this @@ -181,15 +185,23 @@ is accounted to the process. .It Ic iostat Display, in the lower window, statistics about processor use -and disk throughput. Statistics on processor use appear as -bar graphs of the amount of time executing in user mode (``user''), -in user mode running low priority processes (``nice''), in -system mode (``system''), and idle (``idle''). Statistics +and disk throughput. +Statistics on processor use appear as +bar graphs of the amount of time executing in user mode +.Pq Dq user , +in user mode running low priority processes +.Pq Dq nice , +in system mode +.Pq Dq system , +and idle +.Pq Dq idle . +Statistics on disk throughput show, for each drive, kilobytes of data transferred, number of disk transactions performed, and time spent in disk accesses -(in milliseconds). This information may be displayed as -bar graphs or as rows of numbers which scroll downward. Bar -graphs are shown by default. +(in milliseconds). +This information may be displayed as +bar graphs or as rows of numbers which scroll downward. +Bar graphs are shown by default. .Pp The following commands are specific to the .Ic iostat @@ -199,8 +211,8 @@ display; the minimum unambiguous prefix may be supplied. .It Cm numbers Show the disk .Tn I/O -statistics in numeric form. Values are -displayed in numeric columns which scroll downward. +statistics in numeric form. +Values are displayed in numeric columns which scroll downward. .It Cm bars Show the disk .Tn I/O @@ -223,7 +235,7 @@ a total line is also shown. Areas known to the kernel but not in use are shown as not available. .It Ic mbufs Display, in the lower window, the number of mbufs allocated -for particular uses, i.e. data, socket structures, etc. +for particular uses, i.e., data, socket structures, etc. .It Ic vmstat Take over the entire display and show a (rather crowded) compendium of statistics related to virtual memory usage, process scheduling, @@ -262,12 +274,28 @@ and swapped out but desiring to run .Pq Sq w . Below the queue length listing is a numerical listing and a bar graph showing the amount of -system (shown as `='), user (shown as `>'), -nice (shown as `-'), and idle time (shown as ` '). +system (shown as +.Ql = ) , +user (shown as +.Ql > ) , +nice (shown as +.Ql - ) , +and idle time (shown as +.Ql \ ) . .Pp To the right of the Proc display are statistics about -Context switches (`Csw'), Traps (`Trp'), Syscalls (`Sys'), -Interrupts (`Int'), Soft interrupts (`Sof'), and Faults (`Flt') +Context switches +.Pq Dq Csw , +Traps +.Pq Dq Trp , +Syscalls +.Pq Dq Sys , +Interrupts +.Pq Dq Int , +Soft interrupts +.Pq Dq Sof , +and Faults +.Pq Dq Flt which have occurred during the last refresh interval. .Pp Below the CPU Usage graph are statistics on name translations. @@ -354,7 +382,7 @@ The following commands are specific to the .Ic vmstat display; the minimum unambiguous prefix may be supplied. .Pp -.Bl -tag -width Ar -compact +.Bl -tag -width Ds -compact .It Cm boot Display cumulative statistics since the system was booted. .It Cm run @@ -366,14 +394,16 @@ Display statistics averaged over the refresh interval (the default). Reset running statistics to zero. .El .It Ic netstat -Display, in the lower window, network connections. By default, -network servers awaiting requests are not displayed. Each address -is displayed in the format ``host.port'', with each shown symbolically, -when possible. It is possible to have addresses displayed numerically, +Display, in the lower window, network connections. +By default, network servers awaiting requests are not displayed. +Each address +is displayed in the format +.Dq host.port , +with each shown symbolically, when possible. +It is possible to have addresses displayed numerically, limit the display to a set of ports, hosts, and/or protocols (the minimum unambiguous prefix may be supplied): -.Pp -.Bl -tag -width Ar -compact +.Bl -tag -width Ar .It Cm all Toggle the displaying of server processes awaiting requests (this is the equivalent of the @@ -384,7 +414,7 @@ flag to Display network addresses numerically. .It Cm names Display network addresses symbolically. -.It Ar protocol +.It Cm protocol Display only network connections using the indicated protocol (currently either .Dq tcp @@ -392,21 +422,31 @@ or .Dq udp ) . .It Cm ignore Op Ar items Do not display information about connections associated with -the specified hosts or ports. Hosts and ports may be specified -by name (``vangogh'', ``ftp''), or numerically. Host addresses -use the Internet dot notation (``128.32.0.9''). Multiple items +the specified hosts or ports. +Hosts and ports may be specified +by name +.Pf ( Dq vangogh , +.Dq ftp ) , +or numerically. +Host addresses +use the Internet dot notation +.Pq Dq 128.32.0.9 . +Multiple items may be specified with a single command by separating them with spaces. .It Cm display Op Ar items Display information about the connections associated with the -specified hosts or ports. As for +specified hosts or ports. +As for .Ar ignore , .Ar items may be names or numbers. .It Cm show Op Ar ports\&|hosts Show, on the command line, the currently selected protocols, -hosts, and ports. Hosts and ports which are being ignored -are prefixed with a `!'. If +hosts, and ports. +Hosts and ports which are being ignored are prefixed with a +.Ql ! . +If .Ar ports or .Ar hosts @@ -420,28 +460,34 @@ Reset the port, host, and protocol matching mechanisms to the default .El .Pp Commands to switch between displays may be abbreviated to the -minimum unambiguous prefix; for example, ``io'' for ``iostat''. +minimum unambiguous prefix; for example, +.Dq io +for +.Dq iostat . Certain information may be discarded when the screen size is -insufficient for display. For example, on a machine with 10 -drives the +insufficient for display. +For example, on a machine with 10 drives the .Ic iostat -bar graph displays only 3 drives on a 24 line terminal. When -a bar graph would overflow the allotted screen space it is -truncated and the actual value is printed ``over top'' of the bar. +bar graph displays only 3 drives on a 24 line terminal. +When a bar graph would overflow the allotted screen space it is +truncated and the actual value is printed +.Dq over top +of the bar. .Pp The following commands are common to each display which shows -information about disk drives. These commands are used to +information about disk drives. +These commands are used to select a set of drives to report on, should your system have more drives configured than can normally be displayed on the screen. .Pp .Bl -tag -width Tx -compact .It Cm ignore Op Ar drives -Do not display information about the drives indicated. Multiple -drives may be specified, separated by spaces. +Do not display information about the drives indicated. +Multiple drives may be specified, separated by spaces. .It Cm display Op Ar drives -Display information about the drives indicated. Multiple drives -may be specified, separated by spaces. +Display information about the drives indicated. +Multiple drives may be specified, separated by spaces. .El .Sh FILES .Bl -tag -width /etc/networks -compact diff --git a/usr.bin/tail/tail.1 b/usr.bin/tail/tail.1 index 1d368fcff4c..2f9e133bf64 100644 --- a/usr.bin/tail/tail.1 +++ b/usr.bin/tail/tail.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tail.1,v 1.8 2000/01/22 02:17:49 aaron Exp $ +.\" $OpenBSD: tail.1,v 1.9 2000/03/11 21:40:04 aaron Exp $ .\" $NetBSD: tail.1,v 1.4 1994/11/23 07:42:13 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1991, 1993 @@ -61,17 +61,20 @@ or, by default, its standard input, to the standard output. .Pp The display begins at a byte, line or 512-byte block location in the input. -Numbers having a leading plus (``+'') sign are relative to the beginning -of the input, for example, -.Dq -c +2 +Numbers having a leading plus +.Pq Ql + +sign are relative to the beginning of the input, for example, +.Ic -c +2 starts the display at the second byte of the input. -Numbers having a leading minus (``-'') sign or no explicit sign are +Numbers having a leading minus +.Pq Ql - +sign or no explicit sign are relative to the end of the input, for example, -.Dq -n 2 +.Ic -n 2 displays the last two lines of the input. The default starting location is -.Dq -n 10 , +.Ic -n 10 , or the last 10 lines of the input. .Pp The options are as follows: @@ -90,12 +93,14 @@ The option causes .Nm to not stop when end-of-file is reached, but rather to wait for additional -data to be appended to the input. If the file is replaced (i.e., the -inode number changes), +data to be appended to the input. +If the file is replaced (i.e., the inode number changes), .Nm -will reopen the file and continue. If the file is truncated, +will reopen the file and continue. +If the file is truncated, .Nm -will reset its position back to the beginning. This makes +will reset its position back to the beginning. +This makes .Nm more useful for watching log files that may get rotated. The @@ -164,8 +169,11 @@ and .Fl n options modify the .Fl r -option, i.e. ``-r -c 4'' displays the last 4 characters of the last line -of the input, while the historic tail (using the historic syntax ``-4cr'') +option, i.e., +.Ic -r -c 4 +displays the last 4 characters of the last line +of the input, while the historic tail (using the historic syntax +.Ic -4cr ) would ignore the .Fl c option and display the last 4 lines of the input. diff --git a/usr.bin/talk/talk.1 b/usr.bin/talk/talk.1 index 4cdb3e2f8ab..2e1b17aed8c 100644 --- a/usr.bin/talk/talk.1 +++ b/usr.bin/talk/talk.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: talk.1,v 1.9 2000/03/06 03:17:40 aaron Exp $ +.\" $OpenBSD: talk.1,v 1.10 2000/03/11 21:40:04 aaron Exp $ .\" $NetBSD: talk.1,v 1.3 1994/12/09 02:14:23 jtc Exp $ .\" .\" Copyright (c) 1983, 1990, 1993 @@ -45,7 +45,7 @@ .Ar person .Op Ar ttyname .Sh DESCRIPTION -.Nm talk +.Nm is a visual communication program which copies lines from your terminal to that of another user. .Pp @@ -54,8 +54,8 @@ The command arguments are as follows: .It Ar person If you wish to talk to someone on your own machine, then .Ar person -is just the person's login name. If you wish to talk to a user on -another host, then +is just the person's login name. +If you wish to talk to a user on another host, then .Ar person is of the form .Ql user@host . @@ -70,8 +70,9 @@ is of the form .El .Pp When first called, -.Nm talk +.Nm sends the message +.Pp .Bd -literal -offset indent -compact Message from Talk_Daemon@localhost... talk: connection requested by your_name@your_machine. @@ -84,23 +85,27 @@ of the message should reply by typing .Dl talk \ your_name@your_machine .Pp It doesn't matter from which machine the recipient replies, as -long as the login name is the same. If the machine is not the one to which +long as the login name is the same. +If the machine is not the one to which the talk request was sent, it is noted on the screen. Once communication is established, the two parties may type simultaneously, with their output appearing -in separate windows. Typing control-L -.Ql ^L +in separate windows. +Typing control-L +.Pq Ql ^L will cause the screen to be reprinted, while your erase, kill, and word kill characters will -behave normally. To exit, just type your interrupt character; -.Nm talk +behave normally. +To exit, just type your interrupt character; +.Nm then moves the cursor to the bottom of the screen and restores the terminal to its previous state. .Pp Permission to talk may be denied or granted by use of the .Xr mesg 1 -command. At the outset talking is allowed. Certain commands, in -particular +command. +At the outset talking is allowed. +Certain commands, in particular .Xr nroff 1 and .Xr pr 1 , diff --git a/usr.bin/tcopy/tcopy.1 b/usr.bin/tcopy/tcopy.1 index f23d32f070f..a18d3090ebd 100644 --- a/usr.bin/tcopy/tcopy.1 +++ b/usr.bin/tcopy/tcopy.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tcopy.1,v 1.6 1999/10/17 20:24:35 aaron Exp $ +.\" $OpenBSD: tcopy.1,v 1.7 2000/03/11 21:40:04 aaron Exp $ .\" $NetBSD: tcopy.1,v 1.4 1997/04/15 07:23:07 lukem Exp $ .\" .\" Copyright (c) 1985, 1990, 1991, 1993 @@ -47,17 +47,20 @@ .Oo Ar src Op Ar dest .Oc .Sh DESCRIPTION -.Nm tcopy -is designed to copy magnetic tapes. The only assumption made +.Nm +is designed to copy magnetic tapes. +The only assumption made about the tape is that there are two tape marks at the end. -.Nm tcopy +.Nm with only a source tape .Pf ( Ar /dev/rst0 by default) specified will print -information about the sizes of records and tape files. If a destination -is specified a copy will be made of the source tape. The blocking on the -destination tape will be identical to that used on the source tape. Copying -a tape will yield the same output as if just printing the sizes. +information about the sizes of records and tape files. +If a destination +is specified a copy will be made of the source tape. +The blocking on the +destination tape will be identical to that used on the source tape. +Copying a tape will yield the same output as if just printing the sizes. .Pp The options are as follows: .Bl -tag -width s_maxblk diff --git a/usr.bin/telnet/telnet.1 b/usr.bin/telnet/telnet.1 index db2c283bd31..5119e67faf6 100644 --- a/usr.bin/telnet/telnet.1 +++ b/usr.bin/telnet/telnet.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: telnet.1,v 1.21 2000/03/04 22:19:26 aaron Exp $ +.\" $OpenBSD: telnet.1,v 1.22 2000/03/11 21:40:04 aaron Exp $ .\" $NetBSD: telnet.1,v 1.5 1996/02/28 21:04:12 thorpej Exp $ .\" .\" Copyright (c) 1983, 1990, 1993 @@ -68,13 +68,13 @@ protocol .Oc .Sh DESCRIPTION The -.Nm telnet +.Nm command is used to communicate with another host using the .Tn TELNET protocol. If -.Nm telnet +.Nm is invoked without the .Ar host argument, it enters command mode, @@ -88,8 +88,8 @@ command with those arguments. The options are as follows: .Bl -tag -width indent .It Fl 8 -Specifies an 8-bit data path. This causes an attempt to -negotiate the +Specifies an 8-bit data path. +This causes an attempt to negotiate the .Dv TELNET BINARY option on both input and output. .It Fl E @@ -103,8 +103,8 @@ have already been forwarded into the local environment. .It Fl K Specifies no automatic login to the remote system. .It Fl L -Specifies an 8-bit data path on output. This causes the -BINARY option to be negotiated on output. +Specifies an 8-bit data path on output. +This causes the BINARY option to be negotiated on output. .It Fl S Ar tos Sets the IP type-of-service (TOS) option for the telnet connection to the value @@ -144,7 +144,8 @@ impossible). .It Fl c Disables the reading of the user's .Pa \&.telnetrc -file. (See the +file. +(See the .Ic toggle skiprc command on this man page.) .It Fl d @@ -169,7 +170,7 @@ option allows the local credentials to be forwarded to the remote system. If Kerberos authentication is being used, the .Fl k option requests that -.Nm telnet +.Nm obtain tickets for the remote host in realm .Ar realm @@ -210,24 +211,25 @@ Turns on encryption of the data stream if possible. Indicates the official name, an alias, or the Internet address of a remote host. .It Ar port -Indicates a port number (address of an application). If a number is -not specified, the default -.Nm telnet +Indicates a port number (address of an application). +If a number is not specified, the default +.Nm port is used. .El .Pp -When in rlogin mode, a line of the form ~. disconnects from the +When in rlogin mode, a line of the form ~. +disconnects from the remote host; ~ is the telnet escape character. Similarly, the line ~^Z suspends the telnet session. The line ~^] escapes to the normal telnet escape prompt. .Pp Once a connection has been opened, -.Nm telnet +.Nm will attempt to enable the .Dv TELNET LINEMODE option. If this fails, -.Nm telnet +.Nm will revert to one of two input modes: either ``character at a time'' or ``old line by line'' @@ -236,9 +238,11 @@ depending on what the remote system supports. When .Dv LINEMODE is enabled, character processing is done on the -local system, under the control of the remote system. When input +local system, under the control of the remote system. +When input editing or character echoing is to be disabled, the remote system -will relay that information. The remote system will also relay +will relay that information. +The remote system will also relay changes to any special characters that happen on the remote system, so that they can take effect on the local system. .Pp @@ -296,25 +300,25 @@ sequence) and flush previous terminal input (in the case of .Ic quit and -.Ic intr ) . +.Ic intr ) . .Pp While connected to a remote host, -.Nm telnet +.Nm command mode may be entered by typing the -.Nm telnet +.Nm ``escape character'' (initially ``^]''). When in command mode, the normal terminal editing conventions are available. Note that the escape character will return to the command mode of the initial invocation of -.Nm telnet +.Nm that has the controlling terminal. Use the .Cm send escape command to switch to command mode in subsequent -.Nm telnet +.Nm processes on remote hosts. .Pp The following -.Nm telnet +.Nm commands are available. Only enough of each command to uniquely identify it need be typed (this is also true for arguments to the @@ -333,21 +337,23 @@ The .Ic auth command manipulates the information sent through the .Dv TELNET AUTHENTICATE -option. Valid arguments for the -auth command are as follows: +option. +Valid arguments for the +.Ic auth +command are as follows: .Bl -tag -width "disable type" .It Ic disable Ar type Disables the specified .Ar type -of authentication. To -obtain a list of available types, use the +of authentication. +To obtain a list of available types, use the .Ic auth disable \&? command. .It Ic enable Ar type Enables the specified .Ar type -of authentication. To -obtain a list of available types, use the +of authentication. +To obtain a list of available types, use the .Ic auth enable \&? command. .It Ic status @@ -376,26 +382,27 @@ Valid arguments for the encrypt command are as follows: .It Ic disable Ar type Ic [input|output] Disables the specified .Ar type -of encryption. If you -omit +of encryption. +If you omit .Ic input and .Ic output , both input and output -are disabled. To obtain a list of available -types, use the +are disabled. +To obtain a list of available types, use the .Ic encrypt disable \&? command. .It Ic enable Ar type Ic [input|output] Enables the specified .Ar type -of encryption. If you -omit +of encryption. +If you omit .Ic input and .Ic output , both input and output are -enabled. To obtain a list of available types, use the +enabled. +To obtain a list of available types, use the .Ic encrypt enable \&? command. .It Ic input @@ -415,18 +422,20 @@ This is the same as the .Ic encrypt stop output command. .It Ic start Ic [input|output] -Attempts to start encryption. If you omit +Attempts to start encryption. +If you omit .Ic input and .Ic output, -both input and output are enabled. To -obtain a list of available types, use the +both input and output are enabled. +To obtain a list of available types, use the .Ic encrypt enable \&? command. .It Ic status Lists the current status of encryption. .It Ic stop Ic [input|output] -Stops encryption. If you omit +Stops encryption. +If you omit .Ic input and .Ic output , @@ -587,7 +596,7 @@ command. Open a connection to the named host. If no port number is specified, -.Nm telnet +.Nm will attempt to contact a .Tn TELNET server at the default port. @@ -602,24 +611,29 @@ to be passed to the remote system via the .Ev ENVIRON option. When connecting to a non-standard port, -.Nm telnet +.Nm omits any automatic initiation of .Tn TELNET -options. When the port number is preceded by a minus sign, +options. +When the port number is preceded by a minus sign, the initial option negotiation is done. After establishing a connection, the file .Pa \&.telnetrc in the -user's home directory is opened. Lines beginning with a ``#'' are -comment lines. Blank lines are ignored. Lines that begin -without whitespace are the start of a machine entry. The -first thing on the line is the name of the machine that is -being connected to. The rest of the line, and successive +user's home directory is opened. +Lines beginning with a ``#'' are +comment lines. +Blank lines are ignored. +Lines that begin +without whitespace are the start of a machine entry. +The first thing on the line is the name of the machine that is +being connected to. +The rest of the line, and successive lines that begin with whitespace are assumed to be -.Nm telnet +.Nm commands and are processed as if they had been typed in manually to the -.Nm telnet +.Nm command prompt. .It Ic quit Close any open @@ -681,7 +695,7 @@ Sends the sequence. .It Ic escape Sends the current -.Nm telnet +.Nm escape character (initially ``^]''). .It Ic ga Sends the @@ -801,7 +815,7 @@ command. The .Ic set command will set any one of a number of -.Nm telnet +.Nm variables to a specific value or to .Dv TRUE . The special value @@ -819,7 +833,8 @@ The values of variables may be interrogated with the .Ic display command. The variables which may be set or unset, but not toggled, are -listed here. In addition, any of the variables for the +listed here. +In addition, any of the variables for the .Ic toggle command may be explicitly set or unset using the @@ -840,7 +855,8 @@ is enabled, and the status character is typed, a sequence (see .Ic send ayt preceding) is sent to the -remote host. The initial value for the "Are You There" +remote host. +The initial value for the "Are You There" character is the terminal's status character. .It Ic echo This is the value (initially ``^E'') which, when in @@ -849,7 +865,7 @@ of entered characters (for normal processing), and suppressing echoing of entered characters (for entering, say, a password). .It Ic eof If -.Nm telnet +.Nm is operating in .Dv LINEMODE or ``old line by line'' mode, entering this character @@ -862,7 +878,7 @@ character is taken to be the terminal's character. .It Ic erase If -.Nm telnet +.Nm is in .Ic localchars mode (see @@ -870,7 +886,7 @@ mode (see .Ic localchars below), and if -.Nm telnet +.Nm is operating in ``character at a time'' mode, then when this character is typed, a .Dv TELNET EC @@ -887,14 +903,14 @@ the terminal's character. .It Ic escape This is the -.Nm telnet +.Nm escape character (initially ``^['') which causes entry into -.Nm telnet +.Nm command mode (when connected to a remote system). .It Ic flushoutput If -.Nm telnet +.Nm is in .Ic localchars mode (see @@ -924,12 +940,13 @@ is operating in .Dv LINEMODE , these are the characters that, when typed, cause partial lines to be -forwarded to the remote system. The initial value for +forwarded to the remote system. +The initial value for the forwarding characters are taken from the terminal's eol and eol2 characters. .It Ic interrupt If -.Nm telnet +.Nm is in .Ic localchars mode (see @@ -953,7 +970,7 @@ the terminal's character. .It Ic kill If -.Nm telnet +.Nm is in .Ic localchars mode (see @@ -961,7 +978,7 @@ mode (see .Ic localchars below), and if -.Nm telnet +.Nm is operating in ``character at a time'' mode, then when this character is typed, a .Dv TELNET EL @@ -978,7 +995,7 @@ the terminal's character. .It Ic lnext If -.Nm telnet +.Nm is operating in .Dv LINEMODE or ``old line by line'' mode, then this character is taken to @@ -993,7 +1010,7 @@ the terminal's character. .It Ic quit If -.Nm telnet +.Nm is in .Ic localchars mode (see @@ -1017,7 +1034,7 @@ the terminal's character. .It Ic reprint If -.Nm telnet +.Nm is operating in .Dv LINEMODE or old line by line'' mode, then this character is taken to @@ -1039,8 +1056,9 @@ preceded by this character at the beginning of a line. This character, at the beginning of a line, followed by a "." closes the connection; when followed by a ^Z it suspends the -.Nm telnet -command. The initial state is to +.Nm +command. +The initial state is to disable the .Ic rlogin escape character. @@ -1074,7 +1092,7 @@ the terminal's character. .It Ic susp If -.Nm telnet +.Nm is in .Ic localchars mode, or @@ -1101,12 +1119,13 @@ or .Ic option tracing being .Dv TRUE , -will be written. If it is set to +will be written. +If it is set to .Dq Fl , then tracing information will be written to standard output (the default). .It Ic worderase If -.Nm telnet +.Nm is operating in .Dv LINEMODE or ``old line by line'' mode, then this character is taken to @@ -1139,17 +1158,17 @@ or change the state of the special characters when the .Dv TELNET LINEMODE option has -been enabled. Special characters are characters that get -mapped to +been enabled. +Special characters are characters that get mapped to .Tn TELNET commands sequences (like .Ic ip or -.Ic quit ) +.Ic quit ) or line editing characters (like .Ic erase and -.Ic kill ) . +.Ic kill ) . By default, the local special characters are exported. .Bl -tag -width Fl .It Ic check @@ -1158,10 +1177,10 @@ The remote side is requested to send all the current special character settings, and if there are any discrepancies with the local side, the local side will switch to the remote value. .It Ic export -Switch to the local defaults for the special characters. The -local default characters are those of the local terminal at +Switch to the local defaults for the special characters. +The local default characters are those of the local terminal at the time when -.Nm telnet +.Nm was started. .It Ic import Switch to the remote defaults for the special characters. @@ -1185,7 +1204,7 @@ Toggle (between and .Dv FALSE ) various flags that control how -.Nm telnet +.Nm responds to events. These flags may be set explicitly to .Dv TRUE @@ -1220,7 +1239,7 @@ characters are recognized (and transformed into sequences; see .Ic set above for details), -.Nm telnet +.Nm refuses to display any data on the user's terminal until the remote system acknowledges (via a .Dv TELNET TIMING MARK @@ -1234,13 +1253,14 @@ if the terminal user had not done an "stty noflsh", otherwise .Dv FALSE (see -.Xr stty 1 ) . +.Xr stty 1 ) . .It Ic autodecrypt When the .Dv TELNET ENCRYPT option is negotiated, by default the actual encryption (decryption) of the data -stream does not start automatically. The +stream does not start automatically. +The .Ic autoencrypt .Pq Ic autodecrypt command states that encryption of the @@ -1252,7 +1272,8 @@ If the remote side supports the .Dv TELNET AUTHENTICATION option .Tn TELNET -attempts to use it to perform automatic authentication. If the +attempts to use it to perform automatic authentication. +If the .Dv AUTHENTICATION option is not supported, the user's login name are propagated through the @@ -1354,7 +1375,7 @@ control sequences .Ic brk , .Ic ec , and -.Ic el ; +.Ic el ; see .Ic send above). @@ -1393,7 +1414,7 @@ The initial value for this toggle is .Dv FALSE . .It Ic options Toggles the display of some internal -.Nm telnet +.Nm protocol processing (having to do with .Tn TELNET options). @@ -1418,8 +1439,8 @@ When the skiprc toggle is skips the reading of the .Pa \&.telnetrc file in the user's home -directory when connections are opened. The initial -value for this toggle is +directory when connections are opened. +The initial value for this toggle is .Dv FALSE . .It Ic termdata Toggles the display of all terminal data (in hexadecimal format). @@ -1430,9 +1451,10 @@ When the .Ic verbose_encrypt toggle is .Dv TRUE , -.Nm telnet +.Nm prints out a message each time encryption is enabled or -disabled. The initial value for this toggle is +disabled. +The initial value for this toggle is .Dv FALSE . .It Ic \&? Displays the legal @@ -1446,20 +1468,22 @@ This command only works when the user is using the .Xr csh 1 . .It Ic \&! Op Ar command Execute a single command in a subshell on the local -system. If +system. +If .Ar command is omitted, then an interactive subshell is invoked. .It Ic \&? Op Ar command -Get help. With no arguments, -.Nm telnet +Get help. +With no arguments, +.Nm prints a help summary. If a command is specified, -.Nm telnet +.Nm will print the help information for just that command. .El .Sh ENVIRONMENT -.Nm telnet +.Nm uses at least the .Ev HOME , .Ev SHELL , @@ -1478,7 +1502,7 @@ user customized telnet startup values .El .Sh HISTORY The -.Nm telnet +.Nm command appeared in .Bx 4.2 . .Sh NOTES diff --git a/usr.bin/tftp/tftp.1 b/usr.bin/tftp/tftp.1 index 09c47e7399e..f5494f107af 100644 --- a/usr.bin/tftp/tftp.1 +++ b/usr.bin/tftp/tftp.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tftp.1,v 1.5 2000/03/06 03:17:40 aaron Exp $ +.\" $OpenBSD: tftp.1,v 1.6 2000/03/11 21:40:04 aaron Exp $ .\" $NetBSD: tftp.1,v 1.5 1995/08/18 14:45:44 pk Exp $ .\" .\" Copyright (c) 1990, 1993, 1994 @@ -44,7 +44,7 @@ .Nm tftp .Op Ar host .Sh DESCRIPTION -.Nm tftp +.Nm is the user interface to the Internet .Tn TFTP (Trivial File Transfer Protocol), @@ -52,7 +52,7 @@ which allows users to transfer files to and from a remote machine. The remote .Ar host may be specified on the command line, in which case -.Nm tftp +.Nm uses .Ar host as the default host for future transfers (see the @@ -60,7 +60,7 @@ as the default host for future transfers (see the command below). .Sh COMMANDS Once -.Nm tftp +.Nm is running, it issues the prompt .Ql tftp> and recognizes the following commands: @@ -174,6 +174,6 @@ Because there is no user login or validation within the .Tn TFTP protocol, the remote site will probably have some -sort of file access restrictions in place. The -exact methods are specific to each site and therefore +sort of file access restrictions in place. +The exact methods are specific to each site and therefore difficult to document here. diff --git a/usr.bin/time/time.1 b/usr.bin/time/time.1 index dad7c9e1d8b..24d6a6f78e3 100644 --- a/usr.bin/time/time.1 +++ b/usr.bin/time/time.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: time.1,v 1.9 2000/03/06 03:16:00 aaron Exp $ +.\" $OpenBSD: time.1,v 1.10 2000/03/11 21:40:04 aaron Exp $ .\" $NetBSD: time.1,v 1.5 1994/12/08 09:36:57 jtc Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -80,11 +80,12 @@ is available as to .Xr csh users. -.Sh DIAGNOSTICS +.Pp The .Nm utility shall exit with one of the following values: -.Bl -tag -width indent +.Pp +.Bl -tag -width indent -compact .It 1\-125 An error occurred in the .Nm diff --git a/usr.bin/tip/tip.1 b/usr.bin/tip/tip.1 index 759d771d599..cb86cf266a8 100644 --- a/usr.bin/tip/tip.1 +++ b/usr.bin/tip/tip.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tip.1,v 1.6 1999/06/05 01:21:43 aaron Exp $ +.\" $OpenBSD: tip.1,v 1.7 2000/03/11 21:40:05 aaron Exp $ .\" $NetBSD: tip.1,v 1.7 1994/12/08 09:31:05 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -58,12 +58,13 @@ .\" .Op Fl l Ar line .\" .Op Fl # .Sh DESCRIPTION -.Nm tip +.Nm .\" and .\" .Nm cu establishes a full-duplex connection to another machine, giving the appearance of being logged in directly on the -remote CPU. It goes without saying that you must have a login +remote CPU. +It goes without saying that you must have a login on the machine (or equivalent) to which you wish to connect. .\" The preferred interface is .\" .Nm tip . @@ -85,7 +86,8 @@ No escape (disable tilde). .El .Pp Typed characters are normally transmitted directly to the remote -machine (which does the echoing as well). A tilde +machine (which does the echoing as well). +A tilde .Pq Ql ~ appearing as the first character of a line is an escape signal; the following @@ -105,25 +107,27 @@ Escape to a shell (exiting the shell will return you to .Nm tip Ns ). .It Ic \&~> Copy file from local to remote. -.Nm tip +.Nm prompts for the name of a local file to transmit. .It Ic \&~< Copy file from remote to local. -.Nm tip +.Nm prompts first for the name of the file to be sent, then for a command to be executed on the remote machine. .It Ic \&~p Ar from Op Ar to Send a file to a remote .Ux -host. The put command causes the remote +host. +The put command causes the remote .Ux system to run the command string .Dq cat > 'to' , while -.Nm tip +.Nm sends it the .Dq from -file. If the +file. +If the .Dq to file isn't specified the .Dq from @@ -164,7 +168,8 @@ The command string sent to the local system is processed by the shell. .It Ic \&~C Fork a child process on the local system to perform special protocols -such as \s-1XMODEM\s+1. The child program will be run with the following +such as \s-1XMODEM\s+1. +The child program will be run with the following somewhat unusual arrangement of file descriptors: .nf .in +1i @@ -212,11 +217,12 @@ to find how to reach a particular system and to find out how it should operate while talking to the system; refer to -.Xr remote 5 +.Xr remote 5 for a full description. Each system has a default baud rate with which to -establish a connection. If this value is not suitable, the baud rate -to be used may be specified on the command line, e.g. +establish a connection. +If this value is not suitable, the baud rate +to be used may be specified on the command line, e.g., .Ql "tip -300 mds" . .Pp When @@ -230,9 +236,10 @@ is defined in .Pp When .Nm -prompts for an argument (e.g. during setup of +prompts for an argument (e.g., during setup of a file transfer) the line typed may be edited with the standard -erase and kill characters. A null line in response to a prompt, +erase and kill characters. +A null line in response to a prompt, or an interrupt, will abort the dialogue and return you to the remote machine. .Pp @@ -254,9 +261,9 @@ commands, the and .Dq eofwrite variables are used to recognize end-of-file when reading, and -specify end-of-file when writing (see below). File transfers -normally depend on tandem mode for flow control. If the remote -system does not support tandem mode, +specify end-of-file when writing (see below). +File transfers normally depend on tandem mode for flow control. +If the remote system does not support tandem mode, .Dq echocheck may be set to indicate .Nm @@ -283,39 +290,45 @@ Bizcomp 1031 and 1032 integral call unit/modems. maintains a set of variables which control its operation. Some of these variables are read-only to normal users (root is allowed -to change anything of interest). Variables may be displayed -and set through the +to change anything of interest). +Variables may be displayed and set through the .Sq s -escape. The syntax for variables is patterned after +escape. +The syntax for variables is patterned after .Xr vi 1 and .Xr Mail 1 . Supplying .Dq all as an argument to the set command displays all variables readable by -the user. Alternatively, the user may request display of a particular +the user. +Alternatively, the user may request display of a particular variable by attaching a .Ql ? -to the end. For example +to the end. +For example, .Dq escape? displays the current escape character. .Pp -Variables are numeric, string, character, or boolean values. Boolean +Variables are numeric, string, character, or boolean values. +Boolean variables are set merely by specifying their name; they may be reset by prepending a .Ql ! -to the name. Other variable types are set by -concatenating an +to the name. +Other variable types are set by concatenating an .Ql = -and the value. The entire assignment must not -have any blanks in it. A single set command may be used to interrogate +and the value. +The entire assignment must not have any blanks in it. +A single set command may be used to interrogate as well as set a number of variables. Variables may be initialized at run time by placing set commands (without the .Ql ~s prefix in a file .Pa .tiprc -in one's home directory). The +in one's home directory). +The .Fl v option causes .Nm @@ -363,13 +376,13 @@ default value is .It Ar exceptions (str) The set of characters which should not be discarded due to the beautification switch; abbreviated -.Ar ex ; +.Ar ex ; default value is .Dq \et\en\ef\eb . .It Ar force (char) The character used to force literal data transmission; abbreviated -.Ar fo ; +.Ar fo ; default value is .Ql ^P . .It Ar framesize @@ -385,8 +398,8 @@ host; abbreviated .Ar pr ; default value is .Ql \en . -This value is used to synchronize during -data transfers. The count of lines transferred during a file transfer +This value is used to synchronize during data transfers. +The count of lines transferred during a file transfer command is based on receipt of this character. .It Ar raise (bool) Upper case mapping mode; abbreviated @@ -411,7 +424,7 @@ default value is .Dq tip.record . .It Ar script (bool) Session scripting mode; abbreviated -.Ar sc ; +.Ar sc ; default is .Ar off . When @@ -427,20 +440,20 @@ If the switch is on, only printable .Tn ASCII characters will be included in -the script file (those characters between 040 and 0177). The -variable +the script file (those characters between 040 and 0177). +The variable .Ar exceptions is used to indicate characters which are an exception to the normal beautification rules. .It Ar tabexpand (bool) Expand tabs to spaces during file transfers; abbreviated -.Ar tab ; +.Ar tab ; default value is .Ar false . Each tab is expanded to 8 spaces. .It Ar verbose (bool) Verbose mode; abbreviated -.Ar verb ; +.Ar verb ; default is .Ar true . When verbose mode is enabled, @@ -450,8 +463,8 @@ of lines transferred during a file transfer operations, and more. .El .Sh ENVIRONMENT -.Nm -uses the following environment variables: +The following environment variables affect the execution of +.Nm tip : .Bl -tag -width Fl .It Ev SHELL (str) The name of the shell to use for the @@ -492,8 +505,6 @@ line access log lock file to avoid conflicts with .Xr uucp .El -.Sh DIAGNOSTICS -Diagnostics are, hopefully, self-explanatory. .Sh SEE ALSO .Xr phones 5 , .Xr remote 5 diff --git a/usr.bin/tn3270/tn3270/tn3270.1 b/usr.bin/tn3270/tn3270/tn3270.1 index 2075c75985d..8975da8b2c5 100644 --- a/usr.bin/tn3270/tn3270/tn3270.1 +++ b/usr.bin/tn3270/tn3270/tn3270.1 @@ -1,4 +1,5 @@ -.\" $OpenBSD: tn3270.1,v 1.7 2000/03/05 00:28:58 aaron Exp $ +.\" $OpenBSD: tn3270.1,v 1.8 2000/03/11 21:40:05 aaron Exp $ +.\" .\" Copyright (c) 1986, 1990 The Regents of the University of California. .\" All rights reserved. .\" @@ -71,7 +72,7 @@ Terminal Communication System II. is actually a modification of the Arpanet .Tn TELNET user interface (see -.Xr telnet 1 ) +.Xr telnet 1 ) which will, in certain circumstances, interpret and generate raw 3270 control streams. .Pp @@ -99,9 +100,10 @@ data received from the remote .Tn IBM machine. .It Ar sysname -The name of the remote system. If the remote name -is NOT specified, the user will be prompted for a -command (see below). +The name of the remote system. +If the remote name is +.Em not +specified, the user will be prompted for a command (see below). .It Ar port The port to connect to on the remote system. Normally, @@ -128,7 +130,7 @@ looks at the number of lines and columns on the actual terminal (as defined in the .Ev TERM environment variable; see -.Xr termcap 5 ) . +.Xr termcap 5 ) . The terminal (or window in which .Nm tn3270 is running, on multiple @@ -173,14 +175,14 @@ This mapping is terminal dependent and is specified in a description file, .Pa /usr/share/misc/map3270 , (see -.Xr map3270 5 ) +.Xr map3270 5 ) or in an environment variable .Ev MAP3270 (and, if necessary, -.Ev MAP3270A , +.Ev MAP3270A , .Ev MAP3270B , and so on - see -.Xr mset 1 ) . +.Xr mset 1 ) . Any special function keys on the .Tn ASCII keyboard are used whenever possible. @@ -193,7 +195,7 @@ If this is not found, .Nm tn3270 uses a default keyboard mapping (see -.Xr map3270 5 ) . +.Xr map3270 5 ) . .Pp The first character of each special keyboard mapping sequence is either an @@ -226,7 +228,7 @@ In this mode, .Nm tn3270 accepts and executes all the commands of -.Xr telnet 1 , +.Xr telnet 1 , plus one additional command: .Bl -tag -width Ar .It Ic transcom @@ -244,7 +246,7 @@ If .Nm tn3270 has succeeded in negotiating 3270 mode with the remote host, the escape sequence will be as defined by the map3270 (see -.Xr map3270 5 ) +.Xr map3270 5 ) entry for the user's terminal type (typically control-C); otherwise the escape sequence will initially be set to the @@ -260,7 +262,11 @@ The host login session may be resumed by entering an empty line key) in response to the command prompt. A session may be terminated by logging off the foreign host, -or by typing ``quit'' or ``close'' while in local command mode. +or by typing +.Ic quit +or +.Ic close +while in local command mode. .Sh FILES .Bl -tag -width /usr/share/misc/termcap -compact .It Pa /usr/share/misc/termcap diff --git a/usr.bin/top/top.1 b/usr.bin/top/top.1 index e92ff019fe9..015baf21882 100644 --- a/usr.bin/top/top.1 +++ b/usr.bin/top/top.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: top.1,v 1.12 1999/10/17 20:24:36 aaron Exp $ +.\" $OpenBSD: top.1,v 1.13 2000/03/11 21:40:05 aaron Exp $ .\" .\" Copyright (c) 1997, Jason Downs. All rights reserved. .\" @@ -47,10 +47,13 @@ .Sh DESCRIPTION .Nm displays the top processes on the system and periodically updates this -information. If standard output is an intelligent terminal (see below) then +information. +If standard output is an intelligent terminal (see below) then as many processes as will fit on the terminal screen are displayed -by default. Otherwise, a good number of them are shown (around 20). -Raw CPU percentage is used to rank the processes. If +by default. +Otherwise, a good number of them are shown (around 20). +Raw CPU percentage is used to rank the processes. +If .Ar number is given, then the top .Ar number @@ -58,14 +61,16 @@ processes will be displayed instead of the default. .Pp .Nm makes a distinction between terminals that support advanced capabilities -and those that do not. This -distinction affects the choice of defaults for certain options. In the -remainder of this document, an +and those that do not. +This distinction affects the choice of defaults for certain options. +In the remainder of this document, an .Em intelligent terminal is one that supports cursor addressing, clear screen, and clear -to end of line. Conversely, a -.Em dumb -terminal is one that does not support such features. If the output of +to end of line. +Conversely, a +.Dq dumb +terminal is one that does not support such features. +If the output of .Nm is redirected to a file, it acts as if it were being run on a dumb terminal. @@ -73,63 +78,79 @@ terminal. The options are as follows: .Bl -tag -width XxXXXXXXXXX .It Fl S -Show system processes in the display. Normally, system processes such as -the pager and the swapper are not shown. This option makes them visible. +Show system processes in the display. +Normally, system processes such as the pager and the swapper are not shown. +This option makes them visible. .It Fl b Use .Em batch -mode. In this mode, all input from the terminal is -ignored. Interrupt characters (such as ^C and ^\e) still have an effect. +mode. +In this mode, all input from the terminal is ignored. +Interrupt characters (such as +.Ql ^C +and +.Ql ^\e ) +still have an effect. This is the default on a dumb terminal, or when the output is not a terminal. .It Fl i Use .Em interactive -mode. In this mode, any input is immediately read for processing. See the -section on +mode. +In this mode, any input is immediately read for processing. +See the section on .Sx INTERACTIVE MODE -for an explanation of which keys perform what functions. After the command +for an explanation of which keys perform what functions. +After the command is processed, the screen will immediately be updated, even if the command was -not understood. This mode is the default when standard output is an -intelligent terminal. +not understood. +This mode is the default when standard output is an intelligent terminal. .It Fl I Do not display idle processes. By default, top displays both active and idle processes. .It Fl n Use .Em non-interactive -mode. This is identical to +mode. +This is identical to .Em batch mode. .It Fl q Renice .Nm -to -20 so that it will run faster. This can be used when the system is +to -20 so that it will run faster. +This can be used when the system is being very sluggish to improve the possibility of discovering the problem. This option can only be used by root. .It Fl u -Do not take the time to map UID numbers to usernames. Normally, +Do not take the time to map UID numbers to usernames. +Normally, .Nm will read as much of the password database as is necessary to map -all the user ID numbers it encounters into login names. This option -disables all that, while possibly decreasing execution time. The UID -numbers are displayed instead of the names. +all the user ID numbers it encounters into login names. +This option +disables all that, while possibly decreasing execution time. +The UID numbers are displayed instead of the names. .It Fl d Ar count Show only .Ar count -displays, then exit. A display is considered to be one update of the -screen. This option allows the user to select the number of displays +displays, then exit. +A display is considered to be one update of the screen. +This option allows the user to select the number of displays to be shown before .Nm -automatically exits. For intelligent terminals, no upper limit -is set. The default is 1 for dumb terminals. +automatically exits. +For intelligent terminals, no upper limit is set. +The default is 1 for dumb terminals. .It Fl s Ar time Set the delay between screen updates to .Ar time -seconds. The default delay between updates is 5 seconds. +seconds. +The default delay between updates is 5 seconds. .It Fl o Ar field -Sort the process display area using the specified field as the primary -key. The field name is the name of the column as seen in the output, -but in lower case. The +Sort the process display area using the specified field as the primary key. +The field name is the name of the column as seen in the output, +but in lower case. +The .Ox version of top supports .Ar cpu , @@ -151,8 +172,8 @@ and .Ar number fields can be specified as .Li infinite , -indicating that they can stretch as far as possible. This is accomplished -by using any proper prefix of the keywords +indicating that they can stretch as far as possible. +This is accomplished by using any proper prefix of the keywords .Li infinity , .Li maximum , or @@ -164,8 +185,9 @@ on an intelligent terminal is, in fact, .Pp The environment variable .Ev TOP -is examined for options before the command line is scanned. This enables -a user to set his or her own defaults. The number of processes to display +is examined for options before the command line is scanned. +This enables a user to set his or her own defaults. +The number of processes to display can also be specified in the environment variable .Ev TOP . .Pp @@ -174,8 +196,10 @@ The options .Fl S , and .Fl u -are actually toggles. A second specification of any of these options -will negate the first. Thus a user who has the environment variable +are actually toggles. +A second specification of any of these options +will negate the first. +Thus a user who has the environment variable .Ev TOP set to .Dq -I @@ -187,22 +211,26 @@ When .Nm is running in .Em interactive mode , -it reads commands from the terminal and acts upon them accordingly. In this -mode, the terminal is put in +it reads commands from the terminal and acts upon them accordingly. +In this mode, the terminal is put in .Dv CBREAK , -so that a character will be processed as soon as it is typed. Almost always, -a key will be pressed when +so that a character will be processed as soon as it is typed. +Almost always, a key will be pressed when .Nm is between displays; that is, while it is waiting for .Ar time -seconds to elapse. If this is the case, the command will be +seconds to elapse. +If this is the case, the command will be processed and the display will be updated immediately thereafter -(reflecting any changes that the command may have specified). This -happens even if the command was incorrect. If a key is pressed while +(reflecting any changes that the command may have specified). +This happens even if the command was incorrect. +If a key is pressed while .Nm is in the middle of updating the display, it will finish the update and -then process the command. Some commands require additional information, -and the user will be prompted accordingly. While typing this information +then process the command. +Some commands require additional information, +and the user will be prompted accordingly. +While typing this information in, the user's erase and kill keys (as set up by the command .Xr stty 1 ) are recognized, and a newline terminates the input. @@ -231,12 +259,14 @@ Change the number of seconds to delay between displays .It k Send a signal .Ns ( Dv TERM -by default) to a list of processes. This acts similarly to the command +by default) to a list of processes. +This acts similarly to the command .Xr kill 1 . .It r Change the priority (the .Em nice ) -of a list of processes. This acts similarly to the command +of a list of processes. +This acts similarly to the command .Xr renice 8 . .It u Display only processes owned by a specific username (prompt for username). @@ -272,9 +302,11 @@ and a percentage of time spent in each of the processor states It also includes information about physial and virtual memory allocation. .Pp The remainder of the screen displays information about individual -processes. This display is similar in spirit to +processes. +This display is similar in spirit to .Xr ps 1 -but it is not exactly the same. PID is the process ID, USERNAME is the name +but it is not exactly the same. +PID is the process ID, USERNAME is the name of the process's owner (if .Fl u is specified, a UID column will be substituted for USERNAME), @@ -306,7 +338,8 @@ The .Em ABANDONED state (known in the kernel as .Em SWAIT Ns ) -was abandoned, thus the name. A process should never end up in this state. +was abandoned, thus the name. +A process should never end up in this state. .Sh AUTHOR William LeFebvre, EECS Department, Northwestern University .Sh ENVIRONMENT @@ -322,10 +355,18 @@ kernel memory physical memory .It Pa /bsd kernel image +.Sh SEE ALSO +.Xr kill 1 , +.Xr ps 1 , +.Xr stty 1 , +.Xr systat 1 , +.Xr mem 4 , +.Xr renice 8 .Sh BUGS Don't shoot me, but the default for .Fl I -has changed once again. So many people were confused by the fact that +has changed once again. +So many people were confused by the fact that .Nm wasn't showing them all the processes that I have decided to make the default behavior show idle processes, just like it did in version 2. @@ -336,7 +377,8 @@ options in the environment variable .Ev TOP (see the .Sx OPTIONS -section). Those who want the behavior that version 3.0 had need only set +section). +Those who want the behavior that version 3.0 had need only set the environment variable .Ev TOP to @@ -349,12 +391,6 @@ As with .Xr ps 1 , things can change while .Nm -is collecting information for an update. The picture it gives is only a +is collecting information for an update. +The picture it gives is only a close approximation to reality. -.Sh SEE ALSO -.Xr kill 1 , -.Xr ps 1 , -.Xr stty 1 , -.Xr systat 1 , -.Xr mem 4 , -.Xr renice 8 diff --git a/usr.bin/touch/touch.1 b/usr.bin/touch/touch.1 index e7f82621586..70d800dde7f 100644 --- a/usr.bin/touch/touch.1 +++ b/usr.bin/touch/touch.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: touch.1,v 1.4 2000/03/05 00:28:55 aaron Exp $ +.\" $OpenBSD: touch.1,v 1.5 2000/03/11 21:40:05 aaron Exp $ .\" $NetBSD: touch.1,v 1.8 1995/08/31 22:10:05 jtc Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -51,7 +51,7 @@ .Ar file Op Ar ... .Sh DESCRIPTION The -.Nm touch +.Nm utility sets the modification and access times of files to the current time of day. If the file doesn't exist, it is created with default permissions. @@ -66,7 +66,7 @@ flag is also specified. .It Fl c Do not create the file if it does not exist. The -.Nm touch +.Nm utility does not treat this as an error. No error messages are displayed and the exit value is not affected. .It Fl f @@ -127,7 +127,7 @@ letter pair is not specified, the value defaults to 0. .El .Pp The -.Nm touch +.Nm utility exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr utimes 2 @@ -157,14 +157,14 @@ If the .Dq YY letter pair is in the range 69 to 99, the year is set to 1969 to 1999, otherwise, the year is set in the 21st century. -.Sh HISTORY -A -.Nm touch -utility appeared in .At v7 . .Sh STANDARDS The -.Nm touch +.Nm utility is expected to be a superset of the .St -p1003.2 specification. +.Sh HISTORY +A +.Nm +utility appeared in diff --git a/usr.bin/tput/tput.1 b/usr.bin/tput/tput.1 index 4fa22bc2b78..07537f16bfd 100644 --- a/usr.bin/tput/tput.1 +++ b/usr.bin/tput/tput.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tput.1,v 1.9 2000/03/06 03:17:40 aaron Exp $ +.\" $OpenBSD: tput.1,v 1.10 2000/03/11 21:40:05 aaron Exp $ .\" $NetBSD: tput.1,v 1.4 1994/12/07 08:49:10 jtc Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 @@ -84,7 +84,8 @@ If the is of type boolean, .Nm exits 0 if the terminal has the capability or 1 if it -does not. Each +does not. +Each .Ar attribute should be a string defined in either .Xr terminfo 5 diff --git a/usr.bin/tr/tr.1 b/usr.bin/tr/tr.1 index 13b66a6c5ea..238a7d76364 100644 --- a/usr.bin/tr/tr.1 +++ b/usr.bin/tr/tr.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tr.1,v 1.5 2000/03/05 00:28:55 aaron Exp $ +.\" $OpenBSD: tr.1,v 1.6 2000/03/11 21:40:05 aaron Exp $ .\" $NetBSD: tr.1,v 1.5 1994/12/07 08:35:13 jtc Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -61,7 +61,7 @@ .Ar string1 string2 .Sh DESCRIPTION The -.Nm tr +.Nm utility copies the standard input to the standard output with substitution or deletion of selected characters. .Pp @@ -146,7 +146,7 @@ the octal sequence to the full 3 octal digits. .It \echaracter A backslash followed by certain special characters maps to special values. -.sp +.Pp .Bl -column .It \ea .It \eb @@ -156,14 +156,14 @@ values. .It \et .It \ev .El -.sp +.Pp A backslash followed by any other character maps to that character. .It c-c Represents the range of characters between the range endpoints, inclusively. .It [:class:] Represents all characters belonging to the defined character class. Class names are: -.sp +.Pp .Bl -column .It alnum .It alpha @@ -246,23 +246,25 @@ it's interpreted as a decimal value. .El .Pp The -.Nm tr +.Nm utility exits 0 on success or >0 if an error occurred. .Sh EXAMPLES The following examples are shown as given to the shell: -.sp +.Pp Create a list of the words in file1, one per line, where a word is taken to be a maximal string of letters. -.sp +.Pp .D1 Li "tr -cs \*q[:alpha:]\*q \*q\en\*q < file1" -.sp +.Pp Translate the contents of file1 to upper-case. -.sp +.Pp .D1 Li "tr \*q[:lower:]\*q \*q[:upper:]\*q < file1" -.sp +.Pp Strip out non-printable characters from file1. -.sp +.Pp .D1 Li "tr -cd \*q[:print:]\*q < file1" +.Sh SEE ALSO +.Xr sed 1 .Sh COMPATIBILITY System V has historically implemented character ranges using the syntax .Dq [c-c] @@ -271,7 +273,7 @@ instead of the used by historic BSD implementations and standardized by POSIX. System V shell scripts should work under this implementation as long as -the range is intended to map in another range, i.e. the command +the range is intended to map in another range, i.e., the command .Dq tr\ [a-z]\ [A-Z] will work as it will map the .Dq [ @@ -302,13 +304,13 @@ will have to be rewritten as .Dq a\e-z . .Pp The -.Nm tr +.Nm utility has historically not permitted the manipulation of NUL bytes in its input and, additionally, has stripped NUL's from its input stream. This implementation has removed this behavior as a bug. .Pp The -.Nm tr +.Nm utility has historically been extremely forgiving of syntax errors: for example, the .Fl c @@ -318,7 +320,7 @@ options were ignored unless two strings were specified. This implementation will not permit illegal syntax. .Sh STANDARDS The -.Nm tr +.Nm utility is expected to be .St -p1003.2 compatible. diff --git a/usr.bin/true/true.1 b/usr.bin/true/true.1 index d95e6f74b65..1e3767c3475 100644 --- a/usr.bin/true/true.1 +++ b/usr.bin/true/true.1 @@ -1,4 +1,5 @@ -.\" $OpenBSD: true.1,v 1.4 1999/06/05 01:21:44 aaron Exp $ +.\" $OpenBSD: true.1,v 1.5 2000/03/11 21:40:05 aaron Exp $ +.\" .\" Copyright (c) 1983, 1985, 1990 The Regents of the University of California. .\" All rights reserved. .\" diff --git a/usr.bin/tset/tset.1 b/usr.bin/tset/tset.1 index 555f20980c4..09163b5a78f 100644 --- a/usr.bin/tset/tset.1 +++ b/usr.bin/tset/tset.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tset.1,v 1.6 1998/11/16 03:08:41 millert Exp $ +.\" $OpenBSD: tset.1,v 1.7 2000/03/11 21:40:06 aaron Exp $ .\" .\" Copyright (c) 1985, 1990, 1993 .\" The Regents of the University of California. All rights reserved. @@ -81,11 +81,12 @@ The default terminal type, .Dq unknown . .El .Pp -If the terminal type was not specified on the command-line, the +If the terminal type was not specified on the command line, the .Fl m option mappings are then applied (see below for more information). -Then, if the terminal type begins with a question mark (``?''), the user is -prompted for confirmation of the terminal type. +Then, if the terminal type begins with a question mark +.Pq Ql ? , +the user is prompted for confirmation of the terminal type. An empty response confirms the type, or, another type can be entered to specify a new type. Once the terminal type has been determined, the termcap entry for the terminal @@ -108,7 +109,7 @@ newline translation and resets any unset special characters to their default values before doing the terminal initialization described above. This is useful after a program dies leaving a terminal in an abnormal state. Note, you may have to type -.Dq Li reset +.Dq reset (the line-feed character is normally control-J) to get the terminal to work, as carriage-return may no longer work in the abnormal state. Also, the terminal will often not echo the command. @@ -117,8 +118,8 @@ The options are as follows: .Bl -tag -width flag .It Fl The terminal type is displayed to the standard output, and the terminal is -not initialized in any way. This option has been deprecated in favor of -the +not initialized in any way. +This option has been deprecated in favor of the .Fl q flag. .It Fl e Ar ch @@ -156,15 +157,15 @@ See the section below on setting the environment for details. .Pp The arguments for the .Fl e , -.Fl i +.Fl i , and .Fl k options may either be entered as actual characters or by using the .Dq hat -notation, i.e. control-h may be specified as -.Dq Li ^H +notation, i.e., control-H may be specified as +.Dq ^H or -.Dq Li ^h . +.Dq ^h . .Sh SETTING THE ENVIRONMENT It is often desirable to enter the terminal type and information about the terminal's capabilities into the shell's environment. @@ -261,24 +262,25 @@ kind of terminal''. The argument to the .Fl m option consists of an optional port type, an optional operator, an optional -baud rate specification, an optional colon (``:'') character, and a terminal -type. +baud rate specification, an optional colon +.Pq Ql : +character, and a terminal type. The port type is a string (delimited by either the operator or the colon character). The operator may be any combination of: -.Dq Li \&> , -.Dq Li \&< , -.Dq Li \&@ , +.Ql > , +.Ql < , +.Ql @ , and -.Dq Li \&! ; -.Dq Li \&> +.Ql ! ; +.Ql > means greater than, -.Dq Li \&< +.Ql < means less than, -.Dq Li \&@ +.Ql @ means equal to, and -.Dq Li \&! +.Ql ! inverts the sense of the test. The baud rate is specified as a number and is compared with the speed of the standard error output (which should be the control terminal). @@ -292,29 +294,29 @@ in the mapping replaces the current type. If more than one mapping is specified, the first applicable mapping is used. .Pp For example, consider the following mapping: -.Dq Li dialup>9600:vt100 . +.Dq dialup>9600:vt100 . The port type is -.Dq Li dialup , +.Dq dialup , the operator is -.Dq Li > , +.Dq > , the baud rate specification is -.Dq Li 9600 , +.Dq 9600 , and the terminal type is -.Dq Li vt100 . +.Dq vt100 . The result of this mapping is to specify that if the terminal type is -.Dq Li dialup , +.Dq dialup , and the baud rate is greater than 9600 baud, a terminal type of -.Dq Li vt100 +.Dq vt100 will be used. .Pp If no port type is specified, the terminal type will match any port type, for example, -.Dq Li -m dialup:vt100 -m :?xterm +.Dq -m dialup:vt100 -m :?xterm will cause any dialup port, regardless of baud rate, to match the terminal type -.Dq Li vt100 , +.Dq vt100 , and any non-dialup port type to match the terminal type -.Dq Li ?xterm . +.Dq ?xterm . Note, because of the leading question mark, the user will be queried on a default port as to whether they are actually using an .Ar xterm @@ -327,8 +329,10 @@ Also, to avoid problems with meta-characters, it is suggested that the entire .Fl m option argument be placed within single quote characters, and that .Xr csh 1 -users insert a backslash character (``\e'') before any exclamation -marks (``!''). +users insert a backslash character +.Pq Ql \e +before any exclamation marks +.Pq Ql ! . .Sh ENVIRONMENT The .Nm tset @@ -340,7 +344,7 @@ environment variables. .Sh FILES .Bl -tag -width /usr/share/misc/termcap -compact .It Pa /etc/ttys -system port name to terminal type mapping database +port name to terminal type mapping database .It Pa /usr/share/misc/termcap terminal capability database .El @@ -352,11 +356,6 @@ terminal capability database .Xr termcap 5 , .Xr ttys 5 , .Xr environ 7 -.Sh HISTORY -The -.Nm tset -command appeared in -.Bx 3.0 . .Sh COMPATIBILITY The .Nm tset @@ -374,7 +373,8 @@ also reads in the terminal entry from .Xr termcap 5 . However, this info is used for setting .Ev TERMCAP -only. If the terminal type appears in +only. +If the terminal type appears in .Xr terminfo 5 but not in .Xr termcap 5 , @@ -443,3 +443,8 @@ system of a .St -p1003.1-88 compliant terminal interface) and will no longer compile on systems with older terminal interfaces. +.Sh HISTORY +The +.Nm tset +command appeared in +.Bx 3.0 . diff --git a/usr.bin/tsort/tsort.1 b/usr.bin/tsort/tsort.1 index d71147f37f1..48132883ff7 100644 --- a/usr.bin/tsort/tsort.1 +++ b/usr.bin/tsort/tsort.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tsort.1,v 1.5 2000/03/04 22:19:27 aaron Exp $ +.\" $OpenBSD: tsort.1,v 1.6 2000/03/11 21:40:06 aaron Exp $ .\" $NetBSD: tsort.1,v 1.6 1996/01/17 20:37:49 mycroft Exp $ .\" .\" Copyright (c) 1990, 1993, 1994 @@ -49,7 +49,7 @@ .Op Fl q .Op Ar file .Sh DESCRIPTION -.Nm tsort +.Nm takes a list of pairs of node names representing directed arcs in a graph and prints the nodes in topological order on standard output. Input is taken from the named @@ -74,7 +74,8 @@ The options are as follows: Search for and display the longest cycle. Can take a very long time. .It Fl q -Do not display informational messages about cycles. This is primarily +Do not display informational messages about cycles. +This is primarily intended for building libraries, where optimal ordering is not critical, and cycles occur often. .El @@ -86,6 +87,6 @@ A command appeared in .At v7 . This -.Nm tsort +.Nm command and manual page are derived from sources contributed to Berkeley by Michael Rendell of Memorial University of Newfoundland. diff --git a/usr.bin/tty/tty.1 b/usr.bin/tty/tty.1 index 4e499474da5..5ab7c8d450b 100644 --- a/usr.bin/tty/tty.1 +++ b/usr.bin/tty/tty.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tty.1,v 1.8 2000/03/06 03:16:00 aaron Exp $ +.\" $OpenBSD: tty.1,v 1.9 2000/03/11 21:40:06 aaron Exp $ .\" $NetBSD: tty.1,v 1.4 1994/12/07 00:46:55 jtc Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -48,13 +48,16 @@ .Op Fl s .Sh DESCRIPTION The -.Nm tty +.Nm utility writes the name of the terminal attached to standard input to standard output. The name that is written is the string returned by .Xr ttyname 3 . -If the standard input is not a terminal, the message ``not a tty'' +.Pp +If the standard input is not a terminal, the message +.Dq not a tty is written. +.Pp The options are as follows: .Bl -tag -width Ds .It Fl s @@ -67,9 +70,10 @@ option is deprecated in favor of the command. .El .Pp -.Nm tty -exits 0 if the standard input is a terminal, 1 if the standard input is -not a terminal, or >1 if an error occurred. +The +.Nm +utility exits 0 if the standard input is a terminal, 1 if the standard input +is not a terminal, or >1 if an error occurred. .Sh SEE ALSO .Xr stty 1 , .Xr test 1 , @@ -77,7 +81,7 @@ not a terminal, or >1 if an error occurred. .Xr tty 4 .Sh STANDARDS The -.Nm tty +.Nm utility conforms to .St -p1003.2-92 . .Sh HISTORY diff --git a/usr.bin/ul/ul.1 b/usr.bin/ul/ul.1 index 96235c4db3b..19a9ccbe1f2 100644 --- a/usr.bin/ul/ul.1 +++ b/usr.bin/ul/ul.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ul.1,v 1.5 2000/03/05 00:28:55 aaron Exp $ +.\" $OpenBSD: ul.1,v 1.6 2000/03/11 21:40:06 aaron Exp $ .\" $NetBSD: ul.1,v 1.3 1994/12/07 00:28:23 jtc Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -68,7 +68,9 @@ The options are as follows: .Bl -tag -width Ds .It Fl i Underlining is indicated by a separate line containing appropriate -dashes `\-'; this is useful when you want to look at the underlining +dashes +.Pq Ql - ; +this is useful when you want to look at the underlining which is present in an .Xr nroff 1 output stream on a crt-terminal. @@ -77,12 +79,11 @@ Overrides the terminal type specified in the environment with .Ar terminal . .El .Sh ENVIRONMENT -The following environment variable is used: +The following environment variables affect the execution of +.Nm ul : .Bl -tag -width TERM .It Ev TERM -The -.Ev TERM -variable is used to relate a tty device +Used to relate a tty device with its device capability description (see .Xr termcap 5 ) . .Ev TERM @@ -101,8 +102,8 @@ file (see .Sh BUGS .Xr nroff 1 usually outputs a series of backspaces and underlines intermixed -with the text to indicate underlining. No attempt is made to optimize -the backward motion. +with the text to indicate underlining. +No attempt is made to optimize the backward motion. .Sh HISTORY The .Nm diff --git a/usr.bin/uname/uname.1 b/usr.bin/uname/uname.1 index e85243d4d11..f5483bb2174 100644 --- a/usr.bin/uname/uname.1 +++ b/usr.bin/uname/uname.1 @@ -1,4 +1,5 @@ -.\" $OpenBSD: uname.1,v 1.7 2000/03/06 03:16:00 aaron Exp $ +.\" $OpenBSD: uname.1,v 1.8 2000/03/11 21:40:06 aaron Exp $ +.\" .\" Copyright (c) 1990 The Regents of the University of California. .\" All rights reserved. .\" diff --git a/usr.bin/unifdef/unifdef.1 b/usr.bin/unifdef/unifdef.1 index 142ee6577b0..8b0e490fdae 100644 --- a/usr.bin/unifdef/unifdef.1 +++ b/usr.bin/unifdef/unifdef.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: unifdef.1,v 1.7 2000/03/06 03:17:40 aaron Exp $ +.\" $OpenBSD: unifdef.1,v 1.8 2000/03/11 21:40:06 aaron Exp $ .\" $NetBSD: unifdef.1,v 1.4 1994/12/07 00:33:48 jtc Exp $ .\" .\" Copyright (c) 1985, 1991, 1993 @@ -55,10 +55,10 @@ .Ar ... .Op Ar file .Sh DESCRIPTION -.Nm unifdef +.Nm is useful for removing ifdef'ed lines from a file while otherwise leaving the file alone. -.Nm unifdef +.Nm acts on #ifdef, #ifndef, #else, and #endif lines, and it knows only enough about C @@ -74,9 +74,10 @@ it will not complain if it gets to the end of a line and finds no backslash for continuation. .Pp The options are as follows: -.Bl -tag -width Ds -compact -.It Fl D Ns Ar sym -.It Fl U Ns Ar sym +.Bl -tag -width Ds +.It Xo Fl D Ns Ar sym , +.Fl U Ns Ar sym +.Xc Specify which symbols to define or undefine, and the lines inside those ifdefs will be copied to the output or removed as appropriate. @@ -84,41 +85,39 @@ The ifdef, ifndef, else, and endif lines associated with .Ar sym will also be removed. ifdefs involving symbols you don't specify -and ``#if'' control lines -are untouched and copied out +and +.Dq #if +control lines are untouched and copied out along with their associated ifdef, else, and endif lines. If an ifdef X occurs nested inside another ifdef X, then the inside ifdef is treated as if it were an unrecognized symbol. If the same symbol appears in more than one argument, the last occurrence dominates. -.Pp .It Fl c If the .Fl c flag is specified, then the operation of -.Nm unifdef +.Nm is complemented, -i.e. the lines that would have been removed or blanked +i.e., the lines that would have been removed or blanked are retained and vice versa. -.Pp .It Fl l Replace removed lines with blank lines instead of deleting them. -.Pp .It Fl t Disables parsing for C comments and quotes, which is useful for plain text. -.Pp -.It Fl iD Ns Ar sym -.It Fl iU Ns Ar sym +.It Xo Fl iD Ns Ar sym , +.Fl iU Ns Ar sym +.Xc Ignore ifdefs. If your C code uses ifdefs to delimit non-C lines, such as comments or code which is under construction, then you must tell -.Nm unifdef +.Nm which symbols are used for that purpose so that it won't try to parse for quotes and comments inside those ifdefs. @@ -133,7 +132,7 @@ and above. .El .Pp -.Nm unifdef +.Nm copies its output to .Em stdout and will take its input from @@ -142,14 +141,12 @@ if no .Ar file argument is given. .Pp -.Nm unifdef +.Nm works nicely with the .Fl D Ns Ar sym option added to .Xr diff 1 as of the 4.1 Berkeley Software Distribution. -.Sh SEE ALSO -.Xr diff 1 .Sh DIAGNOSTICS Inappropriate else or endif. .br @@ -158,12 +155,16 @@ Premature with line numbers of the unterminated #ifdefs. .Pp Exit status is 0 if output is exact copy of input, 1 if not, 2 if trouble. +.Sh SEE ALSO +.Xr diff 1 .Sh HISTORY The .Nm command appeared in .Bx 4.3 . .Sh BUGS -Should try to deal with ``#if'' lines. +Should try to deal with +.Dq #if +lines. .Pp Doesn't work correctly if input contains null characters. diff --git a/usr.bin/uniq/uniq.1 b/usr.bin/uniq/uniq.1 index a9a0bd367bc..4d12faeebfe 100644 --- a/usr.bin/uniq/uniq.1 +++ b/usr.bin/uniq/uniq.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: uniq.1,v 1.4 2000/03/05 00:28:56 aaron Exp $ +.\" $OpenBSD: uniq.1,v 1.5 2000/03/11 21:40:07 aaron Exp $ .\" $NetBSD: uniq.1,v 1.5 1994/12/06 07:51:15 jtc Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -54,7 +54,7 @@ .Oc .Sh DESCRIPTION The -.Nm uniq +.Nm utility reads the standard input comparing adjacent lines and writes a copy of each unique input line to the standard output. The second and succeeding copies of identical adjacent input lines are @@ -75,7 +75,7 @@ Ignore the first in each input line when doing comparisons. A field is a string of non-blank characters separated from adjacent fields by blanks. -Field numbers are one based, i.e. the first field is field one. +Field numbers are one based, i.e., the first field is field one. .It Fl s Ar chars Ignore the first .Ar chars @@ -87,7 +87,7 @@ option, the first characters after the first .Ar fields fields will be ignored. -Character numbers are one based, i.e. the first character is character one. +Character numbers are one based, i.e., the first character is character one. .It Fl u Don't output lines that are repeated in the input. .\".It Fl Ns Ar n @@ -115,19 +115,19 @@ such argument is used as the name of an input file, the second is used as the name of an output file. .Pp The -.Nm uniq +.Nm utility exits 0 on success or >0 if an error occurred. +.Sh SEE ALSO +.Xr sort 1 .Sh COMPATIBILITY The historic .Cm \&\(pl Ns Ar number and .Fl Ns Ar number options have been deprecated but are still supported in this implementation. -.Sh SEE ALSO -.Xr sort 1 .Sh STANDARDS The -.Nm uniq +.Nm utility is expected to be .St -p1003.2 compatible. -- 2.20.1