From eadcc84a99820050d2d0c87363ce944a92f69051 Mon Sep 17 00:00:00 2001 From: "Cynthia A. E. Livingston" Date: Fri, 10 May 1991 21:12:15 -0800 Subject: [PATCH] mdoc version three SCCS-vsn: sbin/disklabel/disklabel.5.5 6.6 SCCS-vsn: old/dlmpcc/dlmpcc.8 6.6 SCCS-vsn: old/dlmpcc/mpcc.4 6.6 SCCS-vsn: old/dlmpcc/mpcctab.4 6.5 SCCS-vsn: games/dm/dm.conf.5 5.8 SCCS-vsn: sbin/mountd/exports.5 5.2 SCCS-vsn: share/man/man5/fstab.5 6.5 SCCS-vsn: libexec/getty/gettytab.5 6.7 SCCS-vsn: share/man/man5/hosts.5 6.6 SCCS-vsn: usr.bin/man/man.conf.5 5.6 SCCS-vsn: share/man/man5/networks.5 6.5 SCCS-vsn: share/man/man5/printcap.5 6.6 SCCS-vsn: share/man/man5/protocols.5 6.5 SCCS-vsn: share/man/man5/remote.5 6.3 SCCS-vsn: share/man/man5/resolver.5 5.12 SCCS-vsn: share/man/man5/services.5 6.6 SCCS-vsn: share/man/man5/shells.5 5.4 SCCS-vsn: share/man/man5/stab.5 6.5 SCCS-vsn: usr.bin/ranlib/ranlib.5.5 5.2 --- usr/src/games/dm/dm.conf.5 | 65 ++-- usr/src/libexec/getty/gettytab.5 | 326 +++++++++------- usr/src/old/dlmpcc/dlmpcc.8 | 11 +- usr/src/old/dlmpcc/mpcc.4 | 120 ++++-- usr/src/old/dlmpcc/mpcctab.4 | 546 ++++++++++++++++++--------- usr/src/sbin/disklabel/disklabel.5.5 | 247 ++++++------ usr/src/sbin/mountd/exports.5 | 145 ++++--- usr/src/share/man/man5/fstab.5 | 188 +++++---- usr/src/share/man/man5/hosts.5 | 84 +++-- usr/src/share/man/man5/networks.5 | 68 ++-- usr/src/share/man/man5/printcap.5 | 326 ++++++++-------- usr/src/share/man/man5/protocols.5 | 57 +-- usr/src/share/man/man5/remote.5 | 166 ++++---- usr/src/share/man/man5/resolver.5 | 106 ++++-- usr/src/share/man/man5/services.5 | 63 ++-- usr/src/share/man/man5/shells.5 | 41 +- usr/src/share/man/man5/stab.5 | 196 +++++----- usr/src/usr.bin/man/man.conf.5 | 153 +++++--- usr/src/usr.bin/ranlib/ranlib.5.5 | 44 ++- 19 files changed, 1741 insertions(+), 1211 deletions(-) diff --git a/usr/src/games/dm/dm.conf.5 b/usr/src/games/dm/dm.conf.5 index c5605c2c0f..284b1e18bb 100644 --- a/usr/src/games/dm/dm.conf.5 +++ b/usr/src/games/dm/dm.conf.5 @@ -1,32 +1,38 @@ -.\" Copyright (c) 1988 Regents of the University of California. +.\" Copyright (c) 1988, 1991 Regents of the University of California. .\" All rights reserved. .\" .\" %sccs.include.redist.man% .\" -.\" @(#)dm.conf.5 5.7 (Berkeley) %G% +.\" @(#)dm.conf.5 5.8 (Berkeley) %G% .\" -.TH DM.CONF 5 "" -.UC 5 -.SH NAME -dm.conf \- dm configuration file -.SH DESCRIPTION -.I Dm.conf +.Dd +.Dt DM.CONF 5 +.Os BSD 4.2 +.Sh NAME +.Nm dm.conf +.Nd \&dm configuration file +.Sh DESCRIPTION +The +.Xr dm.conf +file is the configuration file for the -.IR dm (8) +.Xr \&dm 8 program. It consists of lines beginning with one of three keywords, ``badtty'', ``game'', and ``time''. All other lines are ignored. -.PP +.Pp Any tty listed after the keyword ``badtty'' may not have games played on -it. Entries consist of two white-space separated fields: the string -``badtty'' and the ttyname as returned by \fIttyname\fP(3). For example, +it. +Entries consist of two white-space separated fields: the string +``badtty'' and the ttyname as returned by +.Xr ttyname 3 . +For example, to keep the uucp dialout, ``tty19'', from being used for games, the entry would be: -.PP -.RS +.Bd -literal -offset indent badtty /dev/tty19 -.RE -.PP +.Ed +.Pp Any day/hour combination listed after the keyword ``time'' will disallow games during those hours. Entries consist of four white-space separated fields: the string ``time'', the unabbreviated day of the week and the @@ -34,11 +40,10 @@ beginning and ending time of a period of the day when games may not be played. The time fields are in a 0 based, 24-hour clock. For example, the following entry allows games playing before 8AM and after 5PM on Mondays. -.PP -.RS +.Bd -literal -offset indent time Monday 8 17 -.RE -.PP +.Ed +.Pp Any game listed after the keyword ``game'' will set parameters for a specific game. Entries consist of five white-space separated fields: the keyword ``game'', the name of a game, the highest system load average at which the @@ -51,12 +56,18 @@ file. Priorities may not be negative. For example, the following entries limits the game ``hack'' to running only when the system has 10 or less users and a load average of 5 or less; all other games may be run any time the system has 15 or less users. -.PP -.RS +.Bd -literal -offset indent game hack 5 10 * game default * 15 * -.RE -.SH FILES -/etc/dm.conf \fIdm\fP(8) configuration file -.SH "SEE ALSO" -setpriority(2), ttyname(3), dm(8) +.Ed +.Sh FILES +.Bl -tag -width /etc/dm.conf -compact +.It Pa /etc/dm.conf +The +.Xr \&dm 8 +configuration file. +.El +.Sh SEE ALSO +.Xr setpriority 2 , +.Xr ttyname 3 , +.Xr dm 8 diff --git a/usr/src/libexec/getty/gettytab.5 b/usr/src/libexec/getty/gettytab.5 index 8454663cd2..b64bbd2bbe 100644 --- a/usr/src/libexec/getty/gettytab.5 +++ b/usr/src/libexec/getty/gettytab.5 @@ -1,118 +1,154 @@ -.\" Copyright (c) 1983 The Regents of the University of California. +.\" Copyright (c) 1983, 1991 The Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)gettytab.5 6.6 (Berkeley) %G% +.\" @(#)gettytab.5 6.7 (Berkeley) %G% .\" -.TH GETTYTAB 5 "" -.UC 5 -.SH NAME -gettytab \- terminal configuration data base -.SH SYNOPSIS -/etc/gettytab -.SH DESCRIPTION -.I Gettytab +.Dd +.Dt GETTYTAB 5 +.Os BSD 4.2 +.Sh NAME +.Nm gettytab +.Nd terminal configuration data base +.Sh SYNOPSIS +.Nm gettytab +.Sh DESCRIPTION +The +.Nm gettytab +file is a simplified version of the -.IR termcap (5) +.Xr termcap 5 data base used to describe terminal lines. The initial terminal login process -.IR getty (8) +.Xr getty 8 accesses the -.I gettytab +.Nm gettytab file each time it starts, allowing simpler reconfiguration of terminal characteristics. Each entry in the data base is used to describe one class of terminals. -.PP +.Pp There is a default terminal class, -.IR default , +.Em default , that is used to set global defaults for all other classes. (That is, the -.I default +.Em default entry is read, then the entry for the class required is used to override particular settings.) -.SH CAPABILITIES +.Sh CAPABILITIES Refer to -.IR termcap (5) +.Xr termcap 5 for a description of the file layout. The -.I default +.Em default column below lists defaults obtained if there is no entry in the table obtained, nor one in the special -.I default +.Em default table. -.nf - -.ta \w'k0-k9 'u +\w'Type 'u +\w'``/usr/bin/login" 'u -\fBName Type Default Description\fR -ap bool false terminal uses any parity -bd num 0 backspace delay -bk str 0377 alternate end of line character (input break) -cb bool false use crt backspace mode -cd num 0 carriage-return delay -ce bool false use crt erase algorithm -ck bool false use crt kill algorithm -cl str NULL screen clear sequence -co bool false console - add \\n after login prompt -ds str ^Y delayed suspend character -dx bool false set DECCTLQ -ec bool false leave echo \s-2OFF\s0 -ep bool false terminal uses even parity -er str ^? erase character -et str ^D end of text (\s-2EOF\s0) character -ev str NULL initial enviroment -f0 num unused tty mode flags to write messages -f1 num unused tty mode flags to read login name -f2 num unused tty mode flags to leave terminal as -fd num 0 form-feed (vertical motion) delay -fl str ^O output flush character -hc bool false do \s-2NOT\s0 hangup line on last close -he str NULL hostname editing string -hn str hostname hostname -ht bool false terminal has real tabs -ig bool false ignore garbage characters in login name -im str NULL initial (banner) message -in str ^C interrupt character -is num unused input speed -kl str ^U kill character -lc bool false terminal has lower case -lm str login: login prompt -ln str ^V ``literal next'' character -lo str /usr/bin/login program to exec when name obtained -nd num 0 newline (line-feed) delay -nl bool false terminal has (or might have) a newline character -np bool false terminal uses all 8 bits for display, thus no parity -nx str default next table (for auto speed selection) -op bool false terminal uses odd parity -os num unused output speed -pc str \\0 pad character -pe bool false use printer (hard copy) erase algorithm -pf num 0 delay between first prompt and following flush (seconds) -ps bool false line connected to a MICOM port selector -qu str ^\\ quit character -rp str ^R line retype character -rw bool false do \s-2NOT\s0 use raw for input, use cbreak -sp num unused line speed (input and output) -su str ^Z suspend character -tc str none table continuation -to num 0 timeout (seconds) -tt str NULL terminal type (for enviroment) -ub bool false do unbuffered output (of prompts etc) -uc bool false terminal is known upper case only -we str ^W word erase character -xc bool false do \s-2NOT\s0 echo control chars as ^X -xf str ^S XOFF (stop output) character -xn str ^Q XON (start output) character -.br -.fi -.PP +.Bl -column Namexx /usr/bin/login Default +.It Sy Name Type Default Description +.It "ap bool false terminal uses any parity" +.It "bd num 0 backspace delay" +.It "bk str 0377 alternate end of line character (input break)" +.It "cb bool false use crt backspace mode" +.It "cd num 0 carriage-return delay" +.It "ce bool false use crt erase algorithm" +.It "ck bool false use crt kill algorithm" +.It "cl str" Ta Dv NULL Ta +.No "screen clear sequence" +.It "co bool false console - add" +.Ql \en +after login prompt +.It "ds str" Ta So Li ^Y Sc Ta +.No "delayed suspend character" +.It "dx bool false set" +.Dv DECCTLQ +.It "ec bool false leave echo" +.Tn OFF +.It "ep bool false terminal uses even parity" +.It "er str" Ta So Li ^? Sc Ta +.No "erase character" +.It "et str" Ta So Li ^D Sc Ta +.No "end of text" +.Pq Dv EOF +character +.It "ev str" Ta Dv NULL Ta +.No "initial enviroment" +.It "f0 num unused tty mode flags to write messages" +.It "f1 num unused tty mode flags to read login name" +.It "f2 num unused tty mode flags to leave terminal as" +.It "fd num 0 form-feed (vertical motion) delay" +.It "fl str" Ta So Li ^O Sc Ta +.No "output flush character" +.It "hc bool false do" +.Tn NOT +hangup line on last close +.It "he str" Ta Dv NULL Ta +.No "hostname editing string" +.It "hn str hostname hostname" +.It "ht bool false terminal has real tabs" +.It "ig bool false ignore garbage characters in login name" +.It "im str" Ta Dv NULL Ta +.No "initial (banner) message" +.It "in str" Ta So Li ^C Sc Ta +.No "interrupt character" +.It "is num unused input speed" +.It "kl str" Ta So Li ^U Sc Ta +.No "kill character" +.It "lc bool false terminal has lower case" +.It "lm str login: login prompt" +.It "ln str" Ta So Li ^V Sc Ta +.No "``literal next'' character" +.It "lo str" Ta Pa /usr/bin/login Ta +.No "program to exec when name obtained" +.It "nd num 0 newline (line-feed) delay" +.It "nl bool false terminal has (or might have) a newline character" +.It "nx str default next table (for auto speed selection)" +.It "op bool false terminal uses odd parity" +.It "os num unused output speed" +.It "pc str" Ta So Li \e0 Sc Ta +.No "pad character" +.It "pe bool false use printer (hard copy) erase algorithm" +.It "pf num 0 delay" +between first prompt and following flush (seconds) +.It "ps bool false line connected to a" +.Tn MICOM +port selector +.It "qu str" Ta So Li \&^\e Sc Ta +.No "quit character" +.It "rp str" Ta So Li ^R Sc Ta +.No "line retype character" +.It "rw bool false do" +.Tn NOT +use raw for input, use cbreak +.It "sp num unused line speed (input and output)" +.It "su str" Ta So Li ^Z Sc Ta +.No "suspend character" +.It "tc str none table continuation" +.It "to num 0 timeout (seconds)" +.It "tt str" Ta Dv NULL Ta +.No "terminal type (for environment)" +.It "ub bool false do unbuffered output (of prompts etc)" +.It "uc bool false terminal is known upper case only" +.It "we str" Ta So Li ^W Sc Ta +.No "word erase character" +.It "xc bool false do +.Tn NOT +echo control chars as +.Ql ^X +.It "xf str" Ta So Li ^S Sc Ta Dv XOFF +(stop output) character +.It "xn str" Ta So Li ^Q Sc Ta Dv XON +(start output) character +.El +.Pp If no line speed is specified, speed will not be altered from that which prevails when getty is entered. Specifying an input or output speed will override line speed for stated direction only. -.PP +.Pp Terminal modes to be used for the output of the message, for input of the login name, and to leave the terminal set as upon completion, @@ -120,132 +156,142 @@ are derived from the boolean flags specified. If the derivation should prove inadequate, any (or all) of these three may be overriden with one of the -.BR f0 , -.BR f1 ", or" -.B f2 +.Em \&f0 , +.Em \&f1 , +or +.Em \&f2 numeric specifications, which can be used to specify (usually in octal, with a leading '0') the exact values of the flags. Local (new tty) flags are set in the top 16 bits of this (32 bit) value. -.PP +.Pp Should -.I getty +.Xr getty receive a null character (presumed to indicate a line break) it will restart using the table indicated by the -.B nx +.Em nx entry. If there is none, it will re-use its original table. -.PP +.Pp Delays are specified in milliseconds, the nearest possible delay available in the tty driver will be used. Should greater certainty be desired, delays with values 0, 1, 2, and 3 are interpreted as choosing that particular delay algorithm from the driver. -.PP +.Pp The -.B cl +.Em \&cl screen clear string may be preceded by a (decimal) number of milliseconds of delay required (a la termcap). This delay is simulated by repeated use of the pad character -.BR pc . -.PP +.Em \&pc . +.Pp The initial message, and login message, -.B im +.Em \&im and -.B lm -may include the character sequence \fB%h\fP or \fB%t\fP to obtain +.Em \&lm +may include the character sequence +.Em \&%h +or +.Em \&%t +to obtain the hostname or tty name respectively. -(\fB%%\fP obtains a single '%' character.) +.Pf ( Em %% +obtains a single '%' character.) The hostname is normally obtained from the system, but may be set by the -.B hn +.Em \&hn table entry. In either case it may be edited with -.BR he . +.Em \&he . The -.B he +.Em \&he string is a sequence of characters, each character that is neither '@' nor '#' is copied into the final hostname. A '@' in the -.B he +.Em \&he string, causes one character from the real hostname to be copied to the final hostname. A '#' in the -.B he +.Em \&he string, causes the next character of the real hostname to be skipped. Surplus '@' and '#' characters are ignored. -.PP +.Pp When getty execs the login process, given in the -.B lo -string (usually "/usr/bin/login"), it will have set +.Em \&lo +string (usually +.Dq Pa /usr/bin/login ) , +it will have set the enviroment to include the terminal type, as indicated by the -.B tt +.Em \&tt string (if it exists). The -.B ev +.Em \&ev string, can be used to enter additional data into the environment. It is a list of comma separated strings, each of which will presumably be of the form -.IR name=value . -.PP +.Em name=value . +.Pp If a non-zero timeout is specified, with -.BR to , +.Em \&to , then getty will exit within the indicated number of seconds, either having received a login name and passed control to -.IR login , +.Xr login , or having received an alarm signal, and exited. This may be useful to hangup dial in lines. -.PP +.Pp Output from -.I getty +.Xr getty is even parity unless -.B op +.Em \&op is specified. -.B Op +The +.Em \&op +string may be specified with -.B ap +.Em \&ap to allow any parity on input, but generate odd parity output. Note: this only applies while getty is being run, terminal driver limitations prevent a more complete implementation. -For terminals that use the full eight bit for character set (like the -IBM PC console and DEC VT 220 terminals), -.B np -may be specified to provide no parity on output, which superceeds the -above mentioned parity options. -.I Getty +.Xr Getty does not check parity of input characters in -.I RAW +.Dv RAW mode. -.SH "SEE ALSO" -login(1), -termcap(5), -getty(8). -.SH BUGS +.Sh SEE ALSO +.Xr login 1 , +.Xr termcap 5 , +.Xr getty 8 . +.Sh BUGS The special characters (erase, kill, etc.) are reset to system defaults by -.IR login (1). +.Xr login 1 . In -.B all +.Em all cases, '#' or '^H' typed in a login name will be treated as an erase character, and '@' will be treated as a kill character. -.PP +.Pp The delay stuff is a real crock. Apart form its general lack of flexibility, some of the delay algorithms are not implemented. The terminal driver should support sane delay settings. -.PP +.Pp The -.B he +.Em \&he capability is stupid. -.PP -.I Termcap +.Pp +The +.Xr termcap format is horrid, something more rational should have been chosen. +.Sh HISTORY +The +.Nm gettytab +file format appeared in 4.2BSD. diff --git a/usr/src/old/dlmpcc/dlmpcc.8 b/usr/src/old/dlmpcc/dlmpcc.8 index f242ef3674..e522cfbdb2 100644 --- a/usr/src/old/dlmpcc/dlmpcc.8 +++ b/usr/src/old/dlmpcc/dlmpcc.8 @@ -1,11 +1,12 @@ -.\" Copyright (c) 1987, 1991 The Regents of the University of California. +.\" Copyright (c) 1987, 1991, 1991 The Regents of the University of California. .\" All rights reserved. .\" .\" This code is derived from software contributed to Berkeley by .\" Computer Consoles Inc. -.\" %sccs.include.redist.man% .\" -.\" @(#)dlmpcc.8 6.5 (Berkeley) %G% +.\" %sccs.include.redist.roff% +.\" +.\" @(#)dlmpcc.8 6.6 (Berkeley) %G% .\" .Dd .Dt DLMPCC 8 @@ -13,7 +14,7 @@ .Sh NAME .Nm dlmpcc .Nd download -MPCC +.Tn MPCC .Sh SYNOPSIS .Nm dlmpcc .Op n @@ -78,7 +79,7 @@ file with an entry similar to: /usr/sbin/dlmpcc > /dev/console 2>&1 .Ed .Sh SEE ALSO -.Xr mpcctab 4 +.Xr mpcctab 4 , .Xr rc 8 .Sh HISTORY The diff --git a/usr/src/old/dlmpcc/mpcc.4 b/usr/src/old/dlmpcc/mpcc.4 index 5001d79abe..05b6858cf5 100644 --- a/usr/src/old/dlmpcc/mpcc.4 +++ b/usr/src/old/dlmpcc/mpcc.4 @@ -1,54 +1,100 @@ -.\" Copyright (c) 1987 The Regents of the University of California. +.\" Copyright (c) 1987, 1991 The Regents of the University of California. .\" All rights reserved. .\" .\" This code is derived from software contributed to Berkeley by .\" Computer Consoles Inc. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)mpcc.4 6.5 (Berkeley) %G% +.\" @(#)mpcc.4 6.6 (Berkeley) %G% .\" -.TH MPCC 4 "" -.UC 7 -.SH NAME -mpcc \- Multi protocol communications controller -.SH SYNOPSIS -device mp0 at vba? csr 0xffff5000 mpintr mpdlintr +.Dd +.Dt MPCC 4 +.Os +.Sh NAME +.Nm mpcc +.Nd multi protocol communications controller +.Sh SYNOPSIS +.Cd "device mp0 at vba? csr 0xffff5000 mpintr mpdlintr" .br -thru -.br -device mp15 at vba? csr 0xffff5f00 mpintr mpdlintr -.SH DESCRIPTION -The MPCC has two different connecter panel styles. -The 16 port MPCC will support any combination of SYNC or ASYNC ports. -The 32 port MPCC will only support ASYNC ports. -Each async line attached to the MPCC communications controller + thru +.Cd "device mp15 at vba? csr 0xffff5f00 mpintr mpdlintr" +.Sh DESCRIPTION +The +.Tn MPCC +has two different connecter panel styles. +The 16 port +.Tn MPCC +will support any combination of +.Tn SYNC +or +.Tn ASYNC +ports. +The 32 port +.Tn MPCC +will only support +.Tn ASYNC +ports. +Each async line attached to the +.Tn MPCC +communications controller behaves as described in -.IR tty (7) +.Xr tty 7 and may be set to run at any of 16 speeds; see -.IR tty (7) +.Xr tty for the encoding. -.PP -Each MPCC controller uses 2 consecutive entries in the SCB for +.Pp +Each +.Tn MPCC +controller uses two consecutive entries in the +.Tn SCB +for download/handshake, and command/response interrupts. These entries start at 0xa0 for the 1st controllers download/handshake interrupts and 0xa1 for the 1st controllers command/response. -.PP -The MPCC controller requires a firmware download to be completed -before it can function. See \fIdlmpcc\fP(8) and \fImpcctab\fP(4) +.Pp +The +.Tn MPCC +controller requires a firmware download to be completed +before it can function. See +.Xr dlmpcc 8 +and +.Xr mpcctab 4 for specific information on how to configure and download the -firmware into the MPCC controller. -.PP -A maximum of 16 MPCC communication controllers can be supported. -.SH FILES -/dev/tty[A-P][0-f] for 16 port MPCC -.br -/dev/tty[A-P][0-f,g-v] for 32 port MPCC -.SH "SEE ALSO" -tty(7) -.SH BUGS -As of the 4.3BSD-tahoe release, only 16 port mpcc's work, and then -only in async mode. Attempting to reload firmware on an mpcc with +firmware into the +.Tn MPCC +controller. +.Pp +A maximum of 16 +.Tn MPCC +communication controllers can be supported. +.Sh FILES +.Bl -tag -width /dev/tty[A-P][0-f,g-v] -compact +.It Pa /dev/tty[A-P][0-f] +for 16 port +.Tn MPCC +.It Pa /dev/tty[A-P][0-f,g-v] +for 32 port +.Tn MPCC +.El +.Sh SEE ALSO +.Xr tty 7 +.Sh HISTORY +The +.Nm mpcc +driver appeared in +.Bx 4.3 tahoe . +.Sh BUGS +As of the +.Bx 4.3 tahoe +release, only 16 port +.Nm mpcc Ns 's +work, and then +only in async mode. Attempting to reload firmware on an +.Nm mpcc +with active ports may crash the system. This should be fixed within -a short period of time; contact the CSRG at University of California, +a short period of time; contact the +.Tn CSRG +at University of California, Berkeley, for upgrade information. diff --git a/usr/src/old/dlmpcc/mpcctab.4 b/usr/src/old/dlmpcc/mpcctab.4 index 166d4e6597..dbdc1965a1 100644 --- a/usr/src/old/dlmpcc/mpcctab.4 +++ b/usr/src/old/dlmpcc/mpcctab.4 @@ -1,276 +1,449 @@ -.\" Copyright (c) 1987 The Regents of the University of California. +.\" Copyright (c) 1987, 1991 The Regents of the University of California. .\" All rights reserved. .\" .\" This code is derived from software contributed to Berkeley by .\" Computer Consoles Inc. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)mpcctab.4 6.4 (Berkeley) %G% +.\" @(#)mpcctab.4 6.5 (Berkeley) %G% .\" -.TH MPCCTAB 4 "" -.UC 7 -.SH NAME -mpcctab \- MPCC configuration file -.SH DESCRIPTION -The file \fBmpcctab\fR is used to configure CCI's Multi-Protocol -Communication Controller (MPCC). +.Dd +.Dt MPCCTAB 4 +.Os +.Sh NAME +.Nm mpcctab +.Nd +.Tn MPCC +configuration file +.Sh DESCRIPTION +The +.Tn ASCII +file +.Nm mpcctab +is used to configure +.Tn CCI Ns 's +Multi-Protocol +Communication Controller +.Pq Tn MPCC . The controller provides high-speed -synchronous communications for the \s-1POWER 6\s+1 family +synchronous communications for the +.Tn POWER +family of computers. -This file determines the MPCC board +This file determines the +.Tn MPCC +board configurations. You can download either a synchronous , bisync or -an asynchronous protocol to an MPCC board. -See \fIdlmpcc\fR(8) -for details. -.LP -A \fBmpcctab\fR file is supplied -with each MPCC release; however, -you can modify this file or create your own file -by using one of the \s-1UNIX\s+1 text editors. -.LP +an asynchronous protocol to an +.Tn MPCC +board. +(See +.Xr dlmpcc 8 +for details.) +.Pp +A +.Nm mpcctab +file is supplied +with each +.Tn MPCC +release; however, +you can modify this file or create your own file. +.Pp The contents of the file consists of entries that describe supported communication protocols and their unique attributes. The protocols supported are -X.25, SNA, ASYNC, and BISYNC. -For ASYNC two different entries are possible in the -\fIprocol\fR field - if 16 port MPCC async is configured, then ASYNC is -entered; 32 port MPCC async is specified by entering 32PORT. +.Tn X Ns \&.25 , +.Tn SNA , +.Tn ASYNC , +and +.Tn BISYNC . +For +.Tn ASYNC +two different entries are possible in the +.Em procol +field - if 16 port +.Tn MPCC +async is configured, then +.Tn ASYNC +is +entered; 32 port +.Tn MPCC +async is specified by entering +.Pf \&32 Tn PORT . This file must reside in the directory -\fB/etc/mpcc\fR. -.SH Entry Line Format -An entry line consists of an \fIitem identifier\fR followed by +.Pa /usr/libdata . +.Sh Entry Line Format +An entry line consists of an +.Em item identifier +followed by variable width arguments separated by colons. There are three -item identifiers: MPCC, PROTOCOL, PORT. The MPCC line in this file -identifies the board number. The PROTOCOL line identifies +item identifiers: +.Tn MPCC , +.Tn PROTOCOL , +.Tn PORT . +The +.Tn MPCC +line in this file +identifies the board number. The +.Tn PROTOCOL +line identifies the specific communication protocol. -The PORT line describes +The +.Tn PORT +line describes the port for the immediately preceding protocol. The number -of arguments for the PROTOCOL and PORT lines, +of arguments for the +.Tn PROTOCOL +and +.Tn PORT +lines, and the arguments themselves, are protocol dependent. See the individual argument descriptions for details. -.LP +.Pp Notes: Use upper case letters for clarity when specifying the item identifier and the protocol name. Make sure that you enter the argument values in the order specified below. Also, use comments liberally, and indicate comment lines by placing a -pound sign (\fB#\fR) in column one. -.LP +pound sign +.Pq Sy # +in column one. +.Pp The item identifiers and their corresponding line formats, with valid argument values, follow: -.LP -\fBMPCC Line\fR -.LP +.Pp +.Sy MPCC Line +.Pp Format: -.RS -.LP -\fBMPCC:\fIbdno\fB:\fR[\fBFCCS,\fIportno\fR\fB,\fItimer\fR]\fB:\fR[\fBSOC,\fIportno\fR] -.RE -.LP +.Bd -filled -offset indent +.Sm off +.Xo +.Sy MPCC: Em bdno Sy \&: +.Op Sy FCCS, Em portno , timer +.Sy \&: +.Op Sy SOC , Em portno +.Xc +.Sm on +.Ed +.Pp Argument Explanations: -.RS -.IP \fIbdno\fR 8 +.Bl -tag -width indent -offset indent +.It Em bdno Specifies the board number. -.IP \fBFCCS\fR 8 -FCCS is a fault-tolerant support system that allows backup ports +.It Sy FCCS +.Tn FCCS +is a fault-tolerant support system that allows backup ports to assume the functions of failed ports. For example, if port 0 fails for any reason, another port may be configured to assume the duties of the failed port. -The keyword \fBFCCS\fR identifies this feature and must be +The keyword +.Sy FCCS +identifies this feature and must be followed by the list of fail-safe port numbers and a time increment, described below. This feature is optional. -.IP \fBSOC\fR 8 -An FCCS port can also be an SOC (Switch On Close) port, +.It Sy SOC +An +.Tn FCCS +port can also be an +.Tn SOC +(Switch On Close) port, meaning that the port will switch when it is closed. -And as with FCCS, the port will switch if it fails. +And as with +.Tn FCCS , +the port will switch if it fails. This feature is optional. -.IP \fIportno\fR 8 -Portno is a list of port numbers, +.It Em portno +.Em Portno +is a list of port numbers, separated by commas, specifying the primary ports you want protected by backup ports. -FCCS boards have either 4 primary and 4 backup ports, +.Tn FCCS +boards have either 4 primary and 4 backup ports, or 8 primary and 8 backup ports. The valid port numbers are -.B 0 +.Sy 0 through -.B 3 +.Sy 3 for the 4-port version, and -.B 0 +.Sy 0 through -.B 7 +.Sy 7 for the 8-port version. -.IP +.Pp Each of the ports has a switched connector. If the board fails for any reason, the traffic on these ports is automatically routed through the switched connector. -These connectors must be cabled to secondary ports on the other FCCS +These connectors must be cabled to secondary ports on the other +.Tn FCCS connector panels. The secondary ports are numbered 8 through 11 on the 4-port version and 8 through 15 on the 8-port version. -Only the primary ports need be designated in the FCCS configuration line, -however all ports must be identified as described in the PORT Line section +Only the primary ports need be designated in the +.Tn FCCS +configuration line, +however all ports must be identified as described in the +.Tn PORT +Line section below. -.if n .bp -.IP \fItime\fR 8 +.It Em time Specifies the time period for the sentinel relay timer. Each board resets its sentinel timer after the specified time period. If the board fails, and therefore can't set the timer, then control is passed automatically to another board, which continues -the current processing. This feature ensures PerpetualProcessing +the current processing. This feature ensures +.Dq PerpetualProcessing and is transparent to the user. The valid range of values -in milliseconds is from \fB50\fR to \fB5950\fR in +in milliseconds is from +.Sy 50 +to +.Sy 5950 +in 50 millisecond increments. -.LP -.RE -\fBPROTOCOL Line\fR -.LP +.El +.Pp +.Sy PROTOCOL Line +.Pp Format: -.LP -.RS -\fBPROTOCOL:\fIprocol\fB:\fIdepargs\fR -.LP -.RE +.Pp +.Bd -filled -offset indent +.Sm off +.Sy PROTOCOL: Em procol Sy \&: Em depargs +.Sm on +.Ed +.Pp Argument Explanations: -.RS -.IP \fIprocol\fR 10 +.Bd -filled -offset indent +.Bl -tag -width indent +.It Em procol Specifies the protocol you want associated with the -board specified in the previous \fBMPCC\fR line. -.IP \fIdepargs\fR 10 -Specifies the protocol-dependent protocol attributes. X.25 and SNA have ten (10) +board specified in the previous +.Tn MPCC +line. +.It Em depargs +Specifies the protocol-dependent protocol attributes. +X.25 +and +.Tn SNA +have ten (10) arguments, -ASYNC has just one (1) argument, and BISYNC has no arguments. -.LP -.cu -X.25 Dependent Attributes -.LP +.Tn ASYNC +has just +.Em one 1 +argument, and +.Tn BISYNC +has no arguments. +.El +.Pp +.Em X.25 Dependent Attributes +.Pp Note: You must be familiar with the -X.25 CCITT Yellow Book (1980) +X.25 +.Tn CCITT +Yellow Book (1980) in order to understand the following values. -.IP \fIN1\fR 8 +.Bl -tag -width indent +.It Em "N1" Specifies the maximum frame size in bytes. -.IP \fIN2\fR 8 +.It Em "N2" Specifies the retry count. -.IP \fIT1\fR 8 +.It Em "T1" Specifies the retry timer in milliseconds. -.IP \fIT2\fR 8 +.It Em "T2" Specifies the response delay timer in milliseconds. -.IP \fIT3\fR 8 +.It Em "T3" Specifies the inactive link timer in milliseconds. -.IP \fIT4\fR 8 +.It Em "T4" Specifies the idle channel timer in milliseconds. -.IP \fIK\fR 8 +.It Em K Specifies the Level 2 window size. -.if n .bp -.IP \fIxid1\fR 8 -Specifies the destination type in the XID command. It must be a number +.It Em xid1 +Specifies the destination type in the +.Tn XID +command. It must be a number from 1-5: -.nf - - 1 = AXE - 2 = CTSS - 3 = DEX - 4 = DMS - 5 = WESCOM -.fi -.IP \fIxid2\fR 8 -Specifies the destination identity in the XID command. It can be three to -nine ASCII characters. -.IP \fIxid3\fR 8 -Specifies the additional information in the XID command. It can be any -ASCII string up to 20 characters long. -.LP -.cu -ASYNC and 32PORT Dependent Attribute -.IP \fIbufsize\fR 10 +.Bd -unfilled -offset indent +1 = AXE +2 = CTSS +3 = DEX +4 = DMS +5 = WESCOM +.Ed +.It Em xid2 +Specifies the destination identity in the +.Tn XID +command. It can be three to +nine +.Tn ASCII +characters. +.It Em xid3 +Specifies the additional information in the +.Tn XID +command. It can be any +.Tn ASCII +string up to 20 characters long. +.El +.Pp +.Em ASYNC and 32PORT Dependent Attribute +.Bl -tag -width indent +.It Em bufsize Specifies the size of the transmit/receive buffers in bytes. -.RE -.LP -\fBPORT Line\fR -.LP +.El +.Ed +.Pp +.Sy PORT Line +.Pp Format: -.LP -.RS -\fBPORT:\fIportno\fB:\fIprocol\fB:\fIdepargs\fR -.RE -.LP +.Bd -filled -offset indent +.Sm off +.Xo +.Sy PORT: Em portno +.Sy \&: Em procol +.Sy \&: Em depargs +.Xc +.Sm on +.Ed +.Pp Argument Explanations: -.RS -.IP \fIportno\fR 10 +.Bd -filled -offset indent +.Bl -tag -width indent +.It Em portno Specifies the port number of the previously specified board. -.IP \fIprocol\fR 10 +.It Em procol Specifies the protocol. You must state the same protocol -as you stated in the preceding PROTOCOL line. -.IP \fIdepargs\fR 10 +as you stated in the preceding +.Tn PROTOCOL +line. +.It Em depargs Specifies the protocol-dependent port attributes. X.25 has -fourteen (14) arguments. ASYNC, 32PORT and BISYNC have none. SNA has 14 +fourteen (14) arguments. +.Tn ASYNC , +.Pf 32 Tn PORT +and +.Tn BISYNC +have none. +.Tn SNA +has 14 fixed arguments. -.LP -.cu -X.25 Dependent Arguments -.LP -Note: You must be familiar with the X.25 CCITT Yellow +.El +.Pp +.Em X.25 Dependent Arguments +.Pp +Note: You must be familiar with the X.25 +.Tn CCITT +Yellow Book (1980) in order to understand the following values. -.IP \fIixmitbuf\fR 12 +.Bl -tag -width surecvbuf +.It Em ixmitbuf Specifies the number of transmit buffers allocated for I frames. -.IP \fIsuxmitbuf\fR 12 +.It Em suxmitbuf Specifies the number of transmit buffers allocated for -S/U frames. -.IP \fIirecvbuf\fR 12 +.Tn S/U +frames. +.It Em irecvbuf Specifies the number of receive buffers allocated for I frames. -.IP \fIsurecvbuf\fR 12 +.It Em surecvbuf Specifies the number of receive buffers allocated for -S/U frames. -.IP \fIxmito\fR 12 +.Tn S/U +frames. +.It Em xmito Specifies the Level 1 transmit timeout. -This argument should be \fB0\fR so that Level 1 calculates timeout from +This argument should be +.Sy 0 +so that Level 1 calculates timeout from the baud rate. -.IP \fIrts\fR 12 +.It Em rts Specifies the modem control value -for rts. Valid values are \fB1\fR which equals -\fBassert\fR, \fB2\fR which equals \fBdrop\fR, and \fB3\fR -which equals \fBauto\fR. -.IP \fIdtr\fR 12 +for rts. Valid values are +.Sy 1 +which equals +.Xr assert , +.Sy 2 +which equals +.Sy drop , +and +.Sy 3 +which equals +.Sy auto . +.It Em dtr Specifies the modem control value for dtr. -Valid values are \fB1\fR which equals -\fBassert\fR, and \fB2\fR which equals \fBdrop\fR. -.IP \fIlineidle\fR 12 +Valid values are +.Sy 1 +which equals +.Xr assert , +and +.Sy 2 +which equals +.Sy drop . +.It Em lineidle Specifies the line state between transmissions. -Valid values are \fB0\fR which specifies a flag -fill, and \fB1\fR which specifies a mark fill. -.IP \fIrcvadr\fR 12 -Specifies the port configuration. A \fB1\fR makes the port -a DCE, while a \fB3\fR makes the port a DTE. -.IP \fImask\fR 12 +Valid values are +.Sy 0 +which specifies a flag +fill, and +.Sy 1 +which specifies a mark fill. +.It Em rcvadr +Specifies the port configuration. A +.Sy 1 +makes the port +a +.Tn DCE , +while a +.Sy 3 +makes the port a +.Tn DTE . +.It Em mask Specifies the data link receive mask. This argument must be -\fB3\fR. -.IP \fIxmtrty\fR 12 +.Sy 3 . +.It Em xmtrty Specifies the number of data link retries after a transmit timeout. This argument should be zero since upper levels of X25 do retries. -.IP \fIbaud\fR 12 +.It Em baud Specifies the baud rate of a transmission. All standard rates -are supported. Some common rate values are \fB0\fR equals a modem, -\fB13\fR equals 9600, and \fB26\fR equals 56KB. See the header file -\fBmp_port.h\fR for other values. -.IP \fIencode\fR 12 -Specifies the physical data encoding. A \fB0\fR indicates NRZ, and a \fB1\fR -indicates NRZI. -.IP \fItrace\fR 12 -Specifies the data link receive trace mode. This argument must be \fB0\fR. -.RE -.if n .bp -.SH EXAMPLE -The following entry configures five MPCC boards: one for X.25, -ASYNC, 32PORT, BISYNC and SNA. Each has two ports. -.nf - +are supported. Some common rate values are +.Sy 0 +equals a modem, +.Sy 13 +equals 9600, and +.Sy 26 +equals +.Pf \&56 Tn KB . +See the header file +.Pa mp_port.h +for other values. +.It Em encode +Specifies the physical data encoding. A +.Sy 0 +indicates +.Tn NRZ , +and a +.Sy 1 +indicates +.Tn NRZI. +.It Em trace +Specifies the data link receive trace mode. This argument must be +.Sy 0 . +.El +.Ed +.Sh EXAMPLES +The following entry configures five +.Tn MPCC +boards: one for X.25, +.Tn ASYNC , +.Pf 32 Tn PORT , +.Tn BISYNC +and +.Tn SNA . +Each has two ports. +.Bd -literal MPCC:0 PROTOCOL:X25:272:2:6000:1000:30000:20000:8:2:ccice1:remote PORT:0:X25:8:16:8:16:0:1:1:0:1:3:0:0:0:0 @@ -295,12 +468,19 @@ MPCC:4 PROTOCOL:SNA:272:4:800:200:20000:20000:8:2:acey:deucy PORT:0:SNA:8:10:10:24:5:3:1:0:193:193:1:0:0:0 PORT:1:SNA:8:10:10:24:5:3:1:0:193:193:1:0:0:0 -.fi -.SH FILES -/etc/mpcctab -/etc/mpcca -/etc/mpccb -/etc/mpcc32 -/etc/mpccx -.SH SEE ALSO -dlmpcc(8) +.Ed +.Sh FILES +.Bl -tag -width /usr/libdata/mpcctab -compact +.It Pa /usr/libdata/mpcctab +.It Pa /usr/libdata/mpcca +.It Pa /usr/libdata/mpccb +.It Pa /usr/libdata/mpcc32 +.It Pa /usr/libdata/mpccx +.El +.Sh SEE ALSO +.Xr dlmpcc 8 +.Sh HISTORY +The +.Nm mpcc +configuration file appeared in +.Bx 4.3 tahoe . diff --git a/usr/src/sbin/disklabel/disklabel.5.5 b/usr/src/sbin/disklabel/disklabel.5.5 index ec4e783690..aef6e47b21 100644 --- a/usr/src/sbin/disklabel/disklabel.5.5 +++ b/usr/src/sbin/disklabel/disklabel.5.5 @@ -1,27 +1,29 @@ -.\" Copyright (c) 1987 Regents of the University of California. +.\" Copyright (c) 1987, 1991 Regents of the University of California. .\" All rights reserved. .\" .\" This code is derived from software contributed to Berkeley by .\" Symmetric Computer Systems. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)disklabel.5.5 6.5 (Berkeley) %G% +.\" @(#)disklabel.5.5 6.6 (Berkeley) %G% .\" -.TH DISKLABEL 5 "" -.UC 7 -.SH NAME -disklabel \- disk pack label -.SH SYNOPSIS -.B #include -.SH DESCRIPTION +.Dd +.Dt DISKLABEL 5 +.Os +.Sh NAME +.Nm disklabel +.Nd disk pack label +.Sh SYNOPSIS +.Fd #include +.Sh DESCRIPTION Each disk or disk pack on a system may contain a disk label which provides detailed information about the geometry of the disk and the partitions into which the disk is divided. It should be initialized when the disk is formatted, and may be changed later with the -.IR disklabel (8) +.Xr disklabel 8 program. This information is used by the system disk driver and by the bootstrap program to determine how to program the drive @@ -32,60 +34,63 @@ The description of each partition contains an identifier for the partition type (standard filesystem, swap area, etc.). The filesystem updates the in-core copy of the label if it contains incomplete information about the filesystem. -.PP +.Pp The label is located in sector number -.I LABELSECTOR +.Dv LABELSECTOR of the drive, usually sector 0 where it may be found without any information about the disk geometry. It is at an offset -.I LABELOFFSET +.Dv LABELOFFSET from the beginning of the sector, to allow room for the initial bootstrap. The disk sector containing the label is normally made read-only so that it is not accidentally overwritten by pack-to-pack copies or swap operations; -the DIOCWLABEL -.IR ioctl , +the +.Dv DIOCWLABEL +.Xr ioctl 2 , which is done as needed by the -.IR disklabel (8) +.Xr disklabel program. -.PP -A copy of the in-core label for a disk can be obtained with the DIOCGDINFO -.IR ioctl ; +.Pp +A copy of the in-core label for a disk can be obtained with the +.Dv DIOCGDINFO +.Xr ioctl ; this works with a file descriptor for a block or character (``raw'') device for any partition of the disk. -The in-core copy of the label is set by the DIOCSDINFO -.IR ioctl . +The in-core copy of the label is set by the +.Dv DIOCSDINFO +.Xr ioctl . The offset of a partition cannot generally be changed while it is open, nor can it be made smaller while it is open. One exception is that any change is allowed if no label was found on the disk, and the driver was able to construct only a skeletal label without partition information. -Finally, the DIOCWDINFO -.I ioctl +Finally, the +.Dv DIOCWDINFO +.Xr ioctl operation sets the in-core label and then updates the on-disk label; there must be an existing label on the disk for this operation to succeed. Thus, the initial label for a disk or disk pack must be installed by writing to the raw disk. All of these operations are normally done using -.IR disklabel (8). -.PP +.Xr disklabel . +.Pp The format of the disk label, as specified in -.RI < sys/disklabel.h >, +.Aw Pa sys/disklabel.h , is -.nf -.DT +.Bd -literal /* - * Disk description table, see disktab(5) - */ +* Disk description table, see disktab(5) +*/ #define DISKTAB "/etc/disktab" /* - * Each disk has a label which includes information about the hardware - * disk geometry, filesystem partitions, and drive specific information. - * The label is in block 0 or 1, possibly offset from the beginning - * to leave room for a bootstrap, etc. - */ -.ta \w'#define 'u +\w'MAXPARTITIONS 'u +\w'((u_long) 0x82564557) 'u +* Each disk has a label which includes information about the hardware +* disk geometry, filesystem partitions, and drive specific information. +* The label is in block 0 or 1, possibly offset from the beginning +* to leave room for a bootstrap, etc. +*/ + #define LABELSECTOR 0 /* sector containing label */ #define LABELOFFSET 64 /* offset of label in sector */ #define DISKMAGIC ((u_long) 0x82564557) /* The disk magic number */ @@ -93,8 +98,6 @@ is #define MAXPARTITIONS 8 #endif - -.ta \w'struct 'u +\w'u_long 'u +\w'd_packname[16] 'u #ifndef LOCORE struct disklabel { u_long d_magic; /* the magic number */ @@ -102,17 +105,17 @@ struct disklabel { short d_subtype; /* controller/d_type specific */ char d_typename[16]; /* type name, e.g. "eagle" */ /* - * d_packname contains the pack identifier and is returned when - * the disklabel is read off the disk or in-core copy. - * d_boot0 and d_boot1 are the (optional) names of the - * primary (block 0) and secondary (block 1-15) bootstraps - * as found in /usr/mdec. These are returned when using - * getdiskbyname(3) to retrieve the values from /etc/disktab. - */ + * d_packname contains the pack identifier and is returned when + * the disklabel is read off the disk or in-core copy. + * d_boot0 and d_boot1 are the (optional) names of the + * primary (block 0) and secondary (block 1-15) bootstraps + * as found in /usr/mdec. These are returned when using + * getdiskbyname(3) + to retrieve the values from /etc/disktab. + */ #if defined(KERNEL) || defined(STANDALONE) char d_packname[16]; /* pack identifier */ #else -.ta \w'struct 'u +\w'struct 'u +\w'struct { 'u +\w'un_d_packname[16] 'u union { char un_d_packname[16]; /* pack identifier */ struct { @@ -120,13 +123,13 @@ struct disklabel { char *un_d_boot1; /* secondary bootstrap name */ } un_b; } d_un; -.ta \w'#define 'u +\w'd_packname 'u + #define d_packname d_un.un_d_packname #define d_boot0 d_un.un_b.un_d_boot0 #define d_boot1 d_un.un_b.un_d_boot1 #endif /* ! KERNEL or STANDALONE */ -.ta \w'struct 'u +\w'u_short 'u +\w'd_d_drivedata[NDDATA] 'u - /* disk geometry: */ + + /* disk geometry: */ u_long d_secsize; /* # of bytes per sector */ u_long d_nsectors; /* # of data sectors per track */ u_long d_ntracks; /* # of tracks per cylinder */ @@ -134,36 +137,36 @@ struct disklabel { u_long d_secpercyl; /* # of data sectors per cylinder */ u_long d_secperunit; /* # of data sectors per unit */ /* - * Spares (bad sector replacements) below - * are not counted in d_nsectors or d_secpercyl. - * Spare sectors are assumed to be physical sectors - * which occupy space at the end of each track and/or cylinder. - */ + * Spares (bad sector replacements) below + * are not counted in d_nsectors or d_secpercyl. + * Spare sectors are assumed to be physical sectors + * which occupy space at the end of each track and/or cylinder. + */ u_short d_sparespertrack; /* # of spare sectors per track */ u_short d_sparespercyl; /* # of spare sectors per cylinder */ /* - * Alternate cylinders include maintenance, replacement, - * configuration description areas, etc. - */ + * Alternate cylinders include maintenance, replacement, + * configuration description areas, etc. + */ u_long d_acylinders; /* # of alt. cylinders per unit */ /* hardware characteristics: */ /* - * d_interleave, d_trackskew and d_cylskew describe perturbations - * in the media format used to compensate for a slow controller. - * Interleave is physical sector interleave, set up by the formatter - * or controller when formatting. When interleaving is in use, - * logically adjacent sectors are not physically contiguous, - * but instead are separated by some number of sectors. - * It is specified as the ratio of physical sectors traversed - * per logical sector. Thus an interleave of 1:1 implies contiguous - * layout, while 2:1 implies that logical sector 0 is separated - * by one sector from logical sector 1. - * d_trackskew is the offset of sector 0 on track N - * relative to sector 0 on track N-1 on the same cylinder. - * Finally, d_cylskew is the offset of sector 0 on cylinder N - * relative to sector 0 on cylinder N-1. - */ + * d_interleave, d_trackskew and d_cylskew describe perturbations + * in the media format used to compensate for a slow controller. + * Interleave is physical sector interleave, set up by the formatter + * or controller when formatting. When interleaving is in use, + * logically adjacent sectors are not physically contiguous, + * but instead are separated by some number of sectors. + * It is specified as the ratio of physical sectors traversed + * per logical sector. Thus an interleave of 1:1 implies contiguous + * layout, while 2:1 implies that logical sector 0 is separated + * by one sector from logical sector 1. + * d_trackskew is the offset of sector 0 on track N + * relative to sector 0 on track N-1 on the same cylinder. + * Finally, d_cylskew is the offset of sector 0 on cylinder N + * relative to sector 0 on cylinder N-1. + */ u_short d_rpm; /* rotational speed */ u_short d_interleave; /* hardware sector interleave */ u_short d_trackskew; /* sector 0 skew, per track */ @@ -178,24 +181,21 @@ struct disklabel { u_long d_magic2; /* the magic number (again) */ u_short d_checksum; /* xor of data incl. partitions */ - /* filesystem and partition information: */ + /* filesystem and partition information: */ u_short d_npartitions; /* number of partitions in following */ u_long d_bbsize; /* size of boot area at sn0, bytes */ u_long d_sbsize; /* max size of fs superblock, bytes */ struct partition { /* the partition table */ -.ta \w'struct 'u +\w'struct 'u +\w'u_short 'u +\w'd_d_drivedata[NDDATA] 'u u_long p_size; /* number of sectors in partition */ u_long p_offset; /* starting sector */ u_long p_fsize; /* filesystem basic fragment size */ u_char p_fstype; /* filesystem type, see below */ u_char p_frag; /* filesystem fragments per block */ u_short p_cpg; /* filesystem cylinders per group */ -.ta \w'struct 'u +\w'u_short 'u +\w'd_d_drivedata[NDDATA] 'u } d_partitions[MAXPARTITIONS]; /* actually may be more */ }; /* d_type values: */ -.ta \w'#define 'u +\w'DTYPE_FLOPPY 'u +\w'0x10 'u #define DTYPE_SMD 1 /* SMD, XSMD; VAX hp/up */ #define DTYPE_MSCP 2 /* MSCP */ #define DTYPE_DEC 3 /* other DEC (rk, rl) */ @@ -223,17 +223,17 @@ static char *dktypenames[] = { #endif /* - * Filesystem type and version. - * Used to interpret other filesystem-specific - * per-partition information. - */ +* Filesystem type and version. +* Used to interpret other filesystem-specific +* per-partition information. +*/ #define FS_UNUSED 0 /* unused */ -#define FS_SWAP 1 /* swap */ -#define FS_V6 2 /* Sixth Edition */ -#define FS_V7 3 /* Seventh Edition */ -#define FS_SYSV 4 /* System V */ -#define FS_V71K 5 /* V7 with 1K blocks (4.1, 2.9) */ -#define FS_V8 6 /* Eighth Edition, 4K blocks */ +#define FS_SWAP 1 /* swap */ +#define FS_V6 2 /* Sixth Edition */ +#define FS_V7 3 /* Seventh Edition */ +#define FS_SYSV 4 /* System V */ +#define FS_V71K 5 /* V7 with 1K blocks (4.1, 2.9) */ +#define FS_V8 6 /* Eighth Edition, 4K blocks */ #define FS_BSDFFS 7 /* 4.2BSD fast file system */ #ifdef DKTYPENAMES @@ -252,39 +252,38 @@ static char *fstypenames[] = { #endif /* - * flags shared by various drives: - */ +* flags shared by various drives: +*/ #define D_REMOVABLE 0x01 /* removable media */ -#define D_ECC 0x02 /* supports ECC */ +#define D_ECC 0x02 /* supports ECC */ #define D_BADSECT 0x04 /* supports bad sector forw. */ #define D_RAMDISK 0x08 /* disk emulator */ -#define D_CHAIN 0x10 /* can do back-back transfers */ +#define D_CHAIN 0x10 /* can do back-back transfers */ /* - * Drive data for SMD. - */ -.ta \w'#define 'u +\w'DTYPE_FLOPPY 'u +\w'd_drivedata[1] 'u +* Drive data for SMD. +*/ + #define d_smdflags d_drivedata[0] -#define D_SSE 0x1 /* supports skip sectoring */ +#define D_SSE 0x1 /* supports skip sectoring */ #define d_mindist d_drivedata[1] #define d_maxdist d_drivedata[2] -#define d_sdist d_drivedata[3] +#define d_sdist d_drivedata[3] /* - * Drive data for ST506. - */ +* Drive data for ST506. +*/ #define d_precompcyl d_drivedata[0] -#define d_gap3 d_drivedata[1] /* used only when formatting */ +#define d_gap3 d_drivedata[1] /* used only when formatting */ #ifndef LOCORE /* - * Structure used to perform a format - * or other raw operation, returning data - * and/or register values. - * Register identification and format - * are device- and driver-dependent. - */ -.ta \w'struct 'u +\w'daddr_t 'u +\w'df_startblk 'u +* Structure used to perform a format +* or other raw operation, returning data +* and/or register values. +* Register identification and format +* are device- and driver-dependent. +*/ struct format_op { char *df_buf; int df_count; /* value-result */ @@ -293,34 +292,36 @@ struct format_op { }; /* - * Structure used internally to retrieve - * information about a partition on a disk. - */ +* Structure used internally to retrieve +* information about a partition on a disk. +*/ struct partinfo { struct disklabel *disklab; struct partition *part; }; /* - * Disk-specific ioctls. - */ - /* get and set disklabel; DIOCGPART used internally */ -.ta \w'#define 'u +\w'DIOCSRETRIES 'u +\w'_IOW( d , 103, struct disklabel) 'u -#define DIOCGDINFO _IOR('d', 101, struct disklabel) /* get */ -#define DIOCSDINFO _IOW('d', 102, struct disklabel) /* set */ -#define DIOCWDINFO _IOW('d', 103, struct disklabel) /* set, update disk */ -#define DIOCGPART _IOW('d', 104, struct partinfo) /* get partition */ +* Disk-specific ioctls. +*/ + /* get and set disklabel; DIOCGPART used internally */ +#define DIOCGDINFO _IOR('d', 101, struct disklabel) /* get */ +#define DIOCSDINFO _IOW('d', 102, struct disklabel) /* set */ +#define DIOCWDINFO _IOW('d', 103, struct disklabel) /* set, update disk */ +#define DIOCGPART _IOW('d', 104, struct partinfo) /* get partition */ /* do format operation, read or write */ #define DIOCRFORMAT _IOWR('d', 105, struct format_op) #define DIOCWFORMAT _IOWR('d', 106, struct format_op) -#define DIOCSSTEP _IOW('d', 107, int) /* set step rate */ -#define DIOCSRETRIES _IOW('d', 108, int) /* set # of retries */ -#define DIOCWLABEL _IOW('d', 109, int) /* write en/disable label */ +#define DIOCSSTEP _IOW('d', 107, int) /* set step rate */ +#define DIOCSRETRIES _IOW('d', 108, int) /* set # of retries */ +#define DIOCWLABEL _IOW('d', 109, int) /* write en/disable label */ -#define DIOCSBAD _IOW('d', 110, struct dkbad) /* set kernel dkbad */ +#define DIOCSBAD _IOW('d', 110, struct dkbad) /* set kernel dkbad */ #endif LOCORE -.SH "SEE ALSO" -disktab(5), disklabel(8) +.Ed +.Sh SEE ALSO +.Xr disktab 5 , +.Xr disklabel 8 +.Sh HISTORY diff --git a/usr/src/sbin/mountd/exports.5 b/usr/src/sbin/mountd/exports.5 index 9caef2ea93..43735726da 100644 --- a/usr/src/sbin/mountd/exports.5 +++ b/usr/src/sbin/mountd/exports.5 @@ -1,80 +1,121 @@ -.\" Copyright (c) 1989 The Regents of the University of California. +.\" Copyright (c) 1989, 1991 The Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)exports.5 5.1 (Berkeley) %G% +.\" @(#)exports.5 5.2 (Berkeley) %G% .\" -.TH EXPORTS 5 "" -.UC 7 -.SH NAME -exports \- define remote mount points for NFS mount requests -.SH SYNOPSIS -.B /etc/exports -.SH DESCRIPTION -.I Exports +.Dd +.Dt EXPORTS 5 +.Os +.Sh NAME +.Nm exports +.Nd define remote mount points for +.Tn NFS +mount requests +.Sh SYNOPSIS +.Nm exports +.Sh DESCRIPTION +The +.Nm exports +file specifies remote mount points for the -.SM NFS +.Tn NFS mount protocol per the -.SM NFS +.Tn NFS server specification; see -``Network File System Protocol Specification, RFC1094''. -.LP +.%T "Network File System Protocol Specification \\*(tNRFC\\*(sP 1094" . +.Pp Each line in the file specifies one remote mount point. The first field is the mount point directory path followed optionally by export options and specific hosts separated by white space. Only the first entry for a given local file system may specify the export -options, since these are handled on a \fIper local file system\fR basis. +options, since these are handled on a +.Em per local file system +basis. If no specific hosts are specified, the mount point is exported to all hosts. -.LP +.Pp The export options are as follows: -.B \-root= +.Sm off +.Fl root No = Aq Sy uid +.Sm on specifies how to map root's uid (default -2). -The option \fB\-r\fR is synonyms for \fB\-root\fP +The option +.Fl r +is synonyms for +.Fl root in an effort to be backward compatible with older export file formats. -.sp -.B \-ro +.Pp +.Fl ro specifies that the file system should be exported Read-only (default Read/Write). -The option \fB-o\fR is synonyms for \fB\-ro\fP +The option +.Fl o +is synonyms for +.Fl ro in an effort to be backward compatible with older export file formats. -.LP +.Pp For example: -.RS +.Bd -literal -offset indent /usr -root=0 rickers snowhite.cis.uoguelph.ca -.br /usr/local 131.104.48.16 -.br /u -root=5 -.br /u2 -ro -.RE -.sp -given that \fB/usr\fR, \fB/u\fR and \fB/u2\fR are -local file system mount points, specifies the following: -.RS -\fB/usr\fR -is exported to hosts \fIrickers\fR and \fIsnowhite.cis.uoguelph.ca\fR with +.Ed +.Pp +Given that +.Sy /usr , +.Sy /u +and +.Sy /u2 +are +local file system mount points, the above example specifies the following: +.Bd -filled -offset indent +.Sy /usr +is exported to hosts +.Em rickers +and +.Em snowhite.cis.uoguelph.ca +with root mapped to root. -.br -\fB/usr/local\fR -is exported to host \fI131.104.48.16\fR with root mapped to root. -.br -\fB/u\fR +.Pp +.Sy /usr/local +is exported to host +.Em 131.104.48.16 +with root mapped to root. +.Pp +.Sy /u is exported to all hosts with root mapped to uid 5. -.br -\fB/u2\fR +.Pp +.Sy /u2 is exported to all hosts Read-only with root mapped to -2. -.RE -.LP -Note that \fB/usr/local -root=5\fR would have been incorrect, -since \fB/usr\fR and \fB/usr/local\fR reside in the same local file system. -.SH FILES -/etc/exports -.SH SEE ALSO -.IR mountd (8), -.IR nfsd (8), -.IR showmount (8) -.SH BUGS +.Ed +.Pp +Note that +.Dq Li "/usr/local -root=5" +would have been incorrect, +since +.Sy /usr +and +.Sy /usr/local +reside in the same local file system. +.Sh FILES +.Bl -tag -width /etc/exports -compact +.It Pa /etc/exports +The remote mount point file +.Nm exports +resides in +.Pa /etc . +.El +.Sh SEE ALSO +.Xr mountd 8 , +.Xr nfsd 8 , +.Xr showmount 8 +.Sh BUGS It would be nice if the export options were not tied to local mount points. +.Sh HISTORY +The +.Nm +file format is +.Ud . diff --git a/usr/src/share/man/man5/fstab.5 b/usr/src/share/man/man5/fstab.5 index add2b2ada7..e62e3597ec 100644 --- a/usr/src/share/man/man5/fstab.5 +++ b/usr/src/share/man/man5/fstab.5 @@ -1,160 +1,169 @@ -.\" Copyright (c) 1980, 1989 The Regents of the University of California. +.\" Copyright (c) 1980, 1989, 1991 The Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)fstab.5 6.4 (Berkeley) %G% +.\" @(#)fstab.5 6.5 (Berkeley) %G% .\" -.TH FSTAB 5 "" -.UC 4 -.SH NAME -fstab \- static information about the filesystems -.SH SYNOPSIS -.B #include -.SH DESCRIPTION +.Dd +.Dt FSTAB 5 +.Os BSD 4 +.Sh NAME +.Nm fstab +.Nd static information about the filesystems +.Sh SYNOPSIS +.Fd #include +.Sh DESCRIPTION The file -.I /etc/fstab +.Nm fstab contains descriptive information about the various file systems. -.I /etc/fstab +.Nm fstab is only read by programs, and not written; it is the duty of the system administrator to properly create and maintain this file. Each filesystem is described on a separate line; fields on each line are separated by tabs or spaces. The order of records in -.I /etc/fstab +.Nm fstab is important because -.I fsck, -.I mount, +.Xr fsck 8 , +.Xr mount 8 , and -.I umount +.Xr umount 8 sequentially iterate through -.I /etc/fstab +.Nm fstab doing their thing. -.PP -The first field, (\c -.IR \|fs_spec ), +.Pp +The first field, +.Pq Fa fs_spec , describes the block special device or remote filesystem to be mounted. For filesystems of type -.BR ufs , +.Em ufs , 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. -.PP -The second field, (\c -.IR \|fs_file ), +.Pp +The second field, +.Pq Fa fs_file , describes the mount point for the filesystem. For swap partitions, this field should be specified as ``none''. -.PP -The third field, (\c -.IR \|fs_vfstype ), +.Pp +The third field, +.Pq Fa fs_vfstype , describes the type of the filesystem. The system currently supports four types of filesystems: -.IP \fBufs\fR 8 -a local UNIX filesystem -.IP \fBmfs\fR 8 -a local memory-based UNIX filesystem -.IP \fBnfs\fR 8 +.Bl -tag -width indent -offset indent +.It Em ufs +a local +.Tn UNIX +filesystem +.It Em mfs +a local memory-based +.Tn UNIX +filesystem +.It Em nfs a Sun Microsystems compatible ``Network File System'' -.IP \fBswap\fR 8 +.It Em swap a disk partition to be used for swapping -.PP -The fourth field, (\c -.IR \|fs_mntops ), +.El +.Pp +The fourth field, +.Pq 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 -.I fs_type +.Fa fs_type below) plus any additional options appropriate to the filesystem type. -.PP +.Pp If the options ``userquota'' and/or ``groupquota'' are specified, the filesystem is automatically processed by the -.IR quotacheck (8) +.Xr quotacheck 8 command, and user and/or group disk quotas are enabled with -.IR quotaon (8). +.Xr quotaon 8 . By default, filesystem quotas are maintained in files named -.I quota.user +.Pa quota.user and -.I quota.group +.Pa quota.group which are located at the root of the associated filesystem. These defaults may be overridden by putting an equal sign and an alternative absolute pathname following the quota option. -Thus, if the user quota file for /tmp is stored in /var/quotas/tmp.user, +Thus, if the user quota file for +.Pa /tmp +is stored in +.Pa /var/quotas/tmp.user , this location can be specified as: -.IP - userquota=/var/quotas/tmp.user -.PP +.Bd -literal -offset indent +userquota=/var/quotas/tmp.user +.Ed +.Pp The type of the mount is extracted from the -.I fs_mntops +.Fa fs_mntops field and stored separately in the -.I fs_type +.Fa fs_type field (it is not deleted from the -.I fs_mntops +.Fa fs_mntops field). If -.I fs_type +.Fa fs_type is ``rw'' or ``ro'' then the filesystem whose name is given in the -.I fs_file +.Fa fs_file field is normally mounted read-write or read-only on the specified special file. If -.I fs_type +.Fa fs_type is ``sw'' then the special file is made available as a piece of swap space by the -.IR swapon (8) +.Xr swapon 8 command at the end of the system reboot procedure. The fields other than -.I fs_spec +.Fa fs_spec and -.I fs_type +.Fa fs_type are unused. If -.I fs_type +.Fa fs_type is specified as ``xx'' the entry is ignored. This is useful to show disk partitions which are currently unused. -.PP -The fifth field, (\c -.IR \|fs_freq ), +.Pp +The fifth field, +.Pq Fa fs_freq , is used for these filesystems by the -.IR dump (8) +.Xr dump 8 command to determine which filesystems need to be dumped. If the fifth field is not present, a value of zero is returned and -.I dump +.Xr dump will assume that the filesystem does not need to be dumped. -.PP -The sixth field, (\c -.IR \|fs_passno ), +.Pp +The sixth field, +.Pq Fa fs_passno , is used by the -.IR fsck (8) +.Xr fsck 8 program to determine the order in which filesystem checks are done at reboot time. The root filesystem should be specified with a -.I fs_passno +.Fa fs_passno of 1, and other filesystems should have a -.I fs_passno +.Fa fs_passno of 2. Filesystems within a drive will be checked sequentially, 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 zero, a value of zero is returned and -.I fsck +.Xr fsck will assume that the filesystem does not need to be checked. -.sp 1 -.nf -.DT +.Bd -literal #define FSTAB_RW "rw" /* read-write device */ #define FSTAB_RO "ro" /* read-only device */ #define FSTAB_SW "sw" /* swap device */ #define FSTAB_XX "xx" /* ignore totally */ -.PP -.ta \w'#define 'u +\w'char\ \ 'u +\w'*fs_vfstype;\ \ 'u + struct fstab { char *fs_spec; /* block special device name */ char *fs_file; /* filesystem path prefix */ @@ -164,13 +173,28 @@ struct fstab { int fs_freq; /* dump frequency, in days */ int fs_passno; /* pass number on parallel dump */ }; -.fi -.PP +.Ed +.Pp The proper way to read records from -.I /etc/fstab -is to use the routines getfsent(), getfsspec(), getfstype(), -and getfsfile(). -.SH FILES -/etc/fstab -.SH SEE ALSO -getfsent(3) +.Pa fstab +is to use the routines +.Xr getfsent 3 , +.Xr getfsspec 3 , +.Xr getfstype 3 , +and +.Xr getfsfile 3 . +.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 +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.0 . diff --git a/usr/src/share/man/man5/hosts.5 b/usr/src/share/man/man5/hosts.5 index affe7976f0..d7eddcd6e4 100644 --- a/usr/src/share/man/man5/hosts.5 +++ b/usr/src/share/man/man5/hosts.5 @@ -1,65 +1,83 @@ -.\" Copyright (c) 1983 The Regents of the University of California. +.\" Copyright (c) 1983, 1991 The Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)hosts.5 6.5 (Berkeley) %G% +.\" @(#)hosts.5 6.6 (Berkeley) %G% .\" -.TH HOSTS 5 "" -.UC 5 -.SH NAME -hosts \- host name data base -.SH DESCRIPTION +.Dd +.Dt HOSTS 5 +.Os BSD 4.2 +.Sh NAME +.Nm hosts +.Nd host name data base +.Sh DESCRIPTION The -.I hosts +.Nm hosts file contains information regarding the known hosts on the network. For each host a single line should be present with the following information: -.HP 10 +.Bd -unfilled -offset indent official host name -.br -.ns -.HP 10 Internet address -.br -.ns -.HP 10 aliases -.PP +.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 the line are not interpreted by routines which search the file. -.PP +.Pp When using the name server -.IR named (8), +.Xr named 8 , this file provides a backup when the name server is not running. For the name server, it is suggested that only a few addresses be included in this file. These include address for the local interfaces that -.IR ifconfig (8C) +.Xr ifconfig 8 needs at boot time and a few machines on the local network. -.PP +.Pp This file may be created from the official host data base maintained at the Network Information Control -Center (NIC), though local changes may be required +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 NIC +and/or unknown hosts. As the data base maintained at +.Tn NIC is incomplete, use of the name server is recommend for -sites on the DARPA Internet. -.PP +sites on the +.Tn DARPA +Internet. +.Pp Network addresses are specified in the conventional -``.'' notation using the \fIinet_addr\fP() routine +``.'' (dot) notation using the +.Xr inet_addr 3 +routine from the Internet address manipulation library, -.IR inet (3N). +.Xr inet 3 . Host names may contain any printable character other than a field delimiter, newline, or comment character. -.SH FILES -/etc/hosts -.SH "SEE ALSO" -gethostbyname(3N), ifconfig(8C), named(8) -.br -Name Server Operations Guide for BIND +.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 named 8 +.Rs +.%T "Name Server Operations Guide for BIND" +.Re +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.2 . diff --git a/usr/src/share/man/man5/networks.5 b/usr/src/share/man/man5/networks.5 index d607ae8bf6..4516c6be40 100644 --- a/usr/src/share/man/man5/networks.5 +++ b/usr/src/share/man/man5/networks.5 @@ -1,48 +1,62 @@ -.\" Copyright (c) 1983 The Regents of the University of California. +.\" Copyright (c) 1983, 1991 The Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)networks.5 6.4 (Berkeley) %G% +.\" @(#)networks.5 6.5 (Berkeley) %G% .\" -.TH NETWORKS 5 "" -.UC 5 -.SH NAME -networks \- network name data base -.SH DESCRIPTION +.Dd +.Dt NETWORKS 5 +.Os BSD 4.2 +.Sh NAME +.Nm networks +.Nd network name data base +.Sh DESCRIPTION The -.I networks +.Xr networks file contains information regarding -the known networks which comprise the DARPA Internet. +the known networks which comprise the +.Tn DARPA +Internet. For each network a single line should be present with the following information: -.HP 10 +.Bd -unfilled -offset indent official network name -.br -.ns -.HP 10 network number -.br -.ns -.HP 10 aliases -.PP +.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 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 (NIC), though local +maintained at the Network Information Control Center +.Pq Tn NIC , +though local changes may be required to bring it up to date regarding unofficial aliases and/or unknown networks. -.PP +.Pp Network number may be specified in the conventional -``.'' notation using the \fIinet_network\fP() routine +``.'' (dot) notation using the +.Xr inet_network 3 +routine from the Internet address manipulation library, -.IR inet (3N). +.Xr inet 3 . Network names may contain any printable character other than a field delimiter, newline, or comment character. -.SH FILES -/etc/networks -.SH "SEE ALSO" -getnetent(3N) -.SH BUGS +.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 +.Sh BUGS A name server should be used instead of a static file. +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.2 . diff --git a/usr/src/share/man/man5/printcap.5 b/usr/src/share/man/man5/printcap.5 index a2b8971eb6..84657155a4 100644 --- a/usr/src/share/man/man5/printcap.5 +++ b/usr/src/share/man/man5/printcap.5 @@ -1,232 +1,262 @@ -.\" Copyright (c) 1983 Regents of the University of California. +.\" Copyright (c) 1983, 1991 Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.roff% +.\" %sccs.include.redist.roff% .\" -.\" @(#)printcap.5 6.5 (Berkeley) %G% +.\" @(#)printcap.5 6.6 (Berkeley) %G% .\" -.TH PRINTCAP 5 "" -.UC 5 -.ad -.SH NAME -printcap \- printer capability data base -.SH SYNOPSIS -/etc/printcap -.SH DESCRIPTION -.I Printcap +.Dd +.Dt PRINTCAP 5 +.Os BSD 4.2 +.Sh NAME +.Nm printcap +.Nd printer capability data base +.Sh SYNOPSIS +.Nm printcap +.Sh DESCRIPTION +The +.Nm Printcap +function is a simplified version of the -.IR termcap (5) +.Xr termcap 5 data base used to describe line printers. The spooling system accesses the -.I printcap +.Nm printcap file every time it is used, allowing dynamic addition and deletion of printers. Each entry in the data base is used to describe one printer. This data base may not be substituted for, as is possible for -.IR termcap , +.Xr termcap , because it may allow accounting to be bypassed. -.PP +.Pp The default printer is normally -.IR lp , -though the environment variable PRINTER +.Em lp , +though the environment variable +.Ev PRINTER may be used to override this. Each spooling utility supports an option, -.BI \-P printer, +.Fl P Ar printer , to allow explicit naming of a destination printer. -.PP +.Pp Refer to the -.ul -4.3BSD Line Printer Spooler Manual +.%T "4.3 BSD Line Printer Spooler Manual" for a complete discussion on how setup the database for a given printer. -.SH CAPABILITIES +.Sh CAPABILITIES Refer to -.IR termcap (5) +.Xr termcap 5 for a description of the file layout. -.nf - -.ta \w'k0-k9 'u +\w'Type 'u +\w'``/usr/spool/lpd\'\' 'u -\fBName Type Default Description\fR -af str NULL name of accounting file -br num none if lp is a tty, set the baud rate (ioctl call) -cf str NULL cifplot data filter -df str NULL tex data filter (DVI format) -fc num 0 if lp is a tty, clear flag bits (sgtty.h) -ff str ``\ef'' string to send for a form feed -fo bool false print a form feed when device is opened -fs num 0 like `fc' but set bits -gf str NULL graph data filter (plot (3X) format) -hl bool false print the burst header page last -ic bool false driver supports (non standard) ioctl to indent printout -if str NULL name of text filter which does accounting -lf str ``/dev/console'' error logging file name -lo str ``lock'' name of lock file -lp str ``/dev/lp'' device name to open for output -mx num 1000 maximum file size (in BUFSIZ blocks), zero = unlimited -nd str NULL next directory for list of queues (unimplemented) -nf str NULL ditroff data filter (device independent troff) -of str NULL name of output filtering program -pc num 200 price per foot or page in hundredths of cents -pl num 66 page length (in lines) -pw num 132 page width (in characters) -px num 0 page width in pixels (horizontal) -py num 0 page length in pixels (vertical) -rf str NULL filter for printing FORTRAN style text files -rg str NULL restricted group. Only members of group allowed access -rm str NULL machine name for remote printer -rp str ``lp'' remote printer name argument -rs bool false restrict remote users to those with local accounts -rw bool false open the printer device for reading and writing -sb bool false short banner (one line only) -sc bool false suppress multiple copies -sd str ``/usr/spool/lpd'' spool directory -sf bool false suppress form feeds -sh bool false suppress printing of burst page header -st str ``status'' status file name -tf str NULL troff data filter (cat phototypesetter) -tr str NULL trailer string to print when queue empties -vf str NULL raster image filter -xc num 0 if lp is a tty, clear local mode bits (tty (4)) -xs num 0 like `xc' but set bits -.fi -.PP +.Bl -column Namexxx Typexx "/var/spool/lpdxxxxx" +.Sy Name Type Description +.It "af str" Ta Dv NULL Ta No "name of accounting file" +.It "br num none if lp is a tty, set the baud rate" +.Pf ( Xr ioctl 2 +call) +.It "cf str" Ta Dv NULL Ta No "cifplot data filter" +.It "df str" Ta Dv NULL Ta No "tex data filter" +.Pf ( Tn DVI +format) +.It "fc num 0 if lp is a tty, clear flag bits" +.Pq Pa sgtty.h +.It "ff str" Ta So Li \ef Sc Ta No "string to send for a form feed" +.It "fo bool false print a form feed when device is opened" +.It "fs num 0 like `fc' but set bits" +.It "gf str" Ta Dv NULL Ta No "graph data filter" +.Pf ( Xr plot 3 +format +.It "hl bool false print the burst header page last" +.It "ic bool false driver supports (non standard) ioctl to indent printout" +.It "if str" Ta Dv NULL Ta No "name of text filter which does accounting" +.It "lf str" Ta Pa /dev/console Ta No "error logging file name" +.It "lo str" Ta Pa lock Ta No "name of lock file" +.It "lp str" Ta Pa /dev/lp Ta No "device name to open for output" +.It "mx num 1000 maximum file size (in" +.Dv BUFSIZ +blocks), zero = unlimited +.It "nd str" Ta Dv NULL Ta No "next directory for list of queues (unimplemented)" +.It "nf str" Ta Dv NULL Ta No "ditroff data filter (device independent troff)" +.It "of str" Ta Dv NULL Ta No "name of output filtering program" +.It "pc num 200 price per foot or page in hundredths of cents" +.It "pl num 66 page length (in lines)" +.It "pw num 132 page width (in characters)" +.It "px num 0 page width in pixels (horizontal)" +.It "py num 0 page length in pixels (vertical)" +.It "rf str" Ta Dv NULL Ta No "filter for printing" +.Tn FORTRAN +style text files +.It "rg str" Ta Dv NULL Ta No "restricted group. Only members of group allowed access" +.It "rm str" Ta Dv NULL Ta No "machine name for remote printer" +.It "rp str ``lp'' remote printer name argument" +.It "rs bool false restrict remote users to those with local accounts" +.It "rw bool false open the printer device for reading and writing" +.It "sb bool false short banner (one line only)" +.It "sc bool false suppress multiple copies" +.It "sd str" Ta Pa /var/spool/lpd Ta No "spool directory" +.It "sf bool false suppress form feeds" +.It "sh bool false suppress printing of burst page header" +.It "st str" Ta Pa status Ta No "status file name" +.It "tf str" Ta Dv NULL Ta No "troff data filter (cat phototypesetter)" +.It "tr str" Ta Dv NULL Ta No "trailer string to print when queue empties" +.It "vf str" Ta Dv NULL Ta No "raster image filter" +.It "xc num 0 if lp is a tty, clear local mode bits" +.Pq Xr tty 4 +.It "xs num 0 like `xc' but set bits" +.El +.Pp If the local line printer driver supports indentation, the daemon must understand how to invoke it. -.SH FILTERS +.Sh FILTERS The -.IR lpd (8) +.Xr lpd 8 daemon creates a pipeline of -.I filters +.Em filters to process files for various printer types. The filters selected depend on the flags passed to -.IR lpr (1). +.Xr lpr 1 . The pipeline set up is: -.RS -.PP -.nf -.ta 0.5i +1i -\-p pr | if regular text + \fIpr\fP(1) +.Bd -literal -offset indent +p pr | if regular text + pr(1) none if regular text -\-c cf cifplot -\-d df DVI (tex) -\-g gf \fIplot\fP(3) -\-n nf ditroff -\-f rf Fortran -\-t tf troff -\-v vf raster image -.fi -.RE -.PP +c cf cifplot +d df DVI (tex) +g gf plot(3) +n nf ditroff +f rf Fortran +t tf troff +v vf raster image +.Ed +.Pp The -.B if +.Sy if filter is invoked with arguments: -.PP - \fIif\fP [ \fB\-c\fP ] \fB\-w\fPwidth \fB\-l\fPlength \fB\-i\fPindent \fB\-n\fP login \fB\-h\fP host acct-file -.PP +.Bd -filled -offset indent +.Cm if +.Op Fl c +.Fl w Ns Ar width +.Fl l Ns Ar length +.Fl i Ns Ar indent +.Fl n Ar login +.Fl h Ar host acct-file +.Ed +.Pp The -.B \-c +.Fl c flag is passed only if the -.B \-l +.Fl l flag (pass control characters literally) is specified to -.IR lpr . -.I Width +.Xr lpr . +The +.Ar Width +function and -.I length +.Ar length specify the page width and length (from -.B pw +.Cm pw and -.B pl +.Cm pl respectively) in characters. The -.B \-n +.Fl n and -.B \-h +.Fl h parameters specify the login name and host name of the owner of the job respectively. -.I Acct-file +The +.Ar Acct-file +function is passed from the -.B af -.I printcap +.Cm af +.Nm printcap entry. -.PP +.Pp If no -.B if +.Cm if is specified, -.B of +.Cm of is used instead, with the distinction that -.B of +.Cm of is opened only once, while -.B if +.Cm if is opened for every individual job. Thus, -.B if +.Cm if is better suited to performing accounting. The -.B of +.Cm of is only given the -.I width +.Ar width and -.I length +.Ar length flags. -.PP +.Pp All other filters are called as: -.PP - \fIfilter\fP \fB\-x\fPwidth \fB\-y\fPlength \fB\-n\fP login \fB\-h\fP host acct-file -.PP +.Bd -filled -offset indent +.Nm filter +.Fl x Ns Ar width +.Fl y Ns Ar length +.Fl n Ar login +.Fl h Ar host acct-file +.Ed +.Pp where -.I width +.Ar width and -.I length +.Ar length are represented in pixels, specified by the -.B px +.Cm px and -.B py +.Cm py entries respectively. -.PP +.Pp All filters take -.I stdin +.Em stdin as the file, -.I stdout +.Em stdout as the printer, may log either to -.I stderr +.Em stderr or using -.IR syslog (3), +.Xr syslog 3 , and must not ignore -.SM SIGINT. -.SH LOGGING +.Dv SIGINT . +.Sh LOGGING Error messages generated by the line printer programs themselves (that is, the -.IR lp * +.Xr lp Ns * programs) are logged by -.IR syslog (3) +.Xr syslog 3 using the -.I LPR +.Dv LPR facility. Messages printed on -.I stderr +.Em stderr of one of the filters are sent to the corresponding -.B lf +.Cm lf file. The filters may, of course, use -.I syslog +.Xr syslog themselves. -.PP +.Pp 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" -termcap(5), -lpc(8), -lpd(8), -pac(8), -lpr(1), -lpq(1), -lprm(1) -.br -.ul -4.3BSD Line Printer Spooler Manual +.Sh SEE ALSO +.Xr termcap 5 , +.Xr lpc 8 , +.Xr lpd 8 , +.Xr pac 8 , +.Xr lpr 1 , +.Xr lpq 1 , +.Xr lprm 1 +.Rs +.%T "4.3 BSD Line Printer Spooler Manual" +.Re +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.2 .. diff --git a/usr/src/share/man/man5/protocols.5 b/usr/src/share/man/man5/protocols.5 index 22f31f755a..0017b6793e 100644 --- a/usr/src/share/man/man5/protocols.5 +++ b/usr/src/share/man/man5/protocols.5 @@ -1,42 +1,51 @@ -.\" Copyright (c) 1983 The Regents of the University of California. +.\" Copyright (c) 1983, 1991 The Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)protocols.5 6.4 (Berkeley) %G% +.\" @(#)protocols.5 6.5 (Berkeley) %G% .\" -.TH PROTOCOLS 5 "" -.UC 5 -.SH NAME -protocols \- protocol name data base -.SH DESCRIPTION +.Dd +.Dt PROTOCOLS 5 +.Os BSD 4.2 +.Sh NAME +.Nm protocols +.Nd protocol name data base +.Sh DESCRIPTION The -.I protocols -file contains information regarding the known protocols used in the DARPA +.Nm protocols +file contains information regarding the known protocols used in the +.Tn DARPA Internet. For each protocol a single line should be present with the following information: -.HP 10 +.Bd -unfilled -offset indent official protocol name -.br -.ns -.HP 10 protocol number -.br -.ns -.HP 10 aliases -.PP +.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 the line are not interpreted by routines which search the file. -.PP +.Pp Protocol names may contain any printable character other than a field delimiter, newline, or comment character. -.SH FILES -/etc/protocols -.SH "SEE ALSO" -getprotoent(3N) -.SH BUGS +.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. +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.2 . diff --git a/usr/src/share/man/man5/remote.5 b/usr/src/share/man/man5/remote.5 index df4bcb39fe..ce252f8719 100644 --- a/usr/src/share/man/man5/remote.5 +++ b/usr/src/share/man/man5/remote.5 @@ -1,166 +1,174 @@ -.\" Copyright (c) 1983 Regents of the University of California. -.\" All rights reserved. +.\" Copyright (c) 1983, 1991 Regents of the University of California. +.\" All rights reserved. .\" -.\" %sccs.include.redist.roff% +.\" %sccs.include.redist.roff% .\" -.\" @(#)remote.5 6.2 (Berkeley) %G% +.\" @(#)remote.5 6.3 (Berkeley) %G% .\" -.TH REMOTE 5 "" -.UC 5 -.SH NAME -remote \- remote host description file -.SH DESCRIPTION +.Dd +.Dt REMOTE 5 +.Os BSD 4.2 +.Sh NAME +.Nm remote +.Nd remote host description file +.Sh DESCRIPTION The systems known by -.IR tip (1C) -and their attributes are stored in an ASCII file which +.Xr tip 1 +and their attributes are stored in an +.Tn ASCII +file which is structured somewhat like the -.IR termcap (5) +.Xr termcap 5 file. Each line in the file provides a description for a single -.IR system . +.Xr system . Fields are separated by a colon (``:''). Lines ending in a \e character with an immediately following newline are continued on the next line. -.PP +.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. 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. -.PP +.Pp Entries named ``tip*'' and ``cu*'' are used as default entries by -.IR tip , +.Xr tip , and the -.I cu +.Xr cu interface to -.IR tip , +.Xr tip , as follows. When -.I tip +.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 which the connection is to be made. When the -.I cu +.Xr cu interface is used, entries of the form ``cu300'' are used. -.SH CAPABILITIES +.Sh CAPABILITIES Capabilities are either strings (str), numbers (num), or boolean flags (bool). A string capability is specified by -.IR capability = value ; -e.g. ``dv=/dev/harris''. A numeric capability is specified by -.IR capability # value ; -e.g. ``xa#99''. A boolean capability is specified by simply listing +.Em capability Ns Ar = Ns Em value ; +for example, ``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 the capability. -.TP 0.5i -.B at +.Bl -tag -width indent +.It Cm \&at (str) Auto call unit type. -.TP 0.5i -.B br +.It Cm \&br (num) The baud rate used in establishing a connection to the remote host. This is a decimal number. The default baud rate is 300 baud. -.TP 0.5i -.B cm +.It Cm \&cm (str) An initial connection message to be sent to the remote host. For example, if a host is reached through port selector, this might be set to the appropriate sequence required to switch to the host. -.TP 0.5i -.B cu +.It Cm \&cu (str) Call unit if making a phone call. Default is the same as the `dv' field. -.TP 0.5i -.B di +.It Cm \&di (str) Disconnect message sent to the host when a disconnect is requested by the user. -.TP 0.5i -.B du +.It Cm \&du (bool) This host is on a dial-up line. -.TP 0.5i -.B dv +.It Cm \&dv (str) -UNIX device(s) to open to establish a connection. +.Tn UNIX +device(s) to open to establish a connection. If this file refers to a terminal line, -.IR tip (1C) +.Xr tip 1 attempts to perform an exclusive open on the device to insure only one user at a time has access to the port. -.TP 0.5i -.B el +.It Cm \&el (str) Characters marking an end-of-line. -The default is NULL. `~' escapes are only +The default is +.Dv NULL . +`~' escapes are only recognized by -.I tip +.Xr tip after one of the characters in `el', or after a carriage-return. -.TP 0.5i -.B fs +.It Cm \&fs (str) Frame size for transfers. -The default frame size is equal to BUFSIZ. -.TP 0.5i -.B hd +The default frame size is equal to +.Dv BUFSIZ . +.It Cm \&hd (bool) The host uses half-duplex communication, local echo should be performed. -.TP 0.5i -.B ie +.It Cm \&ie (str) Input end-of-file marks. -The default is NULL. -.TP 0.5i -.B oe +The default is +.Dv NULL . +.It Cm \&oe (str) Output end-of-file string. -The default is NULL. When -.I tip +The default is +.Dv NULL . +When +.Xr tip is transferring a file, this string is sent at end-of-file. -.TP 0.5i -.B pa +.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. -.TP 0.5i -.B pn +.It Cm \&pn (str) Telephone number(s) for this host. If the telephone number field contains an @ sign, -.I tip +.Xr tip searches the file -.I /etc/phones +.Pa /etc/phones file for a list of telephone numbers; -c.f. -.IR phones (5). -.TP 0.5i -.B tc +(See +.Xr phones 5 . ) +.It Cm \&tc (str) Indicates that the list of capabilities is continued in the named description. This is used primarily to share common capability information. -.PP +.El +.Pp Here is a short example showing the use of the capability continuation feature: -.PP -.nf -.ta 0.5i +.Bd -literal UNIX-1200:\e - :dv=/dev/cau0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D:br#1200: +:dv=/dev/cau0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D:br#1200: arpavax|ax:\e - :pn=7654321%:tc=UNIX-1200 -.fi -.SH FILES -/etc/remote -.SH "SEE ALSO" -tip(1C), -phones(5) +:pn=7654321%:tc=UNIX-1200 +.Ed +.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 , +.Xr phones 5 +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.2 . diff --git a/usr/src/share/man/man5/resolver.5 b/usr/src/share/man/man5/resolver.5 index 36165f02be..c875d12813 100644 --- a/usr/src/share/man/man5/resolver.5 +++ b/usr/src/share/man/man5/resolver.5 @@ -1,67 +1,73 @@ -.\" Copyright (c) 1986 The Regents of the University of California. +.\" Copyright (c) 1986, 1991 The Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)resolver.5 5.11 (Berkeley) %G% +.\" @(#)resolver.5 5.12 (Berkeley) %G% .\" -.TH RESOLVER 5 "" -.UC 4 -.SH NAME -resolver \- resolver configuration file -.SH SYNOPSIS -/etc/resolv.conf -.SH DESCRIPTION -.LP +.Dd +.Dt RESOLVER 5 +.Os BSD 4 +.Sh NAME +.Nm resolver +.Nd resolver configuration file +.Sh SYNOPSIS +.Nm resolv.conf +.Sh DESCRIPTION The -.I resolver -is a set of routines in the C library (\c -.IR resolver (3)) -that provide access to the Internet Domain Name System. +.Xr resolver 3 +is a set of routines in the C library +which provide access to the Internet Domain Name System. The resolver configuration file contains information that is read by the resolver routines the first time they are invoked by a process. The file is designed to be human readable and contains a list of keywords with values that provide various types of resolver information. -.LP +.Pp On a normally configured system this file should not be necessary. The only name server to be queried will be on the local machine, the domain name is determined from the host name, and the domain search path is constructed from the domain name. -.LP +.Pp The different configuration options are: -.TP -\fBnameserver\fP +.Bl -tag -width nameserver +.It Sy nameserver Internet address (in dot notation) of a name server that the resolver should query. -Up to MAXNS (currently 3) name servers may be listed, +Up to +.Dv MAXNS +(currently 3) name servers may be listed, one per keyword. If there are multiple servers, the resolver library queries them in the order listed. -If no \fBnameserver\fP entries are present, +If no +.Sy nameserver +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). -.TP -\fBdomain\fP +.It Sy domain Local domain name. Most queries for names within this domain can use short names relative to the local domain. -If no \fBdomain\fP entry is present, the domain is determined +If no +.Sy domain +entry is present, the domain is determined from the local host name returned by -\fIgethostname\fP\|(2); +.Xr gethostname 2 ; the domain part is taken to be everything after the first `.'. Finally, if the host name does not contain a domain part, the root domain is assumed. -.TP -\fBsearch\fP +.It Sy search Search list for host-name lookup. The search list is normally determined from the local domain name; by default, it begins with the local domain name, then successive parent domains that have at least two components in their names. This may be changed by listing the desired domain search path -following the \fIsearch\fP keyword with spaces or tabs separating +following the +.Sy search +keyword with spaces or tabs separating the names. Most resolver queries will be attempted using each component of the search path in turn until a match is found. @@ -69,20 +75,42 @@ Note that this process may be slow and will generate a lot of network traffic if the servers for the listed domains are not local, and that queries will time out if no server is available for one of the domains. -.IP +.Pp The search list is currently limited to six domains with a total of 256 characters. -.LP -The \fIdomain\fP and \fIsearch\fP keywords are mutually exclusive. +.El +.Pp +The +.Sy domain +and +.Sy search +keywords are mutually exclusive. If more than one instance of these keywords is present, the last instance will override. -.LP +.Pp The keyword and value must appear on a single line, and the keyword -(e.g. \fBnameserver\fP) must start the line. The value follows +(e.g. +.Sy nameserver ) +must start the line. The value follows the keyword, separated by white space. -.SH FILES -.I /etc/resolv.conf -.SH SEE ALSO -gethostbyname(3N), resolver(3), hostname(7), named(8) -.br -Name Server Operations Guide for BIND +.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 named 8 +.Rs +.%T "Name Server Operations Guide for BIND" +.Re +.Sh HISTORY +The +.Nm resolv.conf +file format appeared in +.Bx 4.3 . diff --git a/usr/src/share/man/man5/services.5 b/usr/src/share/man/man5/services.5 index 86826dfb24..6a0339bad7 100644 --- a/usr/src/share/man/man5/services.5 +++ b/usr/src/share/man/man5/services.5 @@ -1,52 +1,59 @@ -.\" Copyright (c) 1983 The Regents of the University of California. +.\" Copyright (c) 1983, 1991 The Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)services.5 6.5 (Berkeley) %G% +.\" @(#)services.5 6.6 (Berkeley) %G% .\" -.TH SERVICES 5 "" -.UC 5 -.SH NAME -services \- service name data base -.SH DESCRIPTION +.Dd +.Dt SERVICES 5 +.Os BSD 4.2 +.Sh NAME +.Nm services +.Nd service name data base +.Sh DESCRIPTION The -.I services +.Nm services file contains information regarding -the known services available in the DARPA Internet. +the known services available in the +.Tn DARPA +Internet. For each service a single line should be present with the following information: -.HP 10 +.Bd -unfilled -offset indent official service name -.br -.ns -.HP 10 port number -.br -.ns -.HP 10 protocol name -.br -.ns -.HP 10 aliases -.PP +.Ed +.Pp Items are separated by any number of blanks and/or tab characters. The port number and protocol name are considered a single -.IR item ; +.Em item ; a ``/'' is used to separate the port and protocol (e.g. ``512/tcp''). A ``#'' 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 +.Pp Service names may contain any printable character other than a field delimiter, newline, or comment character. -.SH FILES -/etc/services -.SH "SEE ALSO" -getservent(3) -.SH BUGS +.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. +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.2 . diff --git a/usr/src/share/man/man5/shells.5 b/usr/src/share/man/man5/shells.5 index 1b9a9dfa5f..66c73abaec 100644 --- a/usr/src/share/man/man5/shells.5 +++ b/usr/src/share/man/man5/shells.5 @@ -1,26 +1,39 @@ -.\" Copyright (c) 1986 The Regents of the University of California. +.\" Copyright (c) 1986, 1991 The Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)shells.5 5.3 (Berkeley) %G% +.\" @(#)shells.5 5.4 (Berkeley) %G% .\" -.TH SHELLS 5 "" -.UC 5 -.SH NAME -shells \- shell database -.SH DESCRIPTION +.Dd +.Dt SHELLS 5 +.Os BSD 4.2 +.Sh NAME +.Nm shells +.Nd shell database +.Sh DESCRIPTION The -.I shells +.Nm shells 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 +.Pp A hash mark (``#'') 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 -/etc/shells -.SH "SEE ALSO" -getusershell(3) +.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 +.Sh HISTORY +The +.Nm +file format appeared in +.Bx 4.3 tahoe . diff --git a/usr/src/share/man/man5/stab.5 b/usr/src/share/man/man5/stab.5 index e2c2220d68..6e58ae5a55 100644 --- a/usr/src/share/man/man5/stab.5 +++ b/usr/src/share/man/man5/stab.5 @@ -1,53 +1,55 @@ -.\" Copyright (c) 1980 Regents of the University of California. +.\" Copyright (c) 1980, 1991 Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.roff% +.\" %sccs.include.redist.man% .\" -.\" @(#)stab.5 6.4 (Berkeley) %G% +.\" @(#)stab.5 6.5 (Berkeley) %G% .\" -.TH STAB 5 "" -.UC 4 -.SH NAME -stab \- symbol table types -.SH SYNOPSIS -.B "#include " -.SH DESCRIPTION -.I Stab.h -defines some values of the n_type field of the symbol table of a.out files. +.Dd +.Dt STAB 5 +.Os BSD 4 +.Sh NAME +.Nm stab +.Nd symbol table types +.Sh SYNOPSIS +.Fd #include +.Sh DESCRIPTION +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.) used by the old debugger -.I sdb +.Em sdb and the Berkeley Pascal compiler -.IR pc (1). +.Xr pc 1 . Symbol table entries can be produced by the -.I .stabs +.Pa .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 -.I .stabd +.Pa .stabd directive can be used to implicitly address the current location. If no name is needed, symbol table entries can be generated using the -.I .stabn +.Pa .stabn directive. The loader promises to preserve the order of symbol table entries produced by -.I .stab +.Pa .stab directives. As described in -.IR a.out (5), +.Xr a.out 5 , an element of the symbol table consists of the following structure: -.PP -.nf +.Bd -literal /* -.ti +\w'/'u * Format of a symbol table entry. -.ti +\w'/'u */ -.ta \w'#define\ 'u +\w'unsigned 'u +\w'char\ \ 'u +\w'n_name;\ \ 'u + struct nlist { union { char *n_name; /* for use when in-core */ @@ -58,23 +60,21 @@ struct nlist { short n_desc; /* see struct desc, below */ unsigned n_value; /* address or offset or line */ }; -.fi -.DT -.PP -The low bits of the n_type field are used to place a symbol into +.Ed +.Pp +The low bits of the +.Fa n_type +field are used to place a symbol into at most one segment, according to the following masks, defined in -.RI < a.out.h >. +.Aq Pa a.out.h . A symbol can be in none of these segments by having none of these segment bits set. -.PP -.nf +.Bd -literal /* -.ti +\w'/'u * Simple values for n_type. -.ti +\w'/'u */ -.ta \w'#define\ 'u +\w'N_FNAME\ 'u +\w'0x0\ \ \ 'u + #define N_UNDF 0x0 /* undefined */ #define N_ABS 0x2 /* absolute */ #define N_TEXT 0x4 /* text */ @@ -82,39 +82,35 @@ bits set. #define N_BSS 0x8 /* bss */ #define N_EXT 01 /* external bit, or'ed in */ -.DT -.fi -.PP -The n_value field of a symbol is relocated by the linker, -.IR ld (1) +.Ed +.Pp +The +.Fa n_value +field of a symbol is relocated by the linker, +.Xr ld 1 as an address within the appropriate segment. -N_value fields of symbols not in any segment are unchanged by the linker. +.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 n_type field has one of the following bits set: -.PP -.nf +of its own, unless the +.Fa n_type +field has one of the following bits set: +.Bd -literal /* -.ti +\w'/'u * Other permanent symbol table entries have some of the N_STAB bits set. -.ti +\w'/'u * These are given in -.ti +\w'/'u */ -.ta \w'#define\ 'u +\w'N_FNAME\ 'u +\w'0x0\ \ \ 'u -#define N_STAB 0xe0 /* if any of these bits set, don't discard */ -.DT -.fi -.PP +#define N_STAB 0xe0 /* if any of these bits set, don't discard */ +.Ed +.Pp This allows up to 112 (7 \(** 16) symbol types, split between the various segments. Some of these have already been claimed. The old symbolic debugger, -.IR sdb , +.Em sdb , uses the following n_type values: -.PP -.nf -.ta \w'#define\ 'u +\w'N_FNAME\ 'u +\w'0x0\ \ \ 'u +.Bd -literal #define N_GSYM 0x20 /* global symbol: name,,0,type,0 */ #define N_FNAME 0x22 /* procedure name (f77 kludge): name,,0 */ #define N_FUN 0x24 /* procedure: name,,0,linenumber,address */ @@ -134,47 +130,67 @@ uses the following n_type values: #define N_ECOMM 0xe4 /* end common: name,, */ #define N_ECOML 0xe8 /* end common (local name): ,,address */ #define N_LENG 0xfe /* second stab entry with length information */ -.fi -.PP +.Ed +.Pp where the comments give -.I sdb +.Em sdb conventional use for -.IR .stab s -and the n_name, n_other, n_desc, and n_value fields -of the given n_type. -.I Sdb -uses the n_desc field to hold a type specifier in the form used +.Pa .stab +.Fa s +and the +.Fa n_name , +.Fa n_other , +.Fa n_desc , +and +.Fa n_value +fields +of the given +.Fa n_type . +.Em Sdb +uses the +.Fa n_desc +field to hold a type specifier in the form used by the Portable C Compiler, -.IR cc (1); -see the header file \fIpcc.h\fP +.Xr cc 1 ; +see the header file +.Pa pcc.h for details on the format of these type values. -.PP +.Pp The Berkeley Pascal compiler, -.IR pc (1), -uses the following n_type value: -.PP -.nf +.Xr pc 1 , +uses the following +.Fa n_type +value: +.Bd -literal #define N_PC 0x30 /* global pascal symbol: name,,0,subtype,line */ -.fi -.PP +.Ed +.Pp and uses the following subtypes to do type checking across separately compiled files: -.nf - 1 source file name - 2 included file name - 3 global label - 4 global constant - 5 global type - 6 global variable - 7 global function - 8 global procedure - 9 external function - 10 external procedure - 11 library variable - 12 library routine -.fi -.SH "SEE ALSO" -as(1), ld(1), dbx(1), a.out(5) -.SH BUGS -.PP +.Bd -unfilled -offset indent +1 source file name +2 included file name +3 global label +4 global constant +5 global type +6 global variable +7 global function +8 global procedure +9 external function +10 external procedure +11 library variable +12 library routine +.Ed +.Sh SEE ALSO +.Xr as 1 , +.Xr ld 1 , +.Xr dbx 1 , +.Xr a.out 5 +.Sh BUGS +.Pp More basic types are needed. +.Sh HISTORY +The +.Nm stab +file appeared in +.Bx 4.0 . diff --git a/usr/src/usr.bin/man/man.conf.5 b/usr/src/usr.bin/man/man.conf.5 index 8247cdd98b..538b4047ea 100644 --- a/usr/src/usr.bin/man/man.conf.5 +++ b/usr/src/usr.bin/man/man.conf.5 @@ -1,111 +1,144 @@ -.\" Copyright (c) 1989 The Regents of the University of California. +.\" Copyright (c) 1989, 1991 The Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)man.conf.5 5.6 (Berkeley) %G% +.\" @(#)man.conf.5 5.6 (Berkeley) %G% .\" -.TH MAN.CONF 5 "" -.SH NAME -man.conf \- man command's configuration file -.SH DESCRIPTION -.IR Man (1), -.IR apropos (1), +.Dd +.Dt MAN.CONF 5 +.Sh NAME +.Nm man.conf +.Nd configuration file for +.Xr man 1 +.Sh DESCRIPTION +The +.Xr man 1 , +.Xr apropos 1 , and -.IR whatis (1) +.Xr whatis 1 +commands search for manual pages or their database files as specified by the -.I man.conf +.Nm man.conf file. Manual pages are expected to be preformatted (see -.IR nroff (1)) +.Xr nroff 1 ) and named with a trailing ``.0''. -.PP +.Pp The -.I man.conf +.Nm man.conf file contains two types of lines. -.PP +.Pp The first type of line is a ``section'' line, which contains a section name followed by a directory path. Lines in this format specify that manual pages for the section may be found in the directory. -.PP +.Pp Directories named with a trailing slash character (``/'') are expected to contain subdirectories (see the keyword ``_subdir'' below) instead of manual pages. These subdirectories are searched instead of the directory. -.PP +.Pp All directories (either explicitly specified or named with a trailing slash) may contain subdirectories. -.IR Man (1) +The +.Xr man 1 +command automatically searches any subdirectory with the same name as the current machine type before the directory is searched. No specification of these subdirectories is necessary in the -.I man.conf +.Nm man.conf file. -.PP +.Pp Section names are unrestricted except for the reserved words specified below; in general, however, it is best to avoid anything beginning with an underscore (``_'') in order to avoid future incompatibilities. -.PP +.Pp The section named ``_default'' is the list of directories to be searched if no section is specified. -.PP +.Pp The second type of line is preceded with a ``keyword''. The possible keywords and their meanings are as follows: -.sp -.TP -_subdir +.Pp +.Bl -tag -width indent +.It _subdir The list (in search order) of subdirectories which will be searched in any directory named with a trailing slash (``/'') character. This -list is also used when a path is specified by the MANPATH environment -variable or the -M option. -. -.TP -_version +list is also used when a path is specified by the +.Ev MANPATH +environment +variable or the +.Fl M +option. +.It _version The version of the configuration file. -.TP -_whatdb +.It _whatdb The full pathname (not just a directory path) for a database to be used by the -.IR apropos (1) +.Xr apropos 1 and -.IR whatis (1) +.Xr whatis 1 commands. -.PP +.El +.Pp Multiple specifications for all types of lines (except for ``_version'') are cumulative and the entries are used in the order listed in the file; multiple entries may be listed per line, as well. -.PP +.Pp Empty lines or lines whose first non-whitespace character is a hash mark (``#'') are ignored. -.SH EXAMPLES +.Sh EXAMPLES Given the following -.I man.conf file: -.sp -.nf -.RS -_version BSD.1 +.Nm man.conf +file: +.Bd -literal -offset indent +_version BSD.1 _subdir cat1 cat2 cat3 -_default /usr/share/man/ +_default /usr/share/man/ sect3 /usr/share/man/cat3 -.fi -.RE -.sp +.Ed +.Pp The default -.IR mktemp (3) -manual page should be stored in ``/usr/share/man/cat3/mktemp.0''. -Any VAX architecture specific version of it should be stored in -``cat3/vax/mktemp.0''. -.PP -The command ``man mktemp'' would search the subdirectories ``cat1'' -``cat2'', and ``cat3'', in ``/usr/share/man'', in that order, for -``mktemp.0''. +.Xr mktemp 3 +manual page should be stored in +.Dq Pa /usr/share/man/cat3/mktemp.0 . +Any +.Tn VAX +architecture specific version of it should be stored in +.Dq Pa cat3/vax/mktemp.0 . +.Pp +The command +.Dq Li man mktemp +would search the subdirectories +.Dq Pa cat1 +.Dq Pa cat2 , +and +.Dq Pa cat3 , +in +.Dq Pa /usr/share/man , +in that order, for +.Dq Pa mktemp.0''. If a subdirectory with the same name as the current machine type existed in any of them, it would be searched as well. -.PP -The command ``man sect3 mktemp'' would only search ``/usr/share/man/cat3'' +.Pp +The command +.Dq Li man sect3 mktemp +would only search +.Dq Li /usr/share/man/cat3 and any possible per machine subdirectory. -.SH FILES -/etc/man.conf standard manual directory search path -.SH "SEE ALSO" -apropos(1), machine(1), man(1), whatis(1), whereis(1) +.Sh FILES +.Bl -tag -width /etc/man.conf -compact +.It Pa /etc/man.conf +Standard manual directory search path. +.El +.Sh SEE ALSO +.Xr apropos 1 , +.Xr machine 1 , +.Xr man 1 , +.Xr whatis 1 , +.Xr whereis 1 +.Sh HISTORY +The +.Nm +file format +.Ud . diff --git a/usr/src/usr.bin/ranlib/ranlib.5.5 b/usr/src/usr.bin/ranlib/ranlib.5.5 index 904867e685..5096b94db0 100644 --- a/usr/src/usr.bin/ranlib/ranlib.5.5 +++ b/usr/src/usr.bin/ranlib/ranlib.5.5 @@ -1,31 +1,34 @@ -.\" Copyright (c) 1990 The Regents of the University of California. +.\" Copyright (c) 1990, 1991 The Regents of the University of California. .\" All rights reserved. .\" -.\" %sccs.include.redist.man% +.\" %sccs.include.redist.roff% .\" -.\" @(#)ranlib.5.5 5.1 (Berkeley) %G% +.\" @(#)ranlib.5.5 5.2 (Berkeley) %G% .\" -.TH RANLIB 5 "" -.AT 3 -.SH NAME -ranlib \- archive (library) table-of-contents format -.SH SYNOPSIS -.B #include -.SH DESCRIPTION -.PP +.Dd +.Dt RANLIB 5 +.Os +.Sh NAME +.Nm ranlib +.Nd archive (library) table-of-contents format +.Sh SYNOPSIS +.Fd #include +.Sh DESCRIPTION The archive table-of-contents command -.IR ranlib +.Nm ranlib creates a table of contents for archives, containing object files, to be used by the link-editor -.IR ld (1). +.Xr ld 1 . It operates on archives created with the utility -.IR ar (1). -.PP -.I Ranlib +.Xr ar 1 . +.Pp +The +.Nm Ranlib +function prepends a new file to the archive which has three separate parts. The first part is a standard archive header, which has a special name field, "__.SYMDEF". -.PP +.Pp The second part is a ``long'' followed by a list of ranlib structures. The long is the size, in bytes, of the list of ranlib structures. Each of the ranlib structures consists of a zero based offset into the @@ -33,8 +36,9 @@ next section (a string table of symbols) and an offset from the beginning of the archive to the start of the archive file which defines the symbol. The actual number of ranlib structures is this number divided by the size of an individual ranlib structure. -.PP +.Pp The third part is a ``long'' followed by a string table. The long is the size, in bytes of the string table. -.SH "SEE ALSO" -ar(1), ranlib(1) +.Sh SEE ALSO +.Xr ar 1 , +.Xr ranlib 1 -- 2.20.1