From: aaron Date: Wed, 8 Mar 2000 03:11:27 +0000 (+0000) Subject: Various cleanups and improvements. X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=2e3943820eba176459604b107caf480c4b2c92f8;p=openbsd Various cleanups and improvements. --- diff --git a/usr.bin/indent/indent.1 b/usr.bin/indent/indent.1 index 4f360c23ca6..2896b8bb77a 100644 --- a/usr.bin/indent/indent.1 +++ b/usr.bin/indent/indent.1 @@ -1,4 +1,5 @@ -.\" $OpenBSD: indent.1,v 1.7 1999/07/04 11:53:55 aaron Exp $ +.\" $OpenBSD: indent.1,v 1.8 2000/03/08 03:11:27 aaron Exp $ +.\" .\" Copyright (c) 1980, 1990 The Regents of the University of California. .\" Copyright (c) 1985 Sun Microsystems, Inc. .\" Copyright (c) 1976 Board of Trustees of the University of Illinois. @@ -83,26 +84,30 @@ .Nm is a .Ar C -program formatter. It reformats the +program formatter. +It reformats the .Ar C program in the .Ar input-file -according to the switches. The switches which can be -specified are described below. They may appear before or after the file -names. +according to the switches. +The switches which can be specified are described below. +They may appear before or after the file names. .Pp -.Sy NOTE : +.Sy NOTE : If you only specify an -.Ar input-file , +.Ar input-file , the formatting is -done `in-place', that is, the formatted file is written back into +done +.Dq in-place , +that is, the formatted file is written back into .Ar input-file and a backup copy of .Ar input-file -is written in the current directory. If +is written in the current directory. +If .Ar input-file is named -.Sq Pa /blah/blah/file , +.Pa /blah/blah/file , the backup file is named .Pa file.BAK . .Pp @@ -114,31 +119,34 @@ checks to make sure it is different from .Ar input-file . .Pp The options listed below control the formatting style imposed by -.Nm indent . +.Nm indent . .Bl -tag -width Op .It Fl bad , nbad If .Fl bad is specified, a blank line is forced after every block of -declarations. Default: -.Fl nbad . +declarations. +Default: +.Fl nbad . .It Fl bap , nbap If .Fl bap -is specified, a blank line is forced after every procedure body. Default: +is specified, a blank line is forced after every procedure body. +Default: .Fl nbap . .It Fl bbb , nbbb If .Fl bbb -is specified, a blank line is forced before every block comment. Default: +is specified, a blank line is forced before every block comment.Default: .Fl nbbb . .It Fl \&bc , nbc If .Fl \&bc is specified, then a newline is forced after each comma in a declaration. .Fl nbc -turns off this option. The default is -.Fl \&bc . +turns off this option. +The default is +.Fl \&bc . .It Fl \&br , \&bl Specifying .Fl \&bl @@ -162,13 +170,15 @@ if (...) { .Ed .Pp .It Fl c Ns Ar n -The column in which comments on code start. The default is 33. +The column in which comments on code start. +The default is 33. .It Fl cd Ns Ar n -The column in which comments on declarations start. The default +The column in which comments on declarations start. +The default is for these comments to start in the same column as those on code. .It Fl cdb , ncdb -Enables (disables) the placement of comment delimiters on blank lines. With -this option enabled, comments look like this: +Enables (disables) the placement of comment delimiters on blank lines. +With this option enabled, comments look like this: .Bd -literal -offset indent .ne 3 /* @@ -182,24 +192,29 @@ Rather than like this: .Ed .Pp This only affects block comments, not comments to the right of -code. The default is -.Fl cdb . +code. +The default is +.Fl cdb . .It Fl ce , nce -Enables (disables) forcing `else's to cuddle up to the immediately preceding -`}'. The default is -.Fl \&ce . +Enables (disables) forcing +.Do Li else Dc Ns s +to cuddle up to the immediately preceding +.Ql } . +The default is +.Fl \&ce . .It Fl \&ci Ns Ar n Sets the continuation indent to be -.Ar n . +.Ar n . Continuation lines will be indented that far from the beginning of the first line of the -statement. Parenthesized expressions have extra indentation added to +statement. +Parenthesized expressions have extra indentation added to indicate the nesting, unless .Fl \&lp is in effect. .Fl \&ci defaults to the same value as -.Fl i . +.Fl i . .It Fl cli Ns Ar n Causes case labels to be indented .Ar n @@ -207,32 +222,37 @@ tab stops to the right of the containing .Ic switch statement. .Fl cli0 .5 -causes case labels to be indented half a tab stop. The -default is -.Fl cli0 . +causes case labels to be indented half a tab stop. +The default is +.Fl cli0 . .It Fl d Ns Ar n Controls the placement of comments which are not to the -right of code. The default +right of code. +The default .Fl \&d\&1 means that such comments are placed one indentation level to the -left of code. Specifying +left of code. +Specifying .Fl \&d\&0 -lines up these comments with the code. See the section on comment -indentation below. +lines up these comments with the code. +See the section on comment indentation below. .It Fl \&di Ns Ar n Specifies the indentation, in character positions, from a declaration keyword -to the following identifier. The default is -.Fl di16 . +to the following identifier. +The default is +.Fl di16 . .It Fl dj , ndj .Fl \&dj left justifies declarations. .Fl ndj -indents declarations the same as code. The default is -.Fl ndj . +indents declarations the same as code. +The default is +.Fl ndj . .It Fl \&ei , nei Enables (disables) special .Ic else-if -processing. If it's enabled, an +processing. +If it's enabled, an .Ic if following an .Ic else @@ -241,25 +261,33 @@ will have the same indentation as the preceding statement. .It Fl fc1 , nfc1 Enables (disables) the formatting of comments that start in column 1. -Often, comments whose leading `/' is in column 1 have been carefully -hand formatted by the programmer. In such cases, +Often, comments whose leading +.Ql / +is in column 1 have been carefully have formatted by the programmer. +In such cases, .Fl nfc1 should be -used. The default is -.Fl fc1 . +used. +The default is +.Fl fc1 . .It Fl i Ns Ar n -The number of spaces for one indentation level. The default is 8. +The number of spaces for one indentation level. +The default is 8. .It Fl \&ip , nip Enables (disables) the indentation of parameter declarations from the left -margin. The default is -.Fl \&ip . +margin. +The default is +.Fl \&ip . .It Fl l Ns Ar n -Maximum length of an output line. The default is 75. +Maximum length of an output line. +The default is 75. .It Fl \&lp , nlp -Lines up code surrounded by parenthesis in continuation lines. If a line +Lines up code surrounded by parenthesis in continuation lines. +If a line has a left paren which is not closed on that line, then continuation lines will be lined up to start at the character position just after the left -paren. For example, here is how a piece of continued code looks with +paren. +For example, here is how a piece of continued code looks with .Fl nlp in effect: .ne 2 @@ -287,32 +315,36 @@ Inserting two more newlines we get: .Ed .It Fl npro Causes the profile files, -.Sq Pa ./.indent.pro +.Pa ./.indent.pro and -.Sq Pa ~/.indent.pro , +.Pa ~/.indent.pro , to be ignored. .It Fl pcs , npcs If true .Pq Fl pcs all procedure calls will have a space inserted between -the name and the `('. The default is -.Fl npcs . +the name and the +.Ql ( . +The default is +.Fl npcs . .It Fl psl , npsl If true .Pq Fl psl the names of procedures being defined are placed in -column 1 \- their types, if any, will be left on the previous lines. The -default is -.Fl psl . +column 1 \- their types, if any, will be left on the previous lines. +The default is +.Fl psl . .It Fl \&sc , nsc -Enables (disables) the placement of asterisks (`*'s) at the left edge of all -comments. +Enables (disables) the placement of asterisks +.Pq Ql * +at the left edge of all comments. .It Fl sob , nsob If .Fl sob -is specified, indent will swallow optional blank lines. You can use this to -get rid of blank lines after declarations. Default: -.Fl nsob . +is specified, indent will swallow optional blank lines. +You can use this to get rid of blank lines after declarations. +Default: +.Fl nsob . .It Fl \&st Causes .Nm @@ -320,14 +352,17 @@ to take its input from stdin, and put its output to stdout. .It Fl T Ns Ar typename Adds .Ar typename -to the list of type keywords. Names accumulate: +to the list of type keywords. +Names accumulate: .Fl T -can be specified more than once. You need to specify all the typenames that +can be specified more than once. +You need to specify all the typenames that appear in your program that are defined by .Ic typedef \- nothing will be harmed if you miss a few, but the program won't be formatted as nicely as -it should. This sounds like a painful thing to have to do, but it's really +it should. +This sounds like a painful thing to have to do, but it's really a symptom of a problem in C: .Ic typedef causes a syntactic change in the @@ -348,35 +383,51 @@ If the output file is not specified, the default is standard output, rather than formatting in place. .It Fl v , \&nv .Fl v -turns on `verbose' mode; +turns on +.Dq verbose +mode; .Fl \&nv -turns it off. When in verbose mode, +turns it off. +When in verbose mode, .Nm reports when it splits one line of input into two or more lines of output, and gives some size statistics at completion. The default is -.Fl \&nv . +.Fl \&nv . .El .Pp -You may set up your own `profile' of defaults to +You may set up your own +.Dq profile +of defaults to .Nm by creating a file called .Pa .indent.pro in your login directory and/or the current directory and including -whatever switches you like. A `.indent.pro' in the current directory takes -precedence over the one in your login directory. If +whatever switches you like. +An +.Pa \&.indent.pro +file in the current directory takes +precedence over the one in your login directory. +If .Nm is run and a profile file exists, then it is read to set up the program's -defaults. Switches on the command line, though, always override profile -switches. The switches should be separated by spaces, tabs or newlines. +defaults. +Switches on the command line, though, always override profile +switches. +The switches should be separated by spaces, tabs or newlines. .Pp .Ss Comments .Sq Em Box .Em comments . .Nm assumes that any comment with a dash, star, or newline immediately after -the start of comment (that is, `/*\-', `/**' or `/*' followed -immediately by a newline character) is a comment surrounded -by a box of stars. Each line of such a comment is left unchanged, except +the start of comment (that is, +.Ql /*\- , +.Ql /** , +or +.Ql /* +followed immediately by a newline character) is a comment surrounded +by a box of stars. +Each line of such a comment is left unchanged, except that its indentation may be adjusted to account for the change in indentation of the first line of the comment. @@ -385,28 +436,34 @@ of the comment. All other comments are treated as straight text. .Nm fits as many words (separated by blanks, tabs, or newlines) on a -line as possible. Blank lines break paragraphs. +line as possible. +Blank lines break paragraphs. .Pp .Ss Comment indentation -If a comment is on a line with code it is started in the `comment column', +If a comment is on a line with code it is started in the +.Dq comment column , which is set by the .Fl c Ns Ns Ar n -command line parameter. Otherwise, the comment is started at +command line parameter. +Otherwise, the comment is started at .Ar n indentation levels less than where code is currently being placed, where .Ar n is specified by the .Fl d Ns Ns Ar n -command line parameter. If the code on a line extends past the comment +command line parameter. +If the code on a line extends past the comment column, the comment starts further to the right, and the right margin may be automatically extended in extreme cases. .Pp .Ss Preprocessor lines In general, .Nm -leaves preprocessor lines alone. The only -reformatting that it will do is to straighten up trailing comments. It -leaves embedded comments alone. Conditional compilation +leaves preprocessor lines alone. +The only +reformatting that it will do is to straighten up trailing comments. +It leaves embedded comments alone. +Conditional compilation .Pq Ic #ifdef...#endif is recognized and .Nm @@ -416,17 +473,24 @@ compensate for the syntactic peculiarities introduced. .Ss C syntax .Nm understands a substantial amount about the syntax of C, but it -has a `forgiving' parser. It attempts to cope with the usual sorts of -incomplete and misformed syntax. In particular, the use of macros like: +has a +.Dq forgiving +parser. +It attempts to cope with the usual sorts of +incomplete and misformed syntax. +In particular, the use of macros like: .Pp .Dl #define forever for(;;) .Pp is handled properly. .Sh ENVIRONMENT -.Nm -uses the -.Ev HOME -environment variable. +The following environment variables affect the execution of +.Nm indent : +.Bl -tag -width Ds +.It Ev HOME +Used to locate the full path to +.Pa ~/.indent.pro . +.El .Sh FILES .Bl -tag -width "./.indent.pro" -compact .It Pa ./.indent.pro diff --git a/usr.bin/ipcrm/ipcrm.1 b/usr.bin/ipcrm/ipcrm.1 index 7b98f385e90..bed4cd7f230 100644 --- a/usr.bin/ipcrm/ipcrm.1 +++ b/usr.bin/ipcrm/ipcrm.1 @@ -1,4 +1,5 @@ -.\" $OpenBSD: ipcrm.1,v 1.5 1999/07/04 11:53:55 aaron Exp $ +.\" $OpenBSD: ipcrm.1,v 1.6 2000/03/08 03:11:28 aaron Exp $ +.\" .\" Copyright (c) 1994 Adam Glass .\" All rights reserved. .\" @@ -42,10 +43,11 @@ segments .Sh DESCRIPTION .Nm removes the specified message queues, semaphores and shared memory -segments. These System V IPC objects can be specified by their +segments. +These System V IPC objects can be specified by their creation ID or any associated key. .Pp -The following options are used to specify which IPC objects will be removed. Any number and combination of these options can be used: +The options are as follows: .Bl -tag -width indent .It Fl q Ar msqid Remove the message queue associated with the ID @@ -78,6 +80,5 @@ from the system. The identifiers and keys associated with these System V IPC objects can be determined by using .Xr ipcs 1 . -. .Sh SEE ALSO .Xr ipcs 1 diff --git a/usr.bin/ipcs/ipcs.1 b/usr.bin/ipcs/ipcs.1 index 5da7829635f..70075ea62a2 100644 --- a/usr.bin/ipcs/ipcs.1 +++ b/usr.bin/ipcs/ipcs.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ipcs.1,v 1.9 1999/10/05 20:53:09 aaron Exp $ +.\" $OpenBSD: ipcs.1,v 1.10 2000/03/08 03:11:29 aaron Exp $ .\" .\" Copyright (c) 1994 SigmaSoft, Th. Lockert .\" All rights reserved. @@ -61,7 +61,8 @@ and options.) .It Fl b Show the maximum allowed sizes for active semaphores, message queues, -and shared memory segments. The +and shared memory segments. +The .Dq maximum allowed size is the maximum number of bytes in a message on a message queue, the size of a shared memory segment, @@ -73,13 +74,15 @@ and shared memory segments. Display information about active shared memory segments. .It Fl o Show outstanding usage for active message queues, -and shared memory segments. The +and shared memory segments. +The .Dq outstanding usage is the number of messages in a message queue, or the number of processes attached to a shared memory segment. .It Fl p Show the process ID information for active semaphores, message queues, -and shared memory segments. The +and shared memory segments. +The .Dq process ID information is the last process to send a message to or receive a message from a message queue, @@ -91,7 +94,8 @@ Display information about active message queues. Display information about active semaphores. .It Fl t Show access times for active semaphores, message queues, -and shared memory segments. The access times is the time +and shared memory segments. +The access times is the time of the last control operation on an IPC object, the last send or receive of a message, the last attach or detach of a shared memory segment, diff --git a/usr.bin/join/join.1 b/usr.bin/join/join.1 index a9a261a54f5..1040931ba36 100644 --- a/usr.bin/join/join.1 +++ b/usr.bin/join/join.1 @@ -1,3 +1,5 @@ +.\" $OpenBSD: join.1,v 1.9 2000/03/08 03:11:29 aaron Exp $ +.\" .\" Copyright (c) 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" @@ -105,7 +107,7 @@ each line with matching join fields. Each element of .Ar list has the form -.Ql file_number.field , +.Dq file_number.field , where .Ar file_number is a file number and @@ -165,8 +167,10 @@ If one of the arguments or .Ar file2 is -.Ql \&- , +.Dq - , the standard input is used. +.\" XXX - use .br as a work-around for an apparent bug in mdoc +.br .Pp The .Nm diff --git a/usr.bin/jot/jot.1 b/usr.bin/jot/jot.1 index 85e50c80a61..0fdded10fe3 100644 --- a/usr.bin/jot/jot.1 +++ b/usr.bin/jot/jot.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: jot.1,v 1.3 1999/07/26 14:14:43 aaron Exp $ +.\" $OpenBSD: jot.1,v 1.4 2000/03/08 03:11:29 aaron Exp $ .\" $NetBSD: jot.1,v 1.2 1994/11/14 20:27:36 jtc Exp $ .\" .\" Copyright (c) 1993 @@ -66,7 +66,7 @@ repetitively. Print .Ar word with the generated data appended to it. -Octal, hexadecimal, exponential, ASCII, zero padded, +Octal, hexadecimal, exponential, ASCII, zero-padded, and right-adjusted representations are possible by using the appropriate .Xr printf 3 diff --git a/usr.bin/kdump/kdump.1 b/usr.bin/kdump/kdump.1 index 9ab2a7a1726..a714e1103c8 100644 --- a/usr.bin/kdump/kdump.1 +++ b/usr.bin/kdump/kdump.1 @@ -1,4 +1,5 @@ -.\" $OpenBSD: kdump.1,v 1.6 2000/03/04 15:53:40 aaron Exp $ +.\" $OpenBSD: kdump.1,v 1.7 2000/03/08 03:11:30 aaron Exp $ +.\" .\" Copyright (c) 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" diff --git a/usr.bin/ktrace/ktrace.1 b/usr.bin/ktrace/ktrace.1 index 37c43f7b1e7..4a73cd82c43 100644 --- a/usr.bin/ktrace/ktrace.1 +++ b/usr.bin/ktrace/ktrace.1 @@ -1,4 +1,5 @@ -.\" $OpenBSD: ktrace.1,v 1.8 2000/03/04 15:53:40 aaron Exp $ +.\" $OpenBSD: ktrace.1,v 1.9 2000/03/08 03:11:30 aaron Exp $ +.\" .\" Copyright (c) 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" diff --git a/usr.bin/last/last.1 b/usr.bin/last/last.1 index 7a04e515612..905c3396f04 100644 --- a/usr.bin/last/last.1 +++ b/usr.bin/last/last.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: last.1,v 1.12 2000/03/06 03:17:38 aaron Exp $ +.\" $OpenBSD: last.1,v 1.13 2000/03/08 03:11:30 aaron Exp $ .\" $NetBSD: last.1,v 1.3 1994/12/21 22:41:23 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -42,31 +42,34 @@ .Nd indicate last logins of users and ttys .Sh SYNOPSIS .Nm last -.Op Fl Ns Ar c +.Op Fl csT .Op Fl Ns Ar n -.Op Fl Ns Ar s -.Op Fl Ns Ar T .Op Fl f Ar file .Op Fl h Ar host .Op Fl t Ar tty .Op Fl d Ar [[yy]yy[mm[dd[hh]]]]mm[.ss] .Op Ar user ... .Sh DESCRIPTION +The .Nm last -will either (1) list the sessions of specified +utility will either (1) list the sessions of specified .Ar users , .Ar ttys , and .Ar hosts , in reverse time order, or (2) list the users logged in at a specified snapshot date & time -in reverse time order. Each line of output contains +in reverse time order. +Each line of output contains the user name, the tty from which the session was conducted, any hostname, the start and stop times for the session, and the duration -of the session. If the session is still continuing or was cut short by +of the session. +If the session is still continuing or was cut short by a crash or shutdown, .Nm last will so indicate. +.Pp +The options are as follows: .Bl -tag -width indent-two .It Fl c Calculates the total time displayed and prints it after the output. @@ -80,16 +83,16 @@ instead of the default, Limits the report to .Ar n lines. -.It Fl Ar s +.It Fl s Display time values in seconds since the epoch, instead of formatted dates. .It Fl t Ar tty Specify the .Ar tty . tty names may be given fully or abbreviated, for example, -.Dq Li "last -t 03" +.Ic last -t 03 is equivalent to -.Dq Li "last -t tty03" . +.Ic last -t tty03 . .It Fl h Ar host .Ar host names may be names or internet numbers. @@ -155,25 +158,26 @@ If multiple arguments are given, and a snapshot time is not specified, the information which applies to any of the arguments is printed, e.g., -.Dq Li "last root -t console" +.Ic last root -t console would list all of -.Dq Li root Ns 's +.Li root Ns 's sessions as well as all sessions on the console terminal. If no -users, hostnames or terminals are specified, +users, hostnames, or terminals are specified, .Nm last prints a record of all logins and logouts. .Pp The pseudo-user -.Ar reboot +.Dq reboot logs in at reboots of the system; thus -.Dq Li last reboot +.Ic last reboot will give an indication of mean time between reboot. .Pp If .Nm last is interrupted, it indicates to what date the search has -progressed. If interrupted with a quit signal +progressed. +If interrupted with a quit signal .Nm last indicates how far the search has progressed and then continues. diff --git a/usr.bin/lastcomm/lastcomm.1 b/usr.bin/lastcomm/lastcomm.1 index 996d0a93c03..690cb0ffadd 100644 --- a/usr.bin/lastcomm/lastcomm.1 +++ b/usr.bin/lastcomm/lastcomm.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lastcomm.1,v 1.11 1999/06/05 01:21:30 aaron Exp $ +.\" $OpenBSD: lastcomm.1,v 1.12 2000/03/08 03:11:30 aaron Exp $ .\" $NetBSD: lastcomm.1,v 1.5 1995/10/22 01:43:41 ghudson Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -54,7 +54,7 @@ With no arguments, prints information about all the commands recorded during the current accounting file's lifetime. .Pp -Option: +The options are as follows: .Bl -tag -width Fl .It Fl f Ar file Read from @@ -83,7 +83,7 @@ executions of commands named by user .Ar root on the terminal -.Ar ttyd0 . +.Ar ttyd0 . .Pp For each process entry, the following are printed: .Pp @@ -91,26 +91,34 @@ For each process entry, the following are printed: .It Name of the user who ran the process. .It -Flags, as accumulated by the accounting facilities in the system. +Flags, as accumulated by the system's accounting facilities. .It Command name under which the process was called. .It -Amount of cpu time used by the process (in seconds). +Amount of CPU time used by the process (in seconds). .It Time the process started. .It Elapsed time of the process. .El .Pp -The flags are encoded as follows: ``S'' indicates the command was -executed by the super-user, ``F'' indicates the command ran after +The flags are encoded as follows: +.Sq S +indicates the command was +executed by the superuser, +.Sq F +indicates the command ran after a fork, but without a following .Xr exec , -``C'' indicates the command was run in PDP-11 compatibility mode +.Sq C +indicates the command was run in PDP-11 compatibility mode (VAX only), -``D'' indicates the command terminated with the generation of a +.Sq D +indicates the command terminated with the generation of a .Pa core -file, and ``X'' indicates the command was terminated with a signal. +file, and +.Sq X +indicates the command was terminated with a signal. .Sh FILES .Bl -tag -width /var/account/acct -compact .It Pa /var/account/acct diff --git a/usr.bin/leave/leave.1 b/usr.bin/leave/leave.1 index 14952cce05f..64b53305d53 100644 --- a/usr.bin/leave/leave.1 +++ b/usr.bin/leave/leave.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: leave.1,v 1.5 1999/10/17 20:24:34 aaron Exp $ +.\" $OpenBSD: leave.1,v 1.6 2000/03/08 03:11:31 aaron Exp $ .\" $NetBSD: leave.1,v 1.5 1995/08/31 22:32:10 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -74,7 +74,7 @@ All times are converted to a 12 hour clock, and assumed to be in the next 12 hours. .It Cm \&+ If the time is preceded by -.Ql Cm \&+ , +.Ql + , the alarm will go off in hours and minutes from the current time. .El diff --git a/usr.bin/lndir/lndir.1 b/usr.bin/lndir/lndir.1 index ff69a83ee5d..120e88472f2 100644 --- a/usr.bin/lndir/lndir.1 +++ b/usr.bin/lndir/lndir.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lndir.1,v 1.8 1999/06/05 01:21:31 aaron Exp $ +.\" $OpenBSD: lndir.1,v 1.9 2000/03/08 03:11:31 aaron Exp $ .\" .\" Copyright (c) 1997, Jason Downs. All rights reserved. .\" @@ -82,10 +82,13 @@ except that the shadow is not populated with real files but instead with symbolic links pointing at the real files in the .Ar fromdir -directory tree. This is usually useful for maintaining source code for -different machine architectures. You create a shadow directory +directory tree. +This is usually useful for maintaining source code for +different machine architectures. +You create a shadow directory containing links to the real source, which you will have usually -mounted from a remote machine. You can build in the shadow tree, and +mounted from a remote machine. +You can build in the shadow tree, and the object files will be in the shadow directory, while the source files in the shadow directory are just symlinks to the real files. @@ -97,9 +100,12 @@ to the shadow directory and recompile away. .Pp The .Ar todir -argument is optional and defaults to the current directory. The +argument is optional and defaults to the current directory. +The .Ar fromdir -argument may be relative (e.g., ../src) and is relative to +argument may be relative (e.g., +.Pa \&.\&./src ) +and is relative to .Ar todir (not the current directory). .Pp @@ -111,7 +117,9 @@ arguments. .Pp If you add files, simply run .Nm lndir -again. New files will be silently added. Old files will be +again. +New files will be silently added. +Old files will be checked that they have the correct link. .Pp Deleting files is a more painful problem; the symlinks will @@ -128,10 +136,12 @@ rather than making a link back to the (symbolic link) entry in The .Fl i flag changes this behavior. -.Sh OPTIONS +.Pp +The options are as follows: .Bl -tag -width XxXXXXXXXXXXXX .It Fl e Ar exceptfile -Add the specified file to the list of excluded files/directories. This is +Add the specified file to the list of excluded files/directories. +This is effective in all directories searched by .Nm lndir . This option may be specified as many times as needed. @@ -142,7 +152,8 @@ descends into each subdirectory. .It Fl i Causes the program to not treat symbolic links in .Ar fromdir -specially. The link created in +specially. +The link created in .Ar todir will point back to the corresponding (symbolic link) file in .Ar fromdir . @@ -150,11 +161,13 @@ If the link is to a directory, this is almost certainly the wrong thing. .Pp This option exists mostly to emulate the behavior the C version of .Nm lndir -had in X11R6. Its use is not recommended. +had in X11R6. +Its use is not recommended. .El .Sh DIAGNOSTICS The program displays the name of each subdirectory it enters, followed -by a colon. The +by a colon. +The .Fl s option suppresses these messages. .Pp @@ -167,7 +180,8 @@ program prints the link name and the location where it does point. .Sh BUGS The .Xr patch 1 -program gets upset if it cannot change the files. You should never run +program gets upset if it cannot change the files. +You should never run .Xr patch 1 from a shadow directory anyway. .Pp diff --git a/usr.bin/locate/locate/locate.1 b/usr.bin/locate/locate/locate.1 index ddc0ab81577..b7e2436b0f2 100644 --- a/usr.bin/locate/locate/locate.1 +++ b/usr.bin/locate/locate/locate.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: locate.1,v 1.11 2000/03/05 00:28:53 aaron Exp $ +.\" $OpenBSD: locate.1,v 1.12 2000/03/08 03:11:31 aaron Exp $ .\" .\" Copyright (c) 1995 Wolfram Schneider . Berlin. .\" Copyright (c) 1990, 1993 @@ -33,7 +33,7 @@ .\" SUCH DAMAGE. .\" .\" @(#)locate.1 8.1 (Berkeley) 6/6/93 -.\" $Id: locate.1,v 1.11 2000/03/05 00:28:53 aaron Exp $ +.\" $Id: locate.1,v 1.12 2000/03/08 03:11:31 aaron Exp $ .\" .Dd June 6, 1993 .Dt LOCATE 1 @@ -48,8 +48,9 @@ .Op Fl d Ar database .Ar pattern Op Ar ... .Sh DESCRIPTION +The .Nm -searches a database for all pathnames which match the specified +utility searches a database for all pathnames which match the specified .Ar pattern . The database is recomputed periodically (usually weekly or daily), and contains the pathnames @@ -79,8 +80,8 @@ is matched as though it were .Pp Historically, .Nm -stores only characters between 32 and 127. The -current implementation stores all characters except newline +stores only characters between 32 and 127. +The current implementation stores all characters except newline .Pq Ql \en and NUL @@ -88,8 +89,8 @@ NUL The 8-bit character support does not waste extra space for plain .Tn ASCII -file names. Characters less than 32 or greater than 127 -are stored as 2 bytes. +file names. +Characters less than 32 or greater than 127 are stored as 2 bytes. .Pp The options are as follows: .Bl -tag -width 10n indent @@ -103,7 +104,8 @@ Search in instead the default file name database. Multiple .Fl d -options are allowed. Each additional +options are allowed. +Each additional .Fl d option adds the specified database to the list of databases to be searched. @@ -206,7 +208,8 @@ option was specified. .Sh BUGS .Nm may fail to list some files that are present, or may -list files that have been removed from the system. This is because +list files that have been removed from the system. +This is because .Nm only reports files that are present in a periodically reconstructed database (typically rebuilt once a week by the @@ -240,7 +243,8 @@ to share the databases between machines with different byte order. The current .Nm implementation understands databases in host byte order or -network byte order. So a little-endian machine can't understand +network byte order. +So a little-endian machine can't understand a locate database which was built on an big-endian machine. .Sh HISTORY The diff --git a/usr.bin/lock/lock.1 b/usr.bin/lock/lock.1 index 00883ca1ab1..63145c38e65 100644 --- a/usr.bin/lock/lock.1 +++ b/usr.bin/lock/lock.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lock.1,v 1.8 1999/10/17 20:24:34 aaron Exp $ +.\" $OpenBSD: lock.1,v 1.9 2000/03/08 03:11:31 aaron Exp $ .\" $NetBSD: lock.1,v 1.4 1994/12/22 01:16:21 jtc Exp $ .\" .\" Copyright (c) 1987, 1990, 1993 @@ -57,13 +57,19 @@ with the appropriate privileges. The options are as follows: .Bl -tag -width Fl .It Fl n -Don't use a timeout value. Terminal will be locked forever. +Don't use a timeout value. +Terminal will be locked forever. .It Fl p A password is not requested, instead the user's current login password is used. If the user has an S/Key key, they may also use it -to unlock the terminal. To do this the user should enter "s/key" -at the unlock "Key:" prompt. The user will then be issued an S/Key +to unlock the terminal. +To do this the user should enter +.Qq s/key +at the unlock +.Dq Key: +prompt. +The user will then be issued an S/Key challenge to which they may respond with a six-word S/Key one-time password. .It Fl t Ar timeout diff --git a/usr.bin/logger/logger.1 b/usr.bin/logger/logger.1 index b13e8345d46..0704d5dfa4c 100644 --- a/usr.bin/logger/logger.1 +++ b/usr.bin/logger/logger.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: logger.1,v 1.6 1999/10/17 20:24:34 aaron Exp $ +.\" $OpenBSD: logger.1,v 1.7 2000/03/08 03:11:32 aaron Exp $ .\" $NetBSD: logger.1,v 1.4 1994/12/22 06:26:59 jtc Exp $ .\" .\" Copyright (c) 1983, 1990, 1993 @@ -48,9 +48,10 @@ .Op Fl t Ar tag .Op Ar message ... .Sh DESCRIPTION +The .Nm logger -provides a shell command interface to the -.Xr syslog 3 +utility provides a shell command interface to the +.Xr syslog 3 system log module. .Pp The options are as follows: diff --git a/usr.bin/login/login.1 b/usr.bin/login/login.1 index ef4cc938f0f..aab4e081cb7 100644 --- a/usr.bin/login/login.1 +++ b/usr.bin/login/login.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: login.1,v 1.11 1999/07/21 01:25:46 deraadt Exp $ +.\" $OpenBSD: login.1,v 1.12 2000/03/08 03:11:32 aaron Exp $ .\" $NetBSD: login.1,v 1.7 1995/08/31 22:52:33 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -55,7 +55,9 @@ of the user fails, .Nm prompts for a user name. Authentication of users is done via passwords. -Alternately, the user can enter the password "s/key", in which case +Alternately, the user can enter the password +.Qq s/key , +in which case S/Key authentication of users is performed, as descibed in .Xr skey 1 . S/Key is a Trademark of Bellcore. @@ -68,15 +70,15 @@ The option is used when a user name is specified to indicate that proper authentication has already been done and that no password need be requested. -This option may only be used by the super-user or when an already +This option may only be used by the superuser or when an already logged in user is logging in as themselves. .It Fl h Ar hostname The .Fl h option specifies the host from which the connection was received. It is used by various daemons such as -.Xr telnetd 8 . -This option may only be used by the super-user. +.Xr telnetd 8 . +This option may only be used by the superuser. .It Fl p By default, .Nm @@ -92,7 +94,7 @@ exists, .Nm displays its contents to the user and exits. This is used by -.Xr shutdown 8 +.Xr shutdown 8 to prevent users from logging in when the system is about to go down. .Pp If the file