diff options
Diffstat (limited to 'share/man/man5')
30 files changed, 800 insertions, 552 deletions
diff --git a/share/man/man5/a.out.5 b/share/man/man5/a.out.5 index 2b0cfadbf47..eb02ff6792b 100644 --- a/share/man/man5/a.out.5 +++ b/share/man/man5/a.out.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: a.out.5,v 1.5 1998/11/26 04:25:58 aaron Exp $ .\" $NetBSD: a.out.5,v 1.8 1994/11/30 19:31:09 jtc Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -50,7 +51,7 @@ The include file declares three structures and several macros. The structures describe the format of executable machine code files -.Pq Sq binaries +.Pq Dq binaries on the system. .Pp A binary file consists of up to 7 sections. @@ -77,7 +78,7 @@ Like the text relocation section, but for data segment pointers. .It symbol table Contains records used by the link editor to cross reference the addresses of named variables and functions -.Pq Sq symbols +.Pq Dq symbols between binary files. .It string table Contains the character strings corresponding to the symbol names. @@ -105,39 +106,43 @@ The fields have the following functions: 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 -.Dv N_GETFLAG() , -.Dv N_GETMID() , and -.Dv N_GETMAGIC() , +.Fn N_GETFLAG , +.Fn N_GETMID , and +.Fn N_GETMAGIC , and set by the macro -.Dv N_SETMAGIC(). +.Fn N_SETMAGIC . .Pp The macro -.Dv N_GETFLAG() +.Fn N_GETFLAG() returns a few flags: .Bl -tag -width EX_DYNAMIC .It Dv EX_DYNAMIC -indicates that the executable requires the services of the run-time link editor. +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 +Indicates that the object contains position independent code. This flag is set by .Xr as 1 when given the -.Sq -k +.Fl k flag and is preserved by .Xr ld 1 if necessary. .El .Pp -If both EX_DYNAMIC and EX_PIC are set, the object file is a position indendent -executable image (eg. a shared library), which is to be loaded into the +If both +.Dv EX_DYNAMIC +and +.Dv EX_PIC +are set, the object file is a position indendent +executable image (e.g., a shared library), which is to be loaded into the process address space by the run-time link editor. .Pp The macro -.Dv N_GETMID() +.Fn N_GETMID returns the machine-id. This indicates which machine(s) the binary is intended to run on. .Pp -.Dv N_GETMAGIC() +.Fn N_GETMAGIC specifies the magic number, which uniquely identifies binary files and distinguishes different loading conventions. The field must contain one of the following values: @@ -166,7 +171,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 -.Sq bss segment +.Dq bss segment and is used by the kernel to set the initial break .Pq Xr brk 2 after the data segment. @@ -192,7 +197,7 @@ include file defines several macros which use an structure to test consistency or to locate section offsets in the binary file. .Bl -tag -width N_BADMAG(exec) .It Fn N_BADMAG exec -Nonzero if the +Non-zero if the .Fa a_magic field does not contain a recognized value. .It Fn N_TXTOFF exec @@ -257,12 +262,12 @@ the link editor must use a symbol address to update the pointer. When the .Fa r_extern bit is clear, the relocation is -.Sq local ; +.Dq local ; the link editor updates the pointer to reflect changes in the load addresses of the various segments, rather than changes in the value of a symbol (except when .Fa r_baserel -is also set (see below). +is also set, see below). In this case, the content of the .Fa r_symbolnum field is an @@ -288,12 +293,12 @@ only occurs in shared objects. If set, this relocation record identifies a symbol whose contents should be copied to the location given in .Fa r_address. -The copying is done by the run-time link-editor from a suitable data +The copying is done by the run-time link editor from a suitable data item in a shared object. .El .Pp Symbols map names to addresses (or more generally, strings to values). -Since the link-editor adjusts addresses, +Since the link editor adjusts addresses, a symbol's name must be used to stand for its address until an absolute value has been assigned. Symbols consist of a fixed-length record in the symbol table @@ -334,7 +339,7 @@ field is broken down into three sub-fields using bitmasks. The link editor treats symbols with the .Dv N_EXT type bit set as -.Sq external +.Dq external symbols and permits references to them from other binary files. The .Dv N_TYPE @@ -346,8 +351,8 @@ The link editor must locate an external symbol with the same name in another binary file to determine the absolute value of this symbol. As a special case, if the .Fa n_value -field is nonzero and no binary file in the link-edit defines this symbol, -the link-editor will resolve this symbol to an address +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 .Fa n_value . @@ -379,7 +384,7 @@ the other symbols from a binary file when merging binary files. The name of the symbol is the filename given to the link editor, and its value is the first text address from that binary file. -Filename symbols are not needed for link-editing or loading, +Filename symbols are not needed for link editing or loading, but are useful for debuggers. .El .Pp @@ -437,8 +442,8 @@ is always 4 on 32-bit machines. .Xr execve 2 , .Xr nlist 3 , .Xr core 5 , -.Xr stab 5 , -.Xr link 5 +.Xr link 5 , +.Xr stab 5 .Sh HISTORY The .Pa a.out.h diff --git a/share/man/man5/acct.5 b/share/man/man5/acct.5 index a1a8ad04c61..96ee91ec52b 100644 --- a/share/man/man5/acct.5 +++ b/share/man/man5/acct.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: acct.5,v 1.5 1998/11/26 04:25:58 aaron Exp $ .\" $NetBSD: acct.5,v 1.4 1995/10/22 01:40:10 ghudson Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -102,10 +103,10 @@ and its status is saved by setting one of more of the following flags in and .Dv ASIG . .Sh SEE ALSO +.Xr lastcomm 1 , .Xr acct 2 , -.Xr accton 8 , .Xr execve 2 , -.Xr lastcomm 1 , +.Xr accton 8 , .Xr sa 8 .Sh HISTORY An diff --git a/share/man/man5/core.5 b/share/man/man5/core.5 index a5842a8aa75..0362d6e8fcb 100644 --- a/share/man/man5/core.5 +++ b/share/man/man5/core.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: core.5,v 1.3 1998/11/26 04:25:58 aaron Exp $ .\" $NetBSD: core.5,v 1.4 1994/11/30 19:31:11 jtc Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -44,12 +45,11 @@ .Sh DESCRIPTION A small number of signals which cause abnormal termination of a process also cause a record of the process's in-core state to be written -to disk for later examination by one of the available debuggers. -(See -.Xr sigaction 2 . ) +to disk for later examination by one of the available debuggers (see +.Xr sigaction 2 ) . This memory image is written to a file named -.Nm programname.core -in the working directory; +.Pa programname.core +in the working directory, provided the terminated process had write permission in the directory, and provided the abnormality did not cause a system crash. @@ -57,13 +57,13 @@ a system crash. .Xr savecore 8 . ) .Pp The maximum size of a -.Nm programname.core +.Pa programname.core file is limited by .Xr setrlimit 2 . Files which would be larger than the limit are not created. .Pp The -.Nm programname.core +.Pa programname.core file consists of the .Fa u . area, whose size (in pages) is @@ -78,11 +78,11 @@ area starts with a structure as given in .Aq Pa sys/user.h . The remainder of the -.Nm programname.core +.Pa programname.core file consists of the data pages followed by the stack pages of the process image. The amount of data space image in the -.Nm programname.core +.Pa programname.core file is given (in pages) by the variable .Fa u_dsize @@ -95,14 +95,16 @@ variable in the .Ar u . area. -The size of a ``page'' is given by the constant +The size of a +.Dq page +is given by the constant .Dv NBPG (also from .Aq Pa sys/param.h ) . .Sh SEE ALSO .Xr gdb 1 , -.Xr sigaction 2 , -.Xr setrlimit 2 +.Xr setrlimit 2 , +.Xr sigaction 2 .Sh HISTORY A .Nm core diff --git a/share/man/man5/dir.5 b/share/man/man5/dir.5 index 309e1a52d34..bf1e8f0fba6 100644 --- a/share/man/man5/dir.5 +++ b/share/man/man5/dir.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: dir.5,v 1.4 1998/11/26 04:25:58 aaron Exp $ .\" $NetBSD: dir.5,v 1.5 1995/03/28 17:30:20 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -64,23 +65,22 @@ and is called a file system (or referred to as a file system tree). Each directory file contains two special directory entries; one is a pointer to the directory itself called dot -.Ql \&. +.Pq Dq \&. and the other a pointer to its parent directory called dot-dot -.Ql \&.. . +.Pq Dq \&.. . Dot and dot-dot are valid pathnames, however, the system root directory -.Ql / , +.Pq Dq / , has no parent and dot-dot points to itself like dot. .Pp File system nodes are ordinary directory files on which has been grafted a file system object, such as a physical disk or a -partitioned area of such a disk. -(See -.Xr mount 8 . ) +partitioned area of such a disk (see +.Xr mount 8 ) . .Pp The directory entry format is defined in the file -.Aq dirent.h : +.Aq Pa dirent.h : .Bd -literal #ifndef _DIRENT_H_ #define _DIRENT_H_ diff --git a/share/man/man5/disktab.5 b/share/man/man5/disktab.5 index 04eddd2cca7..899223e543f 100644 --- a/share/man/man5/disktab.5 +++ b/share/man/man5/disktab.5 @@ -42,7 +42,7 @@ .Sh SYNOPSIS .Fd #include <disktab.h> .Sh DESCRIPTION -.Nm Disktab +.Nm disktab is a simple database which describes disk geometries and disk partition characteristics. It is used @@ -53,80 +53,146 @@ to initialize the disk label on the disk. The format is patterned after the .Xr termcap 5 -terminal data base. Entries in +terminal database. Entries in .Nm disktab -consist of a number of `:' separated fields. The +consist of a number of colon +.Pq Sq \&: +separated fields. The first entry for each disk gives the names which are -known for the disk, separated by `|' characters. The +known for the disk, separated by +.Dq \&| +characters. 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. +stored for each disk entry: .Bl -column "indent" "boolx" .It Sy Name Type Description -.It "\&ty str Type of disk (e.g. removable, winchester)" -.It "\&dt str Type of controller (e.g." +.It "\&ty str Type of disk (e.g., removable, winchester)." +.It "\&dt str Type of controller (e.g.," .Tn SMD , ESDI , -floppy) -.It "\&ns num Number of sectors per track" -.It "\&nt num Number of tracks per cylinder" -.It "\&nc num Total number of cylinders on the disk" -.It "\&sc num Number of sectors per cylinder, nc*nt default" -.It "\&su num Number of sectors per unit, sc*nc default" -.It "\&se num Sector size in bytes," -.Dv DEV_BSIZE -default -.It "\&sf bool Controller supports bad144-style bad sector forwarding" -.It "\&rm num Rotation speed, rpm, 3600 default" -.It "\&sk num Sector skew per track, default 0" -.It "\&cs num Sector skew per cylinder, default 0" -.It "\&hs num Headswitch time, usec, default 0" -.It "\&ts num One-cylinder seek time, usec, default 0" -.It "\&il num Sector interleave (n:1), 1 default" -.It "\&d[0-4] num Drive-type-dependent parameters" -.It "\&bs num Boot block size, default" -.Dv BBSIZE -.It "\&sb num Superblock size, default" -.Dv SBSIZE -.It "\&ba num Block size for partition `a' (bytes)" -.It "\&bd num Block size for partition `d' (bytes)" -.It "\&be num Block size for partition `e' (bytes)" -.It "\&bf num Block size for partition `f' (bytes)" -.It "\&bg num Block size for partition `g' (bytes)" -.It "\&bh num Block size for partition `h' (bytes)" -.It "\&fa num Fragment size for partition `a' (bytes)" -.It "\&fd num Fragment size for partition `d' (bytes)" -.It "\&fe num Fragment size for partition `e' (bytes)" -.It "\&ff num Fragment size for partition `f' (bytes)" -.It "\&fg num Fragment size for partition `g' (bytes)" -.It "\&fh num Fragment size for partition `h' (bytes)" -.It "\&oa num Offset of partition `a' in sectors" -.It "\&ob num Offset of partition `b' in sectors" -.It "\&oc num Offset of partition `c' in sectors" -.It "\&od num Offset of partition `d' in sectors" -.It "\&oe num Offset of partition `e' in sectors" -.It "\&of num Offset of partition `f' in sectors" -.It "\&og num Offset of partition `g' in sectors" -.It "\&oh num Offset of partition `h' in sectors" -.It "\&pa num Size of partition `a' in sectors" -.It "\&pb num Size of partition `b' in sectors" -.It "\&pc num Size of partition `c' in sectors" -.It "\&pd num Size of partition `d' in sectors" -.It "\&pe num Size of partition `e' in sectors" -.It "\&pf num Size of partition `f' in sectors" -.It "\&pg num Size of partition `g' in sectors" -.It "\&ph num Size of partition `h' in sectors" -.It "\&ta str Partition type of partition `a'" -.Pf ( Bx 4.2 -filesystem, swap, etc) -.It "\&tb str Partition type of partition `b'" -.It "\&tc str Partition type of partition `c'" -.It "\&td str Partition type of partition `d'" -.It "\&te str Partition type of partition `e'" -.It "\&tf str Partition type of partition `f'" -.It "\&tg str Partition type of partition `g'" -.It "\&th str Partition type of partition `h'" +floppy). +.It "\&ns num Number of sectors per track." +.It "\&nt num Number of tracks per cylinder." +.It "\&nc num Total number of cylinders on the disk." +.It "\&sc num Number of sectors per cylinder (default: nc*nt)." +.It "\&su num Number of sectors per unit (default: sc*nc)." +.It "\&se num Sector size in bytes (default:" +.Dv DEV_BSIZE ) . +.It "\&sf bool Controller supports bad144-style bad sector forwarding." +.It "\&rm num Rotation speed in RPM (default: 3600)." +.It "\&sk num Sector skew per track (default: 0)." +.It "\&cs num Sector skew per cylinder (default: 0)." +.It "\&hs num Headswitch time in usec (default: 0)." +.It "\&ts num One-cylinder seek time in usec (default: 0)." +.It "\&il num Sector interleave (n:1) (default: 1)." +.It "\&d[0-4] num Drive-type-dependent parameters." +.It "\&bs num Boot block size (default:" +.Dv BBSIZE ) . +.It "\&sb num Superblock size (default: " +.Dv SBSIZE ) . +.It "\&ba num Block size for partition" +.Dq a +(bytes). +.It "\&bd num Block size for partition" +.Dq d +(bytes). +.It "\&be num Block size for partition" +.Dq e +(bytes). +.It "\&bf num Block size for partition" +.Dq f +(bytes). +.It "\&bg num Block size for partition" +.Dq g +(bytes). +.It "\&bh num Block size for partition" +.Dq h +(bytes). +.It "\&fa num Fragment size for partition" +.Dq a +(bytes). +.It "\&fd num Fragment size for partition" +.Dq d +(bytes). +.It "\&fe num Fragment size for partition" +.Dq e +(bytes). +.It "\&ff num Fragment size for partition" +.Dq f +(bytes). +.It "\&fg num Fragment size for partition" +.Dq g +(bytes). +.It "\&fh num Fragment size for partition" +.Dq h +(bytes). +.It "\&oa num Offset of partition" +.Dq a +(sectors). +.It "\&ob num Offset of partition" +.Dq b +(sectors). +.It "\&oc num Offset of partition" +.Dq c +(sectors). +.It "\&od num Offset of partition" +.Dq d +(sectors). +.It "\&oe num Offset of partition" +.Dq e +(sectors). +.It "\&of num Offset of partition" +.Dq f +(sectors). +.It "\&og num Offset of partition" +.Dq g +(sectors). +.It "\&oh num Offset of partition" +.Dq h +(sectors). +.It "\&pa num Size of partition" +.Dq a +(sectors). +.It "\&pb num Size of partition" +.Dq b +(sectors). +.It "\&pc num Size of partition" +.Dq c +(sectors). +.It "\&pd num Size of partition" +.Dq d +(sectors). +.It "\&pe num Size of partition" +.Dq e +(sectors). +.It "\&pf num Size of partition" +.Dq f +(sectors). +.It "\&pg num Size of partition" +.Dq g +(sectors). +.It "\&ph num Size of partition" +.Dq h +(sectors). +.It "\&ta str Type of partition" +.Dq a +(4.2BSD, swap, etc.). +.It "\&tb str Type of partition" +.Dq b . +.It "\&tc str Type of partition" +.Dq c . +.It "\&td str Type of partition" +.Dq d . +.It "\&te str Type of partition" +.Dq e . +.It "\&tf str Type of partition" +.Dq f . +.It "\&tg str Type of partition" +.Dq g . +.It "\&th str Type of partition" +.Dq h . .El .Sh FILES .Bl -tag -width /etc/disktab -compact diff --git a/share/man/man5/ethers.5 b/share/man/man5/ethers.5 index fd55b38e1b8..740e48b1d10 100644 --- a/share/man/man5/ethers.5 +++ b/share/man/man5/ethers.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: ethers.5,v 1.7 1998/11/26 04:25:58 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. @@ -13,13 +14,14 @@ The .Nm ethers 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. -A ``#'' indicates the beginning of a comment; characters up to the end of +A +.Dq # +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 +Ethernet addresses are expressed as six hexadecimal numbers separated by +colons. The functions described in .Xr ethers 3 -and -.Xr ether_aton 3 can read and produce this format. .Pp The @@ -28,21 +30,17 @@ file has support for YP functionality. .Sh FILES .Bl -tag -width /etc/ethers -compact .It Pa /etc/ethers -The -.Nm ethers -file resides in -.Pa /etc . .El .Sh SEE ALSO .Xr ethers 3 , .Xr diskless 8 .Sh BUGS A name server should be used instead of a static file. -.br +.Pp Lines in .Pa /etc/ethers are limited to -.Ev BUFSIZE +.Dv BUFSIZE characters (currently 1024). Longer lines will be ignored. .Sh HISTORY The diff --git a/share/man/man5/fbtab.5 b/share/man/man5/fbtab.5 index c46d72e4f62..56a16b12869 100644 --- a/share/man/man5/fbtab.5 +++ b/share/man/man5/fbtab.5 @@ -1,4 +1,5 @@ -.\" this is comment +.\" $OpenBSD: fbtab.5,v 1.3 1998/11/26 04:25:58 aaron Exp $ +.\" .Dd August 22, 1994 .Dt FBTAB 5 .Os @@ -12,23 +13,32 @@ 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 # and extend to the end of the line. +Comments start with a +.Dq # +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. .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It Login Device -The device you have logged in on, e.g. /dev/ttyv0. +The device you have logged in on (e.g., +.Dq /dev/ttyv0 ) . .It File Permission An octal permission number (0600), as used by .Xr chmod 2 . .It Other devices -The final field is a ":"-delimited list of devices, e.g. -/dev/console:/dev/fd0a. +The final field is a colon +.Pq Sq \&: +delimited list of devices (e.g., +.Dq /dev/console:/dev/fd0a ) . All device names are absolute paths. -A path that ends in "/*" refers to all -directory entries except "." and "..". +A path that ends in +.Dq /\&* +refers to all directory entries except +.Dq \&. +and +.Dq \&.\&. . .El .Pp The @@ -47,10 +57,6 @@ the files once again belonging to root. .Sh FILES .Bl -tag -width /etc/fbtab -compact .It Pa /etc/fbtab -The -.Nm -file resides in -.Pa /etc . .El .Sh SEE ALSO .Xr login 1 , diff --git a/share/man/man5/fs.5 b/share/man/man5/fs.5 index 53aa5a59e9b..fde8eac456b 100644 --- a/share/man/man5/fs.5 +++ b/share/man/man5/fs.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: fs.5,v 1.4 1998/11/26 04:25:58 aaron Exp $ .\" $NetBSD: fs.5,v 1.3 1994/11/30 19:31:17 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -172,14 +173,15 @@ super-block data does not change, so the copies need not be referenced further unless disaster strikes. .Pp Addresses stored in inodes are capable of addressing fragments -of `blocks'. File system blocks of at most size +of +.Dq blocks . +File system blocks of at most size .Dv MAXBSIZE can be optionally broken into 2, 4, or 8 pieces, each of which is addressable; these pieces may be .Dv DEV_BSIZE , -or some multiple of -a +or some multiple of a .Dv DEV_BSIZE unit. .Pp @@ -190,7 +192,7 @@ 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 information in the inode, using the -.Fn blksize fs ip lbn +.Fn blksize macro. .Pp The file system records space availability at the fragment level; @@ -228,14 +230,18 @@ The element specifies whether the file system should try to minimize the time spent allocating blocks, or if it should attempt to minimize the space fragmentation on the disk. -If the value of fs_minfree (see above) is less than 5%, +If the value of +.Fa fs_minfree +(see above) is less than 5%, then the file system defaults to optimizing for space to avoid running out of full sized blocks. -If the value of minfree is greater than or equal to 5%, +If the value of +.Fa fs_minfree +is greater than or equal to 5%, fragmentation is unlikely to be problematical, and the file system defaults to optimizing for time. .Pp -.Em Cylinder group related limits : +.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 @@ -268,7 +274,7 @@ it is possible to create files of size .Dv MINBSIZE must be big enough to hold a cylinder group block, thus changes to -.Pq Fa struct cg +.Fa struct cg must keep its size within .Dv MINBSIZE . Note that super-blocks are never more than size @@ -293,20 +299,18 @@ These blocks are read in from .Fa fs_cssize ) in addition to the super-block. .Pp -.Sy N.B.: -.Xr sizeof Pq Fa struct csum +Note that +.Fn sizeof "struct csum" must be a power of two in order for the .Fn fs_cs macro to work. .Pp -The -.Em "Super-block for a file system" : +.Ss Super-block for a file system The size of the rotational layout tables is limited by the fact that the super-block is of size .Dv SBSIZE . -The size of these tables is -.Em inversely +The size of these tables is inversely proportional to the block size of the file system. The size of the tables is increased when sector sizes are not powers of two, @@ -315,17 +319,16 @@ included before the rotational pattern repeats .Pq Fa fs_cpc . The size of the rotational layout tables is derived from the number of bytes remaining in -.Pq Fa struct fs . +.Fa struct fs . .Pp The number of blocks of data per cylinder group is limited because cylinder groups are at most one block. The inode and free block tables must fit into a single block after deducting space for the cylinder group structure -.Pq Fa struct cg . +.Fa struct cg . .Pp -The -.Em Inode : +.Ss Inodes The inode is the focus of all file activity in the .Tn UNIX file system. @@ -333,7 +336,9 @@ There is a unique inode allocated for each active file, each current directory, each mounted-on file, text file, and the root. -An inode is `named' by its device/i-number pair. +An inode is +.Dq named +by its device/i-number pair. For further information, see the include file .Aq Pa ufs/ufs/inode.h . .Sh HISTORY diff --git a/share/man/man5/fstab.5 b/share/man/man5/fstab.5 index 9684dae899b..5f6328cfbc0 100644 --- a/share/man/man5/fstab.5 +++ b/share/man/man5/fstab.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: fstab.5,v 1.7 1998/11/26 04:25:58 aaron Exp $ .\" $NetBSD: fstab.5,v 1.5.2.1 1995/11/16 20:11:11 pk Exp $ .\" .\" Copyright (c) 1980, 1989, 1991, 1993 @@ -64,59 +65,66 @@ sequentially iterate through doing their thing. .Pp The first field, -.Pq Fa fs_spec , +.Fa fs_spec , describes the block special device or remote filesystem to be mounted. For filesystems of type -.Em ffs , +.Tn ffs , the special file name is the block special file name, and not the character special file name. If a program needs the character special file name, -the program must create it by appending a ``r'' after the -last ``/'' in the special file name. +the program must create it by appending an +.Dq r +after the +last +.Dq / +in the special file name. .Pp The second field, -.Pq Fa fs_file , +.Fa fs_file , describes the mount point for the filesystem. -For swap partitions, this field should be specified as ``none''. +For swap partitions, this field should be specified as +.Dq none . .Pp The third field, -.Pq Fa fs_vfstype , +.Fa fs_vfstype , describes the type of the filesystem. The system currently supports eleven types of filesystems: -.Bl -tag -width indent -offset indent -.It Em adosfs +.Pp +.Bl -tag -width indent -offset indent -compact +.It adosfs An .Tn AmigaDOS -filesystem -.It Em cd9660 -an ISO 9660 CD-ROM filesystem -.It Em fdesc -an implementation of /dev/fd -.It Em ffs -a local +filesystem. +.It cd9660 +An ISO9660 CD-ROM filesystem. +.It fdesc +An implementation of +.Pa /dev/fd . +.It ffs +A local .Tn UNIX -filesystem -.It Em kernfs -various and sundry kernel statistics -.It Em mfs -a local memory-based +filesystem. +.It kernfs +Various and sundry kernel statistics. +.It mfs +A local memory-based .Tn UNIX -filesystem -.It Em msdos -a MSDOS ``FAT'' filesystem -.It Em nfs -a Sun Microsystems compatible ``Network File System'' -.It Em procfs -a local filesystem of process information -.It Em swap -a disk partition to be used for swapping -.It Em union -a translucent filesystem +filesystem. +.It msdos +An MS-DOS FAT filesystem. +.It nfs +A Sun Microsystems compatible Network File System. +.It procfs +A local filesystem containing process information. +.It swap +A disk partition to be used for swapping. +.It union +A translucent filesystem. .El .Pp The fourth field, -.Pq Fa fs_mntops , +.Fa fs_mntops , 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 @@ -124,11 +132,20 @@ It contains at least the type of mount (see below) plus any additional options appropriate to the filesystem type. .Pp -The option ``auto'' can be used in the ``noauto'' form to cause -a file system not to be mounted automatically (with ``mount -a'', -or system boot time). +The option +.Dq auto +can be used in the +.Dq noauto +form to cause +a file system not to be mounted automatically (with +.Ic mount -a , +or at system boot time). .Pp -If the options ``userquota'' and/or ``groupquota'' are specified, +If the options +.Dq userquota +and/or +.Dq groupquota +are specified, the filesystem is automatically processed by the .Xr quotacheck 8 command, and user and/or group disk quotas are enabled with @@ -159,13 +176,19 @@ field (it is not deleted from the field). If .Fa fs_type -is ``rw'' or ``ro'' then the filesystem whose name is given in the +is +.Dq rw +or +.Dq ro +then the filesystem whose name is given in the .Fa fs_file field is normally mounted read-write or read-only on the specified special file. If .Fa fs_type -is ``sw'' then the special file is made available as a piece of swap +is +.Dq sw +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. @@ -176,11 +199,13 @@ and are unused. If .Fa fs_type -is specified as ``xx'' the entry is ignored. +is specified as +.Dq xx +the entry is ignored. This is useful to show disk partitions which are currently unused. .Pp The fifth field, -.Pq Fa fs_freq , +.Fa fs_freq , is used for these filesystems by the .Xr dump 8 command to determine which filesystems need to be dumped. @@ -189,7 +214,7 @@ If the fifth field is not present, a value of zero is returned and will assume that the filesystem does not need to be dumped. .Pp The sixth field, -.Pq Fa fs_passno , +.Fa fs_passno , is used by the .Xr fsck 8 program to determine the order in which filesystem checks are done @@ -204,7 +229,7 @@ but filesystems on different drives will be checked at the same time to utilize parallelism available in the hardware. If the sixth field is not present or is zero, a value of zero is returned and -.Xr fsck +.Xr fsck 8 will assume that the filesystem does not need to be checked. .Bd -literal #define FSTAB_RW "rw" /* read-write device */ @@ -234,10 +259,6 @@ and .Sh FILES .Bl -tag -width /etc/fstab -compact .It Pa /etc/fstab -The file -.Nm fstab -resides in -.Pa /etc . .El .Sh SEE ALSO .Xr getfsent 3 diff --git a/share/man/man5/group.5 b/share/man/man5/group.5 index 115c6f7c817..9cdf172ceff 100644 --- a/share/man/man5/group.5 +++ b/share/man/man5/group.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: group.5,v 1.2 1998/11/26 04:25:58 aaron Exp $ .\" $NetBSD: group.5,v 1.4 1995/07/28 06:41:39 phil Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -42,19 +43,18 @@ .Nd format of the group permissions file .Sh DESCRIPTION The file -.Aq Pa /etc/group +.Pa /etc/group consists of newline separated .Tn ASCII records, one per group, containing four colon -.Ql \&: +.Pq Sq \&: separated fields. These fields are as follows: +.Pp .Bl -tag -width password -offset indent -compact .It group Name of the group. .It passwd -Group's -.Em encrypted -password. +Group's encrypted password. .It gid The group's decimal ID. .It member @@ -73,9 +73,7 @@ across a group of systems) since they control file access. The .Ar passwd field -is an optional -.Em encrypted -password. +is an optional encrypted password. This field is rarely used and an asterisk is normally placed in it rather than leaving it blank. The @@ -87,7 +85,8 @@ 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 file. +.Pa /etc/group +file. .\" .Pp .\" When the system reads the file .\" .Pa /etc/group @@ -115,11 +114,14 @@ which causes the specified group to be included from the .Pa group.byname YP map. .Pp -If no group name is specified, or the ``+'' (plus sign) appears alone +If no group name is specified, or the +.Dq + +(plus sign) appears alone on line, all groups are included from the YP map. .Pp -YP references may appear anywhere in the file, but the single ``+'' form -should be on the last line, for historical reasons. +YP references may appear anywhere in the file, but the single +.Dq + +form should be on the last line, for historical reasons. Only the first group with a specific name encountered, whether in the .Nm file itself, or included via YP, will be used. @@ -128,10 +130,10 @@ file itself, or included via YP, will be used. .It Pa /etc/group .El .Sh SEE ALSO +.Xr passwd 1 , .Xr setgroups 2 , -.Xr initgroups 3 , .Xr crypt 3 , -.Xr passwd 1 , +.Xr initgroups 3 , .Xr passwd 5 , .Xr yp 8 .Sh BUGS diff --git a/share/man/man5/hosts.5 b/share/man/man5/hosts.5 index db82f6f436a..c058c79449c 100644 --- a/share/man/man5/hosts.5 +++ b/share/man/man5/hosts.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: hosts.5,v 1.5 1998/11/26 04:25:58 aaron Exp $ .\" $NetBSD: hosts.5,v 1.4 1994/11/30 19:31:20 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -53,7 +54,9 @@ Aliases .Ed .Pp Items are separated by any number of blanks and/or -tab characters. A ``#'' indicates the beginning of +tab characters. A +.Dq # +indicates the beginning of a comment; characters up to the end of the line are not interpreted by routines which search the file. .Pp @@ -91,8 +94,9 @@ sites on the .Tn DARPA Internet. .Pp -Network addresses are specified in the conventional -``.'' (dot) notation using the +Network addresses are specified in the conventional Internet +.Dq \&. +(dot) notation using the .Xr inet_addr 3 routine from the Internet address manipulation library, @@ -103,26 +107,22 @@ or comment character. .Sh FILES .Bl -tag -width /etc/hosts -compact .It Pa /etc/hosts -The -.Nm hosts -file resides in -.Pa /etc . .El .Sh SEE ALSO .Xr gethostbyname 3 , -.Xr ifconfig 8 , .Xr resolv.conf 5 , +.Xr ifconfig 8 , .Xr named 8 .Rs .%T "Name Server Operations Guide for BIND" .Re .Sh BUGS A name server should be used instead of a static file. -.br +.Pp Lines in .Pa /etc/hosts are limited to -.Ev BUFSIZE +.Dv BUFSIZE characters (currently 1024). Longer lines will be ignored. .Sh HISTORY The diff --git a/share/man/man5/hosts.equiv.5 b/share/man/man5/hosts.equiv.5 index c96e48f604e..822648f012a 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.1 1997/11/30 05:35:25 deraadt Exp $ +.\" $OpenBSD: hosts.equiv.5,v 1.2 1998/11/26 04:25:58 aaron Exp $ .\" .\" Copyright (c) 1997 Todd Vierling .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -47,8 +47,9 @@ The .Nm hosts.equiv and .Nm .rhosts -files list hosts and users which are ``trusted'' by the local host when a -connection is made via +files list hosts and users which are +.Dq trusted +by the local host when a connection is made via .Xr rlogind 8 , .Xr rshd 8 , or any other server that uses @@ -63,49 +64,53 @@ hostname [username] .Ed .Pp The -.Em hostname +.Ar hostname may be specified as a host name (typically a fully qualified host name in a DNS environment) or address, -.Em +@netgroup +.Ar +@netgroup (from which only the host names are checked), -or a ``+'' wildcard (allow all hosts). +or a +.Dq + +wildcard (allow all hosts). .Pp The -.Em username , +.Ar username , if specified, may be given as a user name on the remote host, -.Em +@netgroup +.Ar +@netgroup (from which only the user names are checked), -or a ``+'' wildcard (allow all remote users). +or a +.Dq + +wildcard (allow all remote users). .Pp If a -.Em username +.Ar username is specified, only that user from the specified host may login to the local machine. If a -.Em username +.Ar username is not specified, any user may login with the same user name. .Sh EXAMPLES .Li somehost .Bd -filled -offset indent -compact -A common usage: users on -.Em somehost +A common usage; users on +.Ar somehost may login to the local host as the same user name. .Ed .Li somehost username .Bd -filled -offset indent -compact The user -.Em username +.Ar username on -.Em somehost +.Ar somehost may login to the local host. If specified in -.Em /etc/hosts.equiv , +.Pa /etc/hosts.equiv , the user may login with only the same user name. .Ed .Li +@anetgroup username .Bd -filled -offset indent -compact The user -.Em username +.Ar username may login to the local host from any machine listed in the netgroup -.Em anetgroup . +.Ar anetgroup . .Ed .Bd -literal -compact + @@ -116,10 +121,10 @@ 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 -.Em /etc/hosts.equiv ) . +.Pa /etc/hosts.equiv ) . .Ed .Sh WARNINGS -The username checks provided by this mechanism are +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 @@ -129,26 +134,28 @@ A numeric host address instead of a host name can help security considerations somewhat; the address is then used directly by .Xr iruserok 3 . .Pp -When a username (or netgroup, or +) is specified in -.Em /etc/hosts.equiv , +When a user name (or netgroup, or +.Dq + ) +is specified in +.Pa /etc/hosts.equiv , that user (or group of users, or all users, respectively) may login to the local host as .Em any local user . Usernames in -.Em /etc/hosts.equiv +.Pa /etc/hosts.equiv should therefore be used with extreme caution, or not at all. .Pp A -.Em .rhosts +.Pa .rhosts file must be owned by the user whose home directory it resides in, and must be writable only by that user. .Pp Logins as root only check root's -.Em .rhosts +.Pa .rhosts file; the -.Em /etc/hosts.equiv +.Pa /etc/hosts.equiv file is not checked for security. Access permitted through root's -.Em .rhosts +.Pa .rhosts file is typically only for .Xr rsh 1 , as root must still login on the console for an interactive login such as @@ -156,9 +163,9 @@ as root must still login on the console for an interactive login such as .Sh FILES .Bl -tag -width /etc/hosts.equiv -compact .It Pa /etc/hosts.equiv -Global trusted host-user pairs list +global trusted host-user pairs list .It Pa ~/.rhosts -Per-user trusted host-user pairs list +per-user trusted host-user pairs list .El .Sh SEE ALSO .Xr rcp 1 , @@ -177,4 +184,7 @@ file format appeared in The .Xr ruserok 3 implementation currently skips negative entries (preceded with a -``-'' sign) and does not treat them as ``short-circuit'' negative entries. +.Dq \&- +sign) and does not treat them as +.Dq short-circuit +negative entries. diff --git a/share/man/man5/link.5 b/share/man/man5/link.5 index 52c8343ebf9..7f0d6cf4524 100644 --- a/share/man/man5/link.5 +++ b/share/man/man5/link.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: link.5,v 1.6 1998/11/26 04:25:58 aaron Exp $ .\" $NetBSD: link.5,v 1.5 1996/01/09 00:14:32 pk Exp $ .\" .\" Copyright (c) 1993 Paul Kranenburg @@ -42,8 +43,10 @@ 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 -structures within the binaries resembles the a.out format in many places +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 @@ -56,7 +59,7 @@ The collection of data structures described here will be referred to as the .Em Run-time Relocation Section (RRS) and is embedded in the standard text and data segments of the dynamically linked program or shared object image as the existing -.Xr a.out +.Xr a.out 5 format offers no room for it elsewhere. .Pp Several utilities co-operate to ensure that the task of getting a program @@ -65,10 +68,12 @@ 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 .size assembler directive. PIC code differs from conventional code +through the +.Dq .size +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 -.Em _GLOBAL_OFFSET_TABLE_ . +.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 @@ -83,16 +88,19 @@ image. Again, this is done to avoid run-time modifications to the text segment. 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 -run-time link-editor and stores these along with the image's text and data bits. +run-time link editor and stores these along with the image's text and data bits. Another reserved symbol, -.Em _DYNAMIC +.Dv _DYNAMIC is used to indicate the presence of the run-time linker structures. Whenever -_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 +.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. This is most notably used by the start-up module, .Em crt0 . -The _DYNAMIC structure is conventionally located at the start of the data +The +.Dv _DYNAMIC +structure is conventionally located at the start of the data segment of the image to which it pertains. .Pp .Sh DATA STRUCTURES @@ -102,7 +110,9 @@ The text segments contain read-only data such as symbol descriptions and names, while the data segments contain the tables that need to be modified by during the relocation process. .Pp -The _DYNAMIC symbol references a +The +.Dv _DYNAMIC +symbol references a .Fa _dynamic structure: .Bd -literal -offset indent @@ -118,21 +128,25 @@ struct _dynamic { .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 ld.so are -.Em LD_VERSION_SUN (3), -which is used by the SunOS 4.x releases, and -.Em LD_VERSION_BSD (8), -which is currently in use by OpenBSD. +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 +.Ox . .It Fa d_un Refers to a .Em d_version dependent data structure. .It Fa d_debug -this field provides debuggers with a hook to access symbol tables of shared -objects loaded as a result of the actions of the run-time link-editor. +This field provides debuggers with a hook to access symbol tables of shared +objects loaded as a result of the actions of the run-time link editor. .It Fa d_entry -this field is obsoleted by CRT interface version CRT_VERSION_BSD4, and is -replaced by the crt_ldentry in +This field is obsoleted by CRT interface version +.Li CRT_VERSION_BSD4 , +and is by the +.Fa crt_ldentry +in .Fa crt_ldso . .El .Pp @@ -169,8 +183,7 @@ for the benefit of debuggers that may use it to load a shared object's symbol table. .It Fa sdt_sods The start of a (linked) list of shared object descriptors needed by -.Em this -object. +this object. .It Fa sdt_paths Library search rules. A colon separated list of directories corresponding to the @@ -213,8 +226,8 @@ The size of the Procedure Linkage Table. .Pp A .Fa sod -structure descibes a shared object that is needed -to complete the link edit process of the object containing it. +structure describes a shared object that is needed +to complete the link-edit process of the object containing it. A list of such objects .Po chained through @@ -223,7 +236,9 @@ chained through is pointed at by the .Fa sdt_sods -in the section_dispatch_table structure. +in the +.Fa section_dispatch_table +structure. .Bd -literal -offset indent struct sod { long sod_name; @@ -241,7 +256,9 @@ The offset in the text segment of a string describing this link object. .It Fa sod_library If set, .Fa sod_name -specifies a library that is to be searched for by ld.so. The path name +specifies a library that is to be searched for by +.Xr ld.so . +The path name is obtained by searching a set of directories .Po see also @@ -258,8 +275,8 @@ Specifies the major version number of the shared object to load. Specifies the preferred minor version number of the shared object to load. .El .Pp -The run-time link-editor maintains a list of structures called -.Em link maps +The run-time link editor maintains a list of structures called +.Dq link maps to keep track of all shared objects loaded into a process's address space. These structures are only used at run-time and do not occur within the text or data segment of an executable or shared library. @@ -296,7 +313,7 @@ Pointer to this object's .Fa _dynamic structure. .It Fa som_spd -Hook for attaching private data maintained by the run-time link-editor. +Hook for attaching private data maintained by the run-time link editor. .El .Pp Symbol description with size. This is simply an @@ -324,10 +341,8 @@ struct nzlist { .Ed .Bl -tag -width nz_size .It Fa nlist -.Po -see -.Xr nlist 5 -.Pc . +See +.Xr nlist 3 . .It Fa nz_size The size of the data represented by this symbol. .El @@ -357,6 +372,7 @@ field). 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. .El +.Pp The .Fa rt_symbol structure is used to keep track of run-time allocated commons @@ -380,9 +396,11 @@ struct rt_symbol { .It Fa rt_sp The symbol description. .It Fa rt_next -Virtual address of next rt_symbol. +Virtual address of next +.Fa rt_symbol . .It Fa rt_link -Next in hash bucket. Used by internally by ld.so. +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. .It Fa rt_smp @@ -394,9 +412,10 @@ 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 crt0. +can only do so after the link editor has been called from +.Em crt0 . A dynamically linked binary contains a .Fa so_debug structure which can be located by means of the @@ -426,8 +445,9 @@ Set by the run-time linker whenever it adds symbols by loading shared objects. 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, -.Em crt0.o, -to be some convenient place before the call to _main. +.Em crt0.o , +to be some convenient place before the call to +.Fa _main . .It Fa dd_bpt_shadow Contains the original instruction that was at .Fa dd_bpt_addr . @@ -440,7 +460,9 @@ may be interested in. .Pp The .Em ld_entry -structure defines a set of service routines within ld.so. See +structure defines a set of service routines within +.Xr ld.so . +See .Xr dlfcn 3 for more information. .Bd -literal -offset indent @@ -455,7 +477,10 @@ struct ld_entry { The .Fa crt_ldso -structure defines the interface between ld.so and the start-up code in crt0. +structure defines the interface between +.Xr ld.so +and the start-up code in +.Em crt0 . .Bd -literal -offset indent struct crt_ldso { int crt_ba; @@ -475,13 +500,21 @@ struct crt_ldso { .Ed .Bl -tag -width crt_dzfd .It Fa crt_ba -The virtual address at which ld.so was loaded by crt0. +The virtual address at which +.Xr ld.so +was loaded by +.Em crt0 . .It Fa crt_dzfd On SunOS systems, this field contains an open file descriptor to -.Dq /dev/zero -used to get demand paged zeroed pages. On OpenBSD systems it contains -1. +.Pa /dev/zero +used to get demand paged zeroed pages. On +.Ox +systems it contains -1. .It Fa crt_ldfd -Contains an open file descriptor that was used by crt0 to load ld.so. +Contains an open file descriptor that was used by +.Em crt0 +to load +.Xr ld.so . .It Fa crt_dp A pointer to main's .Fa _dynamic @@ -492,11 +525,15 @@ A pointer to the environment strings. The address at which a breakpoint will be placed by the run-time linker if the main program is run by a debugger. See -.Fa so_debug +.Fa so_debug . .It Fa crt_prog -The name of the main program as determined by crt0 (CRT_VERSION_BSD3 only). +The name of the main program as determined by +.Em crt0 +(CRT_VERSION_BSD3 only). .It Fa crt_ldso -The path of the run-time linker as mapped by crt0 (CRT_VERSION_BSD4 only). +The path of the run-time linker as mapped by +.Em crt0 +(CRT_VERSION_BSD4 only). .It Fa crt_ldentry The .Xr dlfcn 3 @@ -508,11 +545,13 @@ The and .Fa hints_bucket structures define the layout of the library hints, normally found in -.Dq /var/run/ld.so.hints, -which is used by ld.so to quickly locate the shared object images in the +.Pa /var/run/ld.so.hints , +which is used by +.Xr ld.so +to quickly locate the shared object images in the filesystem. The organization of the hints file is not unlike that of an -.Dq a.out +.Xr a.out 5 object file, in that it contains a header determining the offset and size of a table of fixed sized hash buckets and a common string pool. .Bd -literal -offset indent diff --git a/share/man/man5/motd.5 b/share/man/man5/motd.5 index 8e4c6720622..69a1c8da591 100644 --- a/share/man/man5/motd.5 +++ b/share/man/man5/motd.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: motd.5,v 1.3 1998/11/26 04:25:58 aaron Exp $ .\" $NetBSD: motd.5,v 1.2 1994/12/28 18:58:53 glass Exp $ .\" .\" This file is in the public domain. @@ -20,7 +21,7 @@ prepended to this file. .Pp Individual users may suppress the display of this file by creating a file named -.Dq Pa .hushlogin +.Pa .hushlogin in their home directories. .Sh FILES .Bl -tag -width /etc/motd -compact diff --git a/share/man/man5/netgroup.5 b/share/man/man5/netgroup.5 index 13abba9f774..84826cf1cca 100644 --- a/share/man/man5/netgroup.5 +++ b/share/man/man5/netgroup.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: netgroup.5,v 1.3 1998/11/26 04:25:59 aaron Exp $ .\" $NetBSD: netgroup.5,v 1.3 1995/03/18 14:58:34 cgd Exp $ .\" .\" Copyright (c) 1992, 1993 @@ -45,7 +46,9 @@ The .Nm netgroup file -specifies ``netgroups'', which are sets of +specifies +.Dq netgroups , +which are sets of .Sy (host, user, domain) tuples that are to be given similar network access. .Pp @@ -59,16 +62,21 @@ of a tuple as follows: .Ed .Pp where the -.Sy host , -.Sy user , +.Ar host , +.Ar user , and -.Sy domain +.Ar domain are character string names for the corresponding component. -Any of the comma separated fields may be empty to specify a ``wildcard'' value -or may consist of the string ``-'' to specify ``no valid value''. +Any of the comma separated fields may be empty to specify a +.Dq wildcard +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 ``\e'' character may be used at the end of a line to specify -line continuation. +the +.Dq \e +character may be used at the end of a line to specify line continuation. The functions specified in .Xr getnetgrent 3 should normally be used to access the @@ -79,32 +87,27 @@ These functions operate on the .Xr db version of the .Nm netgroup -.Nm (netgroup.db) +.Pq Pa netgroup.db file which can be generated using .Xr netgroup_mkdb . -If that file is not present, and the system supports -.Sy NIS, -then the +If that file is not present, and the system supports NIS, then the .Nm netgroup -.Sy NIS -maps are used. The -.Sy NIS -maps are also used if the +NIS maps are used. The NIS maps are also used if the .Nm netgroup file contains a -.Sy + +.Dq + entry. .Pp Lines that begin with a # are treated as comments. .Sh FILES .Bl -tag -width /etc/netgroup.db -compact .It Pa /etc/netgroup.db -the netgroup database. +netgroup database .El .Sh SEE ALSO -.Xr netgroup_mkdb 8 , .Xr getnetgrent 3 , -.Xr exports 5 +.Xr exports 5 , +.Xr netgroup_mkdb 8 .Sh COMPATIBILITY The file format is compatible with that of various vendors, however it appears that not all vendors use an identical format. diff --git a/share/man/man5/networks.5 b/share/man/man5/networks.5 index 893fb5795bc..b8ef5e0f3cc 100644 --- a/share/man/man5/networks.5 +++ b/share/man/man5/networks.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: networks.5,v 1.5 1998/06/29 13:06:27 deraadt Exp $ +.\" $OpenBSD: networks.5,v 1.6 1998/11/26 04:25:59 aaron Exp $ .\" $NetBSD: networks.5,v 1.3 1994/11/30 19:31:23 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -55,7 +55,9 @@ aliases .Ed .Pp Items are separated by any number of blanks and/or tab characters. -A ``#'' indicates the beginning of a comment; characters up to the end of +A +.Dq # +indicates the beginning of a comment; characters up to the end of the line are not interpreted by routines which search the file. This file is normally created from the official network data base maintained at the Network Information Control Center @@ -64,8 +66,9 @@ though local changes may be required to bring it up to date regarding unofficial aliases and/or unknown networks. .Pp -Network numbers may be specified in the conventional -``.'' (dot) notation using the +Network numbers may be specified in the conventional Internet +.Dq \&. +(dot) notation using the .Xr inet_network 3 routine from the Internet address manipulation library, @@ -91,22 +94,17 @@ database. .Sh FILES .Bl -tag -width /etc/networks -compact .It Pa /etc/networks -The -.Nm networks -file resides in -.Pa /etc . .El .Sh SEE ALSO .Xr getnetent 3 , -.Xr named 8 , -.Xr resolver 3 +.Xr resolver 3 , +.Xr named 8 .Sh BUGS A name server should be used instead of a static file. -.br Lines in .Pa /etc/networks are limited to -.Ev BUFSIZE +.Dv BUFSIZE characters (currently 1024). Longer lines will be ignored. .Sh HISTORY The diff --git a/share/man/man5/passwd.5 b/share/man/man5/passwd.5 index b29ce713597..e9657151161 100644 --- a/share/man/man5/passwd.5 +++ b/share/man/man5/passwd.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: passwd.5,v 1.9 1998/11/20 23:32:34 downsj Exp $ +.\" $OpenBSD: passwd.5,v 1.10 1998/11/26 04:25:59 aaron Exp $ .\" $NetBSD: passwd.5,v 1.4 1995/07/28 06:46:05 phil Exp $ .\" .\" Copyright (c) 1988, 1991, 1993 @@ -45,10 +45,11 @@ The .Nm passwd files are files consisting of newline separated records, one per user, -containing ten colon (``:'') separated fields. These fields are as -follows: +containing ten colon +.Pq Sq \&: +separated fields. These fields are as follows: .Pp -.Bl -tag -width password -offset indent +.Bl -tag -width password -offset indent -compact .It name User's login name. .It password @@ -56,9 +57,9 @@ User's .Em encrypted password. .It uid -User's id. +User's login user ID. .It gid -User's login group id. +User's login group ID. .It class User's general classification (unused). .It change @@ -82,14 +83,20 @@ across the system (and often across a group of systems) since they control file access. .Pp While it is possible to have multiple entries with identical login names -and/or identical user id's, it is usually a mistake to do so. Routines +and/or identical user IDs, it is usually a mistake to do so. Routines that manipulate these files will often return only one of the multiple entries, and that one by random selection. .Pp -The login name must never begin with a hyphen (``-''); also, it is strongly -suggested that neither upper-case characters or dots (``.'') be part +The login name must never begin with a hyphen +.Pq Sq \&- ; +also, it is strongly +suggested that neither uppercase characters nor dots +.Pq Sq \&. +be part of the name, as this tends to confuse mailers. No field may contain a -colon (``:'') as this has been used historically to separate the fields +colon +.Pq Sq \&: +as this has been used historically to separate the fields in the user database. .Pp The password field is the @@ -107,7 +114,9 @@ depends on the configuration in .Xr passwd.conf 5 . It can be different for local and YP passwords. .Pp -The group field is the group that the user will be placed in upon login. +The +.Ar group +field is the group that the user will be placed in upon login. Since this system supports multiple groups (see .Xr groups 1 ) this field currently has little special meaning. @@ -137,17 +146,19 @@ This field may be left empty to turn off the account aging feature. .Pp The .Ar gecos -field normally contains comma (``,'') separated subfields as follows: +field normally contains comma +.Pq Sq \&, +separated subfields as follows: .Pp .Bl -tag -width office -offset indent -compact .It name -user's full name +User's full name. .It office -user's office location +User's office location. .It wphone -user's work phone number +User's work phone number. .It hphone -user's home phone number +User's home phone number. .El .Pp This information is used by the @@ -159,7 +170,9 @@ The user's home directory is the full path name where the user will be placed on login. .Pp -The shell field is the command interpreter the user prefers. +The +.Ar shell +field is the command interpreter the user prefers. If there is nothing in the .Ar shell field, the Bourne shell @@ -171,10 +184,16 @@ If YP is active, the file also supports standard YP exclusions and inclusions, based on user names and netgroups. .Pp -Lines beginning with a ``-'' (minus sign) are entries marked as being excluded -from any following inclusions, which are marked with a ``+'' (plus sign). +Lines beginning with a +.Dq \&- +(minus sign) are entries marked as being excluded +from any following inclusions, which are marked with a +.Dq + +(plus sign). .Pp -If the second character of the line is a ``@'' (at sign), the operation +If the second character of the line is a +.Dq @ +(at sign), the operation involves the user fields of all entries in the netgroup specified by the remaining characters of the .Ar name @@ -183,7 +202,9 @@ Otherwise, the remainder of the .Ar name field is assumed to be a specific user name. .Pp -The ``+'' token may also be alone in the +The +.Dq + +token may also be alone in the .Ar name field, which causes all users from the .Pa passwd.byname @@ -197,7 +218,7 @@ or .Ar gid fields, the specified numbers will override the information retrieved from the YP maps. As well, if the -.Ar gecos, +.Ar gecos , .Ar dir or .Ar shell @@ -223,9 +244,9 @@ containing: .Xr chpass 1 , .Xr login 1 , .Xr passwd 1 , -.Xr passwd.conf 5 , .Xr getpwent 3 , .Xr netgroup 5 , +.Xr passwd.conf 5 , .Xr adduser 8 , .Xr pwd_mkdb 8 , .Xr vipw 8 , @@ -241,7 +262,9 @@ unexpected results. .Sh COMPATIBILITY The password file format has changed since .Bx 4.3 . -The following awk script can be used to convert your old-style password +The following +.Xr awk +script can be used to convert your old-style password file into a new style password file. The additional fields .Dq class , @@ -249,9 +272,14 @@ The additional fields and .Dq expire are added, but are turned off by default. -Class is currently not implemented, but change and expire are; to set them, -use the current day in seconds from the epoch + whatever number of seconds -of offset you want. +.Ar class +is currently not implemented, but +.Ar change +and +.Ar expire +are; to set them, +use the current day in seconds from the epoch plus the number of seconds +of offset desired. .Bd -literal -offset indent BEGIN { FS = ":"} { print $1 ":" $2 ":" $3 ":" $4 "::0:0:" $5 ":" $6 ":" $7 } @@ -262,4 +290,4 @@ A file format appeared in .At v6 . .Pp -YP file format first appeared in SunOS. +The YP file format first appeared in SunOS. diff --git a/share/man/man5/passwd.conf.5 b/share/man/man5/passwd.conf.5 index e703339891b..9d0a9d0ba44 100644 --- a/share/man/man5/passwd.conf.5 +++ b/share/man/man5/passwd.conf.5 @@ -1,4 +1,5 @@ -.\" $OpenBSD: passwd.conf.5,v 1.6 1998/07/05 21:08:37 provos Exp $ +.\" $OpenBSD: passwd.conf.5,v 1.7 1998/11/26 04:25:59 aaron Exp $ +.\" .\" Copyright 1997 Niels Provos <provos@physnet.uni-hamburg.de> .\" All rights reserved. .\" @@ -26,6 +27,7 @@ .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" .Dd February 24, 1997 .Dt PASSWD.CONF 5 .Os @@ -34,31 +36,37 @@ .Nd format of the password configuration file .Sh DESCRIPTION The -.Nm /etc/passwd.conf -file describes the configuration of the password cipher used -to encrypt local or YP passwords. The -.Nm passwd.conf -consists of stanzas. +.Pa /etc/passwd.conf +file, consisting of +.Dq stanzas , +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 +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. +with a single dot +.Pq Sq \&. . .Pp -Some of the fields and their possible values that can appear in +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: 'old', 'newsalt,<rounds>', 'md5' or 'blowfish,<rounds>'. +The cipher to use for local passwords. Possible values are: +.Dq old , +.Dq newsalt,<rounds> , +.Dq md5 , +and +.Dq blowfish,<rounds> . For -.Nm newsalt +.Dq newsalt the value of rounds is a 24-bit integer with a minmum of 7250 rounds. For -.Nm blowfish +.Dq blowfish the value can be between 4 and 31. It specifies the base 2 logarithm of the number of rounds. .It ypcipher @@ -70,8 +78,8 @@ To retrieve information from this file use .Xr pw_getconf 3 . .Pp .Sh EXAMPLE -To use blowfish as local cipher and some more rounds for root and wheel -members. The old unix crypt is used as YP cipher: +Use blowfish as the local cipher; add some more rounds for root and wheel +members. The old Unix crypt is used as YP cipher: .Bd -literal default: localcipher = blowfish,4 @@ -85,5 +93,6 @@ members. The old unix crypt is used as YP cipher: .Ed .Sh SEE ALSO .Xr passwd 1 , -.Xr passwd 5 , -.Xr pw_getconf 3 +.Xr pw_getconf 3 , +.Xr passwd 5 + diff --git a/share/man/man5/phones.5 b/share/man/man5/phones.5 index 35b9ac0dc4e..772741f3977 100644 --- a/share/man/man5/phones.5 +++ b/share/man/man5/phones.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: phones.5,v 1.2 1998/11/26 04:25:59 aaron Exp $ .\" $NetBSD: phones.5,v 1.3 1994/11/30 19:31:25 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -47,16 +48,28 @@ private phone numbers for the .Xr tip 1 program. This file is normally unreadable, and so may contain privileged information. The format of the file is a series of lines -of the form: <system-name>[\ \et]*<phone-number>. The system name is -one of those defined in the +of the form: +.Pp +.D1 Li <system-name>[\ \et]*<phone-number> +.Pp +The system name is one of those defined in the .Xr remote 5 file and the phone number is constructed from any sequence of -characters terminated only by ``,'' or the end of the line. -The ``='' and ``*'' characters are +characters terminated only by +.Dq \&, +or the end of the line. The +.Dq = +and +.Dq \&* +characters are indicators to the auto call units to pause and wait for a second dial -tone (when going through an exchange). The ``='' is required by the +tone (when going through an exchange). The +.Dq = +is required by the .Tn DF02-AC -and the ``*'' is required by the +and the +.Dq \&* +is required by the .Tn BIZCOMP 1030. .Pp diff --git a/share/man/man5/printcap.5 b/share/man/man5/printcap.5 index 372ab79d3a1..87c2e8c3a09 100644 --- a/share/man/man5/printcap.5 +++ b/share/man/man5/printcap.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: printcap.5,v 1.5 1998/11/26 04:25:59 aaron Exp $ .\" $NetBSD: printcap.5,v 1.7 1998/02/20 12:24:50 hubertf Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -43,9 +44,8 @@ .Nm printcap .Sh DESCRIPTION The -.Nm Printcap -function -is a simplified version of the +.Nm printcap +file is a simplified version of the .Xr termcap 5 data base used to describe line printers. The spooling system accesses the @@ -58,11 +58,11 @@ substituted for, as is possible for because it may allow accounting to be bypassed. .Pp The default printer is normally -.Em lp , +.Dq lp , though the environment variable .Ev PRINTER may be used to override this. Each spooling utility supports an option, -.Fl P Ar printer , +.Fl P Ns Ar printer , to allow explicit naming of a destination printer. .Pp Refer to the @@ -134,15 +134,15 @@ If the local line printer driver supports indentation, the daemon must understand how to invoke it. .Sh FILTERS If a printer is specified via -.Sy lp +.Cm lp (either local or remote), the .Xr lpd 8 daemon creates a pipeline of -.Em filters +.Dq filters to process files for various printer types. The pipeline is not set up for remote printers specified via -.Sy rm +.Cm rm unless the local host is the same as the remote printer host given. The filters selected depend on the flags passed to @@ -161,7 +161,7 @@ v vf raster image .Ed .Pp The -.Sy if +.Cm if filter is invoked with arguments: .Bd -filled -offset indent .Cm if @@ -180,9 +180,7 @@ flag is passed only if the flag (pass control characters literally) is specified to .Xr lpr . -The -.Ar Width -function +.Ar width and .Ar length specify the page width and length @@ -198,7 +196,7 @@ and parameters specify the login name and host name of the owner of the job respectively. The -.Ar Acct-file +.Ar acct-file function is passed from the .Cm af @@ -281,13 +279,13 @@ themselves. Error messages sent to the console have a carriage return and a line feed appended to them, rather than just a line feed. .Sh SEE ALSO +.Xr lpq 1 , +.Xr lpr 1 , +.Xr lprm 1 , .Xr termcap 5 , .Xr lpc 8 , .Xr lpd 8 , -.Xr pac 8 , -.Xr lpr 1 , -.Xr lpq 1 , -.Xr lprm 1 +.Xr pac 8 .Rs .%T "4.3 BSD Line Printer Spooler Manual" .Re @@ -295,4 +293,4 @@ feed appended to them, rather than just a line feed. The .Nm file format appeared in -.Bx 4.2 .. +.Bx 4.2 . diff --git a/share/man/man5/protocols.5 b/share/man/man5/protocols.5 index 01a7b000ba9..eb6af8b89c4 100644 --- a/share/man/man5/protocols.5 +++ b/share/man/man5/protocols.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: protocols.5,v 1.3 1998/11/26 04:25:59 aaron Exp $ .\" $NetBSD: protocols.5,v 1.3 1994/11/30 19:31:27 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -53,7 +54,9 @@ aliases .Ed .Pp Items are separated by any number of blanks and/or -tab characters. A ``#'' indicates the beginning of +tab characters. A +.Dq # +indicates the beginning of a comment; characters up to the end of the line are not interpreted by routines which search the file. .Pp @@ -63,20 +66,15 @@ or comment character. .Sh FILES .Bl -tag -width /etc/protocols -compact .It Pa /etc/protocols -The -.Nm protocols -file resides in -.Pa /etc . .El .Sh SEE ALSO .Xr getprotoent 3 .Sh BUGS A name server should be used instead of a static file. -.br Lines in .Pa /etc/protocols are limited to -.Ev BUFSIZE +.Dv BUFSIZE characters (currently 1024). Longer lines will be ignored. .Sh HISTORY The diff --git a/share/man/man5/remote.5 b/share/man/man5/remote.5 index a6ce30e0bee..a4425c35803 100644 --- a/share/man/man5/remote.5 +++ b/share/man/man5/remote.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: remote.5,v 1.3 1998/11/26 04:25:59 aaron Exp $ .\" $NetBSD: remote.5,v 1.4 1997/04/20 00:05:27 mellon Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -49,17 +50,28 @@ is structured somewhat like the .Xr termcap 5 file. Each line in the file provides a description for a single .Xr system . -Fields are separated by a colon (``:''). -Lines ending in a \e character with an immediately following newline are +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. .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. +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 `=' sign indicates a string value follows. A field -name followed by a `#' sign indicates a following numeric value. +field name followed by an equal sign +.Pq Sq = +indicates a string value follows. A field +name followed by a pound sign +.Pq Sq # +indicates a following numeric value. .Pp -Entries named ``tip*'' and ``cu*'' +Entries named +.Dq tip\&* +and +.Dq cu\&* are used as default entries by .Xr tip , and the @@ -69,17 +81,25 @@ interface to as follows. When .Xr tip is invoked with only a phone number, it looks for an entry -of the form ``tip300'', where 300 is the baud rate with +of the form +.Dq tip300 , +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 ``cu300'' are used. +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 .Em capability Ns Ar = Ns Em value ; -for example, ``dv=/dev/harris''. A numeric capability is specified by +for example, +.Dq dv=/dev/harris . +A numeric capability is specified by .Em capability Ns Ar # Ns Em value ; -for example, ``xa#99''. A boolean capability is specified by simply listing +for example, +.Dq xa#99 . +A boolean capability is specified by simply listing the capability. .Bl -tag -width indent .It Cm \&at @@ -101,7 +121,9 @@ required to switch to the host. .It Cm \&cu (str) Call unit if making a phone call. -Default is the same as the `dv' field. +Default is the same as the +.Cm dv +field. .It Cm \&dc (bool) This host is directly connected, and tip should not expect carrier detect @@ -126,10 +148,12 @@ one user at a time has access to the port. Characters marking an end-of-line. The default is .Dv NULL . -`~' escapes are only +.Dq ~ +escapes are only recognized by .Xr tip -after one of the characters in `el', +after one of the characters in +.Cm el , or after a carriage-return. .It Cm \&fs (str) @@ -157,10 +181,16 @@ string is sent at end-of-file. .It Cm \&pa (str) The type of parity to use when sending data -to the host. This may be one of ``even'', -``odd'', ``none'', ``zero'' (always set bit 8 to zero), -``one'' (always set bit 8 to 1). The default -is even parity. +to the host. This may be one of +.Dq even , +.Dq odd , +.Dq none , +.Dq zero +(always set bit 8 to zero), +or +.Dq one +(always set bit 8 to 1). +The default is even parity. .It Cm \&pn (str) Telephone number(s) for this host. @@ -169,9 +199,8 @@ an @ sign, .Xr tip searches the file .Pa /etc/phones -file for a list of telephone numbers; -(See -.Xr phones 5 . ) +file for a list of telephone numbers (see +.Xr phones 5 ) . .It Cm \&tc (str) Indicates that the list of capabilities is continued @@ -190,11 +219,6 @@ arpavax|ax:\e .Sh FILES .Bl -tag -width /etc/remote -compact .It Pa /etc/remote -The -.Nm remote -host description file -resides in -.Pa /etc . .El .Sh SEE ALSO .Xr tip 1 , diff --git a/share/man/man5/resolv.conf.5 b/share/man/man5/resolv.conf.5 index 5ff01039af8..d965ec9d6d9 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.6 1998/07/24 20:49:13 deraadt Exp $ +.\" $OpenBSD: resolv.conf.5,v 1.7 1998/11/26 04:25:59 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. @@ -74,8 +74,8 @@ 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 the name servers -until a maximum number of retries are made). +then repeat trying all name servers +until a maximum number of retries are performed.) .It Sy domain Local domain name. Most queries for names within this domain can use short names @@ -85,7 +85,8 @@ If no entry is present, the domain is determined from the local host name returned by .Xr gethostname 3 ; -the domain part is taken to be everything after the first `.'. +the domain part is taken to be everything after the first +.Dq \&. . Finally, if the host name does not contain a domain part, the root domain is assumed. .It Sy lookup @@ -95,18 +96,19 @@ and .Xr gethostbyaddr 3 . It specifies which databases should be searched, and the order to do so. -The legal space-separated values are -.Bl -tag -width bind +The legal space-separated values are: +.Pp +.Bl -tag -width bind -compact .It Sy bind -use the Domain Name server by querying the -.Xr named 8 +Use the Domain Name server by querying +.Xr named 8 . .It Sy file -search for entries in -.Nm /etc/hosts +Search for entries in +.Pa /etc/hosts . .It Sy yp -talk to the YP system if +Talk to the YP system if .Xr ypbind 8 -is running +is running. .El .Pp If the @@ -121,7 +123,7 @@ file does not exist, then the only database used is .Sy file . .Pp .It Sy search -Search list for host-name lookup. +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. @@ -140,18 +142,21 @@ for one of the domains. The search list is currently limited to six domains with a total of 1024 characters. .It Sy sortlist -Sortlist allows addresses returned by gethostbyname to -be sorted. -A sortlist is specified by IP address netmask pairs. +Allows addresses returned by +.Xr gethostbyname 3 +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. -Up to 10 pairs may be specified, ie. +Up to 10 pairs may be specified, i.e.: .Pp .Sy sortlist 130.155.160.0/255.255.240.0 130.155.0.0 .It Sy options -Options allows certain internal resolver variables to be modified. +Allows certain internal resolver variables to be modified. The syntax is: .Pp .Sy options option ... @@ -159,17 +164,19 @@ The syntax is: where option is one of the following: .Bl -tag -width ndots:n .It Sy debug -sets RES_DEBUG in _res.options. +Sets RES_DEBUG in _res.options. .It Sy inet6 -enable support for IPv6 addresses, by setting RES_USE_INET6 in +Enables support for IPv6 addresses, by setting RES_USE_INET6 in _res.options (see -.Xr resolver 3 ). +.Xr resolver 3 ) . .It Sy ndots:n -sets a threshold for the number of dots which +Sets a threshold for the number of dots which must appear in a name given to res_query (see .Xr resolver 3 ) before an initial absolute query will be made. -The default for n is 1, meaning that if there are any +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. .El @@ -202,23 +209,19 @@ environment variable 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. +(e.g., .Sy nameserver ) must start the line. The value follows -the keyword, separated by white space. +the keyword, separated by whitespace. .Sh FILES .Bl -tag -width /etc/resolv.conf -compact .It Pa /etc/resolv.conf -The file -.Nm resolv.conf -resides in -.Pa /etc . .El .Sh SEE ALSO .Xr gethostbyname 3 , .Xr resolver 3 , -.Xr hostname 7 , .Xr hosts 5 , +.Xr hostname 7 , .Xr named 8 .Rs .%T "Name Server Operations Guide for BIND" diff --git a/share/man/man5/rpc.5 b/share/man/man5/rpc.5 index b487b394823..169d20ed93d 100644 --- a/share/man/man5/rpc.5 +++ b/share/man/man5/rpc.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: rpc.5,v 1.2 1998/11/26 04:25:59 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; .\" @@ -28,7 +29,9 @@ aliases .Pp Items are separated by any number of blanks and/or tab characters. -A ``#'' indicates the beginning of a comment; characters up to the end of +A +.Dq # +indicates the beginning of a comment; characters up to the end of the line are not interpreted by routines which search the file. .Sh EXAMPLES Here is an example of the @@ -70,6 +73,7 @@ nsed 100038 nsemntd 100039 .Ed .Sh FILES -.Pa /etc/rpc +.Bl -tag -width /etc/rpc -compact +.It Pa /etc/rpc .Sh SEE ALSO .Xr getrpcent 3 diff --git a/share/man/man5/services.5 b/share/man/man5/services.5 index 9892018acbe..1b52ccbbc7c 100644 --- a/share/man/man5/services.5 +++ b/share/man/man5/services.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: services.5,v 1.3 1998/11/26 04:25:59 aaron Exp $ .\" $NetBSD: services.5,v 1.3 1994/11/30 19:31:31 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -59,9 +60,14 @@ Items are separated by any number of blanks and/or tab characters. The port number and protocol name are considered a single .Em item ; -a ``/'' is used to -separate the port and protocol (e.g. ``512/tcp''). -A ``#'' indicates the beginning of +a +.Dq / +is used to +separate the port and protocol (e.g., +.Dq 512/tcp ) . +A +.Dq # +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 @@ -71,20 +77,15 @@ or comment character. .Sh FILES .Bl -tag -width /etc/services -compact .It Pa /etc/services -The -.Nm services -file resides in -.Pa /etc . .El .Sh SEE ALSO .Xr getservent 3 .Sh BUGS A name server should be used instead of a static file. -.br Lines in .Pa /etc/services are limited to -.Ev BUFSIZE +.Dv BUFSIZE characters (currently 1024). Longer lines will be ignored. .Sh HISTORY The diff --git a/share/man/man5/shells.5 b/share/man/man5/shells.5 index a536ee0f4cf..016910fde1d 100644 --- a/share/man/man5/shells.5 +++ b/share/man/man5/shells.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: shells.5,v 1.2 1998/11/26 04:25:59 aaron Exp $ .\" $NetBSD: shells.5,v 1.3 1994/11/30 19:31:32 jtc Exp $ .\" .\" Copyright (c) 1986, 1991, 1993 @@ -46,17 +47,15 @@ file contains a list of the shells on the system. For each shell a single line should be present, consisting of the shell's path, relative to root. .Pp -A hash mark (``#'') indicates the beginning of a comment; subsequent +A hash mark +.Pq Sq # +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. Blank lines are also ignored. .Sh FILES .Bl -tag -width /etc/shells -compact .It Pa /etc/shells -The -.Nm shells -file resides in -.Pa /etc . .El .Sh SEE ALSO .Xr getusershell 3 diff --git a/share/man/man5/stab.5 b/share/man/man5/stab.5 index d6a9d097690..cdfc9677b05 100644 --- a/share/man/man5/stab.5 +++ b/share/man/man5/stab.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: stab.5,v 1.3 1998/11/26 04:25:59 aaron Exp $ .\" $NetBSD: stab.5,v 1.3 1994/11/30 19:31:33 jtc Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -46,28 +47,30 @@ The file .Aq Pa stab.h defines some of the symbol table .Fa n_type -field values for a.out files. -These are the types for permanent symbols (i.e. not local labels, etc.) +field values for +.Xr a.out 5 +files. +These are the types for permanent symbols (i.e., not local labels, etc.) used by the old debugger .Em sdb and the Berkeley Pascal compiler .Xr pc 1 . Symbol table entries can be produced by the -.Pa .stabs +.Dq .stabs assembler directive. This allows one to specify a double-quote delimited name, a symbol type, one char and one short of information about the symbol, and an unsigned long (usually an address). To avoid having to produce an explicit label for the address field, the -.Pa .stabd +.Dq .stabd directive can be used to implicitly address the current location. If no name is needed, symbol table entries can be generated using the -.Pa .stabn +.Dq .stabn directive. The loader promises to preserve the order of symbol table entries produced by -.Pa .stab +.Dq .stab directives. As described in .Xr a.out 5 , @@ -117,7 +120,7 @@ The field of a symbol is relocated by the linker, .Xr ld 1 as an address within the appropriate segment. -.Fa N_value +.Fa n_value fields of symbols not in any segment are unchanged by the linker. In addition, the linker will discard certain symbols, according to rules of its own, unless the @@ -137,7 +140,9 @@ segments. Some of these have already been claimed. The old symbolic debugger, .Em sdb , -uses the following n_type values: +uses the following +.Fa n_type +values: .Bd -literal #define N_GSYM 0x20 /* global symbol: name,,0,type,0 */ #define N_FNAME 0x22 /* procedure name (f77 kludge): name,,0 */ @@ -163,8 +168,7 @@ uses the following n_type values: where the comments give .Em sdb conventional use for -.Pa .stab -.Fa s +.Dq .stab s and the .Fa n_name , .Fa n_other , @@ -174,7 +178,7 @@ and fields of the given .Fa n_type . -.Em Sdb +.Em sdb uses the .Fa n_desc field to hold a type specifier in the form used @@ -211,8 +215,8 @@ compiled files: .Ed .Sh SEE ALSO .Xr as 1 , -.Xr ld 1 , .Xr gdb 1 , +.Xr ld 1 , .Xr a.out 5 .Sh BUGS .Pp diff --git a/share/man/man5/sysctl.conf.5 b/share/man/man5/sysctl.conf.5 index a3be418fb14..f1398120973 100644 --- a/share/man/man5/sysctl.conf.5 +++ b/share/man/man5/sysctl.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sysctl.conf.5,v 1.2 1998/06/26 03:08:39 millert Exp $ +.\" $OpenBSD: sysctl.conf.5,v 1.3 1998/11/26 04:25:59 aaron Exp $ .\" .\" Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com> .\" All rights reserved. @@ -27,7 +27,7 @@ .\" .Dd June 25, 1998 .Os -.Dt SYSCTL.CONF 8 +.Dt SYSCTL.CONF 5 .Sh NAME .Nm sysctl.conf .Nd sysctl variables to set at bootup @@ -41,8 +41,10 @@ early on in the boot sequence. .Pp The file is made up of .Xr sysctl 8 -variable assignments (variable=value) with comments designated by a hash, -.Dq # . +variable assignments +.Pq Ar variable Ns No = Ns Ar value +with comments designated by a hash mark +.Pq Sq # . .Sh EXAMPLES To turn on IP forwarding, one would use the following line: .Bd -literal -offset indent @@ -55,12 +57,14 @@ the debugger, the following can be used: ddb.panic=0 .Ed .Sh FILES -.Pa /etc/sysctl.conf +.Bl -tag -width /etc/sysctl.conf -compact +.It Pa /etc/sysctl.conf +.El .Sh SEE ALSO .Xr rc 8 , .Xr sysctl 8 .Sh HISTORY -The file +A .Nm sysctl.conf -first appeared in +file first appeared in .Ox 2.3 . diff --git a/share/man/man5/types.5 b/share/man/man5/types.5 index e3e37ad8dcc..e0df03eb5c8 100644 --- a/share/man/man5/types.5 +++ b/share/man/man5/types.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: types.5,v 1.4 1998/11/26 04:25:59 aaron Exp $ .\" $NetBSD: types.5,v 1.3 1994/11/30 19:31:34 jtc Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -43,9 +44,9 @@ .Fd #include <sys/types.h> .Sh DESCRIPTION The file -.Pa sys/types.h +.Aq Pa sys/types.h contains the defined data types used in the kernel (most are -used through out the system). +used throughout the system). .Bd -literal #ifndef _TYPES_H_ #define _TYPES_H_ @@ -138,9 +139,9 @@ typedef struct fd_set { #endif /* !_TYPES_H_ */ .Ed .Sh SEE ALSO -.Xr fs 5 , +.Xr lseek 2 , .Xr time 3 , -.Xr lseek 2 +.Xr fs 5 .Sh HISTORY A .Nm diff --git a/share/man/man5/utmp.5 b/share/man/man5/utmp.5 index b9a74df1e8d..86cded1d9da 100644 --- a/share/man/man5/utmp.5 +++ b/share/man/man5/utmp.5 @@ -1,3 +1,4 @@ +.\" $OpenBSD: utmp.5,v 1.7 1998/11/26 04:26:00 aaron Exp $ .\" $NetBSD: utmp.5,v 1.5 1994/11/30 19:31:35 jtc Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -47,12 +48,13 @@ The file .Aq Pa utmp.h declares the structures used to record information about current -users in the file -.Nm utmp , -logins and logouts in the file -.Nm wtmp , -and last logins in the file -.Nm lastlog . +users in the +.Nm utmp +file, logins and logouts in the +.Nm wtmp +file, and last logins in the +.Nm lastlog +file. The time stamps of date changes, shutdowns and reboots are also logged in the .Nm wtmp @@ -92,17 +94,18 @@ Each time a user logs in, the program looks up the user's .Tn UID in the file -.Nm lastlog. +.Nm lastlog . If it is found, the timestamp of the last time the user logged in, the terminal line and the hostname -are written to the standard output. (Providing the login is not -.Em quiet , +are written to the standard output (provided the login is not +.Dq quiet , see -.Xr login 1 . ) +.Xr login 1 ) . The .Xr login -program then records the new login time in the file -.Nm lastlog . +program then records the new login time in the +.Nm lastlog +file. .Pp After the new .Fa lastlog @@ -110,9 +113,9 @@ record is written, .\" the .\" .Xr libutil 3 .\" routine -the file +the .Nm utmp -is opened and the +file is opened and the .Fa utmp record for the user inserted. This record remains there until @@ -128,16 +131,16 @@ and .Pp Next, the .Xr login -program opens the file -.Nm wtmp , -and appends the user's +program opens the +.Nm wtmp +file and appends the user's .Fa utmp record. -! When the user logs out, a +When the user logs out, a .Fa utmp -! record with the tty line, an updated time stamp, and zero'd name and host -! fields is appended to the file. (See -.Xr init 8 . ) +record with the tty line, an updated timestamp, and zeroed name and host +fields is appended to the file (see +.Xr init 8 ) . The .Nm wtmp file is used by the programs @@ -145,57 +148,59 @@ file is used by the programs and .Xr ac 8 . .Pp -In the event of a date change, a shutdown or reboot, the +In the event of a date change, shutdown, or reboot, the following items are logged in the .Nm wtmp -file. +file: .Pp .Bl -tag -width shutdownxx -compact .It Li reboot .It Li shutdown A system reboot or shutdown has been initiated. -The character -.Ql \&~ -is placed in the field +A tilde +.Pq Sq \&~ +character is placed in the field .Fa ut_line , and -.Li reboot +.Dq reboot or -.Li shutdown +.Dq shutdown in the field -.Fa ut_name . -(See +.Fa ut_name +(see .Xr shutdown 8 and -.Xr reboot 8 . ) +.Xr reboot 8 ) . .Pp .It Li date -The system time has been manually or automatically updated. -(See -.Xr date 1 . ) +The system time has been manually or automatically updated (see +.Xr date 1 ) . The command name .Xr date is recorded in the field .Fa ut_name . In the field .Fa ut_line , -the character -.Ql \\*(Ba -indicates the time prior to the change, and the character -.Ql \&{ -indicates the new time. +the +.Dq \&| +character indicates the time prior to the change and the +.Dq \&{ +character indicates the new time. .El .Sh FILES .Bl -tag -width /var/log/lastlog -compact .It Pa /var/run/utmp -The -.Nm utmp file. +the +.Nm utmp +file .It Pa /var/log/wtmp -The -.Nm wtmp file. +the +.Nm wtmp +file .It Pa /var/log/lastlog -The -.Nm lastlog file. +the +.Nm lastlog +file .El .Sh SEE ALSO .Xr last 1 , |