From 1f53fde168acc1d0dd0875ec542fe363338e18f8 Mon Sep 17 00:00:00 2001 From: aaron Date: Sun, 19 Mar 2000 19:25:21 +0000 Subject: [PATCH] Various cleanups. --- share/man/man1/cd.1 | 24 +++++----- share/man/man1/intro.1 | 15 ++++-- share/man/man1/wait.1 | 4 +- share/man/man3/assert.3 | 1 + share/man/man3/bitstring.3 | 1 + share/man/man3/dlfcn.3 | 24 ++++++---- share/man/man3/intro.3 | 32 +++++++------ share/man/man3/queue.3 | 4 +- share/man/man3/stdarg.3 | 11 +++-- share/man/man5/a.out.5 | 13 +++--- share/man/man5/acct.5 | 6 +-- share/man/man5/core.5 | 5 +- share/man/man5/disktab.5 | 12 +++-- share/man/man5/ethers.5 | 8 ++-- share/man/man5/fbtab.5 | 5 +- share/man/man5/fs.5 | 30 +++++++----- share/man/man5/group.5 | 5 +- share/man/man5/hostname.if.5 | 12 +++-- share/man/man5/hosts.5 | 13 ++++-- share/man/man5/hosts.equiv.5 | 20 +++++--- share/man/man5/link.5 | 87 ++++++++++++++++++++++------------- share/man/man5/netgroup.5 | 5 +- share/man/man5/passwd.5 | 5 +- share/man/man5/passwd.conf.5 | 36 ++++++++------- share/man/man5/phones.5 | 9 ++-- share/man/man5/protocols.5 | 8 ++-- share/man/man5/remote.5 | 36 +++++++++------ share/man/man5/resolv.conf.5 | 6 +-- share/man/man5/services.5 | 10 ++-- share/man/man7/environ.7 | 9 ++-- share/man/man7/mailaddr.7 | 32 +++++++------ share/man/man7/mdoc.7 | 9 ++-- share/man/man7/mdoc.samples.7 | 32 +++++++------ share/man/man7/operator.7 | 1 + share/man/man7/ports.7 | 60 +++++++++++++++--------- share/man/man7/securelevel.7 | 35 ++++++++------ 36 files changed, 372 insertions(+), 253 deletions(-) diff --git a/share/man/man1/cd.1 b/share/man/man1/cd.1 index c1889be163a..466c9e8b3e8 100644 --- a/share/man/man1/cd.1 +++ b/share/man/man1/cd.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cd.1,v 1.7 1999/06/05 13:18:30 aaron Exp $ +.\" $OpenBSD: cd.1,v 1.8 2000/03/19 19:25:21 aaron Exp $ .\" $NetBSD: cd.1,v 1.2 1994/11/30 08:34:59 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -59,16 +59,22 @@ environment variable (see below). Note that .Nm is implemented as a built-in command in all shells and not as a stand-alone -program. Because each process has its own working directory, a separate +program. +Because each process has its own working directory, a separate .Nm utility would have no effect (it would change the directory and exit, -leaving the working directory in the parent unchanged). Different -shells may implement +leaving the working directory in the parent unchanged). +Different shells may implement .Nm -with features different from those described here. Please consult -the manual for your specific shell. +with features different from those described here. +Please consult the manual for your specific shell. +.Pp +The +.Nm +utility exits 0 on success or >0 if an error occurred. .Sh ENVIRONMENT -The following environment variables affect the execution of cd: +The following environment variables affect the execution of +.Nm cd : .Pp .Bl -tag -width indent .It Ev CDPATH @@ -102,10 +108,6 @@ becomes the new working directory. See .Xr environ 7 for more information on environment variables. -.Pp -The -.Nm -utility exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr csh 1 , .Xr pwd 1 , diff --git a/share/man/man1/intro.1 b/share/man/man1/intro.1 index 3f6901c82d2..4f163b922f5 100644 --- a/share/man/man1/intro.1 +++ b/share/man/man1/intro.1 @@ -1,3 +1,4 @@ +.\" $OpenBSD: intro.1,v 1.5 2000/03/19 19:25:21 aaron Exp $ .\" $NetBSD: intro.1,v 1.4 1994/11/30 08:35:00 jtc Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -45,25 +46,29 @@ which comprise the .Bx user environment. Some of the commands included in section one are -text editors, command shell interpreters, +text editors, +command shell interpreters, searching and sorting tools, file manipulation commands, system status commands, -remote file copy commands, mail commands, +remote file copy commands, +mail commands, compilers and compiler tools, formatted output tools, and line printer commands. .Pp All commands set a status value upon exit which may be tested to see if the command completed normally. -The exit values and their meanings are explained in the individual -manuals. Traditionally, the value 0 signifies successful -completion of the command. +The exit values and their meanings are explained in the individual manuals. +Traditionally, the value 0 signifies successful completion of the command. .Sh SEE ALSO .Xr man 1 , .Xr intro 2 , .Xr intro 3 , .Xr intro 4 , +.Xr intro 5 , +.Xr intro 6 , +.Xr intro 7 , .Xr intro 8 .Pp Tutorials in the diff --git a/share/man/man1/wait.1 b/share/man/man1/wait.1 index 06a1f6cb893..3553695c6ba 100644 --- a/share/man/man1/wait.1 +++ b/share/man/man1/wait.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: wait.1,v 1.4 1998/12/16 03:05:34 aaron Exp $ +.\" $OpenBSD: wait.1,v 1.5 2000/03/19 19:25:22 aaron Exp $ .\" $NetBSD: wait.1,v 1.2 1994/11/30 08:35:03 jtc Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -98,6 +98,8 @@ information of .Nm contains that termination status as well. +.Sh SEE ALSO +.Xr wait 2 .Sh STANDARDS The .Nm diff --git a/share/man/man3/assert.3 b/share/man/man3/assert.3 index 672ac75df0a..6ab5cc4a39a 100644 --- a/share/man/man3/assert.3 +++ b/share/man/man3/assert.3 @@ -1,3 +1,4 @@ +.\" $OpenBSD: assert.3,v 1.4 2000/03/19 19:25:23 aaron Exp $ .\" $NetBSD: assert.3,v 1.5 1994/11/30 15:24:30 jtc Exp $ .\" .\" Copyright (c) 1991, 1993 diff --git a/share/man/man3/bitstring.3 b/share/man/man3/bitstring.3 index 7aaf15269e9..44d2d2703db 100644 --- a/share/man/man3/bitstring.3 +++ b/share/man/man3/bitstring.3 @@ -1,3 +1,4 @@ +.\" $OpenBSD: bitstring.3,v 1.7 2000/03/19 19:25:23 aaron Exp $ .\" $NetBSD: bitstring.3,v 1.4 1994/11/30 15:24:31 jtc Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 diff --git a/share/man/man3/dlfcn.3 b/share/man/man3/dlfcn.3 index fb225f878ea..5faff684be2 100644 --- a/share/man/man3/dlfcn.3 +++ b/share/man/man3/dlfcn.3 @@ -1,3 +1,4 @@ +.\" $OpenBSD: dlfcn.3,v 1.10 2000/03/19 19:25:23 aaron Exp $ .\" $NetBSD: dlfcn.3,v 1.3 1996/01/09 19:43:34 pk Exp $ .\" .\" Copyright (c) 1995 Paul Kranenburg @@ -51,13 +52,17 @@ These functions provide an interface to the run-time linker .Xr ld.so . They allow new shared objects to be loaded into a process's address space under program control. +.Pp The .Fn dlopen -function takes a name of a shared object as its first argument. The -shared object is mapped into the address space, relocated and its external +function takes a name of a shared object as its first argument. +The shared object is mapped into the address space, relocated, and its external references are resolved in the same way as is done with the implicitly loaded -shared libraries at program startup. The argument can either be an absolute -pathname or it can be of the form +shared libraries at program startup. +.Pp +The +.Fa path +argument can either be an absolute pathname or it can be of the form .Sm off .Do Xo lib Ao name Ac .so .Op .xx Op .yy Xc @@ -69,6 +74,7 @@ shared library searches. The second argument currently has no effect, but should be set to .Dv DL_LAZY for future compatibility. +.Pp .Fn dlopen returns a handle to be used in calls to .Fn dlclose , @@ -84,7 +90,8 @@ a handle referring to the resident copy is returned. .Fn dlclose unlinks and removes the object referred to by .Fa handle -from the process address space. If multiple calls to +from the process address space. +If multiple calls to .Fn dlopen have been done on this object .Po or the object was once loaded at startup time @@ -96,15 +103,16 @@ looks for a definition of .Fa symbol in the shared object designated by .Fa handle . -The symbol's address is returned. If the symbol cannot be resolved, +The symbol's address is returned. +If the symbol cannot be resolved, .Dv NULL is returned. .Pp .Fn dlctl provides an interface similar to .Xr ioctl 2 -to control several aspects of the run-time linker's operation. This interface -is +to control several aspects of the run-time linker's operation. +This interface is .Ud . .Pp .Fn dlerror diff --git a/share/man/man3/intro.3 b/share/man/man3/intro.3 index 587835a7cc1..228ac32c1df 100644 --- a/share/man/man3/intro.3 +++ b/share/man/man3/intro.3 @@ -1,3 +1,4 @@ +.\" $OpenBSD: intro.3,v 1.9 2000/03/19 19:25:24 aaron Exp $ .\" $NetBSD: intro.3,v 1.5 1995/05/10 22:46:24 jtc Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -52,8 +53,8 @@ must be indicated at compile time with the option of the compiler. .Pp The various libraries (followed by the loader flag): -.Bl -tag -width "libc (-lc)" -.It Xr libc Pq Fl l Ns Ar c +.Bl -tag -width Ds +.It libc Pq Fl l Ns Ar c Standard C library functions. When using the C compiler .Xr cc 1 , @@ -73,18 +74,19 @@ string operators, character tests and character operators, des encryption routines, storage allocation, time functions, signal handling and more. -.It Xr libc_r Pq Fl l Ns Ar c_r -Reentrant C library. Contains POSIX 1003.1c +.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 .Xr libc . -.It Xr libcurses Pq Fl l Ns Ar curses +.It libcurses Pq Fl l Ns Ar curses Terminal independent screen management routines for two dimensional non-bitmap display terminals. -(See -.Xr curses 3 . ) -.It Xr libcompat Pq Fl l Ns Ar compat +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, @@ -94,17 +96,19 @@ have been included for source code compatibility. Use of these routines should, for the most part, be avoided. The manual page entry for each compatibility routine indicates the proper interface to use. -.It Xr libkvm Pq Fl l Ns Ar kvm -Kernel virtual interface library. For more information, see +.It libkvm Pq Fl l Ns Ar kvm +Kernel virtual interface library. +See .Xr kvm 3 . -.It Xr libl Pq Fl l Ns Ar l +.It libl Pq Fl l Ns Ar l The library for .Xr lex 1 . -.It Xr libm Pq Fl l Ns Ar m +.It libm Pq Fl l Ns Ar m The math library, -.Em libm . See +.Em libm . +See .Xr math 3 . -.It Xr libtermcap Pq Fl l Ns Ar termcap +.It libtermcap Pq Fl l Ns Ar termcap The terminal independent operation library package. (See .Xr termcap 3 . ) .El diff --git a/share/man/man3/queue.3 b/share/man/man3/queue.3 index 3cfb6acd66b..a678b2d6e67 100644 --- a/share/man/man3/queue.3 +++ b/share/man/man3/queue.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: queue.3,v 1.8 1999/09/08 08:20:49 espie Exp $ +.\" $OpenBSD: queue.3,v 1.9 2000/03/19 19:25:24 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. @@ -445,6 +445,7 @@ macros can be used to traverse the list: .Bd -literal -offset indent for (np = SLIST_FIRST(&head); np != NULL; np = SLIST_NEXT(np, NAME)) .Ed +.Pp Or, for simplicity, one can use the .Fn SLIST_FOREACH macro: @@ -546,6 +547,7 @@ macros can be used to traverse the list: .Bd -literal -offset indent for (np = LIST_FIRST(&head); np != NULL; np = LIST_NEXT(np, NAME)) .Ed +.Pp Or, for simplicity, one can use the .Fn LIST_FOREACH macro: diff --git a/share/man/man3/stdarg.3 b/share/man/man3/stdarg.3 index 630627bfb88..6bdba6f39d6 100644 --- a/share/man/man3/stdarg.3 +++ b/share/man/man3/stdarg.3 @@ -1,3 +1,4 @@ +.\" $OpenBSD: stdarg.3,v 1.5 2000/03/19 19:25:25 aaron Exp $ .\" $NetBSD: stdarg.3,v 1.3 1994/11/30 15:24:37 jtc Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 @@ -57,13 +58,13 @@ types. The include file .Aq Pa stdarg.h declares a type -.Pq Em va_list +.Pq Li va_list and defines three macros for stepping through a list of arguments whose number and types are not known to the called function. .Pp The called function must declare an object of type -.Em va_list +.Li va_list which is used by the macros .Fn va_start , .Fn va_arg , @@ -101,7 +102,7 @@ argument in the call. The parameter .Fa ap is the -.Em va_list Fa ap +.Li va_list Fa ap initialized by .Fn va_start . Each call to @@ -114,7 +115,7 @@ The parameter is a type name specified so that the type of a pointer to an object that has the specified type can be obtained simply by adding a -.Dq \&* +.Ql * to .Fa type . .Pp @@ -203,6 +204,6 @@ code, but it also creates difficulties for variadic functions that wish to pass all of their arguments on to a function that takes a -.Em va_list +.Li va_list argument, such as .Xr vfprintf 3 . diff --git a/share/man/man5/a.out.5 b/share/man/man5/a.out.5 index 5631505eba5..fcf7de3b480 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.6 1999/09/23 04:12:06 alex Exp $ +.\" $OpenBSD: a.out.5,v 1.7 2000/03/19 19:25:26 aaron Exp $ .\" $NetBSD: a.out.5,v 1.8 1994/11/30 19:31:09 jtc Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -119,8 +119,8 @@ returns a few flags: .It Dv EX_DYNAMIC Indicates that the executable requires the services of the run-time link editor. .It Dv EX_PIC -Indicates that the object contains position independent code. This flag is -set by +Indicates that the object contains position independent code. +This flag is set by .Xr as 1 when given the .Fl k @@ -287,8 +287,8 @@ If set, the symbol, as identified by the field, is to be relocated to an offset into the Procedure Linkage Table. .It Fa r_relative If set, this relocation is relative to the (run-time) load address of the -image this object file is going to be a part of. This type of relocation -only occurs in shared objects. +image this object file is going to be a part of. +This type of relocation only occurs in shared objects. .It Fa r_copy If set, this relocation record identifies a symbol whose contents should be copied to the location given in @@ -399,7 +399,8 @@ the values are described in This field provides information on the nature of the symbol independent of the symbol's location in terms of segments as determined by the .Fa n_type -field. Currently, the lower 4 bits of the +field. +Currently, the lower 4 bits of the .Fa n_other field hold one of two values: .Dv AUX_FUNC diff --git a/share/man/man5/acct.5 b/share/man/man5/acct.5 index 96ee91ec52b..f4858861d6e 100644 --- a/share/man/man5/acct.5 +++ b/share/man/man5/acct.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: acct.5,v 1.5 1998/11/26 04:25:58 aaron Exp $ +.\" $OpenBSD: acct.5,v 1.6 2000/03/19 19:25:26 aaron Exp $ .\" $NetBSD: acct.5,v 1.4 1995/10/22 01:40:10 ghudson Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -46,8 +46,8 @@ The kernel maintains the following .Fa acct information structure for all -processes. If a process terminates, and accounting is enabled, -the kernel calls the +processes. +If a process terminates, and accounting is enabled, the kernel calls the .Xr acct 2 function call to prepare and append the record to the accounting file. diff --git a/share/man/man5/core.5 b/share/man/man5/core.5 index 9c9014f0519..fd6894bdb90 100644 --- a/share/man/man5/core.5 +++ b/share/man/man5/core.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: core.5,v 1.6 1999/07/09 13:35:38 aaron Exp $ +.\" $OpenBSD: core.5,v 1.7 2000/03/19 19:25:26 aaron Exp $ .\" $NetBSD: core.5,v 1.4 1994/11/30 19:31:11 jtc Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -71,7 +71,8 @@ defined by the .Dv UPAGES manifest in the .Aq Pa sys/param.h -file. The +file. +The .Fa u . area starts with a .Fa user diff --git a/share/man/man5/disktab.5 b/share/man/man5/disktab.5 index e65ee872c96..9558d6defa6 100644 --- a/share/man/man5/disktab.5 +++ b/share/man/man5/disktab.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: disktab.5,v 1.6 2000/03/19 19:25:27 aaron Exp $ .\" $NetBSD: disktab.5,v 1.4 1994/11/30 19:31:15 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -53,16 +54,17 @@ to initialize the disk label on the disk. The format is patterned after the .Xr termcap 5 -terminal database. Entries in +terminal database. +Entries in .Nm consist of a number of colon .Pq Sq \&: -separated fields. The -first entry for each disk gives the names which are +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 +characters. +The last name given should be a long name fully identifying the disk. .Pp The following list indicates the normal values diff --git a/share/man/man5/ethers.5 b/share/man/man5/ethers.5 index 02a7021d68d..eeafd7b7226 100644 --- a/share/man/man5/ethers.5 +++ b/share/man/man5/ethers.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ethers.5,v 1.10 1999/07/09 13:35:38 aaron Exp $ +.\" $OpenBSD: ethers.5,v 1.11 2000/03/19 19:25:27 aaron Exp $ .\" $NetBSD: ethers.5,v 1.2 1994/11/30 19:31:16 jtc Exp $ .\" .\" Written by Roland McGrath . Public domain. @@ -20,7 +20,8 @@ indicates the beginning of a comment; characters up to the end of the line are not interpreted by routines which search the file. .Pp Ethernet addresses are expressed as six hexadecimal numbers separated by -colons. The functions described in +colons. +The functions described in .Xr ethers 3 can read and produce this format. .Pp @@ -41,7 +42,8 @@ Lines in .Pa /etc/ethers are limited to .Dv BUFSIZE -characters (currently 1024). Longer lines will be ignored. +characters (currently 1024). +Longer lines will be ignored. .Sh HISTORY The .Nm diff --git a/share/man/man5/fbtab.5 b/share/man/man5/fbtab.5 index 5dec81633fe..5141cbc17f4 100644 --- a/share/man/man5/fbtab.5 +++ b/share/man/man5/fbtab.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fbtab.5,v 1.5 1999/11/11 06:33:27 ericj Exp $ +.\" $OpenBSD: fbtab.5,v 1.6 2000/03/19 19:25:28 aaron Exp $ .\" .Dd August 22, 1994 .Dt FBTAB 5 @@ -47,7 +47,8 @@ file is used by .Xr login 1 to .Xr chown 2 -the specified files to the user who has performed a login. As well, +the specified files to the user who has performed a login. +As well, .Xr chmod 2 is used to set the devices to the specified permission. When a user logs out, diff --git a/share/man/man5/fs.5 b/share/man/man5/fs.5 index 27fd7130108..a60de210abe 100644 --- a/share/man/man5/fs.5 +++ b/share/man/man5/fs.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fs.5,v 1.7 1999/07/09 13:35:38 aaron Exp $ +.\" $OpenBSD: fs.5,v 1.8 2000/03/19 19:25:28 aaron Exp $ .\" $NetBSD: fs.5,v 1.3 1994/11/30 19:31:17 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -165,10 +165,11 @@ A file system consists of a number of cylinder groups. Each cylinder group has inodes and data. .Pp A file system is described by its super-block, which in turn -describes the cylinder groups. The super-block is critical +describes the cylinder groups. +The super-block is critical data and is replicated in each cylinder group to protect against -catastrophic loss. This is done at file system creation -time and the critical +catastrophic loss. +This is done at file system creation time and the critical super-block data does not change, so the copies need not be referenced further unless disaster strikes. .Pp @@ -185,12 +186,14 @@ or some multiple of a .Dv DEV_BSIZE unit. .Pp -Large files consist of exclusively large data blocks. To avoid -undue wasted disk space, the last data block of a small file is +Large files consist of exclusively large data blocks. +To avoid undue wasted disk space, the last data block of a small file is allocated as only as many fragments of a large block as are -necessary. The file system format retains only a single pointer +necessary. +The file system format retains only a single pointer to such a fragment, which is a piece of a single large block that -has been divided. The size of such a fragment is determinable from +has been divided. +The size of such a fragment is determinable from information in the inode, using the .Fn blksize macro. @@ -209,8 +212,9 @@ Thus the root inode is 2. The .Fa fs_minfree element gives the minimum acceptable percentage of file system -blocks that may be free. If the freelist drops below this level -only the super-user may continue to allocate blocks. +blocks that may be free. +If the freelist drops below this level +only the superuser may continue to allocate blocks. The .Fa fs_minfree element @@ -245,7 +249,8 @@ the file system defaults to optimizing for time. .Ss Cylinder group related limits Each cylinder keeps track of the availability of blocks at different rotational positions, so that sequential blocks can be laid out -with minimum rotational latency. With the default of 8 distinguished +with minimum rotational latency. +With the default of 8 distinguished rotational positions, the resolution of the summary information is 2ms for a typical 3600 rpm drive. .Pp @@ -313,7 +318,8 @@ is limited by the fact that the super-block is of size .Dv SBSIZE . The size of these tables is inversely proportional to the block -size of the file system. The size of the tables is +size of the file system. +The size of the tables is increased when sector sizes are not powers of two, as this increases the number of cylinders included before the rotational pattern repeats diff --git a/share/man/man5/group.5 b/share/man/man5/group.5 index 498e6dcbceb..85058a52f94 100644 --- a/share/man/man5/group.5 +++ b/share/man/man5/group.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: group.5,v 1.5 1999/10/05 20:53:11 aaron Exp $ +.\" $OpenBSD: group.5,v 1.6 2000/03/19 19:25:28 aaron Exp $ .\" $NetBSD: group.5,v 1.4 1995/07/28 06:41:39 phil Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -48,7 +48,8 @@ consists of newline separated .Tn ASCII records, one per group, containing four colon .Pq Sq \&: -separated fields. These fields are as follows: +separated fields. +These fields are as follows: .Pp .Bl -tag -width password -offset indent -compact .It group diff --git a/share/man/man5/hostname.if.5 b/share/man/man5/hostname.if.5 index 70a46e13ccd..a2ec1554d22 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.18 2000/01/18 21:49:00 aaron Exp $ +.\" $OpenBSD: hostname.if.5,v 1.19 2000/03/19 19:25:29 aaron Exp $ .\" $NetBSD: hosts.5,v 1.4 1994/11/30 19:31:20 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -143,8 +143,8 @@ library routines. The prefixlen number, or number of bits in the netmask, to be set on the interface, such as 64. .It Va # -Comments are allowed. Anything following a comment -character is treated as a comment. +Comments are allowed. +Anything following a comment character is treated as a comment. .It Va ! Ar command-line Arbitrary shell commands can be executed using this directive. Useful for doing interface specific configuration using commands like @@ -257,8 +257,10 @@ The options are as follows: .Bl -tag -width indent -offset xxxx .It Va brconfig-arguments .Xr brconfig 8 -is called for each successive line. Comments starting with # are -permitted. +is called for each successive line. +Comments starting with +.Ql # +are permitted .El .Sh SEE ALSO .Xr hosts 5 , diff --git a/share/man/man5/hosts.5 b/share/man/man5/hosts.5 index 16c9b043414..b6bcd4b523e 100644 --- a/share/man/man5/hosts.5 +++ b/share/man/man5/hosts.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hosts.5,v 1.8 2000/01/05 01:04:14 deraadt Exp $ +.\" $OpenBSD: hosts.5,v 1.9 2000/03/19 19:25:29 aaron Exp $ .\" $NetBSD: hosts.5,v 1.4 1994/11/30 19:31:20 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -54,8 +54,9 @@ Aliases .Ed .Pp Items are separated by any number of blanks and/or -tab characters. A -.Dq # +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. @@ -87,7 +88,8 @@ 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 +and/or unknown hosts. +As the data base maintained at .Tn NIC is incomplete, use of the name server is recommended for sites on the @@ -125,7 +127,8 @@ Lines in .Pa /etc/hosts are limited to .Dv BUFSIZE -characters (currently 1024). Longer lines will be ignored. +characters (currently 1024). +Longer lines will be ignored. .Sh HISTORY The .Nm diff --git a/share/man/man5/hosts.equiv.5 b/share/man/man5/hosts.equiv.5 index 760fc3194ee..3e0d9162f0c 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.3 1998/11/29 15:47:24 aaron Exp $ +.\" $OpenBSD: hosts.equiv.5,v 1.4 2000/03/19 19:25:29 aaron Exp $ .\" .\" Copyright (c) 1997 Todd Vierling .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -84,7 +84,8 @@ wildcard (allow all remote users). If a .Ar username is specified, only that user from the specified host may login to the -local machine. If a +local machine. +If a .Ar username is not specified, any user may login with the same user name. .Sh EXAMPLES @@ -100,7 +101,8 @@ The user .Ar username on .Ar somehost -may login to the local host. If specified in +may login to the local host. +If specified in .Pa /etc/hosts.equiv , the user may login with only the same user name. .Ed @@ -116,8 +118,10 @@ may login to the local host from any machine listed in the netgroup + + .Ed .Bd -filled -offset indent -compact -Two severe security hazards. In the first case, allows a user on any -machine to login to the local host as the same user name. In the second +Two severe security hazards. +In the first case, allows a user on any +machine to login to the local host as the same user name. +In the second case, allows any user on any machine to login to the local host (as any user, if in .Pa /etc/hosts.equiv ) . @@ -126,7 +130,8 @@ user, if in The user name checks provided by this mechanism are .Em not secure, as the remote user name is received by the server unchecked -for validity. Therefore this mechanism should only be used +for validity. +Therefore this mechanism should only be used in an environment where all hosts are completely trusted. .Pp A numeric host address instead of a host name can help security @@ -153,7 +158,8 @@ Logins as root only check root's .Pa .rhosts file; the .Pa /etc/hosts.equiv -file is not checked for security. Access permitted through root's +file is not checked for security. +Access permitted through root's .Pa .rhosts file is typically only for .Xr rsh 1 , diff --git a/share/man/man5/link.5 b/share/man/man5/link.5 index 7f0d6cf4524..0e966ab9b9b 100644 --- a/share/man/man5/link.5 +++ b/share/man/man5/link.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: link.5,v 1.6 1998/11/26 04:25:58 aaron Exp $ +.\" $OpenBSD: link.5,v 1.7 2000/03/19 19:25:30 aaron Exp $ .\" $NetBSD: link.5,v 1.5 1996/01/09 00:14:32 pk Exp $ .\" .\" Copyright (c) 1993 Paul Kranenburg @@ -43,14 +43,17 @@ The include file 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 +link editor and loader mechanism. +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. It also records a number of data structures -unique to the dynamic loading and linking process. These include references +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 .Em Position Independent Code @@ -64,39 +67,47 @@ format offers no room for it elsewhere. .Pp Several utilities co-operate to ensure that the task of getting a program ready to run can complete successfully in a way that optimizes the use -of system resources. The compiler emits PIC code from which shared libraries -can be built by +of system resources. +The compiler emits PIC code from which shared libraries can be built by .Xr ld 1 . The compiler also includes size information of any initialized data items through the .Dq .size -assembler directive. PIC code differs from conventional code +assembler directive. +PIC code differs from conventional code in that it accesses data variables through an indirection table, the Global Offset Table, by convention accessible by the reserved name .Dv _GLOBAL_OFFSET_TABLE_ . 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 +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. .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. Again, this is done to avoid run-time modifications to the text segment. +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 when combining PIC object files into an image suitable for mapping into the -process address space. It also collects all symbols that may be needed by the +process address space. +It also collects all symbols that may be needed by the run-time link editor and stores these along with the image's text and data bits. Another reserved symbol, .Dv _DYNAMIC -is used to indicate the presence of the run-time linker structures. Whenever +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 +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, +be derived. +This is most notably used by the start-up module, .Em crt0 . The .Dv _DYNAMIC @@ -118,17 +129,18 @@ structure: .Bd -literal -offset indent struct _dynamic { int d_version; - struct so_debug *d_debug; + struct so_debug *d_debug; union { struct section_dispatch_table *d_sdt; } d_un; - struct ld_entry *d_entry; + struct ld_entry *d_entry; }; .Ed .Bl -tag -width d_version .It Fa d_version This field provides for different versions of the dynamic linking -implementation. The current version numbers understood by ld and +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), @@ -177,7 +189,8 @@ struct section_dispatch_table { .Pp .Bl -tag -width sdt_loaded .It Fa sdt_loaded -A pointer to the first link map loaded (see below). This field is set by +A pointer to the first link map loaded (see below). +This field is set by .Xr ld.so for the benefit of debuggers that may use it to load a shared object's symbol table. @@ -185,8 +198,8 @@ symbol table. The start of a (linked) list of shared object descriptors needed by this object. .It Fa sdt_paths -Library search rules. A colon separated list of directories corresponding -to the +Library search rules. +A colon separated list of directories corresponding to the .Fl R option of .Xr ld 1 . @@ -316,12 +329,15 @@ structure. Hook for attaching private data maintained by the run-time link editor. .El .Pp -Symbol description with size. This is simply an +Symbol description with size. +This is simply an .Fa nlist structure with one field .Pq Fa nz_size -added. Used to convey size information on items in the data segment -of shared objects. An array of these lives in the shared object's +added. +Used to convey size information on items in the data segment +of shared objects. +An array of these lives in the shared object's text segment and is addressed by the .Fa sdt_nzlist field of @@ -370,14 +386,15 @@ The index of the symbol in the shared object's symbol table (as given by the field). .It Fa rh_next In case of collisions, this field is the offset of the next entry in this -hash table bucket. It is zero for the last bucket element. +hash table bucket. +It is zero for the last bucket element. .El .Pp The .Fa rt_symbol structure is used to keep track of run-time allocated commons -and data items copied from shared objects. These items are kept on linked list -and is exported through the +and data items copied from shared objects. +These items are kept on linked list and is exported through the .Fa dd_cc field in the .Fa so_debug @@ -399,7 +416,8 @@ The symbol description. Virtual address of next .Fa rt_symbol . .It Fa rt_link -Next in hash bucket. Used by internally by +Next in hash bucket. +Used by internally by .Xr ld.so . .It Fa rt_srcaddr Location of the source of initialized data within a shared object. @@ -412,7 +430,8 @@ The .Fa so_debug structure is used by debuggers to gain knowledge of any shared objects that have been loaded in the process's address space as a result of run-time -link-editing. Since the run-time link editor runs as a part of process +link-editing. +Since the run-time link editor runs as a part of process initialization, a debugger that wishes to access symbols from shared objects can only do so after the link editor has been called from .Em crt0 . @@ -427,7 +446,7 @@ struct so_debug { int dd_version; int dd_in_debugger; int dd_sym_loaded; - char *dd_bpt_addr; + char *dd_bpt_addr; int dd_bpt_shadow; struct rt_symbol *dd_cc; }; @@ -443,8 +462,8 @@ run under control of a debugger. Set by the run-time linker whenever it adds symbols by loading shared objects. .It Fa dd_bpt_addr The address where a breakpoint will be set by the run-time linker to -divert control to the debugger. This address is determined by the start-up -module, +divert control to the debugger. +This address is determined by the start-up module, .Em crt0.o , to be some convenient place before the call to .Fa _main . @@ -507,7 +526,8 @@ was loaded by .It Fa crt_dzfd On SunOS systems, this field contains an open file descriptor to .Pa /dev/zero -used to get demand paged zeroed pages. On +used to get demand paged zeroed pages. +On .Ox systems it contains -1. .It Fa crt_ldfd @@ -584,7 +604,8 @@ Size of strings. Maximum usable offset in hints file. .It Fa hh_dirlist Offset in string table of a colon-separated list of directories that was -used in constructing the hints file. See also +used in constructing the hints file. +See also .Xr ldconfig 8 . This field is only available with interface version number .Dv LD_HINTS_VERSION_2 diff --git a/share/man/man5/netgroup.5 b/share/man/man5/netgroup.5 index 59169ce0b69..ff61e9a9e52 100644 --- a/share/man/man5/netgroup.5 +++ b/share/man/man5/netgroup.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: netgroup.5,v 1.7 1999/07/09 13:35:38 aaron Exp $ +.\" $OpenBSD: netgroup.5,v 1.8 2000/03/19 19:25:30 aaron Exp $ .\" $NetBSD: netgroup.5,v 1.3 1995/03/18 14:58:34 cgd Exp $ .\" .\" Copyright (c) 1992, 1993 @@ -92,7 +92,8 @@ file which can be generated using .Xr netgroup_mkdb . If that file is not present, and the system supports NIS, then the .Nm -NIS maps are used. The NIS maps are also used if the +NIS maps are used. +The NIS maps are also used if the .Nm file contains a .Dq + diff --git a/share/man/man5/passwd.5 b/share/man/man5/passwd.5 index c1f7b8c3b6b..4385223ab55 100644 --- a/share/man/man5/passwd.5 +++ b/share/man/man5/passwd.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: passwd.5,v 1.13 2000/03/01 18:01:22 aaron Exp $ +.\" $OpenBSD: passwd.5,v 1.14 2000/03/19 19:25:31 aaron Exp $ .\" $NetBSD: passwd.5,v 1.4 1995/07/28 06:46:05 phil Exp $ .\" .\" Copyright (c) 1988, 1991, 1993 @@ -47,7 +47,8 @@ The file, readable only by root, consists of newline-separated records, one per user, containing ten colon .Pq Sq \&: -separated fields. These fields are as follows: +separated fields. +These fields are as follows: .Pp .Bl -tag -width password -offset indent -compact .It name diff --git a/share/man/man5/passwd.conf.5 b/share/man/man5/passwd.conf.5 index ca45ef801c2..d215df0a0a2 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.8 1999/07/09 13:35:38 aaron Exp $ +.\" $OpenBSD: passwd.conf.5,v 1.9 2000/03/19 19:25:31 aaron Exp $ .\" .\" Copyright 1997 Niels Provos .\" All rights reserved. @@ -42,8 +42,8 @@ file, consisting of 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 +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. .Pp @@ -51,12 +51,11 @@ To differentiate between user and group stanzas, groups are prefixed with a single dot .Pq Sq \&. . .Pp -Some of the fields and their possible values that can appear in -this file are: -.Pp -.Bl -tag -width localcipher -offset indent -.It localcipher -The cipher to use for local passwords. Possible values are: +Some fields and their possible values that can appear in this file are: +.Bl -tag -width localcipher +.It Sy localcipher +The cipher to use for local passwords. +Possible values are: .Dq old , .Dq newsalt, , .Dq md5 , @@ -67,19 +66,20 @@ For the value of rounds is a 24-bit integer with a minmum of 7250 rounds. For .Dq blowfish -the value can be between 4 and 31. It specifies the base 2 logarithm of -the number of rounds. -.It ypcipher -The cipher to use for YP passwords. The possible values are the same as -for localcipher. +the value can be between 4 and 31. +It specifies the base 2 logarithm of the number of rounds. +.It Sy ypcipher +The cipher to use for YP passwords. +The possible values are the same as for localcipher. .El .Pp To retrieve information from this file use .Xr pw_getconf 3 . .Pp -.Sh EXAMPLE +.Sh EXAMPLES Use blowfish as the local cipher; add some more rounds for root and wheel -members. The old Unix crypt is used as YP cipher: +members. +The old Unix crypt is used as YP cipher: .Bd -literal default: localcipher = blowfish,4 @@ -91,6 +91,10 @@ members. The old Unix crypt is used as YP cipher: .wheel: localcipher = blowfish,5 .Ed +.Sh FILES +.Bl -tag -width /etc/passwd.conf -compact +.It Pa /etc/passwd.conf +.El .Sh SEE ALSO .Xr passwd 1 , .Xr pw_getconf 3 , diff --git a/share/man/man5/phones.5 b/share/man/man5/phones.5 index 0279ca42368..c161b137649 100644 --- a/share/man/man5/phones.5 +++ b/share/man/man5/phones.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: phones.5,v 1.4 2000/03/01 18:01:21 aaron Exp $ +.\" $OpenBSD: phones.5,v 1.5 2000/03/19 19:25:31 aaron Exp $ .\" $NetBSD: phones.5,v 1.3 1994/11/30 19:31:25 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -56,10 +56,11 @@ The system name is one of those defined in the file and the phone number is constructed from any sequence of characters terminated only by .Ql \&, -or the end of the line. The +or the end of the line. +The .Ql = and -.Ql \&* +.Ql * characters are indicators to the auto call units to pause and wait for a second dial tone (when going through an exchange). @@ -68,7 +69,7 @@ The is required by the .Tn DF02-AC and the -.Ql \&* +.Ql * is required by the .Tn BIZCOMP 1030. diff --git a/share/man/man5/protocols.5 b/share/man/man5/protocols.5 index 242652afacf..ed5693c5983 100644 --- a/share/man/man5/protocols.5 +++ b/share/man/man5/protocols.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: protocols.5,v 1.6 2000/02/29 04:48:39 aaron Exp $ +.\" $OpenBSD: protocols.5,v 1.7 2000/03/19 19:25:32 aaron Exp $ .\" $NetBSD: protocols.5,v 1.3 1994/11/30 19:31:27 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -45,7 +45,8 @@ The .Nm file contains information regarding the known protocols used in the .Tn DARPA -Internet. For each protocol a single line should be present +Internet. +For each protocol a single line should be present with the following information: .Bd -unfilled -offset indent official protocol name @@ -77,7 +78,8 @@ Lines in .Pa /etc/protocols are limited to .Dv BUFSIZ -characters (currently 1024). Longer lines will be ignored. +characters (currently 1024). +Longer lines will be ignored. .Sh HISTORY The .Nm diff --git a/share/man/man5/remote.5 b/share/man/man5/remote.5 index e4012183fae..1030ef93058 100644 --- a/share/man/man5/remote.5 +++ b/share/man/man5/remote.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: remote.5,v 1.6 2000/02/29 04:48:39 aaron Exp $ +.\" $OpenBSD: remote.5,v 1.7 2000/03/19 19:25:32 aaron Exp $ .\" $NetBSD: remote.5,v 1.4 1997/04/20 00:05:27 mellon Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -48,7 +48,8 @@ and their attributes are stored in an file which is structured somewhat like the .Xr termcap 5 -file. Each line in the file provides a description for a single +file. +Each line in the file provides a description for a single .Xr system . Fields are separated by a colon .Pq Sq \&: . @@ -57,14 +58,15 @@ Lines ending with a 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 +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 .Pq Sq \&| . -After the name of the system comes the fields of the description. A -field name followed by an equal sign +After the name of the system comes the fields of the description. +A field name followed by an equal sign .Pq Sq = -indicates a string value follows. A field -name followed by a pound sign +indicates a string value follows. +A field name followed by a pound sign .Pq Sq # indicates a following numeric value. .Pp @@ -78,20 +80,23 @@ and the .Xr cu interface to .Xr tip , -as follows. When +as follows. +When .Xr tip 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. When the +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). A string capability is specified by +flags (bool). +A string capability is specified by .Em capability Ns Ar = Ns Em value ; for example, .Dq dv=/dev/harris . @@ -114,8 +119,8 @@ The default baud rate is 300 baud. .It Sy \&cm (str) An initial connection message to be sent -to the remote host. For example, if a -host is reached through port selector, this +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. .It Sy \&cu @@ -181,7 +186,8 @@ string is sent at end-of-file. .It Sy \&pa (str) The type of parity to use when sending data -to the host. This may be one of +to the host. +This may be one of .Dq even , .Dq odd , .Dq none , @@ -204,8 +210,8 @@ file for a list of telephone numbers (see .It Sy \&tc (str) Indicates that the list of capabilities is continued -in the named description. This is used -primarily to share common capability information. +in the named description. +This is used primarily to share common capability information. .El .Pp Here is a short example showing the use of the capability continuation diff --git a/share/man/man5/resolv.conf.5 b/share/man/man5/resolv.conf.5 index e44011e261d..af28bc4872d 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.11 2000/02/14 13:23:54 itojun Exp $ +.\" $OpenBSD: resolv.conf.5,v 1.12 2000/03/19 19:25:33 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. @@ -213,8 +213,8 @@ to a space-separated list of resolver options as explained above. 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. +must start the line. +The value follows the keyword, separated by whitespace. .Sh FILES .Bl -tag -width /etc/resolv.conf -compact .It Pa /etc/resolv.conf diff --git a/share/man/man5/services.5 b/share/man/man5/services.5 index ff81e755ba8..898fd7a9ca9 100644 --- a/share/man/man5/services.5 +++ b/share/man/man5/services.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: services.5,v 1.7 2000/02/29 04:48:39 aaron Exp $ +.\" $OpenBSD: services.5,v 1.8 2000/03/19 19:25:33 aaron Exp $ .\" $NetBSD: services.5,v 1.3 1994/11/30 19:31:31 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -56,9 +56,8 @@ protocol name 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; +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 .Pq Ql / is used to @@ -86,7 +85,8 @@ Lines in .Pa /etc/services are limited to .Dv BUFSIZ -characters (currently 1024). Longer lines will be ignored. +characters (currently 1024). +Longer lines will be ignored. .Sh HISTORY The .Nm diff --git a/share/man/man7/environ.7 b/share/man/man7/environ.7 index ee313935f7d..43fdd93699d 100644 --- a/share/man/man7/environ.7 +++ b/share/man/man7/environ.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: environ.7,v 1.8 2000/02/14 15:19:47 aaron Exp $ +.\" $OpenBSD: environ.7,v 1.9 2000/03/19 19:25:34 aaron Exp $ .\" $NetBSD: environ.7,v 1.4 1995/07/03 19:45:07 jtc Exp $ .\" .\" Copyright (c) 1983, 1990, 1993 @@ -47,7 +47,8 @@ An array of strings called the .Dq environment is made available by .Xr execve 2 -when a process begins. By convention these strings have the form +when a process begins. +By convention these strings have the form .Ar name Ns No = Ns Ar value . The following variables are recognized by various commands: .Bl -tag -width BLOCKSIZE @@ -141,8 +142,8 @@ and .Xr termcap . .It Ev TERMPATH A sequence of pathnames of termcap files, separated by colons or spaces, -which are searched for terminal descriptions in the order listed. Having -no +which are searched for terminal descriptions in the order listed. +Having no .Ev TERMPATH is equivalent to a .Ev TERMPATH diff --git a/share/man/man7/mailaddr.7 b/share/man/man7/mailaddr.7 index 6fa52345647..31122b2de70 100644 --- a/share/man/man7/mailaddr.7 +++ b/share/man/man7/mailaddr.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mailaddr.7,v 1.4 1999/05/23 14:11:09 aaron Exp $ +.\" $OpenBSD: mailaddr.7,v 1.5 2000/03/19 19:25:34 aaron Exp $ .\" $NetBSD: mailaddr.7,v 1.3 1994/11/30 19:07:17 jtc Exp $ .\" .\" Copyright (c) 1983, 1987, 1990, 1993 @@ -42,12 +42,13 @@ .Nd mail addressing description .Sh DESCRIPTION Mail addresses are based on the Internet protocol listed at the end of this -manual page. These addresses are in the general format +manual page. +These addresses are in the general format .Pp .Dl user@domain .Pp -where a domain is a hierarchical dot separated list of subdomains. For -example, a valid address is: +where a domain is a hierarchical dot separated list of subdomains. +For example, a valid address is: .Pp .Dl eric@CS.Berkeley.EDU .Pp @@ -59,7 +60,8 @@ to CS over the Ethernet rather than going via the Berkeley Internet gateway. .Ss Abbreviation Under certain circumstances it may not be necessary to type the entire -domain name. In general, anything following the first dot may be omitted +domain name. +In general, anything following the first dot may be omitted if it is the same as the domain from which you are sending the message. For example, a user on .Dq calder.berkeley.edu @@ -71,7 +73,8 @@ since it is the same on both sending and receiving hosts. .Ss Compatibility Certain old address formats are converted to the new format to provide -compatibility with the previous mail system. In particular, +compatibility with the previous mail system. +In particular, .Pp .Dl user@host .Pp @@ -103,14 +106,17 @@ on for compatibility with older UUCP hosts. Domain names (i.e., anything after the .Dq @ sign) may be given in any mixture -of upper and lower case with the exception of UUCP hostnames. Most hosts +of upper and lower case with the exception of UUCP hostnames. +Most hosts accept any combination of case in user names, with the notable exception of MULTICS sites. .Ss Route-addrs Under some circumstances it may be necessary to route a message through -several hosts to get it to the final destination. Normally this routing +several hosts to get it to the final destination. +Normally this routing is done automatically, but sometimes it is desirable to route the message -manually. Addresses which show these relays are termed +manually. +Addresses which show these relays are termed .Dq route-addrs . These use the syntax: .Pp @@ -127,8 +133,8 @@ path to .Dq hostc . .Pp Route-addrs occur frequently on return addresses, since these are generally -augmented by the software at each host. It is generally possible to ignore -all but the +augmented by the software at each host. +It is generally possible to ignore all but the .Dq user@hostc part of the address to determine the actual sender. .Pp @@ -151,8 +157,8 @@ Some other networks can be reached by giving the name of the network as the last component of the domain. .Em This is not a standard feature and may -not be supported at all sites. For example, messages to CSNET or BITNET sites -can often be sent to +not be supported at all sites. +For example, messages to CSNET or BITNET sites can often be sent to .Dq user@host.CSNET or .Dq user@host.BITNET , diff --git a/share/man/man7/mdoc.7 b/share/man/man7/mdoc.7 index 3a1cb145a47..c731695ce19 100644 --- a/share/man/man7/mdoc.7 +++ b/share/man/man7/mdoc.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdoc.7,v 1.13 2000/03/04 22:19:33 aaron Exp $ +.\" $OpenBSD: mdoc.7,v 1.14 2000/03/19 19:25:34 aaron Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -58,8 +58,8 @@ a detailed explanation on using the package, see the tutorial sampler .Xr mdoc.samples 7 . .Pp -The macros are described in two groups. The first -includes the structural and physical page layout macros. +The macros are described in two groups. +The first includes the structural and physical page layout macros. The second contains the manual and general text domain macros which differentiate the .Nm -\mdoc @@ -188,7 +188,8 @@ is used. End-display (matches \&.Bd). .It Li \&.Bl Begin-list. -Create lists or columns. Options: +Create lists or columns. +Options: .Bl -tag -width flag -compact .It Em List-types .Bl -column "xbullet " -compact diff --git a/share/man/man7/mdoc.samples.7 b/share/man/man7/mdoc.samples.7 index 09b47367691..9b526ca519f 100644 --- a/share/man/man7/mdoc.samples.7 +++ b/share/man/man7/mdoc.samples.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdoc.samples.7,v 1.21 2000/03/04 22:19:33 aaron Exp $ +.\" $OpenBSD: mdoc.samples.7,v 1.22 2000/03/19 19:25:35 aaron Exp $ .\" $NetBSD: mdoc.samples.7,v 1.5 1996/04/03 20:17:34 jtc Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -73,7 +73,8 @@ page layout macros make up the .Em "page structure domain" which consists of macros for titles, section headers, displays -and lists. Essentially items which affect the physical position +and lists. +Essentially items which affect the physical position of text on a formatted page. In addition to the page structure domain, there are two more domains, the manual domain and the general text domain. @@ -758,8 +759,8 @@ The result is: .Dl Li sptr, ptr), .Pp The punctuation is not recognized and all is output in the -literal font. If the punctuation is separated by a leading -whitespace: +literal font. +If the punctuation is separated by a leading whitespace: .Pp .Dl \&.Li "sptr , ptr ) ," .Pp @@ -1073,7 +1074,8 @@ and may be used with .Ql \&.Fa (function argument) -to get around the limitation. For example: +to get around the limitation. +For example: .Bd -literal -offset indent \&.Fo "int res_mkquery" \&.Fa "int op" @@ -1131,8 +1133,8 @@ section. It may be used anywhere else in the man page without problems, but in the .Sx SYNOPSIS -section it causes a line break after its use. Its main purpose -is to present the function type in kernel normal form +section it causes a line break after its use. +Its main purpose is to present the function type in kernel normal form of a section two or three man page by forcing the function name to appear on the next line. .Pp @@ -1382,7 +1384,8 @@ macro is .Em not parsed and .Em not -callable. It accepts at most two arguments. +callable. +It accepts at most two arguments. .Ss BSD Macro .Dl Usage: .Bx [Version/release] ... \*(Pu .Bl -tag -width ".Bx 4.3 ) ," -compact -offset 14n @@ -1499,7 +1502,8 @@ All handle punctuation properly, as long as it is presented one character at a time and separated by spaces. The quoting macros examine opening and closing punctuation to determine whether it comes before or after the -enclosing string. This makes some nesting possible. +enclosing string. +This makes some nesting possible. .Bl -tag -width xxx,xxxx .It Li \&.Ec , \&.Eo These macros expect the first argument to be the @@ -1511,8 +1515,8 @@ than .Xr nroff . If formatted with .Xr nroff , -a quoted literal is always quoted. If formatted with -troff, an item is only quoted if the width +a quoted literal is always quoted. +If formatted with troff, an item is only quoted if the width of the item is less than three constant width characters. This is to make short strings more visible where the font change to literal (constant width) is less noticeable. @@ -1849,8 +1853,7 @@ The .Sx SYNOPSIS section describes the typical usage of the subject of a man page. -The macros required -are either +The macros required are either .Ql ".Nm" , .Ql ".Cd" , .Ql ".Fn" , @@ -1969,7 +1972,8 @@ macro. Cross references in the .Sx SEE ALSO section should be sorted by section number, and then -placed in alphabetical order and comma separated. For example: +placed in alphabetical order and comma separated. +For example: .Pp .Xr ls 1 , .Xr ps 1 , diff --git a/share/man/man7/operator.7 b/share/man/man7/operator.7 index 76c0c2fc6e5..dd0bd4f582d 100644 --- a/share/man/man7/operator.7 +++ b/share/man/man7/operator.7 @@ -1,3 +1,4 @@ +.\" $OpenBSD: operator.7,v 1.3 2000/03/19 19:25:36 aaron Exp $ .\" $NetBSD: operator.7,v 1.3 1994/11/30 19:07:26 jtc Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 diff --git a/share/man/man7/ports.7 b/share/man/man7/ports.7 index 66585d794c4..7174c3aea5f 100644 --- a/share/man/man7/ports.7 +++ b/share/man/man7/ports.7 @@ -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: ports.7,v 1.8 2000/01/29 20:22:30 espie Exp $ +.\" $OpenBSD: ports.7,v 1.9 2000/03/19 19:25:37 aaron Exp $ .\" $FreeBSD: ports.7,v 1.7 1998/06/23 04:38:50 hoek Exp $ .\" .Dd January 25, 1998 @@ -40,15 +40,16 @@ for users and administrators to install applications. Each .Em port contains any patches necessary to make the original -application source code compile and run on BSD. Compiling an -application is as simple as typing +application source code compile and run on BSD. +Compiling an application is as simple as typing .Ic make -in the port directory! The +in the port directory! +The .Pa Makefile automatically fetches the application source code, either from a local disk or via ftp, unpacks it -on the local system, applies the patches, and compiles it. If all goes well, -simply type +on the local system, applies the patches, and compiles it. +If all goes well, simply type .Ic sudo make install to install the application. .Pp @@ -85,18 +86,20 @@ retrieve information relevant to a given port. Individual ports are controlled through a few documented targets. Some of these targets work recursively through subdirectories, so that someone can, for examples, install all of the net -ports. The targets that do this are +ports. +The targets that do this are .Ar build , checksum , clean , configure , extract , fetch , fetch-list , .Ar install , distclean , deinstall, reinstall, mirror-distfiles, obj , .Ar list-distfiles and .Ar package . .Pp -Target names starting with _ are private to the ports infrastructure, +Target names starting with _ are private to the ports infrastructure, should not be invoked directly, and are liable to change without notice. .Pp In the following list, each target will run the preceeding targets -in order automatically. That is, +in order automatically. +That is, .Ar build will be run .Pq if necessary @@ -132,7 +135,8 @@ will skip this step. .It Ar depends Install .Pq or compile if only compilation is necessary -any dependencies of the current port. When called by the +any dependencies of the current port. +When called by the .Ar extract, install or .Ar fetch @@ -148,17 +152,19 @@ Expand the distfile into a work directory. .It Ar patch Apply any patches that are necessary for the port. .It Ar configure -Configure the port. Some ports will ask questions during -this stage. See +Configure the port. +Some ports will ask questions during this stage. +See .Ev INTERACTIVE and .Ev BATCH . .It Ar build -Build the port. This is the same as calling the +Build the port. +This is the same as calling the .Ar all target. .It Ar install -Install the port and register it with the package system. +Install the port and register it with the package system. .El .Pp The following targets are not run during the normal install process. @@ -169,20 +175,23 @@ build the port. .It Ar depends-list package-depends Print an ordered list of all the compile and run dependencies. .It Ar clean -Remove the expanded source code. This does not recurse to dependencies unless +Remove the expanded source code. +This does not recurse to dependencies unless .Ev CLEANDEPENDS is defined to .Dv Yes . .It Ar distclean Remove the port's distfile(s) and perform the .Ar clean -operation. This does not recurse to dependencies. +operation. +This does not recurse to dependencies. .It Ar reinstall Use this to restore a port after using .Xr pkg_delete 1 . .It Ar package -Make a binary package for the port. The port will be installed if it -hasn't already been. The package is a .tgz file that can be used to +Make a binary package for the port. +The port will be installed if it hasn't already been. +The package is a .tgz file that can be used to install the port on other machines with .Xr pkg_add 1 . If the directory specified by @@ -196,7 +205,8 @@ and .Sh PORT VARIABLES These can be changed in the environment, or in .Pa /etc/mk.conf -for persistence. They can also be set on make's command line, e.g., +for persistence. +They can also be set on make's command line, e.g., .Ic make VAR_FOO=foo .Pp Boolean variables should be set to @@ -216,7 +226,8 @@ and edit it. .Pp .Bl -tag -width MASTER_SITES .It Ev PORTSDIR -Location of the ports tree. This is +Location of the ports tree. +This is .Pa /usr/ports on .\" .Fx @@ -285,7 +296,8 @@ recurse to dependencies (deprecated, use .Ev CLEANDEPENDS instead). .It Ev FETCH_CMD -Command to use to fetch files. Normally +Command to use to fetch files. +Normally .Xr fetch 1 . .It Ev FORCE_PKG_REGISTER If set, overwrite any existing package registration on the system. @@ -326,8 +338,10 @@ The FreeBSD handbook. This man page was originated by David O'Brien. The FreeBSD ports collection is maintained by Satoshi Asami -and the awesome ports team. The OpenBSD ports collection has been maintained by -Marco S Hyman in the past. It is currently managed by Christopher Turan, +and the awesome ports team. +The OpenBSD ports collection has been maintained by +Marco S Hyman in the past. +It is currently managed by Christopher Turan, with much help from Brad Smith and a host of others found at ports@openbsd.org. .Sh HISTORY diff --git a/share/man/man7/securelevel.7 b/share/man/man7/securelevel.7 index 99436ee2058..4f0652c7a91 100644 --- a/share/man/man7/securelevel.7 +++ b/share/man/man7/securelevel.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: securelevel.7,v 1.6 2000/02/27 04:59:10 hugh Exp $ +.\" $OpenBSD: securelevel.7,v 1.7 2000/03/19 19:25:37 aaron Exp $ .\" .\" Copyright (c) 2000 Hugh Graham .\" @@ -67,7 +67,7 @@ and .Pa /dev/kmem may not be written to .It -raw disk devices of mounted filesystems are read-only +raw disk devices of mounted file systems are read-only .It system immutable and append-only file flags may not be removed .It @@ -99,34 +99,40 @@ variables may not be raised .Sh DESCRIPTION Securelevel provides convenient means of .Dq locking down -a system to a degree suited to its environment. It is normally set at -boot via the +a system to a degree suited to its environment. +It is normally set at boot via the .Xr rc.securelevel 8 script, or the superuser may raise securelevel at any time by modifying the .Va kern.securelevel .Xr sysctl 8 -variable. However, only +variable. +However, only .Xr init 8 -may lower it once the system has entered secure mode. A kernel built with -.Dq option INSECURE +may lower it once the system has entered secure mode. +A kernel built with +.Cm option INSECURE in the config file will default to permanently insecure mode. .Pp Highly secure mode may seem Draconian, but is intended as a last line of -defence should the superuser account be compromised. Its effects preclude +defence should the superuser account be compromised. +Its effects preclude circumvention of file flags by direct modification of a raw disk device, -or erasure of a filesystem by means of +or erasure of a file system by means of .Xr newfs 8 . Further, it can limit the potential damage of a compromised .Dq firewall -by prohibiting the modification of packet filter rules. Preventing +by prohibiting the modification of packet filter rules. +Preventing the system clock from being set backwards aids in post-mortem analysis -and helps ensure the integrity of logs. Precision timekeeping is not +and helps ensure the integrity of logs. +Precision timekeeping is not affected because the clock may still be slowed. .Pp Because securelevel can be modified with the in-kernel debugger .Xr ddb 4 , a convenient means of locking it off (if present) is provided -on highly secure systems. This is accomplished by setting +on highly secure systems. +This is accomplished by setting .Va ddb.console and .Va ddb.panic @@ -144,11 +150,10 @@ utility. .Xr init 8 , .Xr rc 8 , .Xr sysctl 8 -.Sh BUGS -The list of securelevel's effects may not be comprehensive. .Sh HISTORY The .Nm manual page first appeared in .Ox 2.6 . - +.Sh BUGS +The list of securelevel's effects may not be comprehensive. -- 2.20.1