diff options
| author | Aaron Campbell <aaron@cvs.openbsd.org> | 2000-10-26 00:37:06 +0000 |
|---|---|---|
| committer | Aaron Campbell <aaron@cvs.openbsd.org> | 2000-10-26 00:37:06 +0000 |
| commit | 01d43ab29c5618b38c41c75e5b155afc5b05f1dd (patch) | |
| tree | b3543c61a16271eb382ee68f04b4bc10769e6240 /share | |
| parent | 79664bbfef78e407d77f500003f78b59577ca8b6 (diff) | |
Some share/man fleshing.
Diffstat (limited to 'share')
41 files changed, 661 insertions, 756 deletions
diff --git a/share/man/man1/cd.1 b/share/man/man1/cd.1 index 466c9e8b3e8..cbda50ff14c 100644 --- a/share/man/man1/cd.1 +++ b/share/man/man1/cd.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cd.1,v 1.8 2000/03/19 19:25:21 aaron Exp $ +.\" $OpenBSD: cd.1,v 1.9 2000/10/26 00:37:02 aaron Exp $ .\" $NetBSD: cd.1,v 1.2 1994/11/30 08:34:59 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -48,8 +48,7 @@ .Ar directory .Sh DESCRIPTION .Ar directory -is an absolute or relative pathname which becomes the new working -directory. +is an absolute or relative pathname which becomes the new working directory. The interpretation of a relative pathname by .Nm depends on the @@ -58,8 +57,7 @@ environment variable (see below). .Pp Note that .Nm -is implemented as a built-in command in all shells and not as a stand-alone -program. +is implemented as a built-in shell command and not as a stand-alone program. Because each process has its own working directory, a separate .Nm utility would have no effect (it would change the directory and exit, @@ -71,7 +69,7 @@ Please consult the manual for your specific shell. .Pp The .Nm -utility exits 0 on success or >0 if an error occurred. +command exits 0 on success or >0 if an error occurred. .Sh ENVIRONMENT The following environment variables affect the execution of .Nm cd : diff --git a/share/man/man1/intro.1 b/share/man/man1/intro.1 index 4f163b922f5..79895fe2889 100644 --- a/share/man/man1/intro.1 +++ b/share/man/man1/intro.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: intro.1,v 1.5 2000/03/19 19:25:21 aaron Exp $ +.\" $OpenBSD: intro.1,v 1.6 2000/10/26 00:37:03 aaron Exp $ .\" $NetBSD: intro.1,v 1.4 1994/11/30 08:35:00 jtc Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -41,8 +41,7 @@ .Nm intro .Nd introduction to general commands (tools and utilities) .Sh DESCRIPTION -Section one of the manual contains most of the commands -which comprise the +Section one of the manual contains most of the commands which comprise the .Bx user environment. Some of the commands included in section one are diff --git a/share/man/man1/wait.1 b/share/man/man1/wait.1 index 3553695c6ba..6e1f5e830d4 100644 --- a/share/man/man1/wait.1 +++ b/share/man/man1/wait.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: wait.1,v 1.5 2000/03/19 19:25:22 aaron Exp $ +.\" $OpenBSD: wait.1,v 1.6 2000/10/26 00:37:03 aaron Exp $ .\" $NetBSD: wait.1,v 1.2 1994/11/30 08:35:03 jtc Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -46,8 +46,7 @@ .Sh DESCRIPTION If invoked with no arguments, the .Nm -utility waits until -all existing child processes in the background +utility waits until all existing child processes in the background have terminated. .Pp Available operands: @@ -58,18 +57,15 @@ If a operand is specified, and it is the process ID of a background child process that still exists, the .Nm -utility -waits until that process has completed and consumes its -status information, without consuming the status information -of any other process. +utility waits until that process has completed and consumes its status +information, without consuming the status information of any other process. .Pp If a .Ar pid operand is specified that is not the process ID of a child background process that still exists, .Nm -exits -without waiting for any processes to complete. +exits without waiting for any processes to complete. .El .Pp The @@ -79,25 +75,20 @@ utility exits with one of the following values: .It \&0 The .Nm -utility was invoked with no operands and -all of the existing background child processes have -terminated, or the process specified by the +utility was invoked with no operands and all of the existing background +child processes have terminated, or the process specified by the .Ar pid operand exited normally with 0 as its exit status. .It \&>\&0 -The specified process did not exist and its exit -status information was not available, or the specified -process existed or its exit status information -was available, and it terminated with a non-zero -exit status. +The specified process did not exist and its exit status information was not +available, or its exit status information was available and it terminated with +a non-zero exit status. .El .Pp -If the specified process terminated abnormally due -to the receipt of a signal, the exit status -information of +If the specified process terminated abnormally due to the receipt of a signal, +the exit status information of .Nm -contains that termination status as -well. +contains that termination status as well. .Sh SEE ALSO .Xr wait 2 .Sh STANDARDS diff --git a/share/man/man3/assert.3 b/share/man/man3/assert.3 index 6ab5cc4a39a..de72ad0a7e6 100644 --- a/share/man/man3/assert.3 +++ b/share/man/man3/assert.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: assert.3,v 1.4 2000/03/19 19:25:23 aaron Exp $ +.\" $OpenBSD: assert.3,v 1.5 2000/10/26 00:37:03 aaron Exp $ .\" $NetBSD: assert.3,v 1.5 1994/11/30 15:24:30 jtc Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -48,10 +48,8 @@ The .Fn assert macro tests the given .Ar expression -and if it is false, -the calling process is terminated. -A -diagnostic message is written to +and if it is false, the calling process is terminated. +A diagnostic message is written to .Em stderr and the .Xr abort 3 @@ -59,16 +57,13 @@ function is called, effectively terminating the program. .Pp If .Ar expression -is true, -the +is true, the .Fn assert macro does nothing. .Pp The .Fn assert -macro -may be removed at compile time with -the +macro may be removed at compile time with the .Xr cc 1 option .Fl DNDEBUG . diff --git a/share/man/man3/bitstring.3 b/share/man/man3/bitstring.3 index 44d2d2703db..b07aa96c5a2 100644 --- a/share/man/man3/bitstring.3 +++ b/share/man/man3/bitstring.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: bitstring.3,v 1.7 2000/03/19 19:25:23 aaron Exp $ +.\" $OpenBSD: bitstring.3,v 1.8 2000/10/26 00:37:03 aaron Exp $ .\" $NetBSD: bitstring.3,v 1.4 1994/11/30 15:24:31 jtc Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 @@ -105,8 +105,7 @@ The .Fn bit_nclear and .Fn bit_nset -macros -clear or set the zero-based numbered bits from +macros clear or set the zero-based numbered bits from .Fa start to .Fa stop @@ -115,8 +114,7 @@ in the bit string .Pp The .Fn bit_test -macro -evaluates to non-zero if the zero-based numbered bit +macro evaluates to non-zero if the zero-based numbered bit .Fa bit of bit string .Fa name @@ -124,8 +122,7 @@ is set, and zero otherwise. .Pp The .Fn bit_ffs -macro -stores in the location referenced by +macro stores in the location referenced by .Fa value the zero-based number of the first bit set in the array of .Fa nbits diff --git a/share/man/man3/dlfcn.3 b/share/man/man3/dlfcn.3 index 4a9bda937d2..d17b4576375 100644 --- a/share/man/man3/dlfcn.3 +++ b/share/man/man3/dlfcn.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dlfcn.3,v 1.11 2000/05/25 21:49:01 deraadt Exp $ +.\" $OpenBSD: dlfcn.3,v 1.12 2000/10/26 00:37:03 aaron Exp $ .\" $NetBSD: dlfcn.3,v 1.3 1996/01/09 19:43:34 pk Exp $ .\" .\" Copyright (c) 1995 Paul Kranenburg @@ -33,7 +33,11 @@ .Dt DLFCN 3 .Os .Sh NAME -.Nm dlopen , dlclose , dlsym , dlctl , dlerror +.Nm dlopen , +.Nm dlclose , +.Nm dlsym , +.Nm dlctl , +.Nm dlerror .Nd dynamic link interface .Sh SYNOPSIS .Fd #include <dlfcn.h> @@ -78,11 +82,10 @@ for future compatibility. .Fn dlopen returns a handle to be used in calls to .Fn dlclose , -.Fn dlsym +.Fn dlsym , and .Fn dlctl . -If the named shared object has already -been loaded by a previous call to +If the named shared object has already been loaded by a previous call to .Fn dlopen .Pq and not yet unloaded by Fn dlclose , a handle referring to the resident copy is returned. diff --git a/share/man/man3/end.3 b/share/man/man3/end.3 index 2c56714e6b7..c76f4be67b5 100644 --- a/share/man/man3/end.3 +++ b/share/man/man3/end.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: end.3,v 1.6 1999/07/09 13:35:37 aaron Exp $ +.\" $OpenBSD: end.3,v 1.7 2000/10/26 00:37:03 aaron Exp $ .\" $NetBSD: end.3,v 1.5 1996/03/01 00:17:49 jtc Exp $ .\" .\" Copyright (c) 1986 @@ -38,7 +38,9 @@ .Dt END 3 .Os .Sh NAME -.Nm end , etext , edata +.Nm end , +.Nm etext , +.Nm edata .Nd end boundaries of image segments .Sh SYNOPSIS .Vt extern end; @@ -46,14 +48,12 @@ .Vt extern edata; .Sh DESCRIPTION The global variables -.Va end , etext +.Va end , +.Va etext , and .Va edata -correspond to -the next address following -the end of the text segment, -the end of initialized data segment and -the end of the data segment +correspond to the next address following the end of the text segment, +the end of initialized data segment, and the end of the data segment .Pq Tn BSS . .Sh SEE ALSO .Xr brk 2 , diff --git a/share/man/man3/intro.3 b/share/man/man3/intro.3 index 228ac32c1df..74fbdc130c8 100644 --- a/share/man/man3/intro.3 +++ b/share/man/man3/intro.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: intro.3,v 1.9 2000/03/19 19:25:24 aaron Exp $ +.\" $OpenBSD: intro.3,v 1.10 2000/10/26 00:37:03 aaron Exp $ .\" $NetBSD: intro.3,v 1.5 1995/05/10 22:46:24 jtc Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -41,9 +41,8 @@ .Nm intro .Nd introduction to the C libraries .Sh DESCRIPTION -This section provides an overview of the C -library functions, their error returns and other -common definitions and concepts. +This section provides an overview of the C library functions, their error +returns, and other common definitions and concepts. Most of these functions are available from the C library, .Em libc . Other libraries, such as the math library, @@ -58,8 +57,7 @@ The various libraries (followed by the loader flag): Standard C library functions. When using the C compiler .Xr cc 1 , -it is not necessary -to supply the loader flag +it is not necessary to supply the loader flag .Fl l Ns Ar c for these functions. There are several @@ -72,25 +70,27 @@ database routines, bit operators, string operators, character tests and character operators, -des encryption routines, -storage allocation, time functions, signal handling and more. +DES encryption routines, +storage allocation, +time functions, +signal handling, +and more. .It libc_r Pq Fl l Ns Ar c_r Reentrant C library. Contains POSIX 1003.1c .Xr pthreads 3 -API and thread scheduler, as well as all of the functions -found in +API and thread scheduler, as well as all of the functions found in .Xr libc . .It libcurses Pq Fl l Ns Ar curses -Terminal independent screen management routines -for two dimensional non-bitmap display terminals. +Terminal independent screen management routines for two-dimensional +non-bitmap display terminals. See .Xr curses 3 . .It libcompat Pq Fl l Ns Ar compat Functions which are obsolete but are available for compatibility with .Bx 4.3 . -In particular, -a number of system call interfaces provided in previous releases of +In particular, a number of system call interfaces provided in previous +releases of .Bx have been included for source code compatibility. Use of these routines should, for the most part, be avoided. @@ -109,7 +109,8 @@ The math library, See .Xr math 3 . .It libtermcap Pq Fl l Ns Ar termcap -The terminal independent operation library package. (See +The terminal independent operation library package. +(See .Xr termcap 3 . ) .El .Sh FILES @@ -126,14 +127,14 @@ reentrant C library (see 4.3 compatibility library .It Pa /usr/lib/libcrypto.a .Xr ssl 8 -support library. +support library .It Pa /usr/lib/libcurses++.a C++ .Xr curses 3 -library. +library .It Pa /usr/lib/libcurses.a .Xr curses 3 -library. +library .It Pa /usr/lib/libdes.a .It Pa /usr/lib/libedit.a .It Pa /usr/lib/libfl.a @@ -143,17 +144,17 @@ library. .It Pa /usr/lib/libiberty.a .It Pa /usr/lib/libkadm.a .Xr kerberos 1 -support library. +support library .It Pa /usr/lib/libkafs.a .Xr afsd 8 -support library. +support library .It Pa /usr/lib/libkdb.a .It Pa /usr/lib/libkeycap.a .It Pa /usr/lib/libkeynote.a .It Pa /usr/lib/libkrb.a .It Pa /usr/lib/libkvm.a .Xr kvm 3 -kernel virtual memory access library. +kernel virtual memory access library .It Pa /usr/lib/libl.a .It Pa /usr/lib/libm.a .Xr math 3 @@ -194,21 +195,20 @@ The .Xr resolver 3 routines are included in .Em libc . -For legacy applications, -this library contains only those functions. +For legacy applications, this library contains only those functions. .It Pa /usr/lib/librpcsvc.a -A library generated by -.Xr rpcgen 1 +generated by +.Xr rpcgen 1 , containing stub functions for many common .Xr rpc 3 -protocols. +protocols .It Pa /usr/lib/libskey.a -A support library for the +support library for the .Xr skey 1 -authentication toolkit. +authentication toolkit .It Pa /usr/lib/libssl.a .Xr ssl 8 -support library. +support library .It Pa /usr/lib/libstdc++.a .It Pa /usr/lib/libtelnet.a .It Pa /usr/lib/libtermcap.a @@ -222,8 +222,8 @@ support library. .It Pa /usr/lib/libi386.a .El .Pp -Must talk about shared libraries, _p profiled libraries and how to tell the -C compiler to use them, and any other issues. +.\" Must talk about shared libraries, _p profiled libraries, and how to tell the +.\" C compiler to use them, and any other issues. .Sh SEE ALSO .Xr cc 1 , .Xr ld 1 , diff --git a/share/man/man3/queue.3 b/share/man/man3/queue.3 index 40f9450652d..5fba8ffb099 100644 --- a/share/man/man3/queue.3 +++ b/share/man/man3/queue.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: queue.3,v 1.11 2000/04/15 01:42:29 deraadt Exp $ +.\" $OpenBSD: queue.3,v 1.12 2000/10/26 00:37:03 aaron Exp $ .\" $NetBSD: queue.3,v 1.4 1995/07/03 00:25:36 mycroft Exp $ .\" .\" Copyright (c) 1993 The Regents of the University of California. @@ -112,7 +112,7 @@ .Nd "implementations of singly-linked lists, doubly-linked lists, simple queues, tail queues, and circular queues" .Sh SYNOPSIS .Fd #include <sys/queue.h> -.sp +.Pp .Fn SLIST_ENTRY "TYPE" .Fn SLIST_HEAD "HEADNAME" "TYPE" .Fn SLIST_HEAD_INITIALIZER "SLIST_HEAD head" @@ -133,7 +133,7 @@ .Fn SLIST_INSERT_HEAD "SLIST_HEAD *head" "struct TYPE *elm" "SLIST_ENTRY NAME" .Ft void .Fn SLIST_REMOVE_HEAD "SLIST_HEAD *head" "SLIST_ENTRY NAME" -.sp +.Pp .Fn LIST_ENTRY "TYPE" .Fn LIST_HEAD "HEADNAME" "TYPE" .Fn LIST_HEAD_INITIALIZER "LIST_HEAD head" @@ -156,7 +156,7 @@ .Fn LIST_INSERT_HEAD "LIST_HEAD *head" "struct TYPE *elm" "LIST_ENTRY NAME" .Ft void .Fn LIST_REMOVE "struct TYPE *elm" "LIST_ENTRY NAME" -.sp +.Pp .Fn SIMPLEQ_ENTRY "TYPE" .Fn SIMPLEQ_HEAD "HEADNAME" "TYPE" .Fn SIMPLEQ_HEAD_INITIALIZER "SIMPLEQ_HEAD head" @@ -176,7 +176,7 @@ .Fn SIMPLEQ_INSERT_AFTER "struct TYPE *listelm" "struct TYPE *elm" "SIMPLEQ_ENTRY NAME" .Ft void .Fn SIMPLEQ_REMOVE_HEAD "SIMPLEQ_HEAD *head" "struct TYPE *elm" "SIMPLEQ_ENTRY NAME" -.sp +.Pp .Fn TAILQ_ENTRY "TYPE" .Fn TAILQ_HEAD "HEADNAME" "TYPE" .Fn TAILQ_HEAD_INITIALIZER "TAILQ_HEAD head" @@ -205,7 +205,7 @@ .Fn TAILQ_INSERT_TAIL "TAILQ_HEAD *head" "struct TYPE *elm" "TAILQ_ENTRY NAME" .Ft void .Fn TAILQ_REMOVE "TAILQ_HEAD *head" "struct TYPE *elm" "TAILQ_ENTRY NAME" -.sp +.Pp .Fn CIRCLEQ_ENTRY "TYPE" .Fn CIRCLEQ_HEAD "HEADNAME" "TYPE" .Fn CIRCLEQ_HEAD_INITIALIZER "CIRCLEQ_HEAD head" @@ -237,8 +237,7 @@ .Fn CIRCLEQ_REMOVE "CIRCLEQ_HEAD *head" "struct TYPE *elm" "CIRCLEQ_ENTRY NAME" .Sh DESCRIPTION These macros define and operate on five types of data structures: -singly-linked lists, simple queues, lists, tail queues, -and circular queues. +singly-linked lists, simple queues, lists, tail queues, and circular queues. All five structures support the following functionality: .Pp .Bl -enum -compact -offset indent @@ -255,8 +254,7 @@ Forward traversal through the list. Singly-linked lists are the simplest of the five data structures and support only the above functionality. Singly-linked lists are ideal for applications with large datasets -and few or no removals, -or for implementing a LIFO queue. +and few or no removals, or for implementing a LIFO queue. .Pp Simple queues add the following functionality: .Pp @@ -343,14 +341,12 @@ Each head entry requires two pointers rather than one. .It The termination condition for traversal is more complex. .It -Code size is about 40% greater and operations run about 45% slower -than lists. +Code size is about 40% greater and operations run about 45% slower than lists. .El .Pp In the macro definitions, .Fa TYPE -is the name tag of a user defined structure, -that must contain a field of type +is the name tag of a user defined structure that must contain a field of type .Li SLIST_ENTRY , .Li LIST_ENTRY , .Li SIMPLEQ_ENTRY , @@ -369,14 +365,12 @@ using the macros .Fn TAILQ_HEAD , or .Fn CIRCLEQ_HEAD . -See the examples below for further explanation of how these -macros are used. +See the examples below for further explanation of how these macros are used. .Sh SINGLY_LINKED LISTS A singly-linked list is headed by a structure defined by the .Fn SLIST_HEAD macro. -This structure contains a single pointer to the first element -on the list. +This structure contains a single pointer to the first element on the list. The elements are singly linked for minimum space and pointer manipulation overhead at the expense of O(n) removal for arbitrary elements. New elements can be added to the list after an existing element or @@ -387,7 +381,7 @@ structure is declared as follows: .Bd -literal -offset indent SLIST_HEAD(HEADNAME, TYPE) head; .Ed -.sp +.Pp where .Fa HEADNAME is the name of the structure to be defined, and struct @@ -397,13 +391,13 @@ A pointer to the head of the list can later be declared as: .Bd -literal -offset indent struct HEADNAME *headp; .Ed -.sp +.Pp (The names .Li head and .Li headp are user selectable.) -.sp +.Pp The .Fa HEADNAME facility is often not used, leading to the following bizarre code: @@ -413,8 +407,7 @@ SLIST_HEAD(, TYPE) head, *headp; .Pp The .Fn SLIST_ENTRY -macro declares a structure that connects the elements in -the list. +macro declares a structure that connects the elements in the list. .Pp The .Fn SLIST_INIT @@ -469,8 +462,7 @@ macro should be used to check whether a simple list is empty. A list is headed by a structure defined by the .Fn LIST_HEAD macro. -This structure contains a single pointer to the first element -on the list. +This structure contains a single pointer to the first element on the list. The elements are doubly linked so that an arbitrary element can be removed without traversing the list. New elements can be added to the list after an existing element, @@ -481,7 +473,7 @@ structure is declared as follows: .Bd -literal -offset indent LIST_HEAD(HEADNAME, TYPE) head; .Ed -.sp +.Pp where .Fa HEADNAME is the name of the structure to be defined, and struct @@ -491,13 +483,13 @@ A pointer to the head of the list can later be declared as: .Bd -literal -offset indent struct HEADNAME *headp; .Ed -.sp +.Pp (The names .Li head and .Li headp are user selectable.) -.sp +.Pp The .Fa HEADNAME facility is often not used, leading to the following bizarre code: @@ -507,8 +499,7 @@ LIST_HEAD(, TYPE) head, *headp; .Pp The .Fn LIST_ENTRY -macro declares a structure that connects the elements in -the list. +macro declares a structure that connects the elements in the list. .Pp The .Fn LIST_INIT @@ -598,9 +589,8 @@ while (head.lh_first != NULL) /* Delete. */ A simple queue is headed by a structure defined by the .Fn SIMPLEQ_HEAD macro. -This structure contains a pair of pointers, -one to the first element in the simple queue and the other to -the last element in the simple queue. +This structure contains a pair of pointers, one to the first element in the +simple queue and the other to the last element in the simple queue. The elements are singly linked. New elements can be added to the queue after an existing element, at the head of the queue or at the tail of the queue. @@ -610,7 +600,7 @@ structure is declared as follows: .Bd -literal -offset indent SIMPLEQ_HEAD(HEADNAME, TYPE) head; .Ed -.sp +.Pp where .Fa HEADNAME is the name of the structure to be defined, and struct @@ -620,7 +610,7 @@ A pointer to the head of the queue can later be declared as: .Bd -literal -offset indent struct HEADNAME *headp; .Ed -.sp +.Pp (The names .Li head and @@ -725,7 +715,7 @@ structure is declared as follows: .Bd -literal -offset indent TAILQ_HEAD(HEADNAME, TYPE) head; .Ed -.sp +.Pp where .Fa HEADNAME is the name of the structure to be defined, and struct @@ -735,7 +725,7 @@ A pointer to the head of the tail queue can later be declared as: .Bd -literal -offset indent struct HEADNAME *headp; .Ed -.sp +.Pp (The names .Li head and @@ -859,7 +849,7 @@ structure is declared as follows: .Bd -literal -offset indent CIRCLEQ_HEAD(HEADNAME, TYPE) head; .Ed -.sp +.Pp where .Fa HEADNAME is the name of the structure to be defined, and struct @@ -869,7 +859,7 @@ A pointer to the head of the circular queue can later be declared as: .Bd -literal -offset indent struct HEADNAME *headp; .Ed -.sp +.Pp (The names .Li head and @@ -878,8 +868,7 @@ are user selectable.) .Pp The .Fn CIRCLEQ_ENTRY -macro declares a structure that connects the elements in -the circular queue. +macro declares a structure that connects the elements in the circular queue. .Pp The .Fn CIRCLEQ_INIT diff --git a/share/man/man3/stdarg.3 b/share/man/man3/stdarg.3 index 45120f09e82..01c12b8be15 100644 --- a/share/man/man3/stdarg.3 +++ b/share/man/man3/stdarg.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: stdarg.3,v 1.6 2000/03/21 14:08:35 aaron Exp $ +.\" $OpenBSD: stdarg.3,v 1.7 2000/10/26 00:37:03 aaron Exp $ .\" $NetBSD: stdarg.3,v 1.3 1994/11/30 15:24:37 jtc Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 @@ -42,7 +42,9 @@ .Dt STDARG 3 .Os .Sh NAME -.Nm va_start , va_arg , va_end +.Nm va_start , +.Nm va_arg , +.Nm va_end .Nd variable argument lists .Sh SYNOPSIS .Fd #include <stdarg.h> diff --git a/share/man/man3/sysexits.3 b/share/man/man3/sysexits.3 index 0d20193ef6c..c1c01732159 100644 --- a/share/man/man3/sysexits.3 +++ b/share/man/man3/sysexits.3 @@ -23,7 +23,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: sysexits.3,v 1.1 2000/04/26 16:01:09 millert Exp $ +.\" $OpenBSD: sysexits.3,v 1.2 2000/10/26 00:37:03 aaron Exp $ .\" $FreeBSD: src/share/man/man3/sysexits.3,v 1.4.2.1 1999/08/29 16:45:41 peter Exp $ .\" .\" " @@ -40,77 +40,80 @@ According to .Xr style 9 , it is not a good practice to call .Xr exit 3 -with arbitrary values to indicate a failure condition when ending -a program. Instead, the pre-defined exit codes from -.Nm sysexits +with arbitrary values to indicate a failure condition when ending a program. +Instead, the pre-defined exit codes from +.Nm should be used, so the caller of the process can get a rough estimation about the failure class without looking up the source code. .Pp The successful exit is always indicated by a status of 0, or -.Sy EX_OK . +.Dv EX_OK . Error numbers begin at -.Sy EX__BASE +.Dv EX__BASE to reduce the possibility of clashing with other exit statuses that -random programs may already return. The meaning of the codes is -approximately as follows: +random programs may already return. +The meaning of the code is approximately as follows: .Bl -tag -width "EX_UNAVAILABLEXX(XX)" -.It Sy EX_USAGE Pq 64 +.It Dv EX_USAGE Pq 64 The command was used incorrectly, e.g., with the wrong number of arguments, a bad flag, a bad syntax in a parameter, or whatever. -.It Sy EX_DATAERR Pq 65 -The input data was incorrect in some way. This should only be used -for user's data and not system files. -.It Sy EX_NOINPUT Pq 66 +.It Dv EX_DATAERR Pq 65 +The input data was incorrect in some way. +This should only be used for user's data and not system files. +.It Dv EX_NOINPUT Pq 66 An input file (not a system file) did not exist or was not readable. This could also include errors like .Dq \&No message to a mailer (if it cared to catch it). -.It Sy EX_NOUSER Pq 67 -The user specified did not exist. This might be used for mail -addresses or remote logins. -.It Sy EX_NOHOST Pq 68 -The host specified did not exist. This is used in mail addresses or -network requests. -.It Sy EX_UNAVAILABLE Pq 69 -A service is unavailable. This can occur if a support program or file -does not exist. This can also be used as a catchall message when -something you wanted to do doesn't work, but you don't know why. -.It Sy EX_SOFTWARE Pq 70 -An internal software error has been detected. This should be limited -to non-operating system related errors as possible. -.It Sy EX_OSERR Pq 71 -An operating system error has been detected. This is intended to be -used for such things as +.It Dv EX_NOUSER Pq 67 +The user specified did not exist. +This might be used for mail addresses or remote logins. +.It Dv EX_NOHOST Pq 68 +The host specified did not exist. +This is used in mail addresses or network requests. +.It Dv EX_UNAVAILABLE Pq 69 +A service is unavailable. +This can occur if a support program or file does not exist. +This can also be used as a catch-all message when something you wanted +to do doesn't work, but you don't know why. +.It Dv EX_SOFTWARE Pq 70 +An internal software error has been detected. +This should be limited to non-operating system related errors if possible. +.It Dv EX_OSERR Pq 71 +An operating system error has been detected. +This is intended to be used for such things as .Dq cannot fork , -.Dq cannot create pipe , -or the like. It includes things like getuid returning a user that -does not exist in the passwd file. -.It Sy EX_OSFILE Pq 72 +or +.Dq cannot create pipe . +It includes things like +.Xr getuid 2 +returning a user that does not exist in the passwd file. +.It Dv EX_OSFILE Pq 72 Some system file (e.g., .Pa /etc/passwd , .Pa /var/run/utmp , etc.) does not exist, cannot be opened, or has some sort of error (e.g., syntax error). -.It Sy EX_CANTCREAT Pq 73 +.It Dv EX_CANTCREAT Pq 73 A (user specified) output file cannot be created. -.It Sy EX_IOERR Pq 74 +.It Dv EX_IOERR Pq 74 An error occurred while doing I/O on some file. -.It Sy EX_TEMPFAIL Pq 75 +.It Dv EX_TEMPFAIL Pq 75 Temporary failure, indicating something that is not really an error. In sendmail, this means that a mailer (e.g.) could not create a connection, and the request should be reattempted later. -.It Sy EX_PROTOCOL Pq 76 +.It Dv EX_PROTOCOL Pq 76 The remote system returned something that was .Dq not possible during a protocol exchange. -.It Sy EX_NOPERM Pq 77 -You did not have sufficient permission to perform the operation. This -is not intended for file system problems, which should use -.Sy EX_NOINPUT +.It Dv EX_NOPERM Pq 77 +You did not have sufficient permission to perform the operation. +This is not intended for file system problems, which should use +.Dv EX_NOINPUT or -.Sy EX_CANTCREAT , +.Dv EX_CANTCREAT , but rather for higher level permissions. -.It Sy EX_CONFIG Pq 78 +.It Dv EX_CONFIG Pq 78 Something was found in an unconfigured or misconfigured state. .El .Pp @@ -129,6 +132,6 @@ This man page has been written by .ie t J\(:org Wunsch .el Joerg Wunsch after the comments in -.Pa <sysexits.h> . +.Aq Pa sysexits.h . .Sh BUGS The choice of an appropriate exit value is often ambiguous. diff --git a/share/man/man5/a.out.5 b/share/man/man5/a.out.5 index fcf7de3b480..6913a8edca7 100644 --- a/share/man/man5/a.out.5 +++ b/share/man/man5/a.out.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: a.out.5,v 1.7 2000/03/19 19:25:26 aaron Exp $ +.\" $OpenBSD: a.out.5,v 1.8 2000/10/26 00:37:03 aaron Exp $ .\" $NetBSD: a.out.5,v 1.8 1994/11/30 19:31:09 jtc Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -49,8 +49,7 @@ The include file .Aq Pa a.out.h declares three structures and several macros. -The structures describe the format of -executable machine code files +The structures describe the format of executable machine code files .Pq Dq binaries on the system. .Pp @@ -58,9 +57,8 @@ A binary file consists of up to 7 sections. In order, these sections are: .Bl -tag -width "text relocations" .It exec header -Contains parameters used by the kernel -to load a binary file into memory and execute it, -and by the link editor +Contains parameters used by the kernel to load a binary file into memory +and execute it, and by the link editor .Xr ld 1 to combine a binary file with other binary files. This section is the only mandatory one. @@ -107,7 +105,8 @@ This field is stored in network byte-order so that binaries for machines with alternate byte orders can be distinguished. It has a number of sub-components accessed by the macros .Fn N_GETFLAG , -.Fn N_GETMID , and +.Fn N_GETMID , +and .Fn N_GETMAGIC , and set by the macro .Fn N_SETMAGIC . @@ -139,7 +138,7 @@ process address space by the run-time link editor. .Pp The macro .Fn N_GETMID -returns the machine-id. +returns the machine ID. This indicates which machine(s) the binary is intended to run on. .Pp .Fn N_GETMAGIC @@ -148,16 +147,14 @@ and distinguishes different loading conventions. The field must contain one of the following values: .Bl -tag -width ZMAGIC .It Dv OMAGIC -The text and data segments immediately follow the header -and are contiguous. +The text and data segments immediately follow the header and are contiguous. The kernel loads both text and data segments into writable memory. .It Dv NMAGIC As with .Dv OMAGIC , text and data segments immediately follow the header and are contiguous. -However, the kernel loads the text into read-only memory -and loads the data into writable memory at the next -page boundary after the text. +However, the kernel loads the text into read-only memory and loads the data +into writable memory at the next page boundary after the text. .It Dv ZMAGIC The kernel loads individual pages on demand from the binary. The header, text segment and data segment are all @@ -171,7 +168,7 @@ Contains the size of the text segment in bytes. Contains the size of the data segment in bytes. .It Fa a_bss Contains the number of bytes in the -.Dq bss segment +.Dq BSS segment and is used by the kernel to set the initial break .Pq Xr brk 2 after the data segment. @@ -208,8 +205,7 @@ The byte offset of the beginning of the symbol table. The byte offset of the beginning of the string table. .El .Pp -Relocation records have a standard format which -is described by the +Relocation records have a standard format which is described by the .Fa relocation_info structure: .Bd -literal -offset indent @@ -237,8 +233,7 @@ and data relocation offsets from the start of the data segment. The link editor adds the value that is already stored at this offset into the new value that it computes using this relocation record. .It Fa r_symbolnum -Contains the ordinal number of a symbol structure -in the symbol table (it is +Contains the ordinal number of a symbol structure in the symbol table (it is .Em not a byte offset). After the link editor resolves the absolute address for this symbol, @@ -247,8 +242,7 @@ it adds that address to the pointer that is undergoing relocation. .Fa r_extern bit is clear, the situation is different; see below.) .It Fa r_pcrel -If this is set, -the link editor assumes that it is updating a pointer +If this is set, the link editor assumes that it is updating a pointer that is part of a machine code instruction using pc-relative addressing. The address of the relocated pointer is implicitly added to its value when the running program uses it. @@ -322,17 +316,14 @@ struct nlist { The fields are used as follows: .Bl -tag -width n_un.n_strx .It Fa n_un.n_strx -Contains a byte offset into the string table -for the name of this symbol. +Contains a byte offset into the string table for the name of this symbol. When a program accesses a symbol table with the .Xr nlist 3 -function, -this field is replaced with the +function, this field is replaced with the .Fa n_un.n_name field, which is a pointer to the string in memory. .It Fa n_type -Used by the link editor to determine -how to update the symbol's value. +Used by the link editor to determine how to update the symbol's value. The .Fa n_type field is broken down into three sub-fields using bitmasks. @@ -353,8 +344,7 @@ As a special case, if the .Fa n_value field is non-zero and no binary file in the link-edit defines this symbol, the link editor will resolve this symbol to an address -in the bss segment, -reserving an amount of bytes equal to +in the BSS segment, reserving an amount of bytes equal to .Fa n_value . If this symbol is undefined in more than one binary file and the binary files do not agree on the size, @@ -375,7 +365,7 @@ addresses; to recover the file offsets, it is necessary to identify the loaded address of the beginning of the corresponding section and subtract it, then add the offset of the section. .It Dv N_BSS -A bss symbol; like text or data symbols but +A BSS symbol; like text or data symbols but has no corresponding offset in the binary file. .It Dv N_FN A filename symbol. @@ -424,7 +414,7 @@ Reserved for use by debuggers; passed untouched by the link editor. Different debuggers use this field for different purposes. .It Fa n_value Contains the value of the symbol. -For text, data and bss symbols, this is an address; +For text, data and BSS symbols, this is an address; for other symbols (such as debugger symbols), the value may be arbitrary. .El @@ -452,7 +442,7 @@ include file appeared in .At v7 . .Sh BUGS Nobody seems to agree on what -.Em bss +.Em BSS stands for. .Pp New binary file formats may be supported in the future, diff --git a/share/man/man5/acct.5 b/share/man/man5/acct.5 index 35d93e43ea3..58412eda8c8 100644 --- a/share/man/man5/acct.5 +++ b/share/man/man5/acct.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: acct.5,v 1.7 2000/04/15 11:45:52 aaron Exp $ +.\" $OpenBSD: acct.5,v 1.8 2000/10/26 00:37:04 aaron Exp $ .\" $NetBSD: acct.5,v 1.4 1995/10/22 01:40:10 ghudson Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -99,7 +99,7 @@ and its status is saved by setting one of more of the following flags in .Dv AFORK , .Dv ASU , .Dv ACOMPAT , -.Dv ACORE +.Dv ACORE , and .Dv ASIG . .Sh SEE ALSO diff --git a/share/man/man5/bsd.port.mk.5 b/share/man/man5/bsd.port.mk.5 index 56a10de1325..3564be391aa 100644 --- a/share/man/man5/bsd.port.mk.5 +++ b/share/man/man5/bsd.port.mk.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: bsd.port.mk.5,v 1.16 2000/09/23 12:38:34 espie Exp $ +.\" $OpenBSD: bsd.port.mk.5,v 1.17 2000/10/26 00:37:04 aaron Exp $ .\" .\" Copyright (c) 2000 Marc Espie .\" @@ -34,24 +34,25 @@ .Fd #include <bsd.port.mk> .Sh DESCRIPTION .Nm -holds all the standard routines used by the ports tree. Some variables -and targets are for its internal use only. The rest is documented here. +holds all the standard routines used by the ports tree. +Some variables and targets are for its internal use only. +The rest is documented here. .Pp -Other BSD, and older versions of -.Nm -included other targets and variables. Conversion methods are outlined here. +Other BSD variants, as well as older versions of +.Nm bsd.port.mk , +include other targets and variables. +Conversion methods are outlined here. .Pp -This is an incomplete draft, some variables and targets are not yet -documented. -.\" -.\" -.\" +This is an incomplete draft; some variables and targets are not yet documented. .Sh TARGETS .Bl -tag -width do-configure .It Ar build , Ar all -Default target. Build the port. Essentially invoke -.Bd -literal -offset indent - env -i ${MAKE_ENV} ${MAKE_PROGRAM} ${MAKE_FLAGS} -f ${MAKE_FILE} ${ALL_TARGET} +Default target. +Build the port. +Essentially invoke +.Bd -literal +env -i ${MAKE_ENV} ${MAKE_PROGRAM} ${MAKE_FLAGS} \\\&\ + -f ${MAKE_FILE} ${ALL_TARGET} .Ed .It Ar checkpatch Debugging version of the @@ -59,10 +60,11 @@ Debugging version of the target that simulates invoking .Xr patch 1 . .It Ar configure -Configure the port. Might be a no operation. Unless overridden, -configure creates the ${WRKBUILD} directory (see SEPARATE_BUILD), runs -${SCRIPTDIR}/configure if it exists, and runs whatever configuration -methods are recorded in +Configure the port. +Might be a no operation. +Unless overridden, configure creates the ${WRKBUILD} +directory (see SEPARATE_BUILD), runs ${SCRIPTDIR}/configure if it exists, +and runs whatever configuration methods are recorded in .Ev CONFIGURE_STYLE . .It Ar distpatch Apply distribution patches only. @@ -78,10 +80,11 @@ needs to invoke directly for historical reasons. .It Ar extract Extract the distfiles (but see -.Ev EXTRACT_ONLY ). +.Ev EXTRACT_ONLY ) . .It Ar fake Do a fake port installation, that is, simulate the port installation under -${WRKINST}. Described in a separate section below. +${WRKINST}. +Described in a separate section below. .It Ar fetch Fetch the distfiles and patchfiles. .It Ar patch @@ -89,31 +92,29 @@ Apply distribution and .Ox specific patches. .It Ar show -Invoked with VARNAME=name, show the contents of VARNAME. Mostly used from -recursive makes, or to know the contents of another port's variables -without guessing wrong. +Invoked with VARNAME=name, show the contents of VARNAME. +Mostly used from recursive makes, or to know the contents of another +port's variables without guessing wrong. .El -.\" -.\" -.\" .Sh VARIABLES .Bl -tag -width MASTER_SITES .It Ev ALL_TARGET -Target used to build software. Default is +Target used to build software. +Default is .Sq all . Can be set to empty, to yield a package's default target. .It Ev ARCH Current machine architecture (read-only). .It Ev AUTOCONF -Location of the autoconf binary if needed. Defaults to autoconf (though maybe -autoreconf might be more appropriate). +Location of the autoconf binary if needed. +Defaults to autoconf (though make autoreconf might be more appropriate). .It Ev AUTOCONF_DIR Where to invoke autoconf if ${CONFIGURE_STYLE} includes autoconf. Defaults to ${WRKSRC}. .\" AUTOCONF_DIR should probably be a list, and be renamed to AUTOCONF_DIRS ? .It Ev BSD_INSTALL_{PROGRAM,SCRIPT,DATA,MAN}[_DIR] -Macros passed to make and configure invocations. Set based on corresponding -INSTALL_* variables. +Macros passed to make and configure invocations. +Set based on corresponding INSTALL_* variables. .It Ev BUILD_DEPENDS List of other ports the current port needs to build correctly. Each item has the form @@ -125,9 +126,9 @@ defaults to .Sq install if it is not specified. .Sq file_to_test -is checked against the current path for ports (see PORTPATH), -or as an absolute -file name. The special name /nonexistent can be used to force a build +is checked against the current path for ports (see PORTPATH), or as an absolute +file name. +The special name /nonexistent can be used to force a build dependency (see the ghostscript port for an example). .Sq directory is set relative to ${PORTSDIR}. @@ -139,29 +140,33 @@ Base location where packages suitable for a CDROM (see PERMIT_PACKAGE_CDROM) will be placed (default: ${PORTSDIR}/cdrom-packages/${ARCH}) .It Ev CFLAGS -Default flags passed to the compiler for building. Many ports ignore it. +Default flags passed to the compiler for building. +Many ports ignore it. See also .Ev COPTS . .It Ev CHECKSUM_FILE Location for this port checksums, used at .Ar checksum -stage. Defaults to ${FILESDIR}/md5. +stage. +Defaults to ${FILESDIR}/md5. .It Ev CLEANDEPENDS If set to .Sq Yes .Sq make clean -will also clean dependencies. Note that distclean never recurses down to -dependencies. +will also clean dependencies. +Note that distclean never recurses down to dependencies. .It Ev COMMENT -File used as a comment for the package, and in the INDEX. Set to +File used as a comment for the package, and in the INDEX. +Set to ${PKGDIR}/COMMENT by default (with corrections for multi-packages and flavors). -If COMMENT starts with a dash, this is a literal string instead. This can -be used to leave a stub Makefile for removed ports and have a complete +If COMMENT starts with a dash, this is a literal string instead. +This can be used to leave a stub Makefile for removed ports and have a complete INDEX entry without needing more files. .It Ev CONFIGURE_SCRIPT Set to name of script invoked by .Ar configure -target, if appropriate. Should be relative to ${WRKSRC}. +target, if appropriate. +Should be relative to ${WRKSRC}. .It Ev CONFIGURE_SHARED Set to --enable-shared or --disable-shared, depending whether the architecture supports shared libraries. @@ -200,24 +205,28 @@ If there is a configure script, but it does not fit the normal gnu configure conventions. .It Ev COPTS -Supplementary options appended to ${CFLAGS} for building. Since most ports -ignore the COPTS convention, they are actually told to use +Supplementary options appended to ${CFLAGS} for building. +Since most ports ignore the COPTS convention, they are actually told to use ${CFLAGS} ${COPTS} as CFLAGS. .It Ev DEF_UMASK Correct value of umask for the port to build and package correctly. Tested against the actual umask at .Ar fake -time. Default is 022. Don't override. +time. +Default is 022. +Don't override. .It Ev DISTDIR -Directory where all ports distfiles are stashed. Defaults to -.Pa ${PORTSDIR}/distfiles. Override if distfiles are stored elsewhere, -but use +Directory where all ports distfiles are stashed. +Defaults to +.Pa ${PORTSDIR}/distfiles. +Override if distfiles are stored elsewhere, but use .Ev FULLDISTDIR to refer to ports's distfiles location instead. .It Ev DISTORIG Suffix used by .Ar distpatch -to rename original files. Defaults to +to rename original files. +Defaults to .Pa .bak.orig . Distinct from .Pa .orig @@ -225,17 +234,19 @@ to avoid confusing .Ar update-patches . .It Ev DIST_SUBDIR Optional subdirectory of ${DISTDIR} where the current port's distfiles -and patchfiles will be located. See target +and patchfiles will be located. +See target .Ar fetch. .It Ev ECHO_MSG Used to display .Sq ===> Configuring for foo -and similar informative messages. Override to turn off, for instance. +and similar informative messages. +Override to turn off, for instance. .It Ev EXTRACT_CASES In the normal extraction stage (when .Ev EXTRACT_ONLY -is not empty), this is the contents of a case statement, used to extract -files. Fragments are automatically appended to extract tar and zip +is not empty), this is the contents of a case statement, used to extract files. +Fragments are automatically appended to extract tar and zip archives, so that the default case is equivalent to the following shell fragment: .Bd -literal -indent @@ -264,42 +275,49 @@ Default value is .tar.gz. .It Ev FAKE Automatically set to .Sq Yes -for most ports (and all new ports). Indicates that the port, using +for most ports (and all new ports). +Indicates that the port, using .Ev FAKE_FLAGS magic, will properly fake installation into ${WRKINST}, to be packaged -and properly installed from the package. Set to +and properly installed from the package. +Set to .Sq No in very rare cases, and during port creation. .It Ev FAKE_FLAGS -Flags passed to ${MAKE_PROGRAM} on fake invocation. By default, -DESTDIR=${WRKINST}. If CONFIGURE_STYLE involves gnu, adds -AM_MAKEFLAGS='DESTDIR=${WRKINST}' to take automatic care of recent automaker -recursive issues. +Flags passed to ${MAKE_PROGRAM} on fake invocation. +By default, DESTDIR=${WRKINST}. +If CONFIGURE_STYLE involves gnu, adds AM_MAKEFLAGS='DESTDIR=${WRKINST}' to +take automatic care of recent automaker recursive issues. .It Ev FETCH_CMD -Command used to fetch distfiles for this port. Defaults to +Command used to fetch distfiles for this port. +Defaults to .Pa /usr/bin/ftp . No current port overrides the default. .It Ev FETCH_DEPENDS -See BUILD_DEPENDS for specification. Fetch dependencies are checked at -the beginning of the extract stage. No current port uses FETCH_DEPENDS. +See BUILD_DEPENDS for specification. +Fetch dependencies are checked at the beginning of the extract stage. +No current port uses FETCH_DEPENDS. .It Ev FILESDIR -Location of other files related to the current ports. Holds at least the -checksum file, and sometimes other files (default: files.${ARCH} or files). +Location of other files related to the current ports. +Holds at least the checksum file, sometimes other files +(default: files.${ARCH} or files). .It Ev FLAVOR -The port current options. Set by the user, and tested by the port to -activate wanted functionalities. +The port current options. +Set by the user, and tested by the port to activate wanted functionalities. .It Ev FLAVORS -List of all flavors keywords a port may match. Used to sort FLAVOR into -a canonical order to build the package name, or to select the packing-list, -and as a quick validity check. +List of all flavors keywords a port may match. +Used to sort FLAVOR into a canonical order to build the package name, +or to select the packing-list, and as a quick validity check. .It Ev FTP_PACKAGES Base location where packages suitable for ftp (see PERMIT_PACKAGE_FTP) will be placed (default: ${PORTSDIR}/ftp-packages/${ARCH}) .It Ev GMAKE -Location of the gnu make binary, if needed. Defaults to gmake. +Location of the gnu make binary, if needed. +Defaults to gmake. .It Ev LIB_DEPENDS -Libraries this port depends upon. Similar to BUILD_DEPENDS, except that +Libraries this port depends upon. +Similar to BUILD_DEPENDS, except that .Sq file_to_test is replaced by a .Sq lib_spec @@ -307,7 +325,7 @@ of the form: .Sq libname.[version.[subversion]] . See BUGS AND LIMITATIONS as well. .Pp -On architectures that use dynamic libraries, +On architectures that use dynamic libraries, .Ev LIB_DEPENDS is also used as a running time dependency, and recorded in the package as such. @@ -324,8 +342,9 @@ Default is .It Ev IS_INTERACTIVE Set to .Sq Yes -if port needs human interaction to build. Usually implies NO_PACKAGE as -well. Porters should strive to minimize IS_INTERACTIVE ports, by using +if port needs human interaction to build. +Usually implies NO_PACKAGE as well. +Porters should strive to minimize IS_INTERACTIVE ports, by using FLAVORS for multiple choice ports, and by postponing human intervention to package installation time. .It Ev LIBTOOL @@ -333,61 +352,73 @@ Location of the libtool binary for ports that set .Ev USE_LIBTOOL (default: ${LOCALBASE}/bin/libtool). .It Ev LIBTOOL_FLAGS -Arguments to pass to libtool. If USE_LIBTOOL is set, the environment variable -LIBTOOL is set to ${LIBTOOL} ${LIBTOOL_FLAGS}. +Arguments to pass to libtool. +If USE_LIBTOOL is set, the environment variable LIBTOOL is set +to ${LIBTOOL} ${LIBTOOL_FLAGS}. .It Ev LOCALBASE where other ports have already been installed (default: /usr/local) .It Ev MAINTAINER -E-mail address of the port's maintainer. Defaults to ports@openbsd.org. +E-mail address of the port's maintainer. +Defaults to ports@openbsd.org. .It Ev MAKE_ENV -Environment variables passed to make invocations. Sets at least -PATH, PREFIX, LOCALBASE, X11BASE, CFLAGS, TRUEPREFIX, DESTDIR and the -BSD_INSTALL_* macros. +Environment variables passed to make invocations. +Sets at least PATH, PREFIX, LOCALBASE, X11BASE, CFLAGS, TRUEPREFIX, DESTDIR, +and the BSD_INSTALL_* macros. .It Ev MAKE_FLAGS Flags used for all make invocations, except for the fake stage, which uses FAKE_FLAGS. .It Ev MAKE_FILE -Name of the Makefile used for ports building. Defaults to Makefile. Used -after changing directory to ${WRKBUILD}. +Name of the Makefile used for ports building. +Defaults to Makefile. +Used after changing directory to ${WRKBUILD}. .It Ev MAKE_PROGRAM -The make program that is used for building the port. Set to ${MAKE} or -${GMAKE} depending on USE_GMAKE. Read-only. +The make program that is used for building the port. +Set to ${MAKE} or ${GMAKE} depending on USE_GMAKE. +Read-only. .It Ev MESSAGE -File recorded in the package and displayed during installation. Defaults -to ${PKGDIR}/MESSAGE if this file exists. Leave empty if no message is needed. +File recorded in the package and displayed during installation. +Defaults to ${PKGDIR}/MESSAGE if this file exists. +Leave empty if no message is needed. .It Ev MTREE_FILE .Xr mtree 1 specification to check when creating a PLIST with the .Ar plist -target. By default, +target. +By default, .Pa ${PORTSDIR}/infrastructure/db/fake.mtree. .It Ev MULTI_PACKAGES -Set to a list of package extensions for ports that create multiple -packages. See +Set to a list of package extensions for ports that create multiple packages. +See .Qq Flavors and multi-packages below. - +.Pp .It Ev NEED_VERSION Specific revision of .Nm -needed by this ports tree. Usually set to the current version of +needed by this ports tree. +Usually set to the current version of .Nm when port was built, and updated by port maintainers when needed. .It Ev NO_SHARED_LIBS Set to .Sq Yes -if platform does not support shared libraries. To be tested after -including +if platform does not support shared libraries. +To be tested after including .Nm bsd.port.mk , if neither PFRAG.SHARED nor CONFIGURE_SHARED are enough. .It Ev OPSYS -Always OpenBSD (read-only). +Always +.Ox OpenBSD +(read-only). .It Ev OPSYS_VER -Revision number of OpenBSD (read-only). +Revision number of +.Ox +(read-only). .It Ev PACKAGES Base location for packages built (default: ${PORTSDIR}/packages/${ARCH}). .It Ev PATCH -Command to use to apply all patches. Defaults to +Command to use to apply all patches. +Defaults to .Pa /usr/bin/patch . .It Ev PATCHDIR Location for patches applied by patch target (default: patches.${ARCH} or @@ -397,11 +428,12 @@ Full list of options used while applying port's patches. .It Ev PATCH_CHECK_ONLY Set to Yes by the .Ar checkpatch -target. Don't touch unless the default +target. +Don't touch unless the default .Ar checkpatch target needs to be redefined. -Ideally, user-defined patch subtargets ought to test checkpatch. In -practice, they don't. +Ideally, user-defined patch subtargets ought to test checkpatch. +In practice, they don't. .It Ev PATCH_DEBUG If set to .Sq Yes , @@ -412,7 +444,8 @@ stage will output extra debug information. Full list of options used while applying distribution patches. .It Ev PATCH_DIST_STRIP Patch option used to strip directory levels while applying distribution -patches. Defaults to -p0 . +patches. +Defaults to -p0 . .It Ev PATCH_LIST Wildcard pattern of patches to select under ${PATCHDIR} (default: patch-*). Note that filenames ending in .orig, or ~ are never applied. @@ -420,30 +453,36 @@ Note that filenames ending in .orig, or ~ are never applied. Patch option used to strip directory levels while applying port's patches. Defaults to -p0 . .It Ev PORTPATH -Path used by most shell invocations. Don't override unless really needed. +Path used by most shell invocations. +Don't override unless really needed. .It Ev PORTSDIR Root of the ports tree (default: /usr/ports). .It Ev PKGDIR Location for packaging information (packing list, port description, port -short description). Default: pkg.${ARCH} or pkg. +short description). +Default: pkg.${ARCH} or pkg. .It Ev PKGNAME -Name of the created package. Default is ${DISTNAME} for the main package, -and ${DISTNAME}${SUBPACKAGE} for multi-packages ports. This is automatically -altered to include flavors, so it is unwise to base other variables on it. +Name of the created package. +Default is ${DISTNAME} for the main package, +and ${DISTNAME}${SUBPACKAGE} for multi-packages ports. +This is automatically altered to include flavors, so it is unwise to +base other variables on it. .It Ev PKGPATH -Path to the current port's directory, relative to ${PORTSDIR}. Read-only. +Path to the current port's directory, relative to ${PORTSDIR}. +Read-only. .It Ev PREFERRED_CIPHERS -List of cryptographic ciphers to use, in order of preference. Defaults -is +List of cryptographic ciphers to use, in order of preference. +Default is .Sq sha1 rmd160 md5 . The first cipher that matches in ${CHECKSUM_FILE} is verified. .It Ev PREFIX -Base directory for the current port installation. Usually ${LOCALBASE}, -though some ports may elect a location under /var, and some multi-packages -ports may install under several locations. +Base directory for the current port installation. +Usually ${LOCALBASE}, though some ports may elect a location under /var, +and some multi-package ports may install under several locations. .It Ev RUN_DEPENDS Specification of ports this port needs installed to be functional. -Same format as BUILD_DEPENDS. The corresponding packages will be built at +Same format as BUILD_DEPENDS. +The corresponding packages will be built at .Ar install stage, and .Xr pkg_add 1 @@ -460,7 +499,8 @@ Location for scripts related to the current port (default: scripts.${ARCH} or scripts). .It Ev SEPARATE_BUILD Many gnu configure ports can be built in a directory distinct from the -place they were unpacked. For some specific ports, this is even mandatory. +place they were unpacked. +For some specific ports, this is even mandatory. Set to .Sq simple if this is the case. @@ -475,12 +515,13 @@ Set to .Sq flavored if distinct flavors of the port may share a common source tree. .It Ev SUBPACKAGE -Set to the sub package suffix when building a package in a multi-package -port. Read-only. Used to test for dependencies or to adjust the package -name. +Set to the sub package suffix when building a package in a multi-package port. +Read-only. +Used to test for dependencies or to adjust the package name. .It Ev SUBST_VARS Make variables whole values get substituted to create the actual package -information. Always holds +information. +Always holds .Ev ARCH , .Ev HOMEPAGE , .Ev PREFIX , @@ -489,10 +530,10 @@ and Add other variables as needed. .It Ev SYSCONFDIR -Location for ports system configuration files. Defaults to +Location for ports system configuration files. +Defaults to .Pa /etc , -should -never be set to +should never be set to .Pa /usr/local/etc . .It Ev TAR Name of the tar binary. @@ -503,28 +544,30 @@ target. .It Ev UNZIP Name of the unzip binary. .It Ev USE_ZIP -Set to Yes if port needs zip to build properly. This is automatic if -EXTRACT_ONLY holds files matching *.zip. +Set to Yes if port needs zip to build properly. +This is automatic if EXTRACT_ONLY holds files matching *.zip. .It Ev USE_BZIP2 -Set to Yes if port needs bzip2 to build properly. This is automatic if -EXTRACT_ONLY holds files matching *.bzip2. +Set to Yes if port needs bzip2 to build properly. +This is automatic if EXTRACT_ONLY holds files matching *.bzip2. .It Ev WRKBUILD -Subdirectory of ${WRKDIR} where the actual build occurs. Defaults to -${WRKSRC}, unless SEPARATE_BUILD is involved, in which case it is set -to an appropriate value. +Subdirectory of ${WRKDIR} where the actual build occurs. +Defaults to ${WRKSRC}, unless SEPARATE_BUILD is involved, in which case +it is set to an appropriate value. .It Ev WRKDIR -Location where all port activity occurs. Apart from the actual port, may -hold all kinds of cookies that checkpoint the port's build. Read-only. +Location where all port activity occurs. +Apart from the actual port, may +hold all kinds of cookies that checkpoint the port's build. +Read-only. Ports that need to know the WRKDIR of another port must use -cd that_port_dir && make show VARNAME=WRKDIR for this. +cd that_port_dir && make show VARNAME=WRKDIR for this. Note that WRKDIR may be a symbolic link. .It Ev WRKDIST -Subdirectory of ${WRKDIR} where the source normally unpacked. Base for all -patches (default: ${WRKDIR}/${DISTNAME}). +Subdirectory of ${WRKDIR} where the source normally unpacked. +Base for all patches (default: ${WRKDIR}/${DISTNAME}). Note that WRKDIST may be a symbolic link, if set to ${WRKDIR}. .It Ev WRKSRC -Subdirectory of ${WRKDIR} where the actual source is. Base for -configuration (default: ${WRKDIST}) +Subdirectory of ${WRKDIR} where the actual source is. +Base for configuration (default: ${WRKDIST}) Note that WRKSRC may be a symbolic link, if set to ${WRKDIR}. .It Ev WRKPKG Subdirectory of ${WRKBUILD} where package information gets generated. @@ -536,8 +579,9 @@ Subdirectory of ${WRKDIR} where port normally installs (see .Ar fake target). .It Ev WRKOBJDIR -If defined, used as a base for the actual port working directory. The real -working directory is created there, and the port ${WRKDIR} is just a link. +If defined, used as a base for the actual port working directory. +The real working directory is created there, and the port ${WRKDIR} is +just a link. .It Ev X11BASE Where X11 has been installed (default: /usr/X11R6). .It Ev USE_GMAKE @@ -555,14 +599,12 @@ Set to .Sq Yes if lesstif is needed for correct behavior of this port. .It Ev XMKMF -Invocation of xmkmf for CONFIGURE_STYLE=imake port. Defaults to -xmkf -a -DPorts. The -DPorts is specific to +Invocation of xmkmf for CONFIGURE_STYLE=imake port. +Defaults to xmkf -a -DPorts. +The -DPorts is specific to .Ox and is always appended. .El -.\" -.\" -.\" .Sh FILES .Bl -tag -width files/md5 .It Pa ../Makefile.inc @@ -570,15 +612,18 @@ Common Makefile fragment for a set of ports, included automatically. .It Pa Makefile.${ARCH} Arch-dependent Makefile fragment, included automatically. .It Pa ${FILESDIR}/md5 -Checksum file. Holds the output of +Checksum file. +Holds the output of .Xr md5 1 , -.Xr sha1 1 +.Xr sha1 1 , and .Xr rmd160 1 for the ports ${DISTFILES} and ${PATCHFILES}. .It Pa ${PKGDIR}/DESCR -Description for the port. Variables such as ${HOMEPAGE} will be expanded -(see SUBST_VARS). Multi-packages ports will use DESCR${SUBPACKAGE}. +Description for the port. +Variables such as ${HOMEPAGE} will be expanded +(see SUBST_VARS). +Multi-package ports will use DESCR${SUBPACKAGE}. .It Pa ${PKGDIR}/COMMENT Short, one line description of the port, that is displayed by .Xr pkg_info 1 , @@ -592,13 +637,11 @@ Use .Ar pre-fake if this is incomplete. .El -.\" -.\" -.\" .Sh OBSOLETE TARGETS .Bl -tag -width do-configure .It Ar {pre,do}-extract -Don't override. Set +Don't override. +Set .Ev EXTRACT_ONLY to nothing and override .Ar post-extract @@ -616,9 +659,6 @@ and .Ar fetch-makefile targets instead. .El -.\" -.\" -.\" .Sh OBSOLETE VARIABLES .Bl -tag -width MASTER_SITES .It Ev DESCR_SRC @@ -626,8 +666,8 @@ From .Nx . This is DESCR. .Ox -does not give a specific name to the generated file. It is not recommended -to try to access them directly. +does not give a specific name to the generated file. +It is not recommended to try to access them directly. .It Ev EXTRACT_AFTER_ARGS Was used to cobble together the normal extraction command, as ${EXTRACT_CMD} ${EXTRACT_BEFORE_ARGS} ${EXTRACT_AFTER_ARGS}. @@ -666,13 +706,14 @@ Use .Ev PERMIT_DISTFILES_FTP and .Ev PERMIT_DISTFILES_CDROM -to determine which files can be mirrored instead. See +to determine which files can be mirrored instead. +See .Xr mirroring-ports 7 . .It Ev NO_CONFIGURE If ${FILESDIR}/configure does not exist, no automatic configuration will be done anyway. .It Ev NO_EXTRACT -Set EXTRACT_ONLY= instead. +Set EXTRACT_ONLY= instead. .It Ev NO_INSTALL_MANPAGES Use .Ev CONFIGURE_STYLE @@ -684,12 +725,13 @@ the operating system installation script runs the /usr/local specification globally, instead of embedding it in each package. So packages no longer record an .Xr mtree 1 -specification. Use an explicit +specification. +Use an explicit .Sq @exec command if needed. .It Ev NO_PATCH -The absence of a patches directory does the same. Use PATCHDIR and -PATCH_LIST if patches need to be changed dynamically. +The absence of a patches directory does the same. +Use PATCHDIR and PATCH_LIST if patches need to be changed dynamically. .It Ev NO_WRKDIR All ports should have a working directory, as this is necessary to store cookies and keep state. @@ -703,8 +745,8 @@ ships with compressed man pages, and uses this variable to control that behavior. .It Ev PATCH_SITES .Ev PATCH_FILES -used to be retrieved from a separate site list. For greater flexibility, -all files are now retrieved from +used to be retrieved from a separate site list. +For greater flexibility, all files are now retrieved from .Ev MASTER_SITES , .Ev MASTER_SITES0 , ..., .Ev MASTER_SITES9 , @@ -728,8 +770,8 @@ From .Nx . This is PLIST. .Ox -does not give a specific name to the generated file. It is not recommended -to try to access them directly. +does not give a specific name to the generated file. +It is not recommended to try to access them directly. .It Ev PLIST_SUBST From .Nx @@ -738,8 +780,8 @@ and Use SUBST_VARS instead. .Ox does not allow general substitutions of the form VAR=value, but uses -only a list of variables instead. Most package files gets transformed, -instead of only the packing list. +only a list of variables instead. +Most package files gets transformed, instead of only the packing list. .It Ev USE_AUTOCONF Use .Ev CONFIGURE_STYLE @@ -749,19 +791,17 @@ Use .Ev CONFIGURE_STYLE instead. .El -.\" -.\" -.\" .Sh OBSOLETE FILES .Bl -tag -width files/md5 .It Pa ${SCRIPTDIR}/{pre,do,post}-* Identical functionality can be obtained through a {pre,do,post}-* target, invoking the script manually if necessary. .It Pa ${PKGDIR}/PLIST.noshared -Use PFRAG.shared or PFRAG.no-shared instead. PLIST.noshared was too easy -to forget when updating ports. +Use PFRAG.shared or PFRAG.no-shared instead. +PLIST.noshared was too easy to forget when updating ports. .It Pa ${PKGDIR}/PLIST.sed -Use PLIST directly. Until revision 1.295, +Use PLIST directly. +Until revision 1.295, .Nm did not substitute variables in the packing list unless this special form was used. @@ -774,26 +814,27 @@ whereas /usr/share/mk/bsd.port.mk is just a stub. The .Ox ports tree focuses on robustness, not on being portable to other operating -systems. In any case, portability should not need to depend on operating +systems. +In any case, portability should not need to depend on operating system dependent patches. .It Pa /usr/local/etc Used by .Fx -to marshall system configuration files. All +to marshall system configuration files. +All .Ox -system configuration files are located in /etc, or in a subdirectory of -/etc. +system configuration files are located in +.Pa /etc , +or in a subdirectory of +.Pa /etc . .El -.\" -.\" -.\" .Sh THE FAKE FRAMEWORK The .Ar fake target is used to install the port in a private directory first, package that false installation, so that the real installation will use the package. - +.Pp Essentially, .Ar fake invokes a real @@ -808,9 +849,9 @@ specification .Pp A .Ar pre-fake -target may be used to complete that skeleton tree. For instance, a few -ports may need supplementary stuff to be present (as it would be installed -if the ports' dependencies were present). +target may be used to complete that skeleton tree. +For instance, a few ports may need supplementary stuff to be present (as +it would be installed if the ports' dependencies were present). .Pp If {pre,do,post}-install overrides are present, they are used with some important changes: PREFIX is set to ${WRKINST}${PREFIX}, DESTDIR is set to @@ -828,23 +869,20 @@ If no do-install override is present, the port is installed using ${MAKE_PROGRAM} ${FAKE_FLAGS} -f ${MAKE_FILE} ${FAKE_TARGET} .Ed .Pp -Note that this does set both PREFIX and DESTDIR. If a port's Makefile both -heeds DESTDIR, and references PREFIX explicitly, FAKE_FLAGS may rectify -the problem by setting PREFIX=${PREFIX} +Note that this does set both PREFIX and DESTDIR. +If a port's Makefile both heeds DESTDIR, and references PREFIX explicitly, +FAKE_FLAGS may rectify the problem by setting PREFIX=${PREFIX} (which will do the right thing, since ${PREFIX} is a .Xr make 1 construct which will not be seen by the shell). .Pp ${FAKE_FLAGS} is used to set variables on .Xr make 1 -command line, which will override the port Makefile contents. Thus, a -port that mentions DESTDIR= does not need any patch to work with fake. +command line, which will override the port Makefile contents. +Thus, a port that mentions DESTDIR= does not need any patch to work with fake. .Pp Recursive makes are a problem, and will often need FAKE_FLAGS to be changed to ensure that the right values are passed down to submakes. -.\" -.\" -.\" .Sh FLAVORS AND MULTI_PACKAGES Starting with .Ox 2.7 , @@ -855,8 +893,8 @@ If a port can be compiled with several options, set FLAVORS to the list of possible options in the Makefile. When building the port, set .Li "FLAVOR='option1 option2...'" -to build a specific flavor of the port. The Makefile should test the value -of FLAVOR as follows: +to build a specific flavor of the port. +The Makefile should test the value of FLAVOR as follows: .Bd -literal FLAVOR?= .if ${FLAVOR:L:Moption1} @@ -898,6 +936,7 @@ MULTI_PACKAGES triggers a recursive make package, with SUBPACKAGE set to the right value. For instance, if MULTI_PACKAGES=-lib -server, make package will work as follows: +.Pp .Bl -bullet -compact .It Run make package SUBPACKAGE=-lib, @@ -908,23 +947,22 @@ Build the main package, by running make package SUBPACKAGE='' .El .Pp The port's Makefile can test the value of SUBPACKAGE to specialize -processing for all sub packages. All packing information is derived from -templates with SUBPACKAGE appended. In the preceding example, the -packing-list template for pkgname-foo must be in PLIST-foo. +processing for all sub packages. +All packing information is derived from +templates with SUBPACKAGE appended. +In the preceding example, the packing-list template for pkgname-foo +must be in PLIST-foo. .Pp It is currently not possible to have a subpackage depend on the main package, except by inserting an explicit .Li "@pkgdep" command into the packing-list. -.\" -.\" -.\" .Sh THE GENERATION OF PACKING INFORMATION Starting after .Ox 2.7 (around revision 1.300 of bsd.port.mk), all packing information is generated from templates in ${PKGDIR}. - +.Pp .Bl -bullet -compact .It If not overriden by the user, determine which set of templates to use, @@ -970,11 +1008,12 @@ Similarly, if FLAVORS lists flav1, then the line .Li "%%flav1%%" (resp. .Li "%%!flav1%%" ) -will trigger the inclusion of +will trigger the inclusion of .Pa ${PKGDIR}/PFRAG.flav1${SUBPACKAGE} (resp. .Pa ${PKGDIR}/PFRAG.no-flav1${SUBPACKAGE} ) -in the packing-list. Fragments that cannot be handled by these simple rules +in the packing-list. +Fragments that cannot be handled by these simple rules can always be specified in a custom SED_PLIST. .Pp The constructs @@ -995,26 +1034,22 @@ PFRAG.shared-auto fragments. .Pp In MULTI_PACKAGES mode, there must be separate COMMENT, DESCR, and PLIST templates for each SUBPACKAGE (and optional distinct MESSAGE, REQ, INSTALL, -DEINSTALL files in a similar way). This contrasts with the FLAVORS +DEINSTALL files in a similar way). +This contrasts with the FLAVORS situation, where all these files will automatically default to the non-flavor version if there is no flavor-specific file around. -.\" -.\" -.\" .Sh BUGS AND LIMITATIONS .Ev LOCALBASE , .Ev X11BASE and .Ev PREFIX -are not heeded consistently. Most of the ports tree will probably fall +are not heeded consistently. +Most of the ports tree will probably fall apart if one tries to build/use stuff elsewhere. .Pp .Ev LIB_DEPENDS is automatically both a BUILD_DEPENDS and a RUN_DEPENDS, whereas some smarter, more intricate mechanism could be designed to minimize dependencies. -.\" -.\" -.\" .Sh HISTORY The ports mechanism originally came from .Fx . @@ -1028,7 +1063,6 @@ its speed and remove a lot of bugs. FLAVORS, MULTI_PACKAGES and FAKE are .Ox improvements. - .\" Voluntarily undocumented: .\" AUTOCONF_ENV: probably not needed anyway, should be internal. .\" HAVE_MOTIF, REQUIRE_MOTIF: need to revisit what these should mean. diff --git a/share/man/man5/core.5 b/share/man/man5/core.5 index fd6894bdb90..737f53c15fa 100644 --- a/share/man/man5/core.5 +++ b/share/man/man5/core.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: core.5,v 1.7 2000/03/19 19:25:26 aaron Exp $ +.\" $OpenBSD: core.5,v 1.8 2000/10/26 00:37:04 aaron Exp $ .\" $NetBSD: core.5,v 1.4 1994/11/30 19:31:11 jtc Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -49,9 +49,8 @@ to disk for later examination by one of the available debuggers (see .Xr sigaction 2 ) . This memory image is written to a file named .Pa programname.core -in the working directory, -provided the terminated process had write permission in the directory, -and provided the abnormality did not cause +in the working directory, provided the terminated process had write +permission in the directory, and provided the abnormality did not cause a system crash. (In this event, the decision to save the core file is arbitrary, see .Xr savecore 8 . ) @@ -66,8 +65,7 @@ The .Pa programname.core file consists of the .Fa u . -area, whose size (in pages) is -defined by the +area, whose size (in pages) is defined by the .Dv UPAGES manifest in the .Aq Pa sys/param.h @@ -80,18 +78,16 @@ structure as given in .Aq Pa sys/user.h . The remainder of the .Pa programname.core -file consists of the data pages followed by -the stack pages of the process image. +file consists of the data pages followed by the stack pages of the +process image. The amount of data space image in the .Pa programname.core -file is given (in pages) by the -variable +file is given (in pages) by the variable .Fa u_dsize in the .Fa u . area. -The amount of stack image in the core file is given (in pages) by the -variable +The amount of stack image in the core file is given (in pages) by the variable .Fa u_ssize in the .Ar u . diff --git a/share/man/man5/dir.5 b/share/man/man5/dir.5 index d5fdcca06bd..9a55dcd5392 100644 --- a/share/man/man5/dir.5 +++ b/share/man/man5/dir.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dir.5,v 1.7 1999/07/09 13:35:38 aaron Exp $ +.\" $OpenBSD: dir.5,v 1.8 2000/10/26 00:37:04 aaron Exp $ .\" $NetBSD: dir.5,v 1.5 1995/03/28 17:30:20 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -38,7 +38,8 @@ .Dt DIR 5 .Os .Sh NAME -.Nm dir , dirent +.Nm dir , +.Nm dirent .Nd directory file format .Sh SYNOPSIS .Fd #include <sys/types.h> @@ -46,15 +47,13 @@ .Sh DESCRIPTION Directories provide a convenient hierarchical method of grouping files while obscuring the underlying details of the storage medium. -A directory file is differentiated from a plain file -by a flag in its +A directory file is differentiated from a plain file by a flag in its .Xr inode 5 entry. It consists of records (directory entries) each of which contains information about a file and a pointer to the file itself. -Directory entries may contain other directories -as well as plain files; such nested directories are referred to as -subdirectories. +Directory entries may contain other directories as well as plain files; +such nested directories are referred to as subdirectories. A hierarchy of directories and files is formed in this manner and is called a file system (or referred to as a file system tree). .\" An entry in this tree, @@ -62,14 +61,11 @@ and is called a file system (or referred to as a file system tree). .\" is a pathname. .Pp Each directory file contains two special directory entries; one is a pointer -to the directory itself -called dot +to the directory itself called dot .Pq Dq \&. and the other a pointer to its parent directory called dot-dot .Pq Dq \&.. . -Dot and dot-dot -are valid pathnames, however, -the system root directory +Dot and dot-dot are valid pathnames, however, the system root directory .Pq Dq / , has no parent and dot-dot points to itself like dot. .Pp @@ -145,6 +141,6 @@ typedef struct _dirdesc { .Xr inode 5 .Sh HISTORY A -.Nm +.Nm dir file format appeared in .At v7 . diff --git a/share/man/man5/disktab.5 b/share/man/man5/disktab.5 index 9558d6defa6..38d5928ba7e 100644 --- a/share/man/man5/disktab.5 +++ b/share/man/man5/disktab.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: disktab.5,v 1.6 2000/03/19 19:25:27 aaron Exp $ +.\" $OpenBSD: disktab.5,v 1.7 2000/10/26 00:37:04 aaron Exp $ .\" $NetBSD: disktab.5,v 1.4 1994/11/30 19:31:15 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -51,24 +51,21 @@ It is used .\"IR.Xr format 8 ) .\"to determine how to format the disk, and to initialize the disk label on the disk. -The format is patterned -after the +The format is patterned after the .Xr termcap 5 terminal database. Entries in .Nm consist of a number of colon -.Pq Sq \&: +.Pq Ql \&: separated fields. The first entry for each disk gives the names which are known for the disk, separated by .Dq \&| characters. -The last name given should be a long name fully identifying -the disk. +The last name given should be a long name fully identifying the disk. .Pp -The following list indicates the normal values -stored for each disk entry: +The following list indicates the normal values stored for each disk entry: .Bl -column "indent" "boolx" .It Sy Name Type Description .It "\&ty str Type of disk (e.g., removable, winchester)." diff --git a/share/man/man5/ethers.5 b/share/man/man5/ethers.5 index eeafd7b7226..969614a30b7 100644 --- a/share/man/man5/ethers.5 +++ b/share/man/man5/ethers.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ethers.5,v 1.11 2000/03/19 19:25:27 aaron Exp $ +.\" $OpenBSD: ethers.5,v 1.12 2000/10/26 00:37:04 aaron Exp $ .\" $NetBSD: ethers.5,v 1.2 1994/11/30 19:31:16 jtc Exp $ .\" .\" Written by Roland McGrath <roland@frob.com>. Public domain. @@ -8,14 +8,15 @@ .Os .Sh NAME .Nm ethers -.Nd Ethernet host name data base +.Nd Ethernet host name database .Sh DESCRIPTION The .Nm file maps Ethernet addresses to host names. -Lines consist of an address and a host name, separated by any number of blanks and/or tab characters. +Lines consist of an address and a host name, separated by any number +of blanks and/or tab characters. A -.Dq # +.Ql # indicates the beginning of a comment; characters up to the end of the line are not interpreted by routines which search the file. .Pp @@ -47,5 +48,4 @@ Longer lines will be ignored. .Sh HISTORY The .Nm -file format was adopted from SunOS and appeared in -NetBSD 0.9b. +file format was adopted from SunOS and appeared in NetBSD 0.9b. diff --git a/share/man/man5/fbtab.5 b/share/man/man5/fbtab.5 index 5141cbc17f4..d05524bcdaf 100644 --- a/share/man/man5/fbtab.5 +++ b/share/man/man5/fbtab.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fbtab.5,v 1.6 2000/03/19 19:25:28 aaron Exp $ +.\" $OpenBSD: fbtab.5,v 1.7 2000/10/26 00:37:04 aaron Exp $ .\" .Dd August 22, 1994 .Dt FBTAB 5 @@ -9,17 +9,15 @@ .Sh DESCRIPTION The .Nm -file contains lines which specify how the permissions and -ownership of various system files should be changed based on -the user's login device name. +file contains lines which specify how the permissions and ownership of +various system files should be changed based on the user's login device name. .Pp Comments start with a -.Dq # +.Ql # and extend to the end of the line. Blank lines or lines with only a comment are ignored. .Pp -All other lines consist of three fields delimited by -whitespace. +All other lines consist of three fields delimited by whitespace. .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It Login Device The device you have logged in on (e.g., @@ -29,7 +27,7 @@ An octal permission number (0600), as used by .Xr chmod 2 . .It Other devices The final field is a colon -.Pq Sq \&: +.Pq Ql \&: delimited list of devices (e.g., .Dq /dev/console:/dev/fd0a ) . All device names are absolute paths. diff --git a/share/man/man5/fstab.5 b/share/man/man5/fstab.5 index 980184775f7..c03825a128f 100644 --- a/share/man/man5/fstab.5 +++ b/share/man/man5/fstab.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fstab.5,v 1.13 2000/10/13 04:09:21 aaron Exp $ +.\" $OpenBSD: fstab.5,v 1.14 2000/10/26 00:37:04 aaron Exp $ .\" $NetBSD: fstab.5,v 1.5.2.1 1995/11/16 20:11:11 pk Exp $ .\" .\" Copyright (c) 1980, 1989, 1991, 1993 @@ -43,31 +43,29 @@ .Sh SYNOPSIS .Fd #include <fstab.h> .Sh DESCRIPTION -The file -.Nm fstab -contains descriptive information about the various file -systems. -.Nm fstab +The +.Nm +file contains descriptive information about the various file systems. +.Nm is only read by programs, and not written; it is the duty of the system administrator to properly create and maintain this file. Each filesystem is described on a separate line; fields on each line are separated by tabs or spaces. The order of records in -.Nm fstab +.Nm is important because .Xr fsck 8 , .Xr mount 8 , and .Xr umount 8 sequentially iterate through -.Nm fstab +.Nm doing their thing. .Pp The first field, .Fa fs_spec , -describes the block special device or -remote filesystem to be mounted. +describes the block special device or remote filesystem to be mounted. For filesystems of type .Tn ffs , the special file name is the block special file name, @@ -75,8 +73,7 @@ and not the character special file name. If a program needs the character special file name, the program must create it by appending an .Dq r -after the -last +after the last .Dq / in the special file name. .Pp @@ -134,8 +131,7 @@ describes the mount options associated with the filesystem. It is formatted as a comma separated list of options. It contains at least the type of mount (see .Fa fs_type -below) plus any additional options -appropriate to the filesystem type. +below) plus any additional options appropriate to the filesystem type. .Pp The option .Dq auto @@ -150,13 +146,11 @@ If the options .Dq userquota and/or .Dq groupquota -are specified, -the filesystem is automatically processed by the +are specified, the filesystem is automatically processed by the .Xr quotacheck 8 command, and user and/or group disk quotas are enabled with .Xr quotaon 8 . -By default, -filesystem quotas are maintained in files named +By default, filesystem quotas are maintained in files named .Pa quota.user and .Pa quota.group @@ -193,8 +187,7 @@ If .Fa fs_type is .Dq sw -then the special file is made available as a piece of swap -space by the +then the special file is made available as a piece of swap space by the .Xr swapon 8 command at the end of the system reboot procedure. The fields other than diff --git a/share/man/man5/group.5 b/share/man/man5/group.5 index 85058a52f94..60b9c9aaa0a 100644 --- a/share/man/man5/group.5 +++ b/share/man/man5/group.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: group.5,v 1.6 2000/03/19 19:25:28 aaron Exp $ +.\" $OpenBSD: group.5,v 1.7 2000/10/26 00:37:04 aaron Exp $ .\" $NetBSD: group.5,v 1.4 1995/07/28 06:41:39 phil Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -47,7 +47,7 @@ The file consists of newline separated .Tn ASCII records, one per group, containing four colon -.Pq Sq \&: +.Pq Ql \&: separated fields. These fields are as follows: .Pp @@ -73,17 +73,15 @@ They should both be unique across the system (and often across a group of systems) since they control file access. The .Ar passwd -field -is an optional encrypted password. -This field is rarely used -and an asterisk is normally placed in it rather than leaving it blank. +field is an optional encrypted password. +This field is rarely used and an asterisk is normally placed in it +rather than leaving it blank. The .Ar member field contains the names of users granted the privileges of .Ar group . The member names are separated by commas without spaces or newlines. -A user is automatically in a group if that group was specified -in their +A user is automatically in a group if that group was specified in their .Pa /etc/passwd entry and does not need to be added to that group in the .Pa /etc/group @@ -117,8 +115,7 @@ which causes the specified group to be included from the YP map. If no group name is specified, or the .Ql + -(plus sign) appears alone -on line, all groups are included from the YP map. +(plus sign) appears alone on a line, all groups are included from the YP map. .Pp YP references may appear anywhere in the file, but the single .Ql + diff --git a/share/man/man5/hostname.if.5 b/share/man/man5/hostname.if.5 index f77395ca26b..f1ad80c41ab 100644 --- a/share/man/man5/hostname.if.5 +++ b/share/man/man5/hostname.if.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hostname.if.5,v 1.21 2000/08/18 17:54:17 jason Exp $ +.\" $OpenBSD: hostname.if.5,v 1.22 2000/10/26 00:37:04 aaron Exp $ .\" $NetBSD: hosts.5,v 1.4 1994/11/30 19:31:20 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -47,10 +47,8 @@ The .Nm hostname.* and .Nm bridgename.* -files contain information regarding -the configuration of each network interface. -One file should exist for each interface that is to be configured, -such as +files contain information regarding the configuration of each network interface. +One file should exist for each interface that is to be configured, such as .Pa hostname.fxp0 or .Pa bridgename.bridge0 . @@ -125,11 +123,9 @@ The optional broadcast address for the interface, i.e., Optional miscellaneous options to set on the interface, i.e., .Dq media 100baseTX mediaopt full-duplex . .It Li dest -If the interface needs a destination address set, this is -the literal text +If the interface needs a destination address set, this is the literal text .Dq dest . -As shown in the example, this declaration should start on a seperate -line. +As shown in the example, this declaration should start on a seperate line. .It Va dest_addr The destination address to be set on the interface, such as 190.191.192.2. @@ -262,7 +258,7 @@ The options are as follows: is called for each successive line. Comments starting with .Ql # -are permitted +are permitted. .El .Sh SEE ALSO .Xr hosts 5 , diff --git a/share/man/man5/hosts.5 b/share/man/man5/hosts.5 index b6bcd4b523e..5247c87a80e 100644 --- a/share/man/man5/hosts.5 +++ b/share/man/man5/hosts.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hosts.5,v 1.9 2000/03/19 19:25:29 aaron Exp $ +.\" $OpenBSD: hosts.5,v 1.10 2000/10/26 00:37:04 aaron Exp $ .\" $NetBSD: hosts.5,v 1.4 1994/11/30 19:31:20 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -39,27 +39,23 @@ .Os .Sh NAME .Nm hosts -.Nd host name data base +.Nd host name database .Sh DESCRIPTION The .Nm -file contains information regarding -the known hosts on the network. -For each host a single line should be present -with the following information: +file contains information regarding the known hosts on the network. +For each host, a single line should be present with the following information: .Bd -unfilled -offset indent Internet address Official host name Aliases .Ed .Pp -Items are separated by any number of blanks and/or -tab characters. +Items are separated by any number of blanks and/or tab characters. A .Ql # -indicates the beginning of -a comment; characters up to the end of the line are -not interpreted by routines which search the file. +indicates the beginning of a comment; characters up to the end of the line +are not interpreted by routines which search the file. .Pp The system configuration file .Xr resolv.conf 5 @@ -74,25 +70,21 @@ database. .Pp When using the name server .Xr named 8 , -this file provides a backup when the name server -is not running. +this file provides a backup when the name server is not running. For the name server, it is suggested that only a few addresses be included in this file. These include addresses for the local interfaces that .Xr ifconfig 8 needs at boot time and a few machines on the local network. .Pp -This file may be created from the official host -data base maintained at the Network Information Control -Center +This file may be created from the official host database maintained at the +Network Information Control Center .Pq Tn NIC , -though local changes may be required -to bring it up to date regarding unofficial aliases -and/or unknown hosts. -As the data base maintained at +though local changes may be required to bring it up to date regarding +unofficial aliases and/or unknown hosts. +As the database maintained at .Tn NIC -is incomplete, use of the name server is recommended for -sites on the +is incomplete, use of the name server is recommended for sites on the .Tn DARPA Internet. .Pp @@ -100,12 +92,10 @@ Network addresses are specified in the conventional Internet .Dq \&. (dot) notation using the .Xr inet_addr 3 -routine -from the Internet address manipulation library, +routine from the Internet address manipulation library, .Xr inet 3 . -Host names may contain any printable -character other than a field delimiter, newline, -or comment character. +Host names may contain any printable character other than a field delimiter, +newline, or comment character. .Sh FILES .Bl -tag -width /etc/hosts -compact .It Pa /etc/hosts diff --git a/share/man/man5/hosts.equiv.5 b/share/man/man5/hosts.equiv.5 index 3e0d9162f0c..c9fe4552d8a 100644 --- a/share/man/man5/hosts.equiv.5 +++ b/share/man/man5/hosts.equiv.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hosts.equiv.5,v 1.4 2000/03/19 19:25:29 aaron Exp $ +.\" $OpenBSD: hosts.equiv.5,v 1.5 2000/10/26 00:37:04 aaron Exp $ .\" .\" Copyright (c) 1997 Todd Vierling .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -39,11 +39,12 @@ .Dt HOSTS.EQUIV 5 .Os .Sh NAME -.Nm hosts.equiv , .rhosts +.Nm hosts.equiv , +.Nm .rhosts .Nd trusted remote hosts and host-user pairs .Sh DESCRIPTION The -.Nm +.Nm hosts.equiv and .Nm .rhosts files list hosts and users which are @@ -69,7 +70,7 @@ name in a DNS environment) or address, .Ar +@netgroup (from which only the host names are checked), or a -.Dq + +.Sq + wildcard (allow all hosts). .Pp The @@ -78,7 +79,7 @@ if specified, may be given as a user name on the remote host, .Ar +@netgroup (from which only the user names are checked), or a -.Dq + +.Sq + wildcard (allow all remote users). .Pp If a @@ -139,7 +140,7 @@ considerations somewhat; the address is then used directly by .Xr iruserok 3 . .Pp When a user name (or netgroup, or -.Dq + ) +.Sq + ) is specified in .Pa /etc/hosts.equiv , that user (or group of users, or all users, respectively) may login to @@ -189,7 +190,7 @@ file format appeared in The .Xr ruserok 3 implementation currently skips negative entries (preceded with a -.Dq \&- +.Sq \&- sign) and does not treat them as .Dq short-circuit negative entries. diff --git a/share/man/man5/intro.5 b/share/man/man5/intro.5 index 0c78f4ce84d..2e51bf71360 100644 --- a/share/man/man5/intro.5 +++ b/share/man/man5/intro.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: intro.5,v 1.2 2000/03/22 21:34:55 aaron Exp $ +.\" $OpenBSD: intro.5,v 1.3 2000/10/26 00:37:04 aaron Exp $ .\" .\" Copyright (c) 1999 Hugh Graham .\" @@ -48,6 +48,6 @@ composition of database files .El .Sh HISTORY The -.Nm intro +.Nm section manual page appeared in .Ox 2.5 . diff --git a/share/man/man5/link.5 b/share/man/man5/link.5 index 0e966ab9b9b..9f2b753313f 100644 --- a/share/man/man5/link.5 +++ b/share/man/man5/link.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: link.5,v 1.7 2000/03/19 19:25:30 aaron Exp $ +.\" $OpenBSD: link.5,v 1.8 2000/10/26 00:37:04 aaron Exp $ .\" $NetBSD: link.5,v 1.5 1996/01/09 00:14:32 pk Exp $ .\" .\" Copyright (c) 1993 Paul Kranenburg @@ -44,18 +44,15 @@ declares several structures that are present in dynamically linked programs and libraries. The structures define the interface between several components of the link editor and loader mechanism. -The layout of a number of these -structures within the binaries resembles the +The layout of a number of these structures within the binaries resembles the .Xr a.out 5 -format in many places -as it serves such similar functions as symbol definitions (including the -accompanying string table) and relocation records needed to resolve -references to external entities. +format in many places as it serves such similar functions as symbol +definitions (including the accompanying string table) and relocation records +needed to resolve references to external entities. It also records a number of data structures unique to the dynamic loading and linking process. -These include references -to other objects that are required to complete the link-editing process and -indirection tables to facilitate +These include references to other objects that are required to complete +the link-editing process and indirection tables to facilitate .Em Position Independent Code (PIC for short) to improve sharing of code pages among different processes. The collection of data structures described here will be referred to as the @@ -82,14 +79,13 @@ The exact mechanism used for this is machine dependent, usually a machine register is reserved for the purpose. The rational behind this construct is to generate code that is independent of the actual load address. -Only -the values contained in the Global Offset Table may need updating at run-time -depending on the load addresses of the various shared objects in the address -space. +Only the values contained in the Global Offset Table may need updating at +run-time depending on the load addresses of the various shared objects +in the address space. .Pp Likewise, procedure calls to globally defined functions are redirected through -the Procedure Linkage Table (PLT) residing in the data segment of the core -image. +the Procedure Linkage Table (PLT) residing in the data segment of the +core image. Again, this is done to avoid run-time modifications to the text segment. .Pp The linker-editor allocates the Global Offset Table and Procedure Linkage Table @@ -102,11 +98,9 @@ Another reserved symbol, is used to indicate the presence of the run-time linker structures. Whenever .Dv _DYNAMIC -is relocated to 0, there is no need to invoke the run-time -link editor. -If this symbol is non-zero, it points at a data structure from -which the location of the necessary relocation and symbol information can -be derived. +is relocated to 0, there is no need to invoke the run-time link editor. +If this symbol is non-zero, it points at a data structure from which the +location of the necessary relocation and symbol information can be derived. This is most notably used by the start-up module, .Em crt0 . The @@ -142,9 +136,8 @@ This field provides for different versions of the dynamic linking implementation. The current version numbers understood by ld and .Xr ld.so -are LD_VERSION_SUN(3), -which is used by the SunOS 4.x releases, and LD_VERSION_BSD(8), -which is currently in use by +are LD_VERSION_SUN(3), which is used by the SunOS 4.x releases, +and LD_VERSION_BSD(8), which is currently in use by .Ox . .It Fa d_un Refers to a @@ -493,7 +486,7 @@ struct ld_entry { void (*dlexit) __P((void)); }; .Ed - +.Pp The .Fa crt_ldso structure defines the interface between @@ -529,7 +522,7 @@ On SunOS systems, this field contains an open file descriptor to used to get demand paged zeroed pages. On .Ox -systems it contains -1. +systems it contains \-1. .It Fa crt_ldfd Contains an open file descriptor that was used by .Em crt0 @@ -568,8 +561,7 @@ structures define the layout of the library hints, normally found in .Pa /var/run/ld.so.hints , which is used by .Xr ld.so -to quickly locate the shared object images in the -filesystem. +to quickly locate the shared object images in the filesystem. The organization of the hints file is not unlike that of an .Xr a.out 5 object file, in that it contains a header determining the offset and size @@ -639,8 +631,6 @@ The number of valid entries in .It Fa hi_next Next bucket in case of hashing collisions. .El - .Sh CAVEATS Only the (GNU) C compiler currently supports the creation of shared libraries. Other programming languages can not be used. - diff --git a/share/man/man5/login.conf.5 b/share/man/man5/login.conf.5 index 63f9fd50cb6..ddd7829fdc7 100644 --- a/share/man/man5/login.conf.5 +++ b/share/man/man5/login.conf.5 @@ -30,7 +30,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $OpenBSD: login.conf.5,v 1.2 2000/08/20 19:11:01 millert Exp $ +.\" $OpenBSD: login.conf.5,v 1.3 2000/10/26 00:37:04 aaron Exp $ .\" BSDI $From: login.conf.5,v 2.20 2000/06/26 14:50:38 prb Exp $ .\" .Dd February 23, 1995 @@ -38,12 +38,12 @@ .Os .Sh NAME .Nm login.conf -.Nd login class capability data base +.Nd login class capability database .Sh SYNOPSIS .Nm /etc/login.conf .Sh DESCRIPTION The -.Nm login.conf +.Nm file describes the various attributes of login classes. A login class determines session resource limits and environment setup. It is used by various programs in the system to set up a user's login @@ -62,9 +62,10 @@ Refer to .Xr getcap 3 for a description of the file layout. All entries in the -.Nm login.conf -file are either boolean or use a `=' to separate the capability -from the value. +.Nm +file are either boolean or use a +.Ql = +to separate the capability from the value. The types are described after the capability table. .Bl -column alwaysuseklogin programxx xusrxbinxbin .Sy Name Type Default Description @@ -138,7 +139,8 @@ warn the user of this. .sp .It path Ta path Ta Dv "value of _PATH_DEFPATH" Ta .br -Default search path. See +Default search path. +See .Pa /usr/include/paths.h . .\" .sp @@ -181,11 +183,9 @@ and .Va openfiles ) actually specify both the maximum and current limits (see .Xr getrlimit 2 ). -The current limit is the one normally used, -although the user is permitted to increase the current limit to the -maximum limit. -The maximum and current limits may be specified individually by appending -a +The current limit is the one normally used, although the user is permitted +to increase the current limit to the maximum limit. +The maximum and current limits may be specified individually by appending a .Va \-max or .Va \-cur @@ -211,7 +211,8 @@ Path name to a text file. A comma separated list of values. .\" .It number -A number. A leading +A number. +A leading .Li 0x implies the number is expressed in hexadecimal. A leading @@ -244,10 +245,8 @@ to multiply the value by 1 M (1048576). .\" .It time A time in seconds. -A time may be expressed as a series of numbers -which are added together. -Each number may have a trailing character to -represent time units: +A time may be expressed as a series of numbers which are added together. +Each number may have a trailing character to represent time units: .Bl -tag -width xxx .\" .It y @@ -269,8 +268,7 @@ Indicates a number of 60 second minutes. Indicates a number of seconds. .El .Pp -For example, to indicate 1 and 1/2 hours, the following string -could be used: +For example, to indicate 1 and 1/2 hours, the following string could be used: .Li 1h30m . .El .\" diff --git a/share/man/man5/motd.5 b/share/man/man5/motd.5 index ce690a668d1..07c1a180749 100644 --- a/share/man/man5/motd.5 +++ b/share/man/man5/motd.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: motd.5,v 1.4 2000/02/29 04:48:39 aaron Exp $ +.\" $OpenBSD: motd.5,v 1.5 2000/10/26 00:37:05 aaron Exp $ .\" $NetBSD: motd.5,v 1.2 1994/12/28 18:58:53 glass Exp $ .\" .\" This file is in the public domain. @@ -19,8 +19,7 @@ It is generally used for important system-wide announcements. During system startup, a line containing the kernel version string is prepended to this file. .Pp -Individual users may suppress the display of this file by -creating a file named +Individual users may suppress the display of this file by creating a file named .Pa .hushlogin in their home directories. .Sh EXAMPLES diff --git a/share/man/man5/netgroup.5 b/share/man/man5/netgroup.5 index ff61e9a9e52..8940e2d2123 100644 --- a/share/man/man5/netgroup.5 +++ b/share/man/man5/netgroup.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: netgroup.5,v 1.8 2000/03/19 19:25:30 aaron Exp $ +.\" $OpenBSD: netgroup.5,v 1.9 2000/10/26 00:37:05 aaron Exp $ .\" $NetBSD: netgroup.5,v 1.3 1995/03/18 14:58:34 cgd Exp $ .\" .\" Copyright (c) 1992, 1993 @@ -45,16 +45,14 @@ .Sh DESCRIPTION The .Nm -file -specifies +file specifies .Dq netgroups , which are sets of .Sy (host, user, domain) tuples that are to be given similar network access. .Pp -Each line in the file -consists of a netgroup name followed by a list of the members of the -netgroup. +Each line in the file consists of a netgroup name followed by a list of +the members of the netgroup. Each member can be either the name of another netgroup or a specification of a tuple as follows: .Bd -literal -offset indent @@ -73,8 +71,7 @@ value or may consist of the single character .Dq \&- to specify .Dq no valid value . -The members of the list may be separated by whitespace; -the +The members of the list may be separated by whitespace; the .Dq \e character may be used at the end of a line to specify line continuation. The functions specified in @@ -99,7 +96,9 @@ file contains a .Dq + entry. .Pp -Lines that begin with a # are treated as comments. +Lines that begin with a +.Ql # +are treated as comments. .Sh FILES .Bl -tag -width /etc/netgroup.db -compact .It Pa /etc/netgroup.db diff --git a/share/man/man5/networks.5 b/share/man/man5/networks.5 index 78f7aa5f868..4d381e17bec 100644 --- a/share/man/man5/networks.5 +++ b/share/man/man5/networks.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: networks.5,v 1.10 2000/10/13 04:09:21 aaron Exp $ +.\" $OpenBSD: networks.5,v 1.11 2000/10/26 00:37:05 aaron Exp $ .\" $NetBSD: networks.5,v 1.9 1999/03/17 20:19:47 garbled Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -54,11 +54,10 @@ networks that the local host could communicate with, distribution and update of such a list for the world-wide .Tn Internet (or, indeed, for any large "enterprise" network) has proven to be -prohibitive, so the Domain Name System -is used instead, except as noted. +prohibitive, so the Domain Name System is used instead, except as noted. .Pp -For each IP -network a single line should be present with the following information: +For each IP network, a single line should be present with the following +information: .Bd -unfilled -offset indent official network name ip network number diff --git a/share/man/man5/passwd.5 b/share/man/man5/passwd.5 index 8f3efbf262e..2cc7aeb78f9 100644 --- a/share/man/man5/passwd.5 +++ b/share/man/man5/passwd.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: passwd.5,v 1.15 2000/08/20 19:37:35 millert Exp $ +.\" $OpenBSD: passwd.5,v 1.16 2000/10/26 00:37:05 aaron Exp $ .\" $NetBSD: passwd.5,v 1.4 1995/07/28 06:46:05 phil Exp $ .\" .\" Copyright (c) 1988, 1991, 1993 @@ -44,9 +44,9 @@ .Sh DESCRIPTION The .Nm master.passwd -file, readable only by root, consists of -newline-separated records, one per user, containing ten colon -.Pq Sq \&: +file, readable only by root, consists of newline-separated records, +one per user, containing ten colon +.Pq Ql \&: separated fields. These fields are as follows: .Pp @@ -77,7 +77,7 @@ User's login shell. .El .Pp The publically-readable -.Nm +.Nm passwd file is generated from the .Nm master.passwd file by @@ -115,13 +115,12 @@ The password field is the form of the password. If the .Ar password -field is empty, no password will be required to gain access to the -machine. +field is empty, no password will be required to gain access to the machine. This is almost invariably a mistake. Because .Nm master.passwd -contains the encrypted user passwords, it should -not be readable by anyone without appropriate privileges. +contains the encrypted user passwords, it should not be readable by anyone +without appropriate privileges. .Pp Which type of cipher is used to encrypt the password information depends on the configuration in @@ -173,7 +172,7 @@ User's home phone number. .El .Pp The full name may contain an ampersand -.Pq Sq \&& , +.Pq Ql \&& , which will be replaced by the capitalized login name when the gecos field is displayed or used by various programs such as .Xr finger 1 , @@ -198,7 +197,7 @@ field, the Bourne shell is assumed. .Sh YP SUPPORT If YP is active, the -.Nm +.Nm passwd file also supports standard YP exclusions and inclusions, based on user names and netgroups. .Pp @@ -301,7 +300,7 @@ BEGIN { FS = ":"} .Ed .Sh HISTORY A -.Nm +.Nm passwd file format appeared in .At v6 . .Pp diff --git a/share/man/man5/passwd.conf.5 b/share/man/man5/passwd.conf.5 index bc5fa9125f4..3104d2524af 100644 --- a/share/man/man5/passwd.conf.5 +++ b/share/man/man5/passwd.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: passwd.conf.5,v 1.10 2000/08/01 22:39:07 provos Exp $ +.\" $OpenBSD: passwd.conf.5,v 1.11 2000/10/26 00:37:05 aaron Exp $ .\" .\" Copyright 1997 Niels Provos <provos@physnet.uni-hamburg.de> .\" All rights reserved. @@ -43,13 +43,12 @@ describes the configuration of the password cipher used to encrypt local or YP passwords. .Pp There are default, user and group specific stanzas. -If no user or group -stanza to a specific option is available, the default stanza -is used. +If no user or group stanza to a specific option is available, +the default stanza is used. .Pp To differentiate between user and group stanzas, groups are prefixed with a single dot -.Pq Sq \&. . +.Pq Ql \&. . .Pp Some fields and their possible values that can appear in this file are: .Bl -tag -width localcipher @@ -72,8 +71,8 @@ It specifies the base 2 logarithm of the number of rounds. The cipher to use for YP passwords. The possible values are the same as for localcipher. .It Sy pwdcheck -An external program that checks the quality of the password. The -password is passed to the program on +An external program that checks the quality of the password. +The password is passed to the program on .Pa stdin . An exit code of 0 indicates that the quality of the password is sufficient, an exit code of 1 signals that the password failed @@ -81,8 +80,9 @@ the check. .It Sy pwdtries The number of times .Xr passwd 1 -enforces a check on the password. If it is 0, the new password -will only be accepted if it passes the password quality check. +enforces a check on the password. +If it is 0, the new password will only be accepted if it passes +the password quality check. The default is 3. .El .Pp @@ -112,4 +112,3 @@ The old Unix crypt is used as YP cipher: .Xr passwd 1 , .Xr pw_getconf 3 , .Xr passwd 5 - diff --git a/share/man/man5/phones.5 b/share/man/man5/phones.5 index c161b137649..3d95b21f986 100644 --- a/share/man/man5/phones.5 +++ b/share/man/man5/phones.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: phones.5,v 1.5 2000/03/19 19:25:31 aaron Exp $ +.\" $OpenBSD: phones.5,v 1.6 2000/10/26 00:37:05 aaron Exp $ .\" $NetBSD: phones.5,v 1.3 1994/11/30 19:31:25 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -39,7 +39,7 @@ .Os .Sh NAME .Nm phones -.Nd remote host phone number data base +.Nd remote host phone number database .Sh DESCRIPTION The .Pa /etc/phones @@ -61,9 +61,8 @@ The .Ql = and .Ql * -characters are -indicators to the auto call units to pause and wait for a second dial -tone (when going through an exchange). +characters are indicators to the auto call units to pause and wait for +a second dial tone (when going through an exchange). The .Ql = is required by the diff --git a/share/man/man5/printcap.5 b/share/man/man5/printcap.5 index a7a38f7c46a..0fe2cf24b06 100644 --- a/share/man/man5/printcap.5 +++ b/share/man/man5/printcap.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: printcap.5,v 1.11 2000/03/02 04:08:11 aaron Exp $ +.\" $OpenBSD: printcap.5,v 1.12 2000/10/26 00:37:05 aaron Exp $ .\" $NetBSD: printcap.5,v 1.7 1998/02/20 12:24:50 hubertf Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -50,8 +50,7 @@ file is a simplified version of the database used to describe line printers. The spooling system accesses the .Nm -file every time it is used, allowing dynamic -addition and deletion of printers. +file every time it is used, allowing dynamic addition and deletion of printers. Each entry in the database is used to describe one printer. This database may not be substituted for, as is possible for .Xr termcap , @@ -146,8 +145,7 @@ daemon creates a pipeline of to process files for various printer types. The pipeline is not set up for remote printers specified via .Sy rm -unless the local host is the same as the remote printer host -given. +unless the local host is the same as the remote printer host given. The filters selected depend on the flags passed to .Xr lpr 1 . The pipeline set up is: @@ -180,8 +178,7 @@ The .Fl c flag is passed only if the .Fl l -flag (pass control characters literally) -is specified to +flag (pass control characters literally) is specified to .Xr lpr . .Ar width and @@ -200,8 +197,7 @@ parameters specify the login name and host name of the owner of the job, respectively. The .Ar acct-file -function -is passed from the +function is passed from the .Sy af .Nm entry. @@ -210,11 +206,9 @@ If no .Sy if is specified, .Sy of -is used instead, -with the distinction that +is used instead, with the distinction that .Sy of -is opened only once, -while +is opened only once, while .Sy if is opened for every individual job. Thus, @@ -241,8 +235,7 @@ where .Ar width and .Ar length -are represented in pixels, -specified by the +are represented in pixels, specified by the .Sy px and .Sy py @@ -270,8 +263,7 @@ using the facility. Messages printed on .Em stderr -of one of the filters -are sent to the corresponding +of one of the filters are sent to the corresponding .Sy lf file. The filters may, of course, use diff --git a/share/man/man5/protocols.5 b/share/man/man5/protocols.5 index ed5693c5983..40e2054213a 100644 --- a/share/man/man5/protocols.5 +++ b/share/man/man5/protocols.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: protocols.5,v 1.7 2000/03/19 19:25:32 aaron Exp $ +.\" $OpenBSD: protocols.5,v 1.8 2000/10/26 00:37:05 aaron Exp $ .\" $NetBSD: protocols.5,v 1.3 1994/11/30 19:31:27 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -39,14 +39,14 @@ .Os .Sh NAME .Nm protocols -.Nd protocol name data base +.Nd protocol name database .Sh DESCRIPTION The .Nm file contains information regarding the known protocols used in the .Tn DARPA Internet. -For each protocol a single line should be present +For each protocol, a single line should be present with the following information: .Bd -unfilled -offset indent official protocol name @@ -54,18 +54,15 @@ protocol number aliases .Ed .Pp -Items are separated by any number of blanks and/or -tab characters. +Items are separated by any number of blanks and/or tab characters. .Pp A hash mark .Pq Ql # -indicates the beginning of -a comment; subsequent characters up to the end of the line are -not interpreted by the routines which search the file. +indicates the beginning of a comment; subsequent characters up to the +end of the line are not interpreted by the routines which search the file. .Pp -Protocol names may contain any printable -character other than a field delimiter, newline, -or comment character. +Protocol names may contain any printable character other than a +field delimiter, newline, or comment character. .Sh FILES .Bl -tag -width /etc/protocols -compact .It Pa /etc/protocols diff --git a/share/man/man5/remote.5 b/share/man/man5/remote.5 index 1030ef93058..3f5f0a0f772 100644 --- a/share/man/man5/remote.5 +++ b/share/man/man5/remote.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: remote.5,v 1.7 2000/03/19 19:25:32 aaron Exp $ +.\" $OpenBSD: remote.5,v 1.8 2000/10/26 00:37:05 aaron Exp $ .\" $NetBSD: remote.5,v 1.4 1997/04/20 00:05:27 mellon Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -45,8 +45,7 @@ The systems known by .Xr tip 1 and their attributes are stored in an .Tn ASCII -file which -is structured somewhat like the +file which is structured somewhat like the .Xr termcap 5 file. Each line in the file provides a description for a single @@ -55,12 +54,11 @@ Fields are separated by a colon .Pq Sq \&: . Lines ending with a .Dq \e -character immediately followed by a newline are -continued on the next line. +character immediately followed by a newline are continued on the next line. .Pp The first entry is the name(s) of the host system. -If there is more -than one name for a system, the names are separated by vertical bars +If there is more than one name for a system, the names are separated by +vertical bars .Pq Sq \&| . After the name of the system comes the fields of the description. A field name followed by an equal sign @@ -83,19 +81,16 @@ interface to as follows. When .Xr tip -is invoked with only a phone number, it looks for an entry -of the form +is invoked with only a phone number, it looks for an entry of the form .Dq tip300 , -where 300 is the baud rate with -which the connection is to be made. +where 300 is the baud rate with which the connection is to be made. When the .Xr cu interface is used, entries of the form .Dq cu300 are used. .Sh CAPABILITIES -Capabilities are either strings (str), numbers (num), or boolean -flags (bool). +Capabilities are either strings (str), numbers (num), or boolean flags (bool). A string capability is specified by .Em capability Ns Ar = Ns Em value ; for example, @@ -104,8 +99,7 @@ A numeric capability is specified by .Em capability Ns Ar # Ns Em value ; for example, .Dq xa#99 . -A boolean capability is specified by simply listing -the capability. +A boolean capability is specified by simply listing the capability. .Bl -tag -width indent .It Sy \&at (str) @@ -118,11 +112,9 @@ This is a decimal number. The default baud rate is 300 baud. .It Sy \&cm (str) -An initial connection message to be sent -to the remote host. +An initial connection message to be sent to the remote host. For example, if a host is reached through port selector, this -might be set to the appropriate sequence -required to switch to the host. +might be set to the appropriate sequence required to switch to the host. .It Sy \&cu (str) Call unit if making a phone call. @@ -135,8 +127,7 @@ This host is directly connected, and tip should not expect carrier detect to be high, nor should it exit if carrier detect drops. .It Sy \&di (str) -Disconnect message sent to the host when a -disconnect is requested by the user. +Disconnect message sent to the host when a disconnect is requested by the user. .It Sy \&du (bool) This host is on a dial-up line. @@ -154,8 +145,7 @@ Characters marking an end-of-line. The default is .Dv NULL . .Dq ~ -escapes are only -recognized by +escapes are only recognized by .Xr tip after one of the characters in .Sy el , @@ -167,8 +157,7 @@ The default frame size is equal to .Dv BUFSIZ . .It Sy \&hd (bool) -The host uses half-duplex communication, local -echo should be performed. +The host uses half-duplex communication, local echo should be performed. .It Sy \&ie (str) Input end-of-file marks. @@ -181,12 +170,10 @@ The default is .Dv NULL . When .Xr tip -is transferring a file, this -string is sent at end-of-file. +is transferring a file, this string is sent at end-of-file. .It Sy \&pa (str) -The type of parity to use when sending data -to the host. +The type of parity to use when sending data to the host. This may be one of .Dq even , .Dq odd , @@ -200,8 +187,9 @@ The default is even parity. .It Sy \&pn (str) Telephone number(s) for this host. -If the telephone number field contains -an @ sign, +If the telephone number field contains a +.Ql @ +(at sign), .Xr tip searches the file .Pa /etc/phones @@ -209,8 +197,7 @@ file for a list of telephone numbers (see .Xr phones 5 ) . .It Sy \&tc (str) -Indicates that the list of capabilities is continued -in the named description. +Indicates that the list of capabilities is continued in the named description. This is used primarily to share common capability information. .El .Pp diff --git a/share/man/man5/resolv.conf.5 b/share/man/man5/resolv.conf.5 index 7ecdc8b19b8..1ef03c1ebb1 100644 --- a/share/man/man5/resolv.conf.5 +++ b/share/man/man5/resolv.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: resolv.conf.5,v 1.13 2000/06/22 07:34:47 itojun Exp $ +.\" $OpenBSD: resolv.conf.5,v 1.14 2000/10/26 00:37:05 aaron Exp $ .\" $NetBSD: resolv.conf.5,v 1.7 1996/03/06 18:22:16 scottr Exp $ .\" .\" Copyright (c) 1986, 1991 The Regents of the University of California. @@ -69,17 +69,14 @@ Scoped IPv6 address notation is accepted as well for details). Up to .Dv MAXNS -(currently 3) name servers may be listed, -one per keyword. -If there are multiple servers, -the resolver library queries them in the order listed. +(currently 3) name servers may be listed, one per keyword. +If there are multiple servers, the resolver library queries them in the +order listed. If no .Sy nameserver -entries are present, -the default is to use the name server on the local machine. +entries are present, the default is to use the name server on the local machine. (The algorithm used is to try a name server, and if the query times out, -try the next, until out of name servers, -then repeat trying all name servers +try the next, until out of name servers, then repeat trying all name servers until a maximum number of retries are performed.) .It Sy domain Local domain name. @@ -99,8 +96,7 @@ This keyword is used by the library routines .Xr gethostbyname 3 and .Xr gethostbyaddr 3 . -It specifies which databases should be searched, -and the order to do so. +It specifies which databases should be searched, and the order to do so. The legal space-separated values are: .Pp .Bl -tag -width bind -compact @@ -132,11 +128,9 @@ Search list for hostname lookup. The search list is normally determined from the local domain name; by default, it begins with the local domain name, then successive parent domains that have at least two components in their names. -This may be changed by listing the desired domain search path -following the +This may be changed by listing the desired domain search path following the .Sy search -keyword with spaces or tabs separating -the names. +keyword with spaces or tabs separating the names. Most resolver queries will be attempted using each component of the search path in turn until a match is found. Note that this process may be slow and will generate a lot of network @@ -153,10 +147,8 @@ to be sorted. A .Sy sortlist is specified by IP address netmask pairs. -The netmask is optional and defaults to the natural -netmask of the net. -The IP address and optional network pairs are separated by -slashes. +The netmask is optional and defaults to the natural netmask of the net. +The IP address and optional network pairs are separated by slashes. Up to 10 pairs may be specified, i.e.: .Pp .Sy sortlist 130.155.160.0/255.255.240.0 130.155.0.0 @@ -183,9 +175,8 @@ must appear in a name given to res_query (see before an initial absolute query will be made. The default for .Ar n -is 1, meaning that if there are any -dots in a name, the name will be tried first as an absolute -name before any search list elements are appended to it. +is 1, meaning that if there are any dots in a name, the name will be tried +first as an absolute name before any search list elements are appended to it. .El .El .Pp @@ -194,8 +185,8 @@ The and .Sy search keywords are mutually exclusive. -If more than one instance of these keywords is present, -the last instance will override. +If more than one instance of these keywords is present, the last instance +will override. .Pp The .Sy search @@ -215,8 +206,7 @@ environment variable .Ev RES_OPTIONS to a space-separated list of resolver options as explained above. .Pp -The keyword and value must appear on a single line, and the keyword -(e.g., +The keyword and value must appear on a single line, and the keyword (e.g., .Sy nameserver ) must start the line. The value follows the keyword, separated by whitespace. diff --git a/share/man/man5/rpc.5 b/share/man/man5/rpc.5 index 575d73159fc..cbc5fce4c28 100644 --- a/share/man/man5/rpc.5 +++ b/share/man/man5/rpc.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rpc.5,v 1.5 2000/02/29 04:48:39 aaron Exp $ +.\" $OpenBSD: rpc.5,v 1.6 2000/10/26 00:37:05 aaron Exp $ .\" $NetBSD: rpc.5,v 1.2 1994/11/30 19:31:30 jtc Exp $ .\" @(#)rpc.5 2.2 88/08/03 4.0 RPCSRC; from 1.4 87/11/27 SMI; .\" @@ -10,7 +10,7 @@ .Os .Sh NAME .Nm rpc -.Nd rpc program number data base +.Nd rpc program number database .Sh DESCRIPTION The .Nm @@ -27,8 +27,7 @@ rpc program number aliases .El .Pp -Items are separated by any number of blanks and/or -tab characters. +Items are separated by any number of blanks and/or tab characters. .Pp A hash mark .Pq Ql # diff --git a/share/man/man5/services.5 b/share/man/man5/services.5 index 898fd7a9ca9..8ae7ae5b62c 100644 --- a/share/man/man5/services.5 +++ b/share/man/man5/services.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: services.5,v 1.8 2000/03/19 19:25:33 aaron Exp $ +.\" $OpenBSD: services.5,v 1.9 2000/10/26 00:37:05 aaron Exp $ .\" $NetBSD: services.5,v 1.3 1994/11/30 19:31:31 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -39,16 +39,15 @@ .Os .Sh NAME .Nm services -.Nd service name data base +.Nd service name database .Sh DESCRIPTION The .Nm -file contains information regarding -the known services available in the +file contains information regarding the known services available in the .Tn DARPA Internet. -For each service a single line should be present -with the following information: +For each service, a single line should be present with the +following information: .Bd -unfilled -offset indent official service name port number @@ -57,22 +56,18 @@ aliases .Ed .Pp Items are separated by any number of blanks and/or tab characters. -The port number and protocol name are considered a single item; -a slash +The port number and protocol name are considered a single item; a slash .Pq Ql / -is used to -separate the port and protocol (e.g., +is used to separate the port and protocol (e.g., .Dq 512/tcp ) . .Pp A hash mark .Pq Ql # -indicates the beginning of -a comment; subsequent characters up to the end of the line are -not interpreted by the routines which search the file. +indicates the beginning of a comment; subsequent characters up to the +end of the line are not interpreted by the routines which search the file. .Pp -Service names may contain any printable -character other than a field delimiter, newline, -or comment character. +Service names may contain any printable character other than a +field delimiter, newline, or comment character. .Sh FILES .Bl -tag -width /etc/services -compact .It Pa /etc/services diff --git a/share/man/man5/stab.5 b/share/man/man5/stab.5 index db5cca3410f..862e8dbeb29 100644 --- a/share/man/man5/stab.5 +++ b/share/man/man5/stab.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: stab.5,v 1.8 2000/02/29 04:48:39 aaron Exp $ +.\" $OpenBSD: stab.5,v 1.9 2000/10/26 00:37:05 aaron Exp $ .\" $NetBSD: stab.5,v 1.3 1994/11/30 19:31:33 jtc Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -59,8 +59,7 @@ and the Berkeley Pascal compiler Symbol table entries can be produced by the .Dq .stabs assembler directive. -This allows one to specify a double-quote delimited name, a symbol type, -one +This allows one to specify a double-quote delimited name, a symbol type, one .Li char and one .Li short @@ -75,8 +74,7 @@ directive can be used to implicitly address the current location. If no name is needed, symbol table entries can be generated using the .Dq .stabn directive. -The loader promises to preserve the order of symbol table entries produced -by +The loader promises to preserve the order of symbol table entries produced by .Dq .stab directives. As described in diff --git a/share/man/man5/utmp.5 b/share/man/man5/utmp.5 index 14fafb7d8cb..a140363284a 100644 --- a/share/man/man5/utmp.5 +++ b/share/man/man5/utmp.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: utmp.5,v 1.13 2000/02/29 04:48:39 aaron Exp $ +.\" $OpenBSD: utmp.5,v 1.14 2000/10/26 00:37:05 aaron Exp $ .\" $NetBSD: utmp.5,v 1.5 1994/11/30 19:31:35 jtc Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -38,7 +38,9 @@ .Dt UTMP 5 .Os .Sh NAME -.Nm utmp , wtmp , lastlog +.Nm utmp , +.Nm wtmp , +.Nm lastlog .Nd login records .Sh SYNOPSIS .Fd #include <utmp.h> @@ -53,14 +55,12 @@ file, logins and logouts in the file, and last logins in the .Nm lastlog file. -The time stamps of date changes, shutdowns, and reboots are also logged in -the +The time stamps of date changes, shutdowns, and reboots are also logged in the .Nm wtmp file. .Pp .Nm wtmp -can grow rapidly on busy systems, so daily or weekly rotation -is recommended. +can grow rapidly on busy systems, so daily or weekly rotation is recommended. If any one of these files does not exist, it is not created. They must be created manually and are maintained by .Xr newsyslog 8 . |