From de1a2e14f08654e7d9a22d7ab948339c5c1eff3f Mon Sep 17 00:00:00 2001 From: aaron Date: Sat, 4 Mar 2000 21:11:59 +0000 Subject: [PATCH] Many improvements and general cleanup/standardization. --- usr.bin/ar/ar.1 | 27 +++--- usr.bin/arch/arch.1 | 24 +++-- usr.bin/asa/asa.1 | 15 +-- usr.bin/at/at.1 | 176 ++++++++++++++++++------------------ usr.bin/basename/basename.1 | 12 +-- usr.bin/basename/dirname.1 | 12 +-- usr.bin/biff/biff.1 | 3 +- usr.bin/cal/cal.1 | 9 +- usr.bin/calendar/calendar.1 | 7 +- usr.bin/cap_mkdb/cap_mkdb.1 | 18 +++- 10 files changed, 162 insertions(+), 141 deletions(-) diff --git a/usr.bin/ar/ar.1 b/usr.bin/ar/ar.1 index 7df64c94876..04b88dd510f 100644 --- a/usr.bin/ar/ar.1 +++ b/usr.bin/ar/ar.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ar.1,v 1.6 1999/08/27 07:14:00 fgsch Exp $ +.\" $OpenBSD: ar.1,v 1.7 2000/03/04 21:11:59 aaron Exp $ .\" $NetBSD: ar.1,v 1.7 1995/08/18 15:05:11 pk Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -90,7 +90,7 @@ utility creates and maintains groups of files combined into an archive. Once an archive has been created, new files can be added and existing files can be extracted, deleted, or replaced. .Pp -Files are named in the archive by a single component, i.e., if a file +Files are named in the archive by a single component; i.e., if a file referenced by a path containing a slash .Pq Ql / is archived it will be @@ -113,6 +113,7 @@ is for the creation and maintenance of libraries suitable for use with the loader (see .Xr ld 1 ) although it is not restricted to this purpose. +.Pp The options are as follows: .Bl -tag -width indent .It Fl a @@ -155,7 +156,7 @@ option. Move the specified archive files within the archive. If one of the options .Fl a , -.Fl b +.Fl b , or .Fl i are specified, the files are moved before or after the @@ -187,7 +188,7 @@ Files that replace existing files do not change the order of the files within the archive. New files are appended to the archive unless one of the options .Fl a , -.Fl b +.Fl b , or .Fl i is specified. @@ -225,15 +226,15 @@ Provide verbose output. When used with the .Fl d , .Fl m , -.Fl q +.Fl q , or .Fl x options, .Nm gives a file-by-file description of the archive modification. -This description consists of three, white-space separated fields: the +This description consists of three, whitespace-separated fields: the option letter, a dash -.Pq Ql - +.Pq Ql - , and the file name. When used with the .Fl r @@ -267,7 +268,7 @@ displays an .Dq ls -l style listing of information about the members of the archive. -This listing consists of eight, white-space separated fields: +This listing consists of eight, whitespace-separated fields: the file permissions (see .Xr strmode 3 ), the decimal user and group IDs, separated by a single slash @@ -309,6 +310,11 @@ default temporary file directory .It Pa ar.XXXXXXXXXX temporary file names .El +.Sh SEE ALSO +.Xr ld 1 , +.Xr ranlib 1 , +.Xr strmode 3 , +.Xr ar 5 .Sh COMPATIBILITY By default, .Nm @@ -335,8 +341,3 @@ The utility is expected to offer a superset of the .St -p1003.2 functionality. -.Sh SEE ALSO -.Xr ld 1 , -.Xr ranlib 1 , -.Xr strmode 3 , -.Xr ar 5 diff --git a/usr.bin/arch/arch.1 b/usr.bin/arch/arch.1 index 892cf112e59..1e08ad58898 100644 --- a/usr.bin/arch/arch.1 +++ b/usr.bin/arch/arch.1 @@ -1,3 +1,5 @@ +.\" $OpenBSD: arch.1,v 1.5 2000/03/04 21:12:00 aaron Exp $ +.\" .\" Copyright (c) 1994 SigmaSoft, Th. Lockert .\" All rights reserved. .\" @@ -26,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.4 1999/08/19 22:17:38 niklas Exp $ +.\" $OpenBSD: arch.1,v 1.5 2000/03/04 21:12:00 aaron Exp $ .\" .Dd June 22, 1996 .Dt ARCH 1 @@ -42,11 +44,11 @@ .Op Fl a .Sh DESCRIPTION The -.Nm +.Nm arch and .Nm machine -command displays the machine's architecture in slightly different ways. -.Nm +commands display the machine's architecture in slightly different ways. +.Nm arch by default displays the application architecture, defined by both the operating system and the instruction set architecture, while .Nm machine @@ -57,8 +59,9 @@ which describes the host. This is useful for dynamic discovery of the target architecture in build or configuration scripts needing to work in cross-compilation environments. .Pp -The following options are available to -.Nm arch : +The options for +.Nm arch +are as follows: .Bl -tag -width indent .It Fl k Display the kernel architecture instead of application @@ -68,17 +71,12 @@ Display the chosen architecture in a short form, i.e. without the operating system prefixed. .El .Pp -The +The options for .Nm machine -command accepts this option: +are as follows: .Bl -tag -width indent .It Fl a Display the application architecture instead of the kernel architecture. .El .Sh SEE ALSO .Xr uname 1 -.Sh HISTORY -The -.Nm -command is -.Ud . diff --git a/usr.bin/asa/asa.1 b/usr.bin/asa/asa.1 index 81266fe8531..6cddd4e1899 100644 --- a/usr.bin/asa/asa.1 +++ b/usr.bin/asa/asa.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: asa.1,v 1.7 1999/07/04 11:53:50 aaron Exp $ +.\" $OpenBSD: asa.1,v 1.8 2000/03/04 21:12:00 aaron Exp $ .\" $NetBSD: asa.1,v 1.4 1995/03/26 02:25:05 glass Exp $ .\" .\" Copyright (c) 1993 Winning Strategies, Inc. @@ -50,7 +50,8 @@ carriage-control characters to line-printer control sequences, and writes them to the standard output. .Pp The first character of each line is interpreted as a carriage-control -character. Additionally, the following characters are interpreted as shown: +character. +Additionally, the following characters are interpreted as shown: .Bl -tag -width indent .It Output the rest of the line without change. @@ -71,19 +72,21 @@ before printing the rest of the line. Lines beginning with characters other than the above are treated as if they begin with a space .Pq Sq \ . +.Pp +The +.Nm +utility exits 0 on success or >0 if an error occurred. .Sh EXAMPLES To view a file containing the output of a .Tn FORTRAN program: +.Pp .Dl asa file .Pp To format the output of a .Tn FORTRAN program and redirect it to a line-printer. +.Pp .Dl a.out | asa | lpr -.Sh DIAGNOSTICS -The -.Nm -utility exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr f77 1 .Sh STANDARDS diff --git a/usr.bin/at/at.1 b/usr.bin/at/at.1 index 2d3228a1734..c33b1d9ac6f 100644 --- a/usr.bin/at/at.1 +++ b/usr.bin/at/at.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: at.1,v 1.12 1999/09/14 05:28:23 deraadt Exp $ +.\" $OpenBSD: at.1,v 1.13 2000/03/04 21:12:00 aaron Exp $ .\" $FreeBSD: at.man,v 1.6 1997/02/22 19:54:05 peter Exp $ .Dd April 12, 1995 .Dt AT 1 @@ -34,17 +34,19 @@ .Op Fl mv .Op Ar time .Sh DESCRIPTION -.Nm +.Nm at and .Nm batch read commands from standard input or a specified file which are to be executed at a later time, using .Xr sh 1 . +.Pp +The related programs are as follows: .Bl -tag -width indent .It Nm at Executes commands at a specified time. .It Nm atq -Lists the user's pending jobs, unless the user is the superuser. +Lists the user's pending jobs, unless the user is the super-user. In that case, all users' jobs are listed. .It Nm atrm Deletes jobs. @@ -54,7 +56,61 @@ the load average drops below 1.5, or the value specified in the invocation of .Nm atrun . .El .Pp -.Nm +The options are as follows: +.Bl -tag -width indent +.It Fl V +Prints the version number to standard error. +.It Fl q Ar queue +Uses the specified queue. +A queue designation consists of a single letter. Valid queue designations +range from +.Sy a +to +.Sy z +and +.Sy A +to +.Sy Z . +The +.Sy c +queue is the default for +.Nm at +and the +.Sy E +queue for +.Nm batch . +Queues with higher letters run with increased niceness. +If a job is submitted to a queue designated with an uppercase letter, it +is treated as if it had been submitted to batch at that time. +If +.Nm atq +is given a specific queue, it will only show jobs pending in that queue. +.It Fl m +Send mail to the user when the job has completed, even if there was no +output. +.It Fl f Ar file +Reads the job from +.Ar file +rather than standard input. +.It Fl l +An alias for +.Nm atq . +.It Fl d +An alias for +.Nm atrm . +.It Fl b +An alias for +.Nm batch . +.It Fl v +For +.Nm atq , +shows completed but not yet deleted jobs in the queue. Otherwise +shows the time the job will be executed. +.It Fl c +Prints the jobs listed on the command line to standard output. +.El +.Pp +.Nm at allows some moderately complex .Ar time specifications. It accepts times of the form @@ -64,15 +120,15 @@ or to run a job at a specific time of day. (If that time is already past, the next day is assumed.) You may also specify -.Nm midnight , -.Nm noon , +.Sy midnight , +.Sy noon , or -.Nm teatime +.Sy teatime (4pm) and you can have a time-of-day suffixed with -.Nm AM +.Dq AM or -.Nm PM +.Dq PM for running in the morning or the evening. You can also say what day the job will be run, by giving a date in the form @@ -84,38 +140,40 @@ or giving a date of the form .Ar MM/DD/YY or .Ar DD.MM.YY . -The year may be given as two digits or four digits. +.Pp +The year may be given as two or four digits. If the year is given as two digits, it is taken to occur as soon as possible in the future, which may be in the next century -- unless it's last year, in which case it's considered to be a typo. +.Pp The specification of a date must follow the specification of the time of day. You can also give times like -.Op Nm now -.Nm + Ar count \%time-units , +.Op Sq now +.Sy + Ar count \%time-units , where the time-units can be -.Nm minutes , -.Nm hours , -.Nm days , +.Sy minutes , +.Sy hours , +.Sy days , or -.Nm weeks +.Sy weeks and you can tell -.Nm +.Nm at to run the job today by suffixing the time with -.Nm today +.Sy today and to run the job tomorrow by suffixing the time with -.Nm tomorrow . +.Sy tomorrow . .Pp For example, to run a job at 4pm three days from now, you would do -.Nm at 4pm + 3 days . +.Ic at 4pm + 3 days . To run a job at 10:00am on July 31, you would do -.Nm at 10am Jul 31 . +.Ic at 10am Jul 31 . To run a job at 1am tomorrow, you would do -.Nm at 1am tomorrow . +.Ic at 1am tomorrow . .Pp For both -.Nm +.Nm at and .Nm batch , commands are read from standard input or the file specified @@ -127,12 +185,12 @@ The working directory, the environment (except for the variables .Ev TERMCAP , .Ev DISPLAY , and -.Ev _ ) +.Ev _ ) , and the .Ar umask are retained from the time of invocation. An -.Nm +.Nm at or .Nm batch command invoked from a @@ -142,12 +200,12 @@ The user will be mailed standard error and standard output from his commands, if any. Mail will be sent using the command .Xr sendmail 8 . If -.Nm +.Nm at is executed from a .Xr su 1 shell, the owner of the login shell will receive the mail. .Pp -The superuser may use these commands in any case. +The super-user may use these commands in any case. For other users, permission to use at is determined by the files .Pa /var/at/at.allow and @@ -157,7 +215,6 @@ If the file .Pa /var/at/at.allow exists, only usernames mentioned in it are allowed to use .Nm at . -.Pp If .Pa /var/at/at.allow does not exist, @@ -165,66 +222,14 @@ does not exist, is checked. Every username not mentioned in it is then allowed to use .Nm at . -.Pp -If neither exists, only the superuser is allowed use of +If neither exists, only the super-user is allowed use of .Nm at . .Pp An empty .Pa /var/at/at.deny means that every user is allowed use these commands. This is the default configuration. -.Sh OPTIONS -.Bl -tag -width indent -.It Fl V -Prints the version number to standard error. -.It Fl q Ar queue -Uses the specified queue. -A queue designation consists of a single letter. Valid queue designations -range from -.Nm a -to -.Nm z -and -.Nm A -to -.Nm Z . -The -.Nm c -queue is the default for -.Nm -and the -.Nm E -queue for -.Nm batch . -Queues with higher letters run with increased niceness. -If a job is submitted to a queue designated with an uppercase letter, it -is treated as if it had been submitted to batch at that time. -If -.Nm atq -is given a specific queue, it will only show jobs pending in that queue. -.It Fl m -Send mail to the user when the job has completed, even if there was no -output. -.It Fl f Ar file -Reads the job from -.Ar file -rather than standard input. -.It Fl l -Is an alias for -.Nm atq . -.It Fl d -Is an alias for -.Nm atrm . -.It Fl b -Is an alias for -.Nm batch . -.It Fl v -For -.Nm atq , -shows completed but not yet deleted jobs in the queue. Otherwise -shows the time the job will be executed. -.It Fl c -Prints the jobs listed on the command line to standard output. +.Pp .Sh FILES .Bl -tag -width /var/at/.lockfile -compact .It Pa /var/at/jobs @@ -246,19 +251,18 @@ job-creation lock file .Xr atrun 8 , .Xr cron 8 , .Xr sendmail 8 -.El .Sh BUGS If the file .Pa /var/run/utmp is not available or corrupted, or if the user is not logged on at the time -.Nm +.Nm at is invoked, the mail is sent to the user ID found in the environment variable .Ev LOGNAME . If that is undefined or empty, the current user ID is assumed. .Pp -.Nm +.Nm at and .Nm batch as presently implemented are not suitable when users are competing for @@ -273,6 +277,6 @@ always prints the year as two digits. Since only permits submission of jobs in the future, it is somewhat clear which century the job will run in. .Sh AUTHORS -.Nm +.Nm at was mostly written by Thomas Koenig . The time parsing routines are by David Parsons . diff --git a/usr.bin/basename/basename.1 b/usr.bin/basename/basename.1 index 995fb1e1e9e..501286f480b 100644 --- a/usr.bin/basename/basename.1 +++ b/usr.bin/basename/basename.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: basename.1,v 1.10 1999/11/20 07:45:56 dugsong Exp $ +.\" $OpenBSD: basename.1,v 1.11 2000/03/04 21:12:01 aaron Exp $ .\" $NetBSD: basename.1,v 1.9 1995/03/25 18:17:45 glass Exp $ .\" .\" Copyright (c) 1990, 1993, 1994 @@ -58,6 +58,11 @@ and a if given. The resulting filename is written to the standard output. A non-existent suffix is ignored. +.Pp +The +.Nm +utility +exits 0 on success or >0 if an error occurred. .Sh EXAMPLES The following line sets the shell variable .Ev FOO @@ -65,11 +70,6 @@ to .Pa tail : .Pp .Dl FOO=`basename /usr/bin/tail` -.Sh DIAGNOSTICS -The -.Nm -utility -exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr csh 1 , .Xr dirname 1 , diff --git a/usr.bin/basename/dirname.1 b/usr.bin/basename/dirname.1 index c6f8ef9f7af..cb60d296fae 100644 --- a/usr.bin/basename/dirname.1 +++ b/usr.bin/basename/dirname.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dirname.1,v 1.6 1999/11/20 07:45:56 dugsong Exp $ +.\" $OpenBSD: dirname.1,v 1.7 2000/03/04 21:12:01 aaron Exp $ .\" .\" Copyright (c) 1990, 1993, 1994 .\" The Regents of the University of California. All rights reserved. @@ -53,6 +53,11 @@ with the last slash character to the end of .Ar string , and writes the result to the standard output. +.Pp +The +.Nm +utility +exits 0 on success or >0 if an error occurred. .Sh EXAMPLES The following line sets the shell variable .Ev FOO @@ -60,11 +65,6 @@ to .Pa /usr/bin : .Pp .Dl FOO=`dirname /usr/bin/tail` -.Sh DIAGNOSTICS -The -.Nm -utility -exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr basename 1 , .Xr csh 1 , diff --git a/usr.bin/biff/biff.1 b/usr.bin/biff/biff.1 index 35e102beddc..01aaae73300 100644 --- a/usr.bin/biff/biff.1 +++ b/usr.bin/biff/biff.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: biff.1,v 1.8 2000/02/29 04:52:36 aaron Exp $ +.\" $OpenBSD: biff.1,v 1.9 2000/03/04 21:12:00 aaron Exp $ .\" $NetBSD: biff.1,v 1.3 1995/03/26 02:34:21 glass Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -49,7 +49,6 @@ informs the system whether you want to be notified when mail arrives during the current terminal session. .Pp The options are as follows: -.Nm biff : .Bl -tag -width 4n .It Cm n Disables notification. diff --git a/usr.bin/cal/cal.1 b/usr.bin/cal/cal.1 index 627fc52f89c..02d5db5a7b1 100644 --- a/usr.bin/cal/cal.1 +++ b/usr.bin/cal/cal.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cal.1,v 1.8 1999/07/04 11:53:51 aaron Exp $ +.\" $OpenBSD: cal.1,v 1.9 2000/03/04 21:12:00 aaron Exp $ .\" $NetBSD: cal.1,v 1.6 1995/09/02 05:34:20 jtc Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 @@ -55,10 +55,11 @@ displays a simple calendar. If arguments are not specified, the current month is displayed. +.Pp The options are as follows: .Bl -tag -width Ds .It Fl j -Display julian dates (days one-based, numbered from January 1). +Display Julian dates (days one-based, numbered from January 1). .It Fl y Display a calendar for the current year. .El @@ -73,7 +74,7 @@ Two parameters denote the month (1 - 12) and year. If no parameters are specified, the current month's calendar is displayed. .Pp -A year starts on Jan 1. +A year starts on January 1st. .Pp The Gregorian Reformation is assumed to have occurred in 1752 after the 2nd of September. @@ -81,6 +82,8 @@ By this time, most countries had recognized the reformation (although a few did not recognize it until the early 1900's.) Eleven days following that date were eliminated by the reformation, so the calendar for that month is a bit unusual. +.Sh SEE ALSO +.Xr calendar 1 .Sh STANDARDS The .Nm diff --git a/usr.bin/calendar/calendar.1 b/usr.bin/calendar/calendar.1 index 607681ac6dd..ac075ee0a09 100644 --- a/usr.bin/calendar/calendar.1 +++ b/usr.bin/calendar/calendar.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: calendar.1,v 1.11 1999/07/04 11:53:51 aaron Exp $ +.\" $OpenBSD: calendar.1,v 1.12 2000/03/04 21:12:01 aaron Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 .\" The Regents of the University of California. All rights reserved. @@ -57,7 +57,7 @@ and displays lines that begin with either today's date or tomorrow's. On Fridays, events on Friday through Monday are displayed. .Pp -The following options are available: +The options are as follows: .Bl -tag -width Ds .It Fl a Process the @@ -202,6 +202,7 @@ Russian calendar .El .Sh SEE ALSO .Xr at 1 , +.Xr cal 1 , .Xr cpp 1 , .Xr mail 1 , .Xr cron 8 @@ -210,7 +211,7 @@ The .Nm program previously selected lines which had the correct date anywhere in the line. -This is no longer true: the date is only recognized when it occurs +This is no longer true: the date is only recognized when it occurs at the beginning of a line. .Sh HISTORY A diff --git a/usr.bin/cap_mkdb/cap_mkdb.1 b/usr.bin/cap_mkdb/cap_mkdb.1 index f0a70aee203..dfc266d08c9 100644 --- a/usr.bin/cap_mkdb/cap_mkdb.1 +++ b/usr.bin/cap_mkdb/cap_mkdb.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cap_mkdb.1,v 1.10 1999/07/03 02:11:08 aaron Exp $ +.\" $OpenBSD: cap_mkdb.1,v 1.11 2000/03/04 21:12:01 aaron Exp $ .\" $NetBSD: cap_mkdb.1,v 1.4 1995/03/26 03:59:36 glass Exp $ .\" .\" Copyright (c) 1992, 1993 @@ -80,7 +80,7 @@ format. .It Fl v Print out the number of capability records in the database. .El -.Sh FORMAT +.Pp Each record is stored in the database using two different types of keys. .Pp The first type is a key which consists of the first capability of @@ -104,10 +104,22 @@ in a key/data pair of the second type. The data field of this key/data pair is used to look up a key/data pair of the first type which has the real data associated with the name. -.Sh RETURN VALUE +.Pp The .Nm utility exits 0 on success or >0 if an error occurred. +.Sh FILES +.Bl -tag -width /usr/share/misc/terminfo.db -compact +.It Pa /usr/share/misc/termcap +uncompiled terminal capabilities file +.It Pa /usr/share/misc/termcap.db +terminal capabilities database +.It Pa /usr/share/misc/terminfo.db +terminal information database +.It Pa /etc/termcap +symbolic link to +.Pa /usr/share/misc/termcap +.El .Sh SEE ALSO .Xr dbopen 3 , .Xr getcap 3 , -- 2.20.1