diff options
90 files changed, 1118 insertions, 559 deletions
diff --git a/sbin/setkey/setkey.8 b/sbin/setkey/setkey.8 index 1f6f33c..1a688b0 100644 --- a/sbin/setkey/setkey.8 +++ b/sbin/setkey/setkey.8 @@ -99,7 +99,8 @@ socket. .It Fl h Add hexadecimal dump on .Fl x -mode. The order is significant. +mode. +The order is significant. .It Fl l Loop forever with short output on .Fl D . @@ -112,7 +113,8 @@ including messages sent from other processes .Pc . .El .Pp -Operation has the following grammar. Note that lines, that start with a +Operation has the following grammar. +Note that lines, that start with a hashmark ('#') are treated as comment lines. Description of meta-arguments follows. .Bl -tag -width Ds diff --git a/usr.sbin/IPXrouted/IPXrouted.8 b/usr.sbin/IPXrouted/IPXrouted.8 index bed2ed6..c9e5946 100644 --- a/usr.sbin/IPXrouted/IPXrouted.8 +++ b/usr.sbin/IPXrouted/IPXrouted.8 @@ -70,7 +70,8 @@ router or not. .It Fl S Do not supply Service Advertizing Protocol .Nm (SAP) -information. The default is to supply +information. +The default is to supply .Nm SAP information. .It Fl t diff --git a/usr.sbin/adduser/adduser.8 b/usr.sbin/adduser/adduser.8 index 12287f5..107325d 100644 --- a/usr.sbin/adduser/adduser.8 +++ b/usr.sbin/adduser/adduser.8 @@ -59,14 +59,17 @@ .Op Fl v | verbose .Sh DESCRIPTION .Nm Adduser -is a simple program for adding new users. Adduser checks -the passwd, group and shell databases. It creates passwd/group entries, +is a simple program for adding new users. +Adduser checks +the passwd, group and shell databases. +It creates passwd/group entries, .Ev HOME directory, dotfiles and sends the new user a welcome message. .Sh RESTRICTIONS .Bl -tag -width Ds -compact .It Sy username -Login name. May contain only lowercase characters or digits. Maximum length +Login name. May contain only lowercase characters or digits. +Maximum length is 16 characters (see .Xr setlogin 2 BUGS section). @@ -81,7 +84,8 @@ in and recompile the world; people have done this and it works, but you will have problems with any precompiled programs, or source that assumes the 8-character -name limit and NIS. The NIS protocol mandates an 8-character username. +name limit and NIS. +The NIS protocol mandates an 8-character username. If you need a longer login name for e-mail addresses, you can define an alias in .Pa /etc/aliases . @@ -186,7 +190,8 @@ Use uid's from .Ar uid on up. .It Sy -verbose,-v -Many warnings, questions. Recommended for novice users. +Many warnings, questions. +Recommended for novice users. .Sh FORMATS .Bl -tag -width Ds -compact .Ql Pa # @@ -198,7 +203,8 @@ See .Pa /etc/adduser.conf for more details. .It Sy message file -Eval variables in this file. See +Eval variables in this file. +See .Pa /etc/adduser.message for more details. diff --git a/usr.sbin/ancontrol/ancontrol.8 b/usr.sbin/ancontrol/ancontrol.8 index 6e07804..1bd4a3e 100644 --- a/usr.sbin/ancontrol/ancontrol.8 +++ b/usr.sbin/ancontrol/ancontrol.8 @@ -88,11 +88,14 @@ The command controls the operation of Aironet wireless networking devices via the .Xr an 4 -driver. Most of the parameters that can be changed relate to the -IEEE 802.11 protocol which the Aironet cards implement. This includes +driver. +Most of the parameters that can be changed relate to the +IEEE 802.11 protocol which the Aironet cards implement. +This includes the station name, whether the station is operating in ad-hoc (point to point) or infrastructure mode, and the network name of a service -set to join. The +set to join. +The .Nm command can also be used to view the current NIC status, configuration and to dump out the values of the card's statistics counters. @@ -107,39 +110,51 @@ device (an0, an1, etc...). The options are as follows: .Bl -tag -width Fl .It Fl i Ar iface Fl A -Display the prefered access point list. The AP list can be used by +Display the prefered access point list. +The AP list can be used by stations to specify the MAC address of access points with which it -wishes to associate. If no AP list is specified (the default) then +wishes to associate. +If no AP list is specified (the default) then the station will associate with the first access point that it finds -which serves the SSID(s) specified in the SSID list. The AP list can +which serves the SSID(s) specified in the SSID list. +The AP list can be modified with the .Fl a option. .It Fl i Ar iface Fl N -Display the SSID list. This is a list of service set IDs (i.e. network names) -with which the station wishes to associate. There may be up to three SSIDs +Display the SSID list. +This is a list of service set IDs (i.e. network names) +with which the station wishes to associate. +There may be up to three SSIDs in the list: the station will go through the list in ascending order and associate with the first matching SSID that it finds. .It Fl i Ar iface Fl S -Display NIC status information. This includes the current operating +Display NIC status information. +This includes the current operating status, current BSSID, SSID, channel, beacon period and currently -associated access point. The operating mode indicates the state of -the NIC, MAC status and receiver status. When the "synced" keyword +associated access point. +The operating mode indicates the state of +the NIC, MAC status and receiver status. +When the "synced" keyword appears, it means the NIC has successfully associated with an access point, associated with an ad-hoc "master" station, or become a "master" -itself. The beacon period can be anything between 20 and 976 milliseconds. +itself. +The beacon period can be anything between 20 and 976 milliseconds. The default is 100. .It Fl i Ar iface Fl I -Display NIC capability information. This shows the device type, +Display NIC capability information. +This shows the device type, frequency, speed and power level capablities and firmware revision levels. .It Fl i Ar iface Fl T Display the NIC's internal statistics counters. .It Fl i Ar iface Fl C -Display current NIC configuration. This shows the current operation mode, +Display current NIC configuration. +This shows the current operation mode, receive mode, MAC address, power save settings, various timing settings, channel selection, diversity, transmit power and transmit speed. .It Fl i Ar iface Fl t Ar 0|1|2|3|4 -Select transmit speed. The available settings are as follows: +Select transmit speed. +The available settings are as follows: .Bd -filled -offset indent .Bl -column "TX rate " "NIC speed " .Em "TX rate NIC speed" @@ -154,7 +169,8 @@ Select transmit speed. The available settings are as follows: Note that the 5.5 and 11Mbps settings are only supported on the 4800 series adapters: the 4500 series adapters have a maximum speed of 2Mbps. .It Fl i Ar iface Fl s Ar 0|1|2|3 -Set power save mode. Valid selections are as follows: +Set power save mode. +Valid selections are as follows: .Bd -filled -offset indent .Bl -column "Selection " "Power save mode " .Em "Selection Power save mode" @@ -168,24 +184,32 @@ Set power save mode. Valid selections are as follows: Note that for IBSS (ad-hoc) mode, only PSP mode is supported, and only if the ATIM window is non-zero. .It Fl i Ar iface Fl a Ar AP "[-v 1|2|3|4]" -Set prefered access point. The +Set prefered access point. +The .Ar AP is specified as a MAC address consisting of 6 hexadecimal values -separated by colons. By default, the +separated by colons. +By default, the .Fl a -option only sets the first entry in the AP list. The +option only sets the first entry in the AP list. +The .Fl v modifier can be used to specify exactly which AP list entry is to be -modified. If the +modified. +If the .Fl v flag is not used, the first AP list entry will be changed. .It Fl i Ar iface Fl b Ar beacon period -Set the ad-hoc mode beacon period. The becon period is specified in -milliseconds. The default is 100ms. +Set the ad-hoc mode beacon period. +The becon period is specified in +milliseconds. +The default is 100ms. .It Fl i Ar iface Fl d Ar 0|1|2|3 "-v 0|1" -Select the antenna diversity. Aironet devices can be configured with up +Select the antenna diversity. +Aironet devices can be configured with up to two antennas, and transmit and receive diversity can be configured -accordingly. Valid selections are as follows: +accordingly. +Valid selections are as follows: .Bd -filled -offset indent .Bl -column "Selection " "Diversity " .Em "Selection Diversity" @@ -196,7 +220,8 @@ accordingly. Valid selections are as follows: .El .Ed .Pp -The receive and transmit diversity can be set independently. The user +The receive and transmit diversity can be set independently. +The user must specify which diversity setting is to be modified by using the .Fl v option: selection @@ -205,20 +230,27 @@ sets the receive diversity and .Ar 1 sets the transmit diversity. .It Fl i Ar iface Fl j Ar netjoin timeout -Set the ad-hoc network join timeout. When a station is first activated +Set the ad-hoc network join timeout. +When a station is first activated in ad-hoc mode, it will search out a 'master' station with the desired -SSID and associate with it. If the station is unable to locate another +SSID and associate with it. +If the station is unable to locate another station with the same SSID after a suitable timeout, it sets itself up -as the 'master' so that other stations may associate with it. This +as the 'master' so that other stations may associate with it. +This timeout defaults to 10000 milliseconds (10 seconds) but may be changed -with this option. The timeout should be specified in milliseconds. +with this option. +The timeout should be specified in milliseconds. .It i Ar iface Fl l Ar station name -Set the station name used internally by the NIC. The +Set the station name used internally by the NIC. +The .Ar station name -can be any text string up to 16 characters in length. The default name +can be any text string up to 16 characters in length. +The default name is set by the driver to "FreeBSD." .It Fl i Ar iface Fl m Ar mac address -Set the station address for the specified interface. The +Set the station address for the specified interface. +The .Ar mac address is specified as a series of six hexadecimal values separated by colons, e.g.: 00:60:1d:12:34:56. This programs the new address into the card @@ -226,33 +258,44 @@ and updates the interface as well. .It Fl i Ar iface Fl n Ar SSID "[-v 1|2|3]" Set the desired SSID (network name). There are three SSIDs which allows the NIC to work with access points at several locations without needing -to be reconfigured. The NIC checks each SSID in sequence when searching -for a match. The SSID to be changed can be specified with the +to be reconfigured. +The NIC checks each SSID in sequence when searching +for a match. +The SSID to be changed can be specified with the .Fl v -modifier option. If the +modifier option. +If the .Fl v flag isn't used, the first SSID in the list is set. .It Fl i Ar iface Fl o Ar 0|1 -Set the operating mode of the Aironet interface. Valid selections are +Set the operating mode of the Aironet interface. +Valid selections are .Ar 0 for ad-hoc mode and .Ar 1 -for infrastructure mode. The default driver setting is for ad-hoc +for infrastructure mode. +The default driver setting is for ad-hoc mode. .It Fl i Ar iface Fl p Ar tx power -Set the transmit power level in milliwatts. Valid power settings +Set the transmit power level in milliwatts. +Valid power settings vary depending on the actual NIC and can be viewed by dumping the device capabilities with the .Fl I -flag. Typical values are 1, 5, 20, 50 and 100mW. Selecting 0 sets +flag. Typical values are 1, 5, 20, 50 and 100mW. +Selecting 0 sets the factory default. .It Fl i Ar iface Fl c Ar channel -Set the radio frequency of a given interface. The +Set the radio frequency of a given interface. +The .Ar frequency -should be specfied as a channel ID as shown in the table below. The +should be specfied as a channel ID as shown in the table below. +The list of available frequencies is dependent on radio regulations specified -by regional authorities. Recognized regulatory authorities include -the FCC (United States), ETSI (Europe), France and Japan. Frequencies +by regional authorities. +Recognized regulatory authorities include +the FCC (United States), ETSI (Europe), France and Japan. +Frequencies in the table are specified in Mhz. .Bd -filled -offset indent .Bl -column "Channel ID " "FCC " "ETSI " "France " "Japan " @@ -275,20 +318,26 @@ in the table are specified in Mhz. .Ed .Pp If an illegal channel is specified, the -NIC will revert to its default channel. For NICs sold in the United States +NIC will revert to its default channel. +For NICs sold in the United States and Europe, the default channel is 3. For NICs sold in France, the default channel is 11. For NICs sold in Japan, the only available channel is 14. Note that two stations must be set to the same channel in order to communicate. .It Fl i Ar iface Fl f Ar fragmentation threshold -Set the fragmentation threshold in bytes. This threshold controls the +Set the fragmentation threshold in bytes. +This threshold controls the point at which outgoing packets will be split into multiple fragments. If a single fragment is not sent successfully, only that fragment will -need to be retransmitted instead of the whole packet. The fragmentation -threshold can be anything from 64 to 2312 bytes. The default is 2312. +need to be retransmitted instead of the whole packet. +The fragmentation +threshold can be anything from 64 to 2312 bytes. +The default is 2312. .It Fl i Ar iface Fl r Ar RTS threshold -Set the RTS/CTS threshold for a given interface. This controls the -number of bytes used for the RTS/CTS handhake boundary. The +Set the RTS/CTS threshold for a given interface. +This controls the +number of bytes used for the RTS/CTS handhake boundary. +The .Ar RTS threshold can be any value between 0 and 2312. The default is 2312. .It Fl h @@ -304,7 +353,8 @@ command first appeared in .Fx 3.0 . .Sh BUGS The statistics counters do not seem to show the amount of transmit -and received frames as increasing. This is likely due to the fact that +and received frames as increasing. +This is likely due to the fact that the .Xr an 4 driver uses unmodified packet mode instead of letting the NIC perform diff --git a/usr.sbin/apm/apm.8 b/usr.sbin/apm/apm.8 index 5bab432..e3d6a2a 100644 --- a/usr.sbin/apm/apm.8 +++ b/usr.sbin/apm/apm.8 @@ -111,7 +111,8 @@ full power mode, but more than suspend mode. Some laptops support resuming from this state on timer or Ring Indicator events. The output of apm tells what your laptop claims to support. .It Fl z -Suspend the system. It is equivalent to +Suspend the system. +It is equivalent to .Nm zzz . .El .Sh BUGS diff --git a/usr.sbin/bootparamd/bootparamd/bootparamd.8 b/usr.sbin/bootparamd/bootparamd/bootparamd.8 index 4503c10..595c3ec 100644 --- a/usr.sbin/bootparamd/bootparamd/bootparamd.8 +++ b/usr.sbin/bootparamd/bootparamd/bootparamd.8 @@ -14,16 +14,19 @@ .Sh DESCRIPTION .Nm Bootparamd is a server process that provides information to diskless clients -necessary for booting. It consults the +necessary for booting. +It consults the .Pa /etc/bootparams file. .Pp This version will allow the use of aliases on the hostname in the .Pa /etc/bootparams -file. The returned hostname to the whoami request done by the booting client +file. +The returned hostname to the whoami request done by the booting client will be the name that appears in .Pa /etc/bootparams -and not the canonical name. In this way you can keep the answer short enough +and not the canonical name. +In this way you can keep the answer short enough so that machines that can not handle long hostnames won't fail during boot. .Sh OPTIONS .Bl -tag -width Fl diff --git a/usr.sbin/burncd/burncd.8 b/usr.sbin/burncd/burncd.8 index 9a5c99f..0ed8cec 100644 --- a/usr.sbin/burncd/burncd.8 +++ b/usr.sbin/burncd/burncd.8 @@ -69,9 +69,11 @@ may be one of: .Pp .Bl -tag -width XXXXXXXXXXXX .It Ar blank -Blank a CD-RW medium. This uses the fast blanking method, so data are not physically overwritten, only those areas that make the media appear blank for further usage. +Blank a CD-RW medium. +This uses the fast blanking method, so data are not physically overwritten, only those areas that make the media appear blank for further usage. .It Ar fixate -Fixate the medium so that the TOC is generated and the media can be used in an ordinary CD drive. The driver defaults to creating multisession media. Should be the last command to +Fixate the medium so that the TOC is generated and the media can be used in an ordinary CD drive. The driver defaults to creating multisession media. +Should be the last command to .Nm as the program exits when this has been done. .It Ar raw | audio @@ -108,7 +110,8 @@ The typical usage for burning a mixed mode CD-R: Probably, please report when found. .Sh HISTORY .Nm burncd -is currently under development. The +is currently under development. +The .Nm command appeared in .Fx 4.0 . diff --git a/usr.sbin/cdcontrol/cdcontrol.1 b/usr.sbin/cdcontrol/cdcontrol.1 index af38043..b5bb726 100644 --- a/usr.sbin/cdcontrol/cdcontrol.1 +++ b/usr.sbin/cdcontrol/cdcontrol.1 @@ -13,7 +13,8 @@ .Op Ar command ... .Sh DESCRIPTION .Nm Cdcontrol -is a program to control audio features of a CD drive. The device is a name such +is a program to control audio features of a CD drive. +The device is a name such as .Pa cd0 or @@ -50,7 +51,8 @@ Suffix `c' is added to the device name if needed. .Pp The available commands are listed below. Only as many characters as are required to uniquely identify a command -need be specified. Word +need be specified. +Word .Em play can be omitted. .Bl -tag -width Cm @@ -88,10 +90,12 @@ using logical blocks. .It Cm pause -Stop playing. Do not stop the disc. +Stop playing. +Do not stop the disc. .It Cm resume -Resume playing. Used after the +Resume playing. +Used after the .Em pause command. diff --git a/usr.sbin/chkgrp/chkgrp.8 b/usr.sbin/chkgrp/chkgrp.8 index 1feb178..b7bce56 100644 --- a/usr.sbin/chkgrp/chkgrp.8 +++ b/usr.sbin/chkgrp/chkgrp.8 @@ -38,7 +38,8 @@ .Sh DESCRIPTION .Nm Chkgrp scans the given file or, failing that, the system-wide group file for -errors. Specifically, it checks that every non-blank, non-comment +errors. +Specifically, it checks that every non-blank, non-comment entry is composed of four colon-separated fields, that none of them contains whitespace, and that the third field (the group ID) is numeric. @@ -53,7 +54,8 @@ numeric. For each error found, .Nm will print an error message containing the name of the file being -scanned and the line number on which the error was found. Otherwise no +scanned and the line number on which the error was found. +Otherwise no output is produced. .Pp .Nm Chkgrp diff --git a/usr.sbin/config/config.8 b/usr.sbin/config/config.8 index 565df77..fa62fe4 100644 --- a/usr.sbin/config/config.8 +++ b/usr.sbin/config/config.8 @@ -76,7 +76,8 @@ Available options and operands: .It Fl d Ar destdir Use .Ar destdir -as the output directory, instead of the default one. Note +as the output directory, instead of the default one. +Note that config does not append .Ar SYSTEM_NAME to the directory given. diff --git a/usr.sbin/crunch/crunchgen/crunchgen.1 b/usr.sbin/crunch/crunchgen/crunchgen.1 index 0aec659..b30bc80 100644 --- a/usr.sbin/crunch/crunchgen/crunchgen.1 +++ b/usr.sbin/crunch/crunchgen/crunchgen.1 @@ -204,7 +204,8 @@ An underscore is prepended to each symbol and it becomes the argument to a .Fl k option for the .Xr crunchide 1 -phase. This option is to be used as a last resort as its use can cause a +phase. +This option is to be used as a last resort as its use can cause a symbol conflict, however in certain instances it may be the only way to have a symbol resolve. .El diff --git a/usr.sbin/fdcontrol/fdcontrol.8 b/usr.sbin/fdcontrol/fdcontrol.8 index 5e8fd57..ab7adab 100644 --- a/usr.sbin/fdcontrol/fdcontrol.8 +++ b/usr.sbin/fdcontrol/fdcontrol.8 @@ -77,13 +77,15 @@ facility. .Sh BUGS The .Nm -command is currently under development. It's user interface is rather +command is currently under development. +It's user interface is rather silly and likely to change in future, options should be provided to allow anything being modified from the command line. .Pp The driver does actually support only two debug levels .Pq 0 and 1 , -where debug level 1 will generate huge amounts of output. It is likely +where debug level 1 will generate huge amounts of output. +It is likely to overflow the syslog if not used with extreme care. .Sh SEE ALSO .Xr ioctl 2 , @@ -91,7 +93,8 @@ to overflow the syslog if not used with extreme care. .Xr fdc 4 .Sh HISTORY .Nm Fdcontrol -is currently under development. It's user interface and overall +is currently under development. +It's user interface and overall functionality are subjects to future improvements and changes. .Sh AUTHORS The program has been contributed by diff --git a/usr.sbin/fdformat/fdformat.1 b/usr.sbin/fdformat/fdformat.1 index 8f0ab5e..998aa42 100644 --- a/usr.sbin/fdformat/fdformat.1 +++ b/usr.sbin/fdformat/fdformat.1 @@ -76,7 +76,8 @@ user for a confirmation whether to format the floppy disk at .It Fl f Ar capacity The normal way to specify the desired formatting parameters. .Ar Capacity -is the number of kilobytes to format. Valid choices are 360, 720, 800, 820, +is the number of kilobytes to format. +Valid choices are 360, 720, 800, 820, 1200, 1440, 1480 or 1720. .It Fl n Don't verify floppy after formatting. @@ -106,7 +107,8 @@ An alternate method to specify the geometry data to write to the floppy disk. If the .Fl q flag has not been specified, the user is asked for a confirmation -of the intended formatting process. In order to continue, an answer +of the intended formatting process. +In order to continue, an answer of .Dq y must be given. @@ -136,7 +138,8 @@ while it's being verified, and if an error has been detected, it will finally change to .Sq Em E . .Pp -An exit status of 0 is returned upon successful operation. Exit status +An exit status of 0 is returned upon successful operation. +Exit status 1 is returned on any errors during floppy formatting, and an exit status of 2 reflects invalid arguments given to the program (along with an appropriate information written to diagnostic output). @@ -149,7 +152,8 @@ appropriate information written to diagnostic output). has been developed for 386BSD 0.1 and upgraded to the new .Xr fdc 4 -floppy disk driver. It later became part of the +floppy disk driver. +It later became part of the .Fx 1.1 system. .Sh AUTHORS diff --git a/usr.sbin/fdwrite/fdwrite.1 b/usr.sbin/fdwrite/fdwrite.1 index 9bda4d8..cdaa7de 100644 --- a/usr.sbin/fdwrite/fdwrite.1 +++ b/usr.sbin/fdwrite/fdwrite.1 @@ -51,7 +51,8 @@ remaining on the current floppy disk, and the letters I, Z, F, W, R and C, which indicates completion of Input, Zero-fill, Format Write, Read and Compare of current track respectively. .It Fl y -Don't ask for presence of a floppy disk in the drive. This non-interactive flag +Don't ask for presence of a floppy disk in the drive. +This non-interactive flag is useful for shell scripts. .It Fl f Ar inputfile Input file to read. If none is given, stdin is assumed. diff --git a/usr.sbin/i4b/isdnd/isdnd.8 b/usr.sbin/i4b/isdnd/isdnd.8 index 8ab59f2..5d91273 100644 --- a/usr.sbin/i4b/isdnd/isdnd.8 +++ b/usr.sbin/i4b/isdnd/isdnd.8 @@ -66,7 +66,8 @@ instead of the default file If debugging support is compiled into .Nm isdnd this option is used to specify the debugging level, or better which kind -of debugging messages are displayed. The debugging level is the sum of the +of debugging messages are displayed. +The debugging level is the sum of the following values: .Pp .Bl -tag -width Ds -compact -offset indent @@ -102,14 +103,16 @@ disable displaying debug messages on the full-screen display. .It Fl f Specifying this option causes .Nm isdnd -to enter the full-screen mode of operation. When operating in this mode, +to enter the full-screen mode of operation. +When operating in this mode, entering the control character .Em Control-L causes the display to be refreshed and entering .Em Carriage-Return or .Em Enter -will pop-up a command window. Because the +will pop-up a command window. +Because the .Nm daemon will not listen to messages while the command window is active, this command window will disappear automatically after 5 seconds without @@ -119,7 +122,8 @@ While the command window is active, .Em Tab or .Em Space -advances to the next menu item. To execute a command, press +advances to the next menu item. +To execute a command, press .Em Return or .Em Enter @@ -133,13 +137,15 @@ facility but instead is appended to a file. .It Fl L Specifies the name of the logfile which is used when the option .Em -l -is set. See also the keyword +is set. +See also the keyword .Em rotatesuffix in the system section of .Xr isdnd.rc 5 . .It Fl P This option prints out the parsed and verified isdnd configuration in the same -format as the isdnd.rc file. This output can be used as an isdnd.rc file. This +format as the isdnd.rc file. This output can be used as an isdnd.rc file. +This feature is especially useful when debugging an isdnd.rc file to see, what the default settings of options are when they are not set in the isdnd.rc input file. @@ -163,7 +169,8 @@ and on which the full-screen mode output is displayed. This option may be used to specify the logging facility in case .Xr syslog 3 logging is configured and another facility than the default LOCAL0 -facility shall be used. The facility is to be specified as an integer in +facility shall be used. +The facility is to be specified as an integer in the range 0-11 or 16-23 (see the file /usr/include/syslog.h). .It Fl t In conjunction with the @@ -175,7 +182,8 @@ options, specifies a terminal type or termcap entry name (such as vt220) for the device used for .Nm isdnd -full-screen output. This is useful if an unused (no getty running) tty line is +full-screen output. +This is useful if an unused (no getty running) tty line is used for full-screen output for which no .Li TERM environment variable exists. @@ -187,7 +195,8 @@ is set to .Em cmdl . .It Fl m If the isdn daemon is compiled with local or remote monitoring support, -this option disables all monitoring access. It overrides the config +this option disables all monitoring access. +It overrides the config file option .Em monitor-allowed . .El @@ -274,7 +283,8 @@ After getting the CDID, the daemon looks up several additional information in its entry section of the configuration corresponding to that connection and issues a .Em I4B_CONNECT_REQ -ioctl message to the kernel. The kernel now dials the remote side and +ioctl message to the kernel. +The kernel now dials the remote side and if the remote side accepts the call, the kernel sends a .Em MSG_CONNECT_ACTIVE_IND to the daemon. @@ -323,7 +333,8 @@ message and the CDID corresponding to the call is no longer valid. Sending a HUP signal to .Nm causes all open connections to be terminated and the configuration file is -reread. In case aliasfile handling was enabled, the aliasfile is also +reread. +In case aliasfile handling was enabled, the aliasfile is also reread. Sending a USR1 signal to diff --git a/usr.sbin/i4b/isdnd/isdnd.acct.5 b/usr.sbin/i4b/isdnd/isdnd.acct.5 index 3ee378b..8813db8 100644 --- a/usr.sbin/i4b/isdnd/isdnd.acct.5 +++ b/usr.sbin/i4b/isdnd/isdnd.acct.5 @@ -64,7 +64,8 @@ is the time the connection was established in the format .Dl Day.Month.Year Hour:Minutes:seconds .Pp .Em UNTIL -is the time the connection was closed. The format is the same as +is the time the connection was closed. +The format is the same as described for .Em FROM above. diff --git a/usr.sbin/i4b/isdnd/isdnd.rates.5 b/usr.sbin/i4b/isdnd/isdnd.rates.5 index d57d703..3ad72d0 100644 --- a/usr.sbin/i4b/isdnd/isdnd.rates.5 +++ b/usr.sbin/i4b/isdnd/isdnd.rates.5 @@ -38,7 +38,8 @@ The file .Pa isdnd.rates contains descriptions how long charging units last at a given time of day, -day of week and the distance to the destination. If this file is available, +day of week and the distance to the destination. +If this file is available, this information may be used by the .Xr isdnd 8 ISDN connection management daemon to calculate the short hold time for a @@ -71,9 +72,12 @@ start_hour.start_minutes-end_hour.end_minutes:charge_unit_length .Ed .Pp Start_hour and start_minutes define the begin of a time section and end_hour -and end_minutes define the end. Charge_unit_length define the length of a -charging unit in the previously defined time section. No spaces or tabs are -allowed inside this field. The hour and minutes specifications MUST have +and end_minutes define the end. +Charge_unit_length define the length of a +charging unit in the previously defined time section. +No spaces or tabs are +allowed inside this field. +The hour and minutes specifications MUST have exactly 2 digits, in case just one digit is needed, a leading 0 must be used. .Pp For example, diff --git a/usr.sbin/i4b/isdnd/isdnd.rc.5 b/usr.sbin/i4b/isdnd/isdnd.rc.5 index 4a65603..e223bce 100644 --- a/usr.sbin/i4b/isdnd/isdnd.rc.5 +++ b/usr.sbin/i4b/isdnd/isdnd.rc.5 @@ -83,8 +83,10 @@ The following keywords are recognized by .Bl -tag -width system -compact .It Li system -This keyword starts the system configuration section. It must not -have a parameter and may be used only once. The keyword is mandatory. +This keyword starts the system configuration section. +It must not +have a parameter and may be used only once. +The keyword is mandatory. The following keywords are valid in the system configuration section: .Bl -tag -width useacctfile -compact @@ -127,12 +129,14 @@ ring the bell when connecting or disconnecting a call. If this parameter is set to .Em on , date/time information from the exchange (if provided) is written to the -logfile. The default is off. (optional) +logfile. +The default is off. (optional) .It Li mailer This keyword is used to specify the path/name of a mail program which which is able to use the "-s" flag to specify a subject on its -command line. In case of a fatal error exit of +command line. +In case of a fatal error exit of .Nm this program is used to send mail to an administrator specified by the keyword @@ -164,7 +168,8 @@ This integer parameter is optional and is set to port 451 by default. .It Li monitor This keyword specifies a local socket name or a host or network for remote -monitoring. The +monitoring. +The .Em monitor specification may either be: .Pp @@ -184,7 +189,8 @@ example: up-vision-net/24 .It Li monitor-access This keyword specifies the access rights for a previously used .Em monitor -keyword. The supported access rights are: +keyword. +The supported access rights are: .Pp .Bl -tag -width Ds -compact -offset .It Ar fullcmd @@ -196,11 +202,13 @@ keyword. The supported access rights are: .El .It Li ratesfile -Specifies the name of the ratesfile. If this keyword is omitted the system +Specifies the name of the ratesfile. +If this keyword is omitted the system default is used. (optional) .It Li regexpr -This keyword is used to specify regular expressions. It can be specified +This keyword is used to specify regular expressions. +It can be specified more than once up to a compile time dependent value (currently set to 5 by the MAX_RE definition in the source). .Pp @@ -233,7 +241,8 @@ which is prepended to the string specified as a parameter to this keyword. (optional) .It Li rotatesuffix -Specifies a suffix for renaming the log- and the accountingfilename. In case +Specifies a suffix for renaming the log- and the accountingfilename. +In case rotatesuffix is used and a USR1 signal is sent to isdnd, the logfile and the accounting file is not only closed and reopened but the old logfile is also renamed to the former filename with the rotatesuffix string appended. @@ -244,7 +253,8 @@ is also the default behaviour. (optional) Specifies the realtime priority .Nm isdnd runs at as an integer value in the range 0...31 with 0 being the highest -priority. This keyword is optional; if not specified the process priority of +priority. +This keyword is optional; if not specified the process priority of .Nm isdnd is not touched in any way. ( See also @@ -263,15 +273,19 @@ accounting file. (optional) .El .It Li controller -This keyword starts the controller configuration section. It must not -have a parameter and may be used once for every controller. The keyword -is optional. The following keywords are valid in a controller +This keyword starts the controller configuration section. +It must not +have a parameter and may be used once for every controller. +The keyword +is optional. +The following keywords are valid in a controller configuration section: .Bl -tag -width useacctfile -compact .It Li protocol This keyword is used to set the D-channel protocol for the S0-bus a -controller is connected to. The following parameters are currently +controller is connected to. +The following parameters are currently supported: .Pp .Bl -tag -width calledback -compact -offset @@ -284,7 +298,8 @@ An ISDN leased line with a single B-channel (called D64S in Germany). .El .It Li entry -This keyword starts one configuration entry. It must not have a parameter. +This keyword starts one configuration entry. +It must not have a parameter. This keyword must be used at least once. The following keywords are valid in an entry section: .Bl -tag -width unitlengthsrc -compact @@ -293,7 +308,8 @@ The following keywords are valid in an entry section: This keyword is used to specify the name of a program which is run in case an incoming telephone connection specified .Em answer -in its configuration entry. The default name is +in its configuration entry. +The default name is .Em answer . .Nm Isdnd expects to find this program beneath the path @@ -302,15 +318,18 @@ which is prepended to the string specified as a parameter to this keyword. (optional) .It Li alert -is used to specify a time in seconds to wait before accepting a call. This +is used to specify a time in seconds to wait before accepting a call. +This keyword is only usable for incoming telephone calls (dialin-reaction = answer). It is used to have a chance to accept an incoming call on the phone before -the answering machine starts to run. The minimum value for the alert parameter +the answering machine starts to run. +The minimum value for the alert parameter is 5 seconds and the maximum parameter allowed is 180 seconds. (optional) .It Li b1protocol -The B channel layer 1 protocol used for this connection. The keyword is mandatory. +The B channel layer 1 protocol used for this connection. +The keyword is mandatory. The currently configurable values are: .Pp .Bl -tag -width Ds -compact -offset @@ -411,7 +430,8 @@ expected next charging unit will occur. (optional) .It Li idle-algorithm-outgoing The algorithm used to determine when to hang up an outgoing call when the -line becomes idle. The current algorithms are: +line becomes idle. +The current algorithms are: .Pp .Bl -tag -width calledback -compact -offset @@ -452,8 +472,10 @@ A delay value suitable for the kernel subroutine to delay the transmittion of the first packet after a successfull connection is made by this value for .Em incoming -ISDN connections. The specification unit is 1/100 second. A zero (0) disables -this feature and is the default value. This feature is implemented (and makes +ISDN connections. The specification unit is 1/100 second. +A zero (0) disables +this feature and is the default value. +This feature is implemented (and makes sense only) for the .Xr i4bipr 4 IP over raw HDLC ISDN driver. (optional) @@ -464,14 +486,17 @@ A delay value suitable for the kernel subroutine to delay the transmittion of the first packet after a successfull connection is made by this value for .Em outgoing -ISDN connections. The specification unit is 1/100 second. A zero (0) disables -this feature and is the default value. This feature is implemented (and makes +ISDN connections. The specification unit is 1/100 second. +A zero (0) disables +this feature and is the default value. +This feature is implemented (and makes sense only) for the .Xr i4bipr 4 IP over raw HDLC ISDN driver. (optional) .It Li local-phone-dialout -The local telephone number used when the local site dials out. When dialing +The local telephone number used when the local site dials out. +When dialing out to a remote site, the number specified here is put into the .Em "Calling Party Number Information Element" . .Pp @@ -481,8 +506,10 @@ userland interfaces. .It Li local-phone-incoming The local telephone number used for verifying the destination of incoming -calls. When a remote site dials in, this number is used to verify that it -is the local site which the remote site wants to connect to. It is compared +calls. +When a remote site dials in, this number is used to verify that it +is the local site which the remote site wants to connect to. +It is compared with the .Em "Called Party Number Information Element" got from the telephone exchange. @@ -490,7 +517,8 @@ got from the telephone exchange. This keyword is mandatory for the ipr interfaces. .It Li name -Defines a symbolic name for this configuration entry. It's purpose is to +Defines a symbolic name for this configuration entry. +It's purpose is to use this name in the full-screen display for easy identification of a link to a remote site and for accounting purposes. (mandatory) @@ -521,19 +549,23 @@ follows the last one used. .El .It Li remote-phone-dialout -The remote telephone number used when the local site dials out. When dialing +The remote telephone number used when the local site dials out. +When dialing out to a remote site, the number specified here is put into the .Em "Called Party Number Information Element" . .Pp This keyword is mandatory for the .Em ipr -interfaces. It may be specified more than once to try to dial to several +interfaces. +It may be specified more than once to try to dial to several numbers until one succeeds. .It Li remote-phone-incoming -The remote telephone number used to verify an incoming call. When a remote site +The remote telephone number used to verify an incoming call. +When a remote site dials in, this number is used to verify that it is the correct remote site -which is herewith authorized to connect into the local system. This parameter +which is herewith authorized to connect into the local system. +This parameter is compared against the .Em "Calling Party Number Information Element" got from the telephone exchange. @@ -543,13 +575,15 @@ This keyword is mandatory for the ipr interfaces. This keyword may have a wildcard parameter '*' to permit anyone dialing in. .It Li unitlength -The length of a charging unit in seconds. This is used in conjunction with +The length of a charging unit in seconds. +This is used in conjunction with the idletime to decide when to hangup a connection. (optional) .It Li unitlengthsrc This keyword is used to specify from which source .Xr isdnd 8 -takes the unitlength for shorthold mode. The currently configurable values are: +takes the unitlength for shorthold mode. +The currently configurable values are: .Pp .Bl -tag -width Ds -compact -offset .It Ar none @@ -572,7 +606,8 @@ to indicate billable units). .It Li usrdevicename Specifies the userland interface which is used for interfacing ISDN B channel -data to the userland. The keyword is mandatory. +data to the userland. +The keyword is mandatory. This keyword accepts the following parameters: .Pp .Bl -tag -width Ds -compact -offset @@ -696,10 +731,13 @@ must be greater than 0 (zero); .Ed During the unchecked window which is (unitlength - (idle-time+earlyhangup)) -in length, no idle check is done. After the unchecked window has ended, -the line is checked for idle-time length if no traffic takes place. In case +in length, no idle check is done. +After the unchecked window has ended, +the line is checked for idle-time length if no traffic takes place. +In case there was traffic detected in the check-window, the same procedure is restarted -at the beginning of the next unit. In case no traffic was detected during +at the beginning of the next unit. +In case no traffic was detected during the check-window, the line is closed at the end of the check window. .Pp Notice: diff --git a/usr.sbin/i4b/isdndebug/isdndebug.8 b/usr.sbin/i4b/isdndebug/isdndebug.8 index 3322caa..a65080d 100644 --- a/usr.sbin/i4b/isdndebug/isdndebug.8 +++ b/usr.sbin/i4b/isdndebug/isdndebug.8 @@ -72,7 +72,8 @@ Get the debugging mask for the selected layer(s). .It Fl h Display the HSCX error counters. .It Fl l -Specify the layer for which a command applies. Default is all layers. +Specify the layer for which a command applies. +Default is all layers. .It Fl m Set debugging mask for the selected layer(s) to display all possible debugging messages (maximum output). @@ -82,7 +83,8 @@ Display the Q.921 (D-channel layer 2) frame receive/transmit statistics. Set debugging mask for the selected layer(s) to the compiled in default (reset). .It Fl s -Set debugging mask for the selected layer(s) to value. Value can be +Set debugging mask for the selected layer(s) to value. +Value can be specified in any number base supported by .Xr sscanf 3 . .It Fl u diff --git a/usr.sbin/i4b/isdndecode/isdndecode.8 b/usr.sbin/i4b/isdndecode/isdndecode.8 index d73126f..6d9faca 100644 --- a/usr.sbin/i4b/isdndecode/isdndecode.8 +++ b/usr.sbin/i4b/isdndecode/isdndecode.8 @@ -73,9 +73,11 @@ Run in analyzer mode by using two passive cards and a custom cable which can be build as described in the file .Em cable.txt -in the isdn4bsd source distribution. One card acts as a receiver for the +in the isdn4bsd source distribution. +One card acts as a receiver for the transmitting direction on the S0 bus while the other card acts as a receiver -for the receiving direction on the S0 bus. Complete traffic monitoring is +for the receiving direction on the S0 bus. +Complete traffic monitoring is possible using this setup. .It Fl b @@ -137,7 +139,8 @@ When the USR1 signal is sent to a process, the currently used logfiles are reopened, so that logfile rotation becomes possible. .Pp -The decode output should be obvious. It is very handy to have the following +The decode output should be obvious. +It is very handy to have the following standard texts available when tracing ISDN protocols: .Pp .Bl -tag -width Ds -compact -offset indent diff --git a/usr.sbin/i4b/isdnmonitor/isdnmonitor.8 b/usr.sbin/i4b/isdnmonitor/isdnmonitor.8 index e29a6ae..d790133 100644 --- a/usr.sbin/i4b/isdnmonitor/isdnmonitor.8 +++ b/usr.sbin/i4b/isdnmonitor/isdnmonitor.8 @@ -52,17 +52,20 @@ devices supported by the isdn4bsd package. The options are as follows: .Bl -tag -width Ds .It Fl c -Switch to (curses-) fullscreen mode of operation. In this mode, +Switch to (curses-) fullscreen mode of operation. +In this mode, .Nm behaves nearly exactly as .Xr isdnd 8 -in fullscreen mode. In fullscreen mode, entering the control character +in fullscreen mode. +In fullscreen mode, entering the control character .Em Control-L causes the display to be refreshed and entering .Em Carriage-Return or .Em Enter -will pop-up a command window. Because +will pop-up a command window. +Because .Nm will not listen to messages while the command window is active, this command window will disappear automatically after 5 seconds without @@ -72,7 +75,8 @@ While the command window is active, .Em Tab or .Em Space -advances to the next menu item. To execute a command, press +advances to the next menu item. +To execute a command, press .Em Return or .Em Enter diff --git a/usr.sbin/i4b/isdntel/isdntel.8 b/usr.sbin/i4b/isdntel/isdntel.8 index 5dca414..646ff69 100644 --- a/usr.sbin/i4b/isdntel/isdntel.8 +++ b/usr.sbin/i4b/isdntel/isdntel.8 @@ -50,11 +50,13 @@ The following options are supported: .It Fl a Use .Ar aliasfile -as the pathname for an aliasfile containing aliases for phone numbers. The +as the pathname for an aliasfile containing aliases for phone numbers. +The default path is .Em /etc/isdn/isdntel.alias . The format of an alias entry is the number string followed by one or more -spaces or tabs. The rest of the line is taken as the alias string. Comments +spaces or tabs. The rest of the line is taken as the alias string. +Comments are introduced by a leading blank, tab or "#" character. .It Fl d Use @@ -71,9 +73,11 @@ The format of a voice message filename is: Use .Ar playcommand as the command string to execute for playing a voice message to some audio -output facility. The characters +output facility. +The characters .Em %s -are replaced by the currently selected filename. The default string is +are replaced by the currently selected filename. +The default string is .Em cat %s | alaw2ulaw >/dev/audio .It Fl t The value for @@ -82,7 +86,8 @@ specifies the time in seconds the program rereads the spool directory when there is no keyboard activity. .El .Pp -The screen output should be obvious. If in doubt, consult the source. +The screen output should be obvious. +If in doubt, consult the source. .Sh SEE ALSO .Xr isdnd 8 .Xr isdnd.rc 5 diff --git a/usr.sbin/i4b/isdntelctl/isdntelctl.8 b/usr.sbin/i4b/isdntelctl/isdntelctl.8 index 617a2a1..cb3f57d 100644 --- a/usr.sbin/i4b/isdntelctl/isdntelctl.8 +++ b/usr.sbin/i4b/isdntelctl/isdntelctl.8 @@ -54,7 +54,8 @@ Clear the telephone input queue. .It Fl g Get the sound format currently in use. .It Fl u -Set the /dev/i4btel unit number. The default value is zero to access +Set the /dev/i4btel unit number. +The default value is zero to access device /dev/i4btel0. .It Fl A Do A-law (ISDN line) -> u-law (userland) conversion. diff --git a/usr.sbin/i4b/isdntrace/isdntrace.8 b/usr.sbin/i4b/isdntrace/isdntrace.8 index fc13bd4..fc89ace 100644 --- a/usr.sbin/i4b/isdntrace/isdntrace.8 +++ b/usr.sbin/i4b/isdntrace/isdntrace.8 @@ -75,9 +75,11 @@ Run in analyzer mode by using two passive cards and a custom cable which can be build as described in the file .Em cable.txt -in the isdn4bsd source distribution. One card acts as a receiver for the +in the isdn4bsd source distribution. +One card acts as a receiver for the transmitting direction on the S0 bus while the other card acts as a receiver -for the receiving direction on the S0 bus. Complete traffic monitoring is +for the receiving direction on the S0 bus. +Complete traffic monitoring is possible using this setup. .It Fl b switch B channel tracing on (default off). @@ -116,7 +118,8 @@ Write undecoded binary trace data to a file for later or remote analyzing (default off). .It Fl F This option can only be used when option -P (playback from binary data file) -is used. The -F option causes playback not to stop at end of file but rather +is used. +The -F option causes playback not to stop at end of file but rather to wait for additional data to be available from the input file. .Pp This option is useful when trace data is accumulated in binary format (to @@ -139,7 +142,8 @@ When the USR1 signal is sent to a process, the currently used logfiles are reopened, so that logfile rotation becomes possible. .Pp -The trace output should be obvious. It is very handy to have the following +The trace output should be obvious. +It is very handy to have the following standard texts available when tracing ISDN protocols: .Pp .Bl -tag -width Ds -compact -offset indent diff --git a/usr.sbin/jail/jail.8 b/usr.sbin/jail/jail.8 index 1f85de5..2b46681 100644 --- a/usr.sbin/jail/jail.8 +++ b/usr.sbin/jail/jail.8 @@ -212,8 +212,10 @@ and once each boot. A few warnings will be produced, because most .Xr sysctl 8 configuration variables cannot be set from within the jail, as they are -global across all jails and the host environment. However, it should all -work properly. You should be able to see +global across all jails and the host environment. +However, it should all +work properly. +You should be able to see .Xr inetd 8 , .Xr syslogd 8 , and other processes running within the jail using diff --git a/usr.sbin/kbdmap/kbdmap.1 b/usr.sbin/kbdmap/kbdmap.1 index c57f8f2..ae8d35e 100644 --- a/usr.sbin/kbdmap/kbdmap.1 +++ b/usr.sbin/kbdmap/kbdmap.1 @@ -55,7 +55,8 @@ in other languages. It is strongly recommended to not choose .Tn MSDOS codepage keymaps -or fonts. Use the +or fonts. +Use the .Tn ISO standard version if available! .Tn X11 @@ -73,7 +74,8 @@ Run as command Run as command .Xr vidfont 1 . .It Fl d , Fl default -Use default language. Ignore +Use default language. +Ignore .Ev LANG environment variable. .It Fl h , Fl help diff --git a/usr.sbin/lpr/lp/lp.1 b/usr.sbin/lpr/lp/lp.1 index 5ab91e7..808d0fa 100644 --- a/usr.sbin/lpr/lp/lp.1 +++ b/usr.sbin/lpr/lp/lp.1 @@ -64,7 +64,8 @@ command exit only after further access to any of the input files is no longer required. The application can then safely delete or modify the files without affecting the output operation. .It Fl d Ar dest -Specify a particular printer. If no +Specify a particular printer. +If no .Fl d is provided on the command line, the contents of the environment variables diff --git a/usr.sbin/lpr/lpc/lpc.8 b/usr.sbin/lpr/lpc/lpc.8 index 21c095a..f0586d7 100644 --- a/usr.sbin/lpr/lpc/lpc.8 +++ b/usr.sbin/lpr/lpc/lpc.8 @@ -102,7 +102,8 @@ printer jobs from being entered into the queue by .It Ic down No {\ all\ |\ printer\ } message ... Turn the specified printer queue off, disable printing and put .Em message -in the printer status file. The message doesn't need to be quoted, the +in the printer status file. +The message doesn't need to be quoted, the remaining arguments are treated like .Xr echo 1 . This is normally used to take a printer down and let others know why @@ -143,7 +144,8 @@ printing. Place the jobs in the order listed at the top of the printer queue. .Pp .It Ic up No {\ all\ |\ printer\ } -Enable everything and start a new printer daemon. Undoes the effects of +Enable everything and start a new printer daemon. +Undoes the effects of .Ic down . .Sh FILES .Bl -tag -width /var/spool/*/lockx -compact diff --git a/usr.sbin/lpr/lpd/lpd.8 b/usr.sbin/lpr/lpd/lpd.8 index cde575f..d8ff190 100644 --- a/usr.sbin/lpr/lpd/lpd.8 +++ b/usr.sbin/lpr/lpd/lpd.8 @@ -50,7 +50,8 @@ at boot time from the file. It makes a single pass through the .Xr printcap 5 file to find out about the existing printers and -prints any files left after a crash. It then uses the system calls +prints any files left after a crash. +It then uses the system calls .Xr listen 2 and .Xr accept 2 @@ -71,7 +72,8 @@ The .Fl l flag causes .Nm -to log valid requests received from the network. This can be useful +to log valid requests received from the network. +This can be useful for debugging purposes. .It Ar "port#" The Internet port number used to rendezvous @@ -82,7 +84,8 @@ but can be changed with the argument. .El .Pp -Access control is provided by two means. First, all requests must come from +Access control is provided by two means. +First, all requests must come from one of the machines listed in the file .Pa /etc/hosts.equiv or @@ -162,7 +165,8 @@ DVI format from Standford. Graph File. The file contains data produced by .Xr plot 3 . .It c -Cifplot File. The file contains data produced by +Cifplot File. +The file contains data produced by .Em cifplot . .It v The file contains a raster image. @@ -178,7 +182,8 @@ Troff Font B. Name of the font file to use instead of the default. .It \&4 Troff Font S. Name of the font file to use instead of the default. .It W -Width. Changes the page width (in characters) used by +Width. +Changes the page width (in characters) used by .Xr pr 1 and the text filters. .It I diff --git a/usr.sbin/lpr/lpr/lpr.1 b/usr.sbin/lpr/lpr/lpr.1 index 396fa2d..6a481c0 100644 --- a/usr.sbin/lpr/lpr/lpr.1 +++ b/usr.sbin/lpr/lpr/lpr.1 @@ -58,7 +58,8 @@ uses a spooling daemon to print the named files when facilities become available. If no names appear, the standard input is assumed. .Pp The following single letter options are used to notify the line printer -spooler that the files are not standard text files. The spooling daemon will +spooler that the files are not standard text files. +The spooling daemon will use the appropriate filters to print the data accordingly. .Bl -tag -width indent .It Fl c @@ -144,7 +145,8 @@ of the file bar.c, etc. On the other hand, cat foo.c bar.c more.c \&| lpr \-#3 .Ed .Pp -will give three copies of the concatenation of the files. Often +will give three copies of the concatenation of the files. +Often a site will disable this feature to encourage use of a photocopier instead. .It Xo @@ -255,5 +257,6 @@ Fonts for .Xr troff 1 and .Xr tex -reside on the host with the printer. It is currently not possible to +reside on the host with the printer. +It is currently not possible to use local font libraries. diff --git a/usr.sbin/lptcontrol/lptcontrol.8 b/usr.sbin/lptcontrol/lptcontrol.8 index b8669e8..bf9ed50 100644 --- a/usr.sbin/lptcontrol/lptcontrol.8 +++ b/usr.sbin/lptcontrol/lptcontrol.8 @@ -37,7 +37,8 @@ devices. When a printer is switched from a mode to another, this change will only take effect the next time the device is opened. .Pp -Extended mode is anything the parallel port interface can support. For an +Extended mode is anything the parallel port interface can support. +For an ECP/ISA parallel port, it may be FIFO+DMA or ECP. .Pp The following command line options are supported: diff --git a/usr.sbin/mailwrapper/mailwrapper.8 b/usr.sbin/mailwrapper/mailwrapper.8 index 3dfa210..9b83f06 100644 --- a/usr.sbin/mailwrapper/mailwrapper.8 +++ b/usr.sbin/mailwrapper/mailwrapper.8 @@ -38,7 +38,8 @@ .Nm mailwrapper .Nd invoke appropriate MTA software based on configuration file .Sh SYNOPSIS -Special. See below. +Special. +See below. .Sh DESCRIPTION At one time, the only Mail Transfer Agent (MTA) software easily available was @@ -70,13 +71,15 @@ also typically has aliases named .Xr mailq 1 and .Xr newaliases 1 -linked to it. The program knows to behave differently when its +linked to it. +The program knows to behave differently when its .Va argv[0] is .Dq mailq or .Dq newaliases -and behaves appropriately. Typically, replacement MTAs provide similar +and behaves appropriately. +Typically, replacement MTAs provide similar functionality, either through a program that also switches behavior based on calling name, or through a set of programs that provide similar functionality. @@ -140,7 +143,8 @@ and then .Sh AUTHORS Perry E. Metzger <perry@piermont.com> .Sh BUGS -The entire reason this program exists is a crock. Instead, a command +The entire reason this program exists is a crock. +Instead, a command for how to submit mail should be standardized, and all the "behave differently if invoked with a different name" behavior of things like .Xr mailq 1 diff --git a/usr.sbin/memcontrol/memcontrol.8 b/usr.sbin/memcontrol/memcontrol.8 index 3107b16..2c128ab 100644 --- a/usr.sbin/memcontrol/memcontrol.8 +++ b/usr.sbin/memcontrol/memcontrol.8 @@ -89,7 +89,8 @@ Attributes applied to this range; one of .Ar write-protect .El .It Ar clear -Clear memory range attributes. Ranges may be cleared by owner or by +Clear memory range attributes. +Ranges may be cleared by owner or by base/length combination. .Pp To clear based on ownership: diff --git a/usr.sbin/mergemaster/mergemaster.8 b/usr.sbin/mergemaster/mergemaster.8 index d0dee82..4f319ec 100644 --- a/usr.sbin/mergemaster/mergemaster.8 +++ b/usr.sbin/mergemaster/mergemaster.8 @@ -54,15 +54,18 @@ The script uses to build a temporary root environment from .Pa / down, populating that environment with the various -files. You can specify a different source directory +files. +You can specify a different source directory with the .Op Fl m command line option. It then compares each file in that environment -to its installed counterpart. When the script finds a +to its installed counterpart. +When the script finds a change in the new file, or there is no installed version of the new file it gives you four options to -deal with it. You can install the new file as is, +deal with it. +You can install the new file as is, delete the new file, merge the old and new files (as appropriate) using .Xr sdiff 1 @@ -74,9 +77,11 @@ By default it creates the temporary root in and compares the .Xr cvs 1 version $Id/$FreeBSD strings for files that have them, deleting -the temporary file if the strings match. If there is +the temporary file if the strings match. +If there is no $Id string, or if the strings are different it -compares the files themselves. You can +compares the files themselves. +You can also specify that the script ignore the $Id strings and compare every file. .Pp @@ -84,13 +89,16 @@ compare every file. checks your umask and issues a warning for anything other than 022. While it is not mandatory to grant world read permissions for most configuration files, you -may run into problems without them. If you choose a +may run into problems without them. +If you choose a umask other than 022 and experience trouble later this could be the cause. .Pa /etc/master.passwd -is treated as a special case. If you choose to install +is treated as a special case. +If you choose to install this file or a merged version of it the file permissions -are always 600 (rw-------) for security reasons. After +are always 600 (rw-------) for security reasons. +After installing an updated version of this file you should probably run .Xr pwd_mkdb 8 @@ -115,23 +123,29 @@ Use context diffs instead of unified diffs. Re-run .Nm on a previously cleaned directory, skipping the creation of -the temporary root environment. This option is compatible +the temporary root environment. +This option is compatible with all other options. .It Fl v -Be more verbose about the process. You should probably use +Be more verbose about the process. +You should probably use this option the first time you run .Nm mergemaster . This option also gives you a list of files that exist only in the installed version of .Pa /etc . .It Fl a -Run automatically. This option will leave all the files that +Run automatically. +This option will leave all the files that differ from the installed versions in the temporary directory -to be dealt with by hand. If the +to be dealt with by hand. +If the .Pa temproot directory exists, it creates a new one in a previously -non-existent directory. This option unsets the verbose flag, -but is compatible with all other options. Setting -a makes +non-existent directory. +This option unsets the verbose flag, +but is compatible with all other options. +Setting -a makes -w superfluous. .It Fl h Display usage and help information. @@ -147,21 +161,25 @@ instead of the default .Pa /var/tmp/temproot . .It Fl d Add the date and time to the name of the temporary -root directory. If -t is specified, this option must +root directory. +If -t is specified, this option must follow it if you want the date added too. .It Fl u Ar N -Specify a numeric umask. The default is 022. +Specify a numeric umask. +The default is 022. .It Fl w Ar N Supply an alternate screen width to the .Xr sdiff 1 -command in numbers of columns. The default is 80. +command in numbers of columns. +The default is 80. .El .Sh ENVIRONMENT The .Nm script uses the .Ev PAGER -environment variable if set. Otherwise it uses +environment variable if set. +Otherwise it uses .Xr more 1 . If .Ev PAGER @@ -200,8 +218,10 @@ comparison, use: .Pa $HOME/.mergemasterrc .Pp .Nm -will . (source) this file if it exists. Command line options -will override rc file options. Here is an example +will . (source) this file if it exists. +Command line options +will override rc file options. +Here is an example with all values commented out: .Pp .Bd -literal @@ -273,7 +293,10 @@ make world tutorial which is referenced above. This manual page and the script itself were written by .An Douglas Barton Aq Doug@gorean.org . .Sh BUGS -There are no known bugs. Please report any problems, -comments or suggestions to the author. Several of the +There are no known bugs. +Please report any problems, +comments or suggestions to the author. +Several of the improvements to this program have come from user -suggestions. Thank you. +suggestions. +Thank you. diff --git a/usr.sbin/mixer/mixer.8 b/usr.sbin/mixer/mixer.8 index 7b54a93..55d2898 100644 --- a/usr.sbin/mixer/mixer.8 +++ b/usr.sbin/mixer/mixer.8 @@ -47,7 +47,8 @@ .Sh DESCRIPTION The .Nm -command is used to set and display soundcard mixer device levels. It may +command is used to set and display soundcard mixer device levels. +It may also be used to start and stop recording from the soundcard. The list of mixer devices that may be modified are: .Pp diff --git a/usr.sbin/moused/moused.8 b/usr.sbin/moused/moused.8 index 1f35869..c089f4d 100644 --- a/usr.sbin/moused/moused.8 +++ b/usr.sbin/moused/moused.8 @@ -81,19 +81,22 @@ data to the device so that the user program will see it. .Pp If the mouse daemon receives the signal .Dv SIGHUP , -it will reopen the mouse port and reinitializes itself. Useful if +it will reopen the mouse port and reinitializes itself. +Useful if the mouse is attached/detached while the system is suspended. .Pp The following options are available: .Bl -tag -width indent .It Fl 3 -Emulate the third (middle) button for 2-button mice. It is emulated +Emulate the third (middle) button for 2-button mice. +It is emulated by pressing the left and right physical buttons simultaneously. .It Fl C Ar threshold Set double click speed as the maximum interval in msec between button clicks. Without this option, the default value of 500 msec will be assumed. This option will have effect only on the cut and paste operations -in the text mode console. The user program which is reading mouse data +in the text mode console. +The user program which is reading mouse data via .Xr sysmouse 4 won't be affected. @@ -128,9 +131,11 @@ This option is valid only if .Ar mousesystems is selected as the protocol type by the .Fl t -option below. It is often used with the +option below. +It is often used with the .Fl D -option above. Both RTS and DTR lines may need to be dropped for +option above. +Both RTS and DTR lines may need to be dropped for a 3-button mouse to operate in the .Ar mousesystems mode. @@ -139,7 +144,8 @@ Select the baudrate for the serial port (1200 to 9600). Not all serial mice support this option. .It Fl c Some mice report middle button down events -as if the left and right buttons are pressed. This option handles this. +as if the left and right buttons are pressed. +This option handles this. .It Fl d Enable debugging messages. .It Fl f @@ -159,7 +165,8 @@ and .It Ar if Interface type: serial, bus, inport or ps/2. .It Ar type -Protocol type. It is one of the types listed under the +Protocol type. +It is one of the types listed under the .Fl t option below or .Ar sysmouse @@ -186,7 +193,8 @@ to the logical button .Ar N. You may specify as many instances of this option as you like. More than one physical button may be assigned to a logical button at the -same time. In this case the logical button will be down, +same time. +In this case the logical button will be down, if either of the assigned physical buttons is held down. Do not put space around `='. .It Fl p Ar port @@ -325,7 +333,8 @@ Report the virtual buttons and .Ar N+1 down events respectively when negative and positive Z axis movement -is detected. There doesn't need to be physical buttons +is detected. +There doesn't need to be physical buttons .Ar N and .Ar N+1 . @@ -401,7 +410,8 @@ option yields nothing, you need to specify a protocol type to the .Nm command by the .Fl t -option. You have to make a guess and try. +option. +You have to make a guess and try. There is rule of thumb: .Pp .Bl -tag -compact -width 1.X @@ -425,7 +435,8 @@ protocol. .It 5. 3-button serial mice may work with the .Ar mousesystems -protocol. If it doesn't, it may work with the +protocol. +If it doesn't, it may work with the .Ar microsoft protocol although the third (middle) button won't function. @@ -457,8 +468,10 @@ start the mouse daemon in the foreground mode, .Dl moused -f -p Ar _selected_port_ -t Ar _selected_protocol_ .Pp and see if the mouse pointer travels correctly -according to the mouse movement. Then try cut & paste features by -clicking the left, right and middle buttons. Type ^C to stop +according to the mouse movement. +Then try cut & paste features by +clicking the left, right and middle buttons. +Type ^C to stop the command. .Ss Multiple Mice As many instances of the mouse daemon as the number of mice attached to @@ -475,7 +488,8 @@ then the application program will always see mouse data from either mice. When the serial mouse is not attached, the corresponding mouse daemon won't detect any movement or button state change and the application program will only see mouse data coming from the daemon for the -PS/2 mouse. In contrast when both mice are attached and both of them +PS/2 mouse. +In contrast when both mice are attached and both of them are moved at the same time in this configuration, the mouse pointer will travel across the screen just as if movement of the mice is combined all together. @@ -553,7 +567,8 @@ Many pad devices behave as if the first (left) button were pressed if the user `taps' the surface of the pad. In contrast, some ALPS GlidePoint and Interlink VersaPad models treat the tapping action -as fourth button events. Use the option ``-m 1=4'' for these models +as fourth button events. +Use the option ``-m 1=4'' for these models to obtain the same effect as the other pad devices. .Pp Cut and paste functions in the virtual console assume that there @@ -589,7 +604,8 @@ command partially supports in order to support PnP serial mice. However, due to various degrees of conformance to the specification by existing serial mice, it does not strictly follow the version 1.0 of the -standard. Even with this less strict approach, +standard. +Even with this less strict approach, it may not always determine an appropriate protocol type for the given serial mouse. .Sh AUTHORS diff --git a/usr.sbin/mrouted/map-mbone.8 b/usr.sbin/mrouted/map-mbone.8 index 63027b8..d7c6938 100644 --- a/usr.sbin/mrouted/map-mbone.8 +++ b/usr.sbin/mrouted/map-mbone.8 @@ -25,24 +25,30 @@ is the localhost. .Pp .Nm Map-mbone traverses neighboring multicast routers by sending the ASK_NEIGHBORS IGMP -message to the multicast starting_router. If this multicast router responds, +message to the multicast starting_router. +If this multicast router responds, the version number and a list of their neighboring multicast router addresses is -part of that response. If the responding router has recent multicast version +part of that response. +If the responding router has recent multicast version number, then .Nm requests additional information such as metrics, thresholds, and flags from the -multicast router. For each new occurrence of neighboring multicast router in +multicast router. +For each new occurrence of neighboring multicast router in the reply and provided the flooding option has been selected, then .Nm -asks each of this multicast router for a list of neighbors. This search +asks each of this multicast router for a list of neighbors. +This search for unique routers will continue until no new neighboring multicast routers are reported. .Pp The following options are available: .Bl -tag -width indent .It Fl d -Set the debug level. When the debug level is greater than the -default value of 0, addition debugging messages are printed. Regardless of +Set the debug level. +When the debug level is greater than the +default value of 0, addition debugging messages are printed. +Regardless of the debug level, an error condition, will always write an error message and will cause .Nm @@ -58,7 +64,8 @@ all level 2 messages plus notifications of all packet timeouts are printed to stderr. .El .It Fl f -Set flooding option. Flooding allows the recursive search +Set flooding option. +Flooding allows the recursive search of neighboring multicast routers and is enable by default when starting_router is not used. .It Fl g @@ -66,10 +73,12 @@ Set graphing in GraphEd format. .It Fl n Disable the DNS lookup for the multicast routers names. .It Fl r Ar retry_count -Set the neighbor query retry limit. Default is 1 retry. +Set the neighbor query retry limit. +Default is 1 retry. .It Fl t Ar timeout_count Set the number of seconds to wait for a neighbor query -reply before retrying. Default timeout is 2 seconds. +reply before retrying. +Default timeout is 2 seconds. .El .Sh IMPORTANT NOTE .Nm Map-mbone diff --git a/usr.sbin/mrouted/mrinfo.8 b/usr.sbin/mrouted/mrinfo.8 index 3a56910..c8b5c01 100644 --- a/usr.sbin/mrouted/mrinfo.8 +++ b/usr.sbin/mrouted/mrinfo.8 @@ -18,20 +18,25 @@ attempts to display the configuration information from the multicast router .Ar multicast_router . .Pp .Nm Mrinfo -uses the ASK_NEIGHBORS IGMP message to the specified multicast router. If this +uses the ASK_NEIGHBORS IGMP message to the specified multicast router. +If this multicast router responds, the version number and a list of their neighboring -multicast router addresses is part of that response. If the responding router +multicast router addresses is part of that response. +If the responding router has a recent multicast version number, then .Nm requests additional information such as metrics, thresholds, and flags from the -multicast router. Once the specified multicast router responds, the +multicast router. +Once the specified multicast router responds, the configuration is displayed to the standard output. .Pp The following options are available: .Bl -tag -width indent .It Fl d Ar debug_level -Set the debug level. When the debug level is greater than the -default value of 0, addition debugging messages are printed. Regardless of +Set the debug level. +When the debug level is greater than the +default value of 0, addition debugging messages are printed. +Regardless of the debug level, an error condition, will always write an error message and will cause .Nm @@ -47,10 +52,12 @@ all level 2 messages plus notifications of all packet timeouts are printed to stderr. .El .It Fl r Ar retry_count -Set the neighbor query retry limit. Default is 3 retries. +Set the neighbor query retry limit. +Default is 3 retries. .It Fl t Ar timeout_count Set the number of seconds to wait for a neighbor query -reply. Default timeout is 4 seconds. +reply. +Default timeout is 4 seconds. .El .Sh SAMPLE OUTPUT .nf @@ -63,8 +70,10 @@ reply. Default timeout is 4 seconds. .fi .Pp For each neighbor of the queried multicast router, the IP of the queried router -is displayed, followed by the IP and name of the neighbor. In square brackets -the metric (cost of connection), the treashold (multicast ttl) is displayed. If +is displayed, followed by the IP and name of the neighbor. +In square brackets +the metric (cost of connection), the treashold (multicast ttl) is displayed. +If the queried multicast router has a newer version number, the type (tunnel, srcrt) and status (disabled, down) of the connection is displayed. .Sh IMPORTANT NOTE diff --git a/usr.sbin/mrouted/mrouted.8 b/usr.sbin/mrouted/mrouted.8 index 2aad223..1e56452 100644 --- a/usr.sbin/mrouted/mrouted.8 +++ b/usr.sbin/mrouted/mrouted.8 @@ -23,12 +23,15 @@ datagram forwarding algorithm called Reverse Path Multicasting. .Pp .Nm Mrouted forwards a multicast datagram along a shortest (reverse) path tree -rooted at the subnet on which the datagram originates. The multicast +rooted at the subnet on which the datagram originates. +The multicast delivery tree may be thought of as a broadcast delivery tree that has been pruned back so that it does not extend beyond those subnetworks -that have members of the destination group. Hence, datagrams +that have members of the destination group. +Hence, datagrams are not forwarded along those branches which have no listeners of the -multicast group. The IP time-to-live of a multicast datagram can be +multicast group. +The IP time-to-live of a multicast datagram can be used to limit the range of multicast datagrams. .Pp In order to support multicasting among subnets that are separated by (unicast) @@ -74,7 +77,8 @@ in order to perform multicast forwarding. The following options are available: .Bl -tag -width indent .It Fl c Ar config_file -Specify an alternative file for configuration commands. Default is +Specify an alternative file for configuration commands. +Default is .Pa /etc/mrouted.conf . .It Fl d Op Ar debug_level If no @@ -291,7 +295,8 @@ traffic. It defaults 0 (unlimited). .It boundary Ar "boundary-name|scoped-addr/mask-len" The boundary option allows an interface to be configured as an administrative boundary for the specified -scoped address. Packets belonging to this address will not +scoped address. +Packets belonging to this address will not be forwarded on a scoped interface. The boundary option accepts either a name or a boundary spec. This command may be specified several times on an interface in order to describe multiple boundaries. @@ -493,8 +498,10 @@ instance of .Nm is the one responsible for sending periodic group membership queries on the vif 0 and vif 1 subnets, as indicated by the -"querier" flags. The list of boundaries indicate the scoped addresses on that -interface. A count of the no. of incoming and outgoing packets is also +"querier" flags. +The list of boundaries indicate the scoped addresses on that +interface. +A count of the no. of incoming and outgoing packets is also shown at each interface. .Pp Associated with each subnet from which a multicast datagram can originate @@ -507,7 +514,8 @@ origin, and a multicast datagram from that origin will be forwarded on that outgoing vif only if there are members of the destination group on that leaf. .Pp .Nm Mrouted -also maintains a copy of the kernel forwarding cache table. Entries +also maintains a copy of the kernel forwarding cache table. +Entries are created and deleted by .Nm mrouted . .Pp @@ -545,16 +553,21 @@ amount of time until the upstream prune will time out. The 'Ivif' field indicates the incoming vif for multicast packets from that origin. Each router also maintains a record of the number of prunes received from neighboring -routers for a particular source and group. If there are no members of +routers for a particular source and group. +If there are no members of a multicast group on any downward link of the multicast tree for a -subnet, a prune message is sent to the upstream router. They are +subnet, a prune message is sent to the upstream router. +They are indicated by a "P" after the vif number. .Pp The Forwvifs field shows the interfaces along which datagrams belonging to the source-group are -forwarded. A "p" indicates that no datagrams are being forwarded along -that interface. An unlisted interface is a leaf subnet with no -members of the particular group on that subnet. A "b" on an interface +forwarded. +A "p" indicates that no datagrams are being forwarded along +that interface. +An unlisted interface is a leaf subnet with no +members of the particular group on that subnet. +A "b" on an interface indicates that it is a boundary interface, i.e. traffic will not be forwarded on the scoped address on that interface. .Pp diff --git a/usr.sbin/newsyslog/newsyslog.8 b/usr.sbin/newsyslog/newsyslog.8 index 9fde863..c57a664 100644 --- a/usr.sbin/newsyslog/newsyslog.8 +++ b/usr.sbin/newsyslog/newsyslog.8 @@ -224,7 +224,8 @@ file. This field must start with "/" in order to be recognized properly. .It Ar signal_number This optional field specifies -the signal number will be sent to the daemon process. By default +the signal number will be sent to the daemon process. +By default a SIGHUP will be sent. .El .Sh OPTIONS diff --git a/usr.sbin/ngctl/ngctl.8 b/usr.sbin/ngctl/ngctl.8 index 11cf21f..b6f0b45 100644 --- a/usr.sbin/ngctl/ngctl.8 +++ b/usr.sbin/ngctl/ngctl.8 @@ -56,7 +56,8 @@ If no flag is given, no command is supplied on the command line, and standard input is a tty, .Nm -will enter interactive mode. Otherwise +will enter interactive mode. +Otherwise .Nm will execute the supplied command(s) and exit immediately. .Pp @@ -83,7 +84,8 @@ are ignored. .It Fl n Ar nodename Assign .Em nodename -to the newly created netgraph node. The default name is +to the newly created netgraph node. +The default name is .Em ngctlXXX where XXX is the process ID number. .It Fl d diff --git a/usr.sbin/ntp/doc/ntpq.8 b/usr.sbin/ntp/doc/ntpq.8 index e27de0e..6ae30b7 100644 --- a/usr.sbin/ntp/doc/ntpq.8 +++ b/usr.sbin/ntp/doc/ntpq.8 @@ -54,7 +54,8 @@ topology. makes one attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time. .Pp -Command line options are described following. Specifying a command line +Command line options are described following. +Specifying a command line option other than .Fl i or @@ -151,7 +152,8 @@ messages can be assembled, and sent using the .Ic readlist and .Ic writelist -commands described below. The +commands described below. +The .Ic addvars command allows variables and their optional values to be added to the list. @@ -249,7 +251,8 @@ The only formatting and intepretation done on the data is to transform non-ASCII data into a printable (but barely understandable) form. .It Ic timeout Ar milliseconds -Specify a timeout period for responses to server queries. The default +Specify a timeout period for responses to server queries. +The default is about 5000 milliseconds. Note that since .Nm @@ -382,7 +385,8 @@ command. Like the .Ic readvar command except the query is done for each of a range of (nonzero) -association IDs. This range is determined from the association list +association IDs. +This range is determined from the association list cached by the most recent .Ic associations command. diff --git a/usr.sbin/pccard/pccardc/pccardc.8 b/usr.sbin/pccard/pccardc/pccardc.8 index a5d0968..c790d2d 100644 --- a/usr.sbin/pccard/pccardc/pccardc.8 +++ b/usr.sbin/pccard/pccardc/pccardc.8 @@ -171,7 +171,8 @@ It turns ON/OFF a power supply of a card in the slot specified in .Pp .Bl -tag -width Ds .It Ar 0 -turn OFF a power supply. If a card becomes unstable when it is removed at +turn OFF a power supply. +If a card becomes unstable when it is removed at activate state, this can force it to turn into inactive state first and remove it safely. .It Ar 1 diff --git a/usr.sbin/pccard/pccardd/pccard.conf.5 b/usr.sbin/pccard/pccardd/pccard.conf.5 index c10c4d2..999f18e 100644 --- a/usr.sbin/pccard/pccardd/pccard.conf.5 +++ b/usr.sbin/pccard/pccardd/pccard.conf.5 @@ -58,9 +58,11 @@ Each PC-CARD card contains configuration tuples that provide the manufacturer and card version; these are used to identify the card specification in the configuration file, and from this find a driver that can be used to -interface to the particular card. There is a many-to-one mapping +interface to the particular card. +There is a many-to-one mapping between cards to drivers i.e a single driver may interface to -multiple types of cards. To aid this, card parameters may be +multiple types of cards. +To aid this, card parameters may be specified separately from the driver to initialize the card or extract (in the case of a network card) an Ethernet address. .Pp @@ -77,7 +79,8 @@ and .Em remove commands allow a shell command line to be executed. The command to be executed is the rest of the line after -the keyword. The line can be continued using a backslash. +the keyword. +The line can be continued using a backslash. A simple macro substitution allows the current kernel device name .Em ( $device ) @@ -101,7 +104,8 @@ A hash character comments out the rest of the line. .Ss "Resource pool" The (optional) section specifies a pool of system resources such as ISA bus memory address space, Input/Output ports and -interrupt request numbers. This resource pool is used +interrupt request numbers. +This resource pool is used to allocate address space and interrupt numbers dynamically according to the requirements specified in each driver description. @@ -134,18 +138,21 @@ The syntax for card identifiers is: .Pp The first line is mandatory; the latter statements are optional and can appear in -any order. There may be multiple +any order. +There may be multiple .Em config lines. The .Em card parameters are the Manufacturer name and card version that -is used to match the values from the card's CIS memory. The +is used to match the values from the card's CIS memory. +The .Em config parameters select the particular card's configuration index from the range available in the card's CIS, the driver that is to be associated with this configuration, and the interrupt -level (if any) to be assigned. An optional set of flags may +level (if any) to be assigned. +An optional set of flags may be assigned. In .Ar index , @@ -156,9 +163,11 @@ from the CIS and status of using I/O resources. The optional .Em ether keyword is used when network cards have their physical Ethernet address -located within the attribute memory of the card. The parameter of this +located within the attribute memory of the card. +The parameter of this statement indicates the offset within the attribute memory of the -Ethernet address. This value can be used within insert/remove +Ethernet address. +This value can be used within insert/remove commands using the .Em $ether macro. @@ -168,7 +177,8 @@ The and .Em remove sections allow shell commands to be specified that are executed -when the card is inserted or removed. Multiple +when the card is inserted or removed. +Multiple .Em insert and .Em remove diff --git a/usr.sbin/pccard/pccardd/pccardd.8 b/usr.sbin/pccard/pccardd/pccardd.8 index 8fb912d..6013255 100644 --- a/usr.sbin/pccard/pccardd/pccardd.8 +++ b/usr.sbin/pccard/pccardd/pccardd.8 @@ -82,7 +82,8 @@ this card. If the attach succeeds, then specific shell commands may be executed to configure the device, such as .Xr ifconfig 8 -to set up a network interface. Separate commands may be specified +to set up a network interface. +Separate commands may be specified for each card, driver or device, and are executed in that order. .El .Pp @@ -91,7 +92,8 @@ When detects that a card has been removed, the following sequence occurs: .Bl -enum .It -The shell commands associated with card removal are executed. These +The shell commands associated with card removal are executed. +These are intended to reset any device associated with the removed card. Separate commands may exist for card, driver and device instances. .It @@ -100,15 +102,18 @@ The PC-CARD slot resources are freed. .Pp Once a card/driver instance is configured, the resources bound to that instance are remembered, and if the card is removed -and reinserted, the same driver is allocated. The primary reason +and reinserted, the same driver is allocated. +The primary reason is that once a driver is associated with a card, the driver's .Fn probe routine has been called, and this usually causes driver specific data areas to be initialized with the I/O ports or memory resources -allocated to the card. Most drivers are not designed to be +allocated to the card. +Most drivers are not designed to be disassociated from the hardware and then reassociated with different -parameters. This will change significantly when loadable kernel +parameters. +This will change significantly when loadable kernel modules are supported. .Pp The start options understood by diff --git a/usr.sbin/pciconf/pciconf.8 b/usr.sbin/pciconf/pciconf.8 index 31f032e..0808806 100644 --- a/usr.sbin/pciconf/pciconf.8 +++ b/usr.sbin/pciconf/pciconf.8 @@ -71,16 +71,19 @@ hex digits, followed by the sub-class and the interface bytes. The third column gives the contents of the subvendorid register, introduced in revision 2.1 of the .Tn PCI -standard. It is 0 for most current (2.0) +standard. +It is 0 for most current (2.0) .Tn PCI cards, but is supposed to be loaded with a unique card identification code in newly developed .Tn PCI -cards. The field consists of the card ID in the upper +cards. +The field consists of the card ID in the upper half and the card vendor ID in the lower half of the value. .Pp The fourth column contains the chip device ID, which identifies the chip -this card is based on. It consists of two fields, identifying the chip and +this card is based on. +It consists of two fields, identifying the chip and its vendor, as above. The fifth column prints the chip's revision. The sixth column describes the header type. @@ -88,7 +91,8 @@ Currently assigned header types are 0 for all devices except .Tn PCI to .Tn PCI -bridges, and 1 for such bridge chips. If the most significant bit +bridges, and 1 for such bridge chips. +If the most significant bit of the header type register is set for function 0 of a .Tn PCI @@ -185,7 +189,8 @@ It might be useful to give non-root users access to the .Fl a and .Fl r -options. But only root will be able to execute a +options. +But only root will be able to execute a .Nm kldload to provide the device with a driver KLD, and reading of configuration space registers may cause a failure in badly designed diff --git a/usr.sbin/pcvt/cursor/cursor.1 b/usr.sbin/pcvt/cursor/cursor.1 index e396d33..88cb223 100644 --- a/usr.sbin/pcvt/cursor/cursor.1 +++ b/usr.sbin/pcvt/cursor/cursor.1 @@ -52,7 +52,8 @@ The options are as follows: .It Fl d Specifies a device for which the cursor shape is set. .It Fl n -Sets the virtual screen number to apply the following parameters to. Not +Sets the virtual screen number to apply the following parameters to. +Not specifying this parameter implies the current virtual screen or the screen referenced by the -d parameter. .It Fl s diff --git a/usr.sbin/pcvt/ispcvt/ispcvt.8 b/usr.sbin/pcvt/ispcvt/ispcvt.8 index 19b46a1..d98c206 100644 --- a/usr.sbin/pcvt/ispcvt/ispcvt.8 +++ b/usr.sbin/pcvt/ispcvt/ispcvt.8 @@ -44,7 +44,8 @@ The .Nm ispcvt utility allows the user to check whether the current video driver compiled -into the kernel is a pcvt driver. The major and minor release numbers of +into the kernel is a pcvt driver. +The major and minor release numbers of the driver are also checked. Furthermore .Nm ispcvt @@ -58,13 +59,15 @@ The options are as follows: .It Fl d Specifies a device for which the check is done. .It Fl v -Specifies being verbose. On success the name and revision is reported, on +Specifies being verbose. +On success the name and revision is reported, on failure which comparison failed. .It Fl c This options prints out the values of all .Dq Ar PCVT_XXXXXX #defines which were given to the compiler at the time the currently running -kernel was compiled. Specifying +kernel was compiled. +Specifying .Fl v with the .Fl c diff --git a/usr.sbin/pcvt/kcon/kcon.1 b/usr.sbin/pcvt/kcon/kcon.1 index 3f35193..6f60a40 100644 --- a/usr.sbin/pcvt/kcon/kcon.1 +++ b/usr.sbin/pcvt/kcon/kcon.1 @@ -56,7 +56,8 @@ The available options are: .Bl -tag -width flag .It Fl d Ar delay Specifies the delay after which the last key entered will be repeated by the -Keyboard. Valid values are 0..3 corresponding to delays of 250, 500, 750 and +Keyboard. +Valid values are 0..3 corresponding to delays of 250, 500, 750 and 1000 milliseconds. .It Fl l Displays the current keyboard map in use by the driver. @@ -76,7 +77,8 @@ octal or hexadecimal and not as 'ESC'. To be used in conjunction with the .Fl l option. .It Fl r Ar rate -Specifies the character repetition rate. Valid argument values are 0...31 +Specifies the character repetition rate. +Valid argument values are 0...31 corresponding to rates of 30 characters/second ... 2 characters/second. .It Fl R Reset the Keyboard. @@ -92,7 +94,8 @@ Specify this option to enable ( Switches display of control codes to hexadecimal in the listing of the current map. To be used in conjunction with the .Fl l -option. This is the default behaviour. +option. +This is the default behaviour. .Sh FILES .Bl -tag -width /usr/share/misc/keycap.pcvt -compact .It Pa /usr/share/misc/keycap.pcvt @@ -104,10 +107,13 @@ Keyboard raw device. .Xr keycap 5 .Sh BUGS .Nm kcon -detects several inconsistencies in the keycap database. In case of errors +detects several inconsistencies in the keycap database. +In case of errors .Nm kcon -exits with an error message. If this happens, the keyboard may remain in -an undefined state. To recover from such situation, execute +exits with an error message. +If this happens, the keyboard may remain in +an undefined state. +To recover from such situation, execute .Nm kcon -m default .Sh EXAMPLES The command diff --git a/usr.sbin/pcvt/keycap/man5/keycap.5 b/usr.sbin/pcvt/keycap/man5/keycap.5 index cb3342b..cb4dfbb 100644 --- a/usr.sbin/pcvt/keycap/man5/keycap.5 +++ b/usr.sbin/pcvt/keycap/man5/keycap.5 @@ -102,7 +102,8 @@ tt\||test\||Test entry which swaps y and z:\e .Ed .Pp Entries may continue onto multiple lines by giving a \e as the last -character of a line. Comments may be included on lines beginning with +character of a line. +Comments may be included on lines beginning with .Dq # . .Sh FILES .Bl -tag -width /usr/share/misc/keycap.pcvt -compact diff --git a/usr.sbin/pcvt/loadfont/loadfont.1 b/usr.sbin/pcvt/loadfont/loadfont.1 index 866f8ed..04e82a7 100644 --- a/usr.sbin/pcvt/loadfont/loadfont.1 +++ b/usr.sbin/pcvt/loadfont/loadfont.1 @@ -51,7 +51,8 @@ VT220 driver on EGA and VGA boards into the font ram of this boards. The options are as follows: .Bl -tag -width Ds .It Fl c -Specifies the slot, the font is to load into. EGA boards have four +Specifies the slot, the font is to load into. +EGA boards have four slots and VGA boards have eight slots available for downloading fonts. .It Fl d Specifies the devicefile to use. diff --git a/usr.sbin/pcvt/mcon/mcon.1 b/usr.sbin/pcvt/mcon/mcon.1 index 47581ba..11134ce 100644 --- a/usr.sbin/pcvt/mcon/mcon.1 +++ b/usr.sbin/pcvt/mcon/mcon.1 @@ -62,10 +62,12 @@ Either way, the .Nm program must be called with an argument .Ar device -that specifies the device node used for the mouse emulation. This is +that specifies the device node used for the mouse emulation. +This is usually the first device node of the .Xr pcvt 4 -driver not being used as a virtual terminal device. E.\ g., if you +driver not being used as a virtual terminal device. +E.\ g., if you have configured eight virtual terminals .Pq the default value , named @@ -91,7 +93,8 @@ Maps the named .Ar button key to emulate either the left, middle, or right mouse button. .Ar Button key -is the usual name for that key. Normal ASCII keys are denoted by the +is the usual name for that key. +Normal ASCII keys are denoted by the character they're labeled with, function keys are named .Em f1 through @@ -108,8 +111,10 @@ it only allows basic PC-scancode keys to be used. .It Fl a Ar accel-time Set the time limit for the internal accelerator to .Ar accel-time -milliseconds. Key events occurring after a longer time than this limit -will move the mouse cursor in single steps. Key events arriving more +milliseconds. +Key events occurring after a longer time than this limit +will move the mouse cursor in single steps. +Key events arriving more frequently will move the cursor accelerated by a factor of 6. Note that despite of .Em milliseconds @@ -121,9 +126,11 @@ granularity of 10 milliseconds. .It Fl s Ar 1 | true | yes The first form disables, the second form enables the .Em sticky -behaviour of the mouse buttons. Sticky mouse keys behave much like +behaviour of the mouse buttons. +Sticky mouse keys behave much like toggle-buttons: on first press, they become active, on second press, -they're deactivated. Pressing another button will deactivate any +they're deactivated. +Pressing another button will deactivate any other sticky button anyway. Sticky buttons might be more convenient since you don't need 20 fingers @@ -144,7 +151,8 @@ mouse emulator: .Sh BUGS The key names used to map the button-emulating keys to scan codes .Pq and vica verse -are based on the American keyboard layout. This would usually not +are based on the American keyboard layout. +This would usually not cause any trouble since the .Dq button-of-choice is certainly some function key that should be equal for any national diff --git a/usr.sbin/pcvt/scon/scon.1 b/usr.sbin/pcvt/scon/scon.1 index 6f8bc6e..d2511de 100644 --- a/usr.sbin/pcvt/scon/scon.1 +++ b/usr.sbin/pcvt/scon/scon.1 @@ -89,12 +89,15 @@ Specify the device filename (i.e. /dev/ttyv2) further operations specified on the command line should be applied to. .It Fl f Some programs which silently assume 24 lines when they run on a VT220 show -incorrect behaviour when the terminal has really 25 lines. To support full +incorrect behaviour when the terminal has really 25 lines. +To support full VT220 behaviour, it is possible to force pcvt to select only 24 lines when -it is running in 25-lines pure VT mode and/or in 28-lines HP-mode. The +it is running in 25-lines pure VT mode and/or in 28-lines HP-mode. +The .Fl f option requires one additional parameter, the string 'on' or 'off' to switch -this mode for a virtual screen on or off respectively. This mode has no effect +this mode for a virtual screen on or off respectively. +This mode has no effect if any other vertical resolutions are selected than the two above mentioned. .It Fl h Prints a usage/help text. @@ -112,14 +115,17 @@ Specify verbose operation of the program. Switch the specified/current screen into a pure VT220 mode without recognizing any HP escape sequences and without displaying function key labels. .It Fl H -Switch the specified/current screen into a mixed HP/VT220 mode. That is, that +Switch the specified/current screen into a mixed HP/VT220 mode. +That is, that in addition to the full VT220 emulation, the HP function key labels and the escape sequences for handling the labels are available to the user. .It Fl s -Specify the number of character lines on the screen. Possible parameters are +Specify the number of character lines on the screen. +Possible parameters are 25, 28, 35, 40, 43 or 50. To use all this screen sizes, the fonts required for proper operation of a desired size have to be downloaded to the EGA/VGA -font ram. This option is available only for EGA and VGA boards. +font ram. +This option is available only for EGA and VGA boards. .It Fl p Modify VGA palette .Pq DAC . @@ -132,7 +138,8 @@ and .Fl V . Naturally, option .Fl p -is available only for VGA boards. Three flavors are available. +is available only for VGA boards. +Three flavors are available. If used with argument .Dq Ar default , @@ -143,13 +150,17 @@ as installed by VGA ROM BIOS after hardware reset If used with argument .Dq Ar list , -the current VGA DAC palette entries are listed. Each entry contains +the current VGA DAC palette entries are listed. +Each entry contains the table index, values for red, green, and blue, and if there's a -known name for this entry, the color name. Trailing empty table +known name for this entry, the color name. +Trailing empty table slots (RGB values all zero) are omitted. -Otherwise, four comma-separated arguments are expected. The first -denotes the number of palette entry to be modified. This may be either +Otherwise, four comma-separated arguments are expected. +The first +denotes the number of palette entry to be modified. +This may be either a number between 0 and 255, or the usual name of an associated color .Pq case-insensitive . The following values for red, green and blue are restricted to 0 through 63 @@ -166,11 +177,13 @@ options may be specified if unambiguous. .It Fl t Specifying .Fl t -will activate the screen saver. The behaviour depends on +will activate the screen saver. +The behaviour depends on .Ar timeout : if .Ar timeout -is given as 0, the screen saver is turned off. Otherwise, +is given as 0, the screen saver is turned off. +Otherwise, .Ar timeout is taken as a number of seconds to wait until activating the screen saver. diff --git a/usr.sbin/pcvt/userkeys/vt220keys.1 b/usr.sbin/pcvt/userkeys/vt220keys.1 index 65e596a..d4df9aa 100644 --- a/usr.sbin/pcvt/userkeys/vt220keys.1 +++ b/usr.sbin/pcvt/userkeys/vt220keys.1 @@ -13,7 +13,8 @@ vt220keys \- define SHIFTED function keys on VT220 terminal .SH DESCRIPTION .I Vt220keys sets up a "vt220 terminal" in vt200 mode to allow user -definition of the SHIFTED function keys. Each +definition of the SHIFTED function keys. +Each \f2keyname\f1 specified on the command line will be loaded with the corresponding \f2keystring\f1. A \f2keyname\f1 is one of the following "words": @@ -114,7 +115,8 @@ This will require you to press the SHIFT key and ESC to generate the escape sequence. .sp Some editors, allow other character(s) to be substituted for the -escape character. For example with +escape character. +For example with .B emacs include this line in your .emacs_pro: .br diff --git a/usr.sbin/pcvt/vgaio/vgaio.8 b/usr.sbin/pcvt/vgaio/vgaio.8 index 4736b57..d5d3285 100644 --- a/usr.sbin/pcvt/vgaio/vgaio.8 +++ b/usr.sbin/pcvt/vgaio/vgaio.8 @@ -61,8 +61,10 @@ Turn on the grammar parser debugger. .Ss Command language The command language of .Nm -constitutes of some very simple tokens and rules. Commands are executed -line by line as they are entered. Each line may contain any number of +constitutes of some very simple tokens and rules. +Commands are executed +line by line as they are entered. +Each line may contain any number of semicolon-separated input/output commands. Symbolic register names look like: @@ -115,7 +117,8 @@ Spaces or Tabs between the .Aq Em reggroup , the .Aq Em regnumber , -or any of the other tokens are ignored. They are not required anyway. +or any of the other tokens are ignored. +They are not required anyway. The .Dq Em mi diff --git a/usr.sbin/pim6dd/pim6dd.8 b/usr.sbin/pim6dd/pim6dd.8 index 9b76c07..e907072 100644 --- a/usr.sbin/pim6dd/pim6dd.8 +++ b/usr.sbin/pim6dd/pim6dd.8 @@ -55,7 +55,8 @@ By default, .Pa /etc/pim6dd.conf is used. .It Fl d -Specify debug levels. If this option is specified without any arguments, +Specify debug levels. +If this option is specified without any arguments, all debug messages will be printed out. A subset of the messages to be printed out can be specified as arguments of the option. diff --git a/usr.sbin/pim6dd/pim6dd.conf.5 b/usr.sbin/pim6dd/pim6dd.conf.5 index a526c59..1b750f2 100644 --- a/usr.sbin/pim6dd/pim6dd.conf.5 +++ b/usr.sbin/pim6dd/pim6dd.conf.5 @@ -61,7 +61,8 @@ unicast routing protocols, so a default value may be configured. .It Ic default_source_metric Ar metric Specifies a default metric value when sending a PIM assert message. It is recommended that preferences be set such that metrics are never -consulted. However, default metrics may also be set and will default to +consulted. +However, default metrics may also be set and will default to 1024. .\" .It Xo @@ -87,7 +88,8 @@ assert message on the interface. .It Xo .Ic filter Ar groupaddrs Ar interfaces... .Xc -Specifies an output filter. If an incoming multicast packet's destination +Specifies an output filter. +If an incoming multicast packet's destination matches the specified .Ar groupaddrs, the packet is not sent on the @@ -121,7 +123,8 @@ is omitted, it means the exact match for .Ar multicastaddr. .El .Ar interfaces -are specified as a blank separated list of interfaces. Each interface is +are specified as a blank separated list of interfaces. +Each interface is specified in the form of "name unit". .El .\" diff --git a/usr.sbin/pim6sd/mtrace6/mtrace6.8 b/usr.sbin/pim6sd/mtrace6/mtrace6.8 index 1beab02..f0b437d 100644 --- a/usr.sbin/pim6sd/mtrace6/mtrace6.8 +++ b/usr.sbin/pim6sd/mtrace6/mtrace6.8 @@ -50,7 +50,8 @@ a receiver .Sh DESCRIPTION .Nm utilizes a tracing feature implemented in multicast routers that is -accessed via an extension to the MLD protocol. A trace query is +accessed via an extension to the MLD protocol. +A trace query is passed hop-by-hop along the reverse path from the .Ar destination to the @@ -74,7 +75,8 @@ can also be a multicast address that the last hop router joins. .It Fl h Ar hops Set .Ar hops -to the IPv6 hop limit field of query packets. The default is 64. +to the IPv6 hop limit field of query packets. +The default is 64. .It Fl i Ar interface Specifies the local interface (on a multi-homed host) for sending the trace query and as the default for the receiver and the response @@ -83,7 +85,8 @@ destination. Set to .Ar maxhops to the maximum number of hops that will be traced from the receiver -back toward the source. The default is 127 hops. +back toward the source. +The default is 127 hops. .It Fl n Print hop addresses numerically rather than symbolically and numerically (saves a nameserver address-to-name lookup for each router found on @@ -95,14 +98,16 @@ By default, the response will send to the host running .It Fl w Ar waittime Set the time to wait for a trace response to .Ar waittime -seconds. The default is 3 seconds. +seconds. +The default is 3 seconds. .El .Sh SEE ALSO .Xr pim6dd 8 , .Xr pim6sd 8 , .Xr mtrace 8 .Sh BUGS -Multicast trace for IPv6 is experimental. MLD types for query and +Multicast trace for IPv6 is experimental. +MLD types for query and response, and packet format are not officially defined. .Pp .Ar waittime diff --git a/usr.sbin/pim6sd/pim6sd.8 b/usr.sbin/pim6sd/pim6sd.8 index 317bd91..8311df14 100644 --- a/usr.sbin/pim6sd/pim6sd.8 +++ b/usr.sbin/pim6sd/pim6sd.8 @@ -56,7 +56,8 @@ By default, .Pa /etc/pim6sd.conf is used. .It Fl d -Specify debug levels. If this option is specified without any arguments, +Specify debug levels. +If this option is specified without any arguments, all debug messages will be printed out. A subset of the messages to be printed out can be specified as arguments of the option. @@ -71,7 +72,8 @@ Valid debug levels are and .Ic asserts. .It Fl f -Do not become daemon, run in foreground. This option is for debugging +Do not become daemon, run in foreground. +This option is for debugging use. .El .Pp @@ -91,7 +93,8 @@ it receives a SIGUSR1 signal. The information includes a list of PIM neighbors, .Nm internal multicast routing table, and -BSR and RP related information. Also, the program dumps its internal +BSR and RP related information. +Also, the program dumps its internal statistics to a file when it receives a SIGINFO signal. .Pp When diff --git a/usr.sbin/pim6sd/pim6sd.conf.5 b/usr.sbin/pim6sd/pim6sd.conf.5 index ea27c06..0256b8f 100644 --- a/usr.sbin/pim6sd/pim6sd.conf.5 +++ b/usr.sbin/pim6sd/pim6sd.conf.5 @@ -65,7 +65,8 @@ The following statements can be specified in the configuration file. .Ar option... .Ic ; .Xc -Specify debug messages to be printed out. Each +Specify debug messages to be printed out. +Each .Ar option usually specifies a subset of the messages to be printed. If an @@ -73,7 +74,8 @@ If an begins with .Ic no , it means that the set of the messages that are specified by the option -will not be printed. For example, +will not be printed. +For example, .Ic `all nomld' means that all the messages except MLD related ones will be printed. Valid options are @@ -145,7 +147,8 @@ The default preference is 1024. .It Ic default_source_metric Ar metric; Specifies a default metric value when sending a PIM assert message. It is recommended that preferences be set such that metrics are never -consulted. However, default metrics may also be set and will default to +consulted. +However, default metrics may also be set and will default to 1024. .\" .It Xo @@ -166,7 +169,8 @@ the holdtime will be * .Ar coef . The default values of the period and the coefficient are 30 and 3.5, -respectively. The default holdtime is 105 seconds as a result. +respectively. +The default holdtime is 105 seconds as a result. .\" .It Xo .Ic join_prune_period Ar period Ar coef; @@ -180,7 +184,8 @@ the holdtime will be * .Ar coef . The default values of the period and the coefficient are 60 and 3.5, -respectively. Consequently, the default holdtime is 210 seconds. +respectively. +Consequently, the default holdtime is 210 seconds. .\" .It Xo .Ic data_timeout Ar timer; diff --git a/usr.sbin/pkg_install/add/pkg_add.1 b/usr.sbin/pkg_install/add/pkg_add.1 index 670e3d1..9f9051c 100644 --- a/usr.sbin/pkg_install/add/pkg_add.1 +++ b/usr.sbin/pkg_install/add/pkg_add.1 @@ -71,7 +71,8 @@ The following command line arguments are supported: .It Ar pkg-name [... pkg-name] The named packages are installed. A package name of - will cause .Nm -to read from stdin. If the packages are not found in the current +to read from stdin. +If the packages are not found in the current working directory, .Nm will search them in each directory named by @@ -89,7 +90,8 @@ Do not record the installation of a package. This means that you cannot deinstall it later, so only use this option if you know what you are doing! .It Fl r -Use the remote fetching feature. This will determine the appropriate +Use the remote fetching feature. +This will determine the appropriate objformat and release and then fetch and install the package. .It Fl f Force installation to proceed even if prerequisite packages are not @@ -344,7 +346,8 @@ is that this allows you to write a single .Ar install script that does both .Dq before and after -actions. But, separating the +actions. +But, separating the functionality is more advantageous and easier from a maintainence viewpoint. .It After installation is complete, a copy of the packing list, @@ -378,7 +381,8 @@ The value of the .Ev PKG_PATH is used if a given package can't be found. The environment variable should be a series of entries seperated by colons. Each entry -consists of a directory name. The current directory may be indicated +consists of a directory name. +The current directory may be indicated implicitly by an empty directory name, or explicitly by a single period. .Pp @@ -407,7 +411,8 @@ The environment variable .Ev PACKAGESITE specifies an alternate location for .Nm -to fetch from. This variable subverts the automatic directory logic +to fetch from. +This variable subverts the automatic directory logic that .Nm uses when the diff --git a/usr.sbin/pkg_install/create/pkg_create.1 b/usr.sbin/pkg_install/create/pkg_create.1 index 3407210..4ecc921 100644 --- a/usr.sbin/pkg_install/create/pkg_create.1 +++ b/usr.sbin/pkg_install/create/pkg_create.1 @@ -110,7 +110,8 @@ Set .Ar iscript to be the pre-install procedure for the package. This can be any executable program (or shell script). It will be invoked automatically when the -package is later installed. It will be passed the package's name as the +package is later installed. +It will be passed the package's name as the first argument. .Cm Note: @@ -128,7 +129,8 @@ Set .Ar piscript to be the post-install procedure for the package. This can be any executable program (or shell script). It will be invoked automatically -when the package is later installed. It will be passed the package's name as +when the package is later installed. +It will be passed the package's name as the first argument. .It Fl P Ar pkgs Set the initial package dependency list to @@ -149,7 +151,8 @@ Set .Ar dscript to be the de-install procedure for the package. This can be any executable program (or shell script). It will be invoked automatically when the -package is later (if ever) de-installed. It will be passed the package's +package is later (if ever) de-installed. +It will be passed the package's name as the first argument. .Cm Note: @@ -167,7 +170,8 @@ Set .Ar pdscript to be the post-deinstall procedure for the package. This can be any executable program (or shell script). It will be invoked automatically when -the package is later de-installed. It will be passed the package's name as +the package is later de-installed. +It will be passed the package's name as the first argument. .It Fl r Ar rscript diff --git a/usr.sbin/pkg_install/version/pkg_version.1 b/usr.sbin/pkg_install/version/pkg_version.1 index ce50745..efb1130 100644 --- a/usr.sbin/pkg_install/version/pkg_version.1 +++ b/usr.sbin/pkg_install/version/pkg_version.1 @@ -126,11 +126,13 @@ the version numbers in the on-line ports collection: .Dl % pkg_version ftp://ftp.FreeBSD.org/pub/FreeBSD/ports-current/INDEX .Pp The command below generates a file of commands to run to update the installed -files. It is +files. +It is .Bf Em not .Ef -suggested that you run these commands automatically. Always review the +suggested that you run these commands automatically. +Always review the suggestions, and then cut-and-paste (or retype) the commands you want to run. .Pp .Dl % pkg_version -c > do_update @@ -150,7 +152,8 @@ Updates to packages that don't change the version number (e.g. small delta bugfixes in the package/port itself) aren't detected. .Pp -Commands output doesn't know about dependencies between packages. For +Commands output doesn't know about dependencies between packages. +For example, you might have two versions of Tcl installed because two other packages require the different versions. .Nm diff --git a/usr.sbin/pw/pw.8 b/usr.sbin/pw/pw.8 index c65aafe..2b35639 100644 --- a/usr.sbin/pw/pw.8 +++ b/usr.sbin/pw/pw.8 @@ -450,7 +450,8 @@ Set the field in the user's passwd record. This field is not currently used, but will be used in the future to specify a .Em termcap -entry like tag. See +entry like tag. +See .Xr passwd 5 for details. .It Fl h Ar fd @@ -628,7 +629,8 @@ You should only set this option for NIS servers. .Pp The .Ar userdel -command has only three valid options. The +command has only three valid options. +The .Ql Fl n Ar name and .Ql Fl u Ar uid diff --git a/usr.sbin/pw/pw.conf.5 b/usr.sbin/pw/pw.conf.5 index 2cec824..7c91dd3 100644 --- a/usr.sbin/pw/pw.conf.5 +++ b/usr.sbin/pw/pw.conf.5 @@ -284,7 +284,8 @@ expiration date. .Sh LIMITS The maximum line length of .Pa /etc/pw.conf -is 1024 characters. Longer lines will be skipped and treated +is 1024 characters. +Longer lines will be skipped and treated as comments. .Sh FILES .Bl -tag -width /etc/master.passwd -compact diff --git a/usr.sbin/pwd_mkdb/pwd_mkdb.8 b/usr.sbin/pwd_mkdb/pwd_mkdb.8 index b2a5cd6..5d3e0e8 100644 --- a/usr.sbin/pwd_mkdb/pwd_mkdb.8 +++ b/usr.sbin/pwd_mkdb/pwd_mkdb.8 @@ -67,7 +67,8 @@ different from the historic Version 7 style format. The options are as follows: .Bl -tag -width flag .It Fl C -Check if the password file is in the correct format. Do not +Check if the password file is in the correct format. +Do not change, add, or remove any files. .It Fl N Tell diff --git a/usr.sbin/rndcontrol/rndcontrol.8 b/usr.sbin/rndcontrol/rndcontrol.8 index e94c762..f358484 100644 --- a/usr.sbin/rndcontrol/rndcontrol.8 +++ b/usr.sbin/rndcontrol/rndcontrol.8 @@ -40,7 +40,8 @@ The .Nm command is used to set which interrupts are used to help randomise -the ``pool of entropy'' maintained by the kernel. The +the ``pool of entropy'' maintained by the kernel. +The .Pa /dev/random and .Pa /dev/urandom @@ -54,12 +55,14 @@ Turn off all output except errors. .It Fl s Ar n Allow IRQ .Ar n -to be used as a source of randomness. This option may be repeated for +to be used as a source of randomness. +This option may be repeated for more than one IRQ. .It Fl c Ar n Stop IRQ .Ar n -from being used as a source of randomness. This option may be repeated for +from being used as a source of randomness. +This option may be repeated for more than one IRQ. .El .Pp diff --git a/usr.sbin/rpc.umntall/rpc.umntall.8 b/usr.sbin/rpc.umntall/rpc.umntall.8 index 268e0fc..849b010 100644 --- a/usr.sbin/rpc.umntall/rpc.umntall.8 +++ b/usr.sbin/rpc.umntall/rpc.umntall.8 @@ -49,11 +49,14 @@ RPC specification; see .Re It uses remote procedure calls to remove mount entries from .Pa /var/db/mountdtab -on the remote NFS server. It is called automatically +on the remote NFS server. +It is called automatically without any parameters during startup and shutdown of -the system. This ensures that +the system. +This ensures that .Xr showmount 8 -does not display old and expired entries. The +does not display old and expired entries. +The .Nm command is only needed on client side, where @@ -62,7 +65,8 @@ adds a mount entry with the current date to .Pa /var/db/mounttab , and .Xr umount 8 -removes the entry again. The +removes the entry again. +The .Nm command cares about all remaining entries in this table which result from crashes @@ -76,19 +80,25 @@ All entries which are not actually mounted or older than (seconds) are removed from .Pa /var/db/mounttab . This may be the case -for DNS changes or long out of service periods. Default expire time +for DNS changes or long out of service periods. +Default expire time is 86400 seconds (one day). .It Fl h Ar host -Only remove the specific hostname. Send a UMNTALL RPC to the NFS server. +Only remove the specific hostname. +Send a UMNTALL RPC to the NFS server. .It Fl k -Keep entries for existing NFS filesystems. Compare the NFS filesystems from +Keep entries for existing NFS filesystems. +Compare the NFS filesystems from the mounttab against the kernel mountlist and do not send the RPC to -existing mount entries. Useful during startup of the system. It may be +existing mount entries. Useful during startup of the system. +It may be possible that there are already mounted NFS filesystems, so calling -RPC UMOUNT isn't a good idea. This is the case if the user has rebooted +RPC UMOUNT isn't a good idea. +This is the case if the user has rebooted to 'single user mode' and starts up the system again. .It Fl p Ar path -Only remove the specific mount-path. Send a UMOUNT RPC to the NFS server. +Only remove the specific mount-path. +Send a UMOUNT RPC to the NFS server. This option implies the .Fl host option. diff --git a/usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 b/usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 index a654abf..b875f5c 100644 --- a/usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 +++ b/usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 @@ -72,7 +72,8 @@ The .Nm server allows a normal NIS user to change his or her NIS password, full name (also -known as 'GECOS' field) or shell. These updates are typically done using +known as 'GECOS' field) or shell. +These updates are typically done using the .Xr yppasswd 1 , .Xr ypchfn 1 , @@ -104,7 +105,8 @@ and then runs the .Pa /usr/libexec/yppwupdate script to rebuild the NIS maps. (This script has two arguments passed to it: the absolute pathname of the password template that was modified -and the name of the domain that is to be updated. These in turn are +and the name of the domain that is to be updated. +These in turn are passed to .Pa /var/yp/Makefile ) . .Pp @@ -113,7 +115,8 @@ The version of .Nm also allows the super-user on the NIS master server to perform more -sophisticated updates on the NIS passwd maps. The super-user can modify +sophisticated updates on the NIS passwd maps. +The super-user can modify any field in any user's master.passwd entry in any domain, and can do so without knowing the user's existing NIS password (when the server receives a request from the super-user, the password authentication @@ -159,39 +162,46 @@ server can support multiple domains, however it must choose one domain as a default. It will try to use the system default domain name as set by the .Xr domainname 1 -command for this default. However, +command for this default. +However, if the system domain name is not set, a default domain must be specified on -the command line. If the system default domain is set, +the command line. +If the system default domain is set, then this option can be used to override it. .It Fl p Ar path This option can be used to override the default path to the location of the NIS -map databases. The compiled-in default path is +map databases. +The compiled-in default path is .Pa /var/yp . .It Fl s Disallow changing of shell information. .It Fl f Disallow changing of full name ('GECOS') information. .It Fl a -Allow additions to be made to the NIS passwd databases. The super-user on the +Allow additions to be made to the NIS passwd databases. +The super-user on the NIS master server is permitted to use the .Xr ypchpass 1 command to perform unrestricted modifications to any field in a user's .Pa master.passwd -map entry. When +map entry. +When .Nm is started with this flag, it will also allow the super-user to add new records to the NIS passwd maps, just as is possible when using .Xr chpass 1 to modify the local password database. .It Fl m -Turn on multi-domain mode. Even though +Turn on multi-domain mode. +Even though .Xr ypserv 8 can handle several simultaneous domains, most implementations of .Nm can only operate on a single NIS domain, which is generally the same as -the system default domain of the NIS master server. The +the system default domain of the NIS master server. +The .Bx Free .Nm attempts to overcome this problem in spite of the inherent limitations @@ -199,7 +209,8 @@ of the .Pa yppasswd protocol, which does not allow for a .Pa domain -argument in client requests. In multi-domain mode, +argument in client requests. +In multi-domain mode, .Nm will search through all the passwd maps of all the domains it can find under @@ -210,7 +221,8 @@ UID and GID fields.) The matched entry and corresponding domain are then used for the update. .Pp Note that in order for multi-domain mode to work, there have to be -seperate template files for each domain. For example, if a server +seperate template files for each domain. +For example, if a server supports three domains, .Pa foo , .Pa bar , @@ -232,26 +244,33 @@ The server will check for the latter file first and then use the former if it can't find it. .Pp Multi-domain mode is off by default since it can fail if there are -duplicate or near-duplicate user entries in different domains. The server +duplicate or near-duplicate user entries in different domains. +The server will abort an update request if it finds more than one user entry that -matches its search criteria. Even so, paranoid administrators +matches its search criteria. +Even so, paranoid administrators may wish to leave multi-domain mode disabled. .It Fl i If .Nm -is invoked with this flag, it will perform map updates in place. This +is invoked with this flag, it will perform map updates in place. +This means that instead of just modifying the password template file and starting a map update, the server will modify the map databases -directly. This is useful when the password maps are large: if, for +directly. +This is useful when the password maps are large: if, for example, the password database has tens of thousands of entries, it -can take several minutes for a map update to complete. Updating the +can take several minutes for a map update to complete. +Updating the maps in place reduces this time to a few seconds. .It Fl v -Turn on verbose logging mode. The server normally only logs messages +Turn on verbose logging mode. +The server normally only logs messages using the .Xr syslog 3 facility when it encounters an error condition, or when processing -updates for the super-user on the NIS master server. Running the server +updates for the super-user on the NIS master server. +Running the server with the .Fl v flag will cause it to log informational messages for all updates. @@ -268,16 +287,19 @@ ports when establishing client connections for the super-user. By default, .Nm expects to receive requests from clients using reserved ports; requests -received from non-privileged ports are rejected. Unfortunately, this +received from non-privileged ports are rejected. +Unfortunately, this behavior prevents any client systems that to not use privileged -ports from sucessfully submitting password updates. Specifying +ports from sucessfully submitting password updates. +Specifying the .Fl u flag to .Nm disables the privileged port check so that it will work with .Xr yppasswd 1 -clients that don't use privileged ports. This reduces security to +clients that don't use privileged ports. +This reduces security to a certain small degree, but it might be necessary in cases where it is not possible to change the client behavior. .It Fl h @@ -308,7 +330,8 @@ The template password file(s) for non-default domains As listed in the yppasswd.x protocol definition, the YPPASSWDPROC_UPDATE procedure takes two arguments: a V7-style passwd structure containing updated user information and the user's existing unencrypted (cleartext) -password. Since +password. +Since .Nm is supposed to handle update requests from remote NIS client machines, this means that @@ -320,7 +343,8 @@ This is not a problem for password updates since the plaintext password sent with the update will no longer be valid once the new encrypted password is put into place, but if the user is only updating his or her 'GECOS' information or shell, then the cleartext password sent with the update -will still be valid once the update is completed. If the network is +will still be valid once the update is completed. +If the network is insecure, this cleartext password could be intercepted and used to gain unauthorized access to the user's account. .Sh AUTHORS diff --git a/usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8 b/usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8 index c086f77..0543b75 100644 --- a/usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8 +++ b/usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8 @@ -43,7 +43,8 @@ The .Nm daemon is used to speed up the distribtion of very large NIS maps -from NIS master to NIS slave servers. The normal method for transfering +from NIS master to NIS slave servers. +The normal method for transfering maps involves several steps: .Bl -bullet -offset indent .It @@ -71,12 +72,14 @@ database handles. .El .Pp This process can take several minutes when there are very large -maps involved. For example: a passwd database with several tens of +maps involved. +For example: a passwd database with several tens of thousands of entries can consume several megabytes of disk space, and it can take the .Xr db 3 library package a long time to sort and store all the records -in a hash database. Consider also that there are two sets of map +in a hash database. +Consider also that there are two sets of map files: .Pa master.passwd.by{name,uid} and @@ -86,9 +89,11 @@ The .Nm server speeds up the transfer process by allowing NIS slave servers to simply copy the master server's map files rather than building their -own from scratch. Simply put, +own from scratch. +Simply put, .Nm -implements an RPC-based file transfer protocol. Transfering even +implements an RPC-based file transfer protocol. +Transfering even a multi-megabyte file in this fashion takes only a few seconds compared to the several minutes it would take even a reasonably fast slave server to build a new map from scratch. @@ -100,7 +105,8 @@ server uses the same access restriction mechanism as This means that slave servers will only be permitted to transfer files if the rules in the .Xr securenets 5 -database permit it. Furthermore, only slave servers using reserved +database permit it. +Furthermore, only slave servers using reserved ports will be allowed to transfer the .Pa master.passwd maps. @@ -110,7 +116,8 @@ The following option is available: .It Fl p Ar path This option can be used to override the default path to the location of the NIS -map databases. The compiled-in default path is +map databases. +The compiled-in default path is .Pa /var/yp . .El .Sh FILES @@ -127,13 +134,16 @@ The NIS maps for a particular NIS domain. The .Bx Free .Nm ypxfrd -protocol is not compatible with that used by SunOS. This is unfortunate +protocol is not compatible with that used by SunOS. +This is unfortunate but unavoidable: Sun's protocol is not freely available, and even if it were it would probably not be useful since the SunOS NIS v2 implementation uses the original ndbm package for its map databases whereas the .Bx Free -implementation uses Berkeley DB. These two packages use vastly different -file formats. Furthermore, ndbm is byte-order sensitive and not very +implementation uses Berkeley DB. +These two packages use vastly different +file formats. +Furthermore, ndbm is byte-order sensitive and not very smart about it, meaning that am ndbm database created on a big endian system can't be read on a little endian system. .Sh AUTHORS diff --git a/usr.sbin/rrenumd/rrenumd.conf.5 b/usr.sbin/rrenumd/rrenumd.conf.5 index 76453cb..2accf05 100644 --- a/usr.sbin/rrenumd/rrenumd.conf.5 +++ b/usr.sbin/rrenumd/rrenumd.conf.5 @@ -83,7 +83,8 @@ then debugging is enabled, If .Ic off is specified, -then debugging is disabled. It is disabled by default. +then debugging is disabled. +It is disabled by default. .\" .It Ic dest Ar dest-list Op Ar retrycmd ; Specifies destinations to which router renumbering messages should be @@ -180,7 +181,8 @@ Valid value for .Ar time is decimal seconds number or special format as "d00h00m00s00", where 00 can take any decimal number, and "d" means days, "h" means hours, -"m" means minutes, "s" means seconds. And alternatively, special keyword +"m" means minutes, "s" means seconds. +And alternatively, special keyword "infinity" can be also be specified. .It Cm pltime Ar pltime-val Assign an @@ -192,7 +194,8 @@ is same as for .Ar vltime-val . .It Cm raf_onlink Cm on|off Let the prefix to be added to have on-link or off-link nature -for the assigned interface. If +for the assigned interface. +If .Cm on is specified, the prefix have on-link nature. (e.g. the prefix belong to the link) If @@ -201,29 +204,36 @@ is specified, the prefix have off-link nature. (e.g. the prefix does not belong to the link) .It Cm raf_auto Cm on|off Enable or disable the autonomous address auto configuration -for the prefix to be added. If +for the prefix to be added. +If .Cm on is specified, autonomous address auto configuration is -enabled. If +enabled. +If .Cm off is specified, it is disabled. .It Cm rrf_decrprefd Cm on|off -Enable or disable the decrementation of the pltime. If +Enable or disable the decrementation of the pltime. +If .Cm on -is specified, decrementation of the pltime is enabled. If +is specified, decrementation of the pltime is enabled. +If .Cm off is specified, decrementation of the pltime is disabled. .It Cm rrf_decrvalid Cm on|off -Enable or disable the decrementation of the vltime. If +Enable or disable the decrementation of the vltime. +If .Cm on -is specified, decrementation of the vltime is enabled. If +is specified, decrementation of the vltime is enabled. +If .Cm off is specified, decrementation of the vltime is disabled. .El .\" .It seqnum Ar seqnum-val { Ar rrenum-cmd } ; Specifies contents of sending router renumbering message with some -specific seqnum. Multiple of this statement can be specified if they +specific seqnum. +Multiple of this statement can be specified if they have different .Ar seqnum-val each other. @@ -268,7 +278,8 @@ If you are going to do renumbering, then following procedure will be natural. Assigne new prefix. .It Set old prefix lifetimes to some appropriate transition -period. In the followng example we use 1 week for valid +period. +In the followng example we use 1 week for valid lifetime, and 0 for preferred lifetime. Also, enable old prefix lifetime expiration. (By default, it is static and does not expire) diff --git a/usr.sbin/rtadvd/rtadvd.8 b/usr.sbin/rtadvd/rtadvd.8 index 096581d..2c56bae 100644 --- a/usr.sbin/rtadvd/rtadvd.8 +++ b/usr.sbin/rtadvd/rtadvd.8 @@ -90,9 +90,12 @@ is used. .It Fl P Specifies that .Nm -receives router renumbering messages. Also, specifies IPsec policy for -rrenumd sessions. Because router renumbering can change the system's -IPv6 prefix, its messages must be protected by IPsec. For details about +receives router renumbering messages. +Also, specifies IPsec policy for +rrenumd sessions. +Because router renumbering can change the system's +IPv6 prefix, its messages must be protected by IPsec. +For details about .Ar policy , please refer to .Xr ipsec 4 diff --git a/usr.sbin/rtprio/rtprio.1 b/usr.sbin/rtprio/rtprio.1 index be6c750..0b7c4d7 100644 --- a/usr.sbin/rtprio/rtprio.1 +++ b/usr.sbin/rtprio/rtprio.1 @@ -198,7 +198,8 @@ processes can starve realtime processes, or idletime processes can starve normal priority processes. .Sh AUTHORS .An Henrik Vestergaard Draboel Aq hvd@terry.ping.dk -is the original author. This +is the original author. +This implementation in .Bx Free was substantially rewritten by diff --git a/usr.sbin/setkey/setkey.8 b/usr.sbin/setkey/setkey.8 index 1f6f33c..1a688b0 100644 --- a/usr.sbin/setkey/setkey.8 +++ b/usr.sbin/setkey/setkey.8 @@ -99,7 +99,8 @@ socket. .It Fl h Add hexadecimal dump on .Fl x -mode. The order is significant. +mode. +The order is significant. .It Fl l Loop forever with short output on .Fl D . @@ -112,7 +113,8 @@ including messages sent from other processes .Pc . .El .Pp -Operation has the following grammar. Note that lines, that start with a +Operation has the following grammar. +Note that lines, that start with a hashmark ('#') are treated as comment lines. Description of meta-arguments follows. .Bl -tag -width Ds diff --git a/usr.sbin/sgsc/sgsc.1 b/usr.sbin/sgsc/sgsc.1 index a502d80..4df3295 100644 --- a/usr.sbin/sgsc/sgsc.1 +++ b/usr.sbin/sgsc/sgsc.1 @@ -49,10 +49,12 @@ The .Nm utility provides shell level access to the ioctl -requests served by the handy scanner device driver gsc. Please see +requests served by the handy scanner device driver gsc. +Please see .Xr gsc 4 for the exact meaning of the requests. Generally they modify -the output and behaviour of the gsc scanner device. When +the output and behaviour of the gsc scanner device. +When .Nm is called with no option only the current settings are reported. .Pp @@ -65,9 +67,11 @@ Operate in quiet mode, i.e. do not report any of the current settings. Normally the parameters are shown after the modifications have been performed. .It Fl f Ar file -Operate on a different scanner device node given by filename. Note +Operate on a different scanner device node given by filename. +Note that even though there may exist more than one node of scanner device -several of them will refer the same device unit. The modifications are +several of them will refer the same device unit. +The modifications are performed od the unit regardless of the device node by which it is accessed. .It Fl r Ar resolution [GSC_SRES] diff --git a/usr.sbin/sicontrol/sicontrol.8 b/usr.sbin/sicontrol/sicontrol.8 index be965a7..d4f36a9 100644 --- a/usr.sbin/sicontrol/sicontrol.8 +++ b/usr.sbin/sicontrol/sicontrol.8 @@ -60,7 +60,8 @@ specified with a device name from .It Cm mstate Show the current incoming modem control signals. .It Cm ccbstat -Show the current "ccb" structure for the specified port. This is not of +Show the current "ccb" structure for the specified port. +This is not of much use outside of debugging the driver and determining why a port is wedged. .It Cm ttystat diff --git a/usr.sbin/sliplogin/sliplogin.8 b/usr.sbin/sliplogin/sliplogin.8 index b7ee94f..c927477 100644 --- a/usr.sbin/sliplogin/sliplogin.8 +++ b/usr.sbin/sliplogin/sliplogin.8 @@ -160,18 +160,21 @@ and .Ar slunit . .Bl -tag -width keepalive .It Ar keepalive -Set SLIP "keep alive" timeout in seconds. If FRAME_END is not received in +Set SLIP "keep alive" timeout in seconds. +If FRAME_END is not received in this amount of time, .Nm closes the line and exits. The default value is no timeout (zero). .It Ar outfill -Set SLIP "out fill" timeout in seconds. It forces at least one FRAME_END +Set SLIP "out fill" timeout in seconds. +It forces at least one FRAME_END to be sent during this time period, which is necessary for the "keep alive" timeout on the remote side. The default value is no timeout (zero). .It Ar slunit -Set the SLIP unit number directly. Use with caution, because no check is made +Set the SLIP unit number directly. +Use with caution, because no check is made for two interfaces with same number. By default sliplogin dynamically assigns the unit number. .El diff --git a/usr.sbin/slstat/slstat.8 b/usr.sbin/slstat/slstat.8 index eb37f48..92ba8a1 100644 --- a/usr.sbin/slstat/slstat.8 +++ b/usr.sbin/slstat/slstat.8 @@ -68,7 +68,8 @@ Is number specifying the .Tn SLIP interface, or a .Tn SLIP -interface name. The default unit is +interface name. +The default unit is .Sy 0 for interface .Sy sl0 . diff --git a/usr.sbin/syslogd/syslog.conf.5 b/usr.sbin/syslogd/syslog.conf.5 index 4be715a..4e493d2 100644 --- a/usr.sbin/syslogd/syslog.conf.5 +++ b/usr.sbin/syslogd/syslog.conf.5 @@ -71,7 +71,8 @@ This functionality was added for the ease of configuration (e.g. it is possible to cut-and-paste into .Pa syslog.conf ), -and to avoid possible mistakes. This change however preserves +and to avoid possible mistakes. +This change however preserves backwards compatibility with the old style of the .Pa syslog.conf (i.e. tab characters only). @@ -135,7 +136,8 @@ values specified to the .Xr syslog 3 library routine. .Pp -Each block of lines is separated from the previous block by a tag. The tag +Each block of lines is separated from the previous block by a tag. +The tag is a line beginning with .Em #!prog or @@ -144,7 +146,8 @@ or .Pa syslog.conf files, for example) and each block will be associated with calls to syslog from that specific -program. A tag for ``foo'' will also match any message logged by the kernel +program. +A tag for ``foo'' will also match any message logged by the kernel with the prefix ``foo: ''. .Pp See @@ -153,11 +156,13 @@ for a further descriptions of both the .Em facility and .Em level -keywords and their significance. It's preferred that selections be made on +keywords and their significance. +It's preferred that selections be made on .Em facility rather than .Em program , -since the latter can easily vary in a networked environment. In some cases, +since the latter can easily vary in a networked environment. +In some cases, though, an appropriate .Em facility simply doesn't exist. diff --git a/usr.sbin/syslogd/syslogd.8 b/usr.sbin/syslogd/syslogd.8 index 52b7f4c..78de545 100644 --- a/usr.sbin/syslogd/syslogd.8 +++ b/usr.sbin/syslogd/syslogd.8 @@ -239,6 +239,7 @@ list. .Pp The log socket was moved from .Pa /dev -to ease the use of a read-only root filesystem. This may confuse +to ease the use of a read-only root filesystem. +This may confuse some old binaries so that a symbolic link might be used for a transitional period. diff --git a/usr.sbin/usbd/usbd.8 b/usr.sbin/usbd/usbd.8 index c3e3238..814929c 100644 --- a/usr.sbin/usbd/usbd.8 +++ b/usr.sbin/usbd/usbd.8 @@ -51,30 +51,37 @@ .Op Fl v .Sh DESCRIPTION .Nm -handles the USB device attachment and detachment. It does two things. +handles the USB device attachment and detachment. +It does two things. Through opening the .Pa /dev/usb0 , .Pa /dev/usb1 , etc. devices, it enables the kernel to do handle change requests from -attached hubs. This functionality will be removed when the kernel has -kernel threads. The (multiple) +attached hubs. +This functionality will be removed when the kernel has +kernel threads. +The (multiple) .Fl f Ar device command line options specify which controllers it should handle. Normally this option is not needed. .Pp The second part is the handling of the attachment and detachment of USB -devices. The device +devices. +The device .Pa /dev/usb -is opened and events are read from it. Whenever a device is attached or +is opened and events are read from it. +Whenever a device is attached or detached the list of actions read from .Pa /etc/usbd.conf -are searched for a matching entry. If found, the corresponding action is +are searched for a matching entry. +If found, the corresponding action is executed. .Pp The command line options are as follows: .Bl -tag -width Ds .It Fl c Ar filename -Name of configuration file. The default is +Name of configuration file. +The default is .Pa /etc/usbd.conf. .It Fl d Enable debugging to the standard output, @@ -90,7 +97,8 @@ through .Pa /dev/usb3 . Do not specify the device .Pa /dev/usb -here. It is used for events only. +here. +It is used for events only. .It Fl n Do not handle the event queue on /dev/usb. .It Fl t Ar timeout @@ -98,7 +106,8 @@ Set the timeout interval (in seconds) before an exploration happens without being triggered by a connect or disconnect. A timeout of 0 means that there is no timeout. The default is 30. .It Fl v -Be verbose. Repeating the flag makes +Be verbose. +Repeating the flag makes .Nm usbd more verbose. .El @@ -124,7 +133,8 @@ driver was written by .An Lennart Augustsson Aq augustss@carlstedt.se for the .Nx -project. The event queue handling in +project. +The event queue handling in .Nm usbd was added by .An Nick Hibma Aq n_hibma@freebsd.org . diff --git a/usr.sbin/usbd/usbd.conf.5 b/usr.sbin/usbd/usbd.conf.5 index 07a77b9..5757265 100644 --- a/usr.sbin/usbd/usbd.conf.5 +++ b/usr.sbin/usbd/usbd.conf.5 @@ -41,22 +41,29 @@ The .Nm file is the configuration file for the .Xr usbd 8 -daemon. It provides information to allow execution of userland commands +daemon. +It provides information to allow execution of userland commands on events reported by the .Xr usb 4 -subsystem in the kernel. Currently the only events are device attach and +subsystem in the kernel. +Currently the only events are device attach and detach, but could in the future be extended to include power management functions. .Pp -The configuration file consists of a sorted list of entries. Each entry -describes a set of criteria commands. When an event occurs, the criteria +The configuration file consists of a sorted list of entries. +Each entry +describes a set of criteria commands. +When an event occurs, the criteria are checked and if met, the commands for that event are executed through -a shell. The list is sorted and scanned from top to bottom. The first +a shell. The list is sorted and scanned from top to bottom. +The first matching entry is used for an event. .Pp -Each entry contains a number of fields. There are 3 types of fields: +Each entry contains a number of fields. +There are 3 types of fields: descriptive fields, selection criteria and commands to execute on -events. The field name is case sensitive and should be all lower case. +events. +The field name is case sensitive and should be all lower case. Each field can have one or more arguments. .Pp The following fields are available: @@ -79,7 +86,8 @@ Device Subclass Device Protocol .It devname Ar string Device name, for example umass2, or ums0. These device names can contain -regular expressions. See +regular expressions. +See .Xr regex 3 and .Xr re_format 7 . @@ -87,10 +95,13 @@ The device name that is matched can be used in the commands below through adding ${DEVNAME} somewhere in that string. .El .Pp -String arguments may be quoted. If a string argument contains a space or -tab character it needs to be enclosed in single or double quotes. If an +String arguments may be quoted. +If a string argument contains a space or +tab character it needs to be enclosed in single or double quotes. +If an argument contains a single or double quote, that quote needs to be -enclosed in double or single quotes respectively. See below for +enclosed in double or single quotes respectively. +See below for examples. .Pp Numeric arguments can either be specified in decimal (42), octal (052) or diff --git a/usr.sbin/vidcontrol/vidcontrol.1 b/usr.sbin/vidcontrol/vidcontrol.1 index 66c61dd..511f8e1 100644 --- a/usr.sbin/vidcontrol/vidcontrol.1 +++ b/usr.sbin/vidcontrol/vidcontrol.1 @@ -50,7 +50,8 @@ saver timeout. The following command line options are supported: .Bl -tag -width indent .It Ar mode -Select a new video mode. The modes currently recognized are: +Select a new video mode. +The modes currently recognized are: .Ar 80x25 , .Ar 80x30 , .Ar 80x43 , @@ -82,7 +83,8 @@ See .Sx Video Mode Support below. .It Ar foreground Op Ar background -Change colors when displaying text. Specify the foreground color +Change colors when displaying text. +Specify the foreground color (e.g. .Dq vidcontrol white ) , or both a foreground and background colors @@ -103,7 +105,8 @@ Set border color to .Ar color . This option may not be always supported by the video driver. .It Fl c Cm normal | blink | destructive -Change the cursor appearance. The cursor is either an inverting block +Change the cursor appearance. +The cursor is either an inverting block .Pq Cm normal that eventually can .Cm blink . diff --git a/usr.sbin/vipw/vipw.8 b/usr.sbin/vipw/vipw.8 index 03bb4c0..fe09a9f 100644 --- a/usr.sbin/vipw/vipw.8 +++ b/usr.sbin/vipw/vipw.8 @@ -48,7 +48,8 @@ and does any necessary processing after the password file is unlocked. If the password file is already locked for editing by another user, .Nm will ask you -to try again later. The default editor for +to try again later. +The default editor for .Nm is .Xr vi 1 . diff --git a/usr.sbin/wicontrol/wicontrol.8 b/usr.sbin/wicontrol/wicontrol.8 index b186a90..4ac9673 100644 --- a/usr.sbin/wicontrol/wicontrol.8 +++ b/usr.sbin/wicontrol/wicontrol.8 @@ -84,11 +84,14 @@ The command controls the operation of WaveLAN/IEEE wireless networking devices via the .Xr wi 4 -driver. Most of the parameters that can be changed relate to the -IEEE 802.11 protocol which the WaveLAN implements. This includes +driver. +Most of the parameters that can be changed relate to the +IEEE 802.11 protocol which the WaveLAN implements. +This includes the station name, whether the station is operating in ad-hoc (point to point) or BSS (service set) mode, and the network name of a service -set to join (IBSS) if BSS mode is enabled. The +set to join (IBSS) if BSS mode is enabled. +The .Nm command can also be used to view the current settings of these parameters and to dump out the values of the card's statistics counters. @@ -111,11 +114,14 @@ flag will cause .Nm to print out the statistics counters instead of the card settings. .It Fl i Ar iface Fl t Ar tx rate -Set the transmit rate of the specified interface. The legal values +Set the transmit rate of the specified interface. +The legal values for the transmit rate vary depending on whether the interface is a -standard WaveLAN/IEEE or a WaveLAN/IEEE Turbo adapter. The standard +standard WaveLAN/IEEE or a WaveLAN/IEEE Turbo adapter. +The standard NICs support a maximum transmit rate of 2Mbps while the turbo NICs -support a maximum speed of 6Mbps. The following table shows the +support a maximum speed of 6Mbps. +The following table shows the legal transmit rate settings and the corresponding transmit speeds: .Bd -filled -offset indent .Bl -column "TX rate " "NIC speed " @@ -135,11 +141,14 @@ all the above listed speed settings. The default driver setting is 3 (auto rate select). .It Fl i Ar iface Fl n Ar network name Set the name of the service set (IBSS) that this station wishes to -join. The +join. +The .Ar network name -can be any text string up to 30 characters in length. The default name +can be any text string up to 30 characters in length. +The default name is the string "ANY" which should allow the station to connect to the first -available access point. The interface should be set for BSS mode using +available access point. +The interface should be set for BSS mode using the .Fl p flag in order for this to work. @@ -150,9 +159,11 @@ in another driver which indicates that the "ANY" string works as well. .It Fl i Ar iface Fl s Ar station name Sets the .Ar station name -for the specified interface. The +for the specified interface. +The .Ar station name -is used for diagnostic purposes. The Lucent WaveMANAGER software can +is used for diagnostic purposes. +The Lucent WaveMANAGER software can poll the names of remote hosts. .It Fl i Ar iface Fl c Ar 0|1 Allow the station to create a service set (IBSS). Permitted values @@ -172,21 +183,26 @@ the creation of an IBSS on a host system doesn't appear to actually work. .It Fl i Ar iface Fl p Ar port type Set the .Ar port type -for a specified interface. The legal values for +for a specified interface. +The legal values for .Ar port type -are 1 (BSS mode) and 3 (ad-hoc) mode. In ad-hoc mode, the station can +are 1 (BSS mode) and 3 (ad-hoc) mode. +In ad-hoc mode, the station can communicate directly with any other stations within direct radio range (provided that they are also operating in ad-hoc mode). In BSS mode, hosts must associate with a service set controlled by an access point, -which relays traffic between end stations. The default setting is 3 +which relays traffic between end stations. +The default setting is 3 (ad-hoc mode). .It Fl i Ar iface Fl a Ar access_point_density Specify the .Ar access point density -for a given interface. Legal values are 1 (low), 2 (medium) and 3 (high). +for a given interface. +Legal values are 1 (low), 2 (medium) and 3 (high). This setting influences some of the radio modem threshold settings. .It Fl i Ar iface Fl m Ar mac address -Set the station address for the specified interface. The +Set the station address for the specified interface. +The .Ar mac address is specified as a series of six hexadecimal values separated by colons, e.g.: 00:60:1d:12:34:56. This programs the new address into the card @@ -197,19 +213,24 @@ The .Ar max data length can be any number from 350 to 2304. The default is 2304. .It Fl i Ar iface Fl e Ar 0|1 -Enable or disable WEP encryption. Permitted values are +Enable or disable WEP encryption. +Permitted values are .Ar 0 (encryption disabled) or .Ar 1 (encryption enabled). Encryption is off by default. .It Fl i Ar iface Fl k Ar key "[-v 1|2|3|4]" -Set WEP encryption keys. There are four default encryption keys -that can be programmed. A specific key can be set using +Set WEP encryption keys. +There are four default encryption keys +that can be programmed. +A specific key can be set using the .Fl v -flag. If the +flag. +If the .Fl v -flag is not specified, the first key will be set. Encryption keys +flag is not specified, the first key will be set. +Encryption keys can either be normal text (i.e. "hello") or a series of hexadecimal digits (i.e. "0x1234512345"). For WaveLAN Turbo Silver cards, the key is restricted to 40 bits, hence @@ -225,17 +246,23 @@ supposed to allow 128 bits of key info for the gold cards. Specify which of the four WEP encryption keys will be used to encrypt transmitted packets. .It Fl i Ar iface Fl r Ar RTS threshold -Set the RTS/CTS threshold for a given interface. This controls the -number of bytes used for the RTS/CTS handshake boundary. The +Set the RTS/CTS threshold for a given interface. +This controls the +number of bytes used for the RTS/CTS handshake boundary. +The .Ar RTS threshold can be any value between 0 and 2047. The default is 2347. .It Fl i Ar iface Fl f Ar frequency -Set the radio frequency of a given interface. The +Set the radio frequency of a given interface. +The .Ar frequency -should be specified as a channel ID as shown in the table below. The +should be specified as a channel ID as shown in the table below. +The list of available frequencies is dependent on radio regulations specified -by regional authorities. Recognized regulatory authorities include -the FCC (United States), ETSI (Europe), France and Japan. Frequencies +by regional authorities. +Recognized regulatory authorities include +the FCC (United States), ETSI (Europe), France and Japan. +Frequencies in the table are specified in Mhz. .Bd -filled -offset indent .Bl -column "Channel ID " "FCC " "ETSI " "France " "Japan " @@ -258,27 +285,34 @@ in the table are specified in Mhz. .Ed .Pp If an illegal channel is specified, the -NIC will revert to its default channel. For NICs sold in the United States +NIC will revert to its default channel. +For NICs sold in the United States and Europe, the default channel is 3. For NICs sold in France, the default channel is 11. For NICs sold in Japan, the only available channel is 14. Note that two stations must be set to the same channel in order to communicate. .It Fl i Ar iface Fl P Ar 0|1 -Enable or disable power management on a given interface. Enabling +Enable or disable power management on a given interface. +Enabling power management uses an alternating sleep/wake protocol to help conserve power on mobile stations, at the cost of some increased -receive latency. Power management is off by default. Note that power +receive latency. Power management is off by default. +Note that power management requires the cooperation of an access point in order to -function; it is not functional in ad-hoc mode. Also, power management +function; it is not functional in ad-hoc mode. +Also, power management is only implemented in Lucent WavePOINT firmware version 2.03 or -later, and in WaveLAN PCMCIA adapter firmware 2.00 or later. Older -revisions will silently ignore the power management setting. Legal +later, and in WaveLAN PCMCIA adapter firmware 2.00 or later. +Older +revisions will silently ignore the power management setting. +Legal values for this parameter are 0 (off) and 1 (on). .It Fl i Ar iface Fl S Ar max_sleep_interval Specify the sleep interval to use when power management is enabled. The .Are max sleep interval -is specified in milliseconds. The default is 100. +is specified in milliseconds. +The default is 100. .It Fl i Ar iface Fl Z Clear the signal strength cache maintained internally by the .Nm wi @@ -286,8 +320,10 @@ driver. .It Fl i Ar iface Fl C Display the cached signal strength information maintained by the .Nm wi -driver. The driver retains information about signal strength and -noise level for packets received from different hosts. The signal +driver. +The driver retains information about signal strength and +noise level for packets received from different hosts. +The signal strength and noise level values are displayed in units of dBms. The signal quality values is produced by subtracting the noise level from the signal strength (i.e. less noise and better signal yields diff --git a/usr.sbin/yp_mkdb/yp_mkdb.8 b/usr.sbin/yp_mkdb/yp_mkdb.8 index fc08d32..599aceb 100644 --- a/usr.sbin/yp_mkdb/yp_mkdb.8 +++ b/usr.sbin/yp_mkdb/yp_mkdb.8 @@ -68,7 +68,8 @@ format (using the hash table method). The input should be in 'key data' format, which is to say two fields of .Tn ASCII -data separated by white space. The first field +data separated by white space. +The first field is assumed to be the key, and everything else is assumed to be the data. These databases are typically stored in @@ -81,7 +82,8 @@ is usually invoked by .Pa /var/yp/Makefile . .Nm Yp_mkdb can also be used to dump an NIS database file so that its -contents can be examined. For security reasons, all databases that +contents can be examined. +For security reasons, all databases that .Nm creates are readable and writable by owner only (and usually the owner is root). @@ -93,9 +95,12 @@ Cause .Nm to send a YPPROC_CLEAR request to .Xr ypserv 8 -on the local host. This signal tells the server to close any open -database descriptors and flush out its database cache. If used alone, -this flag signals the server and does nothing else. If used as part +on the local host. +This signal tells the server to close any open +database descriptors and flush out its database cache. +If used alone, +this flag signals the server and does nothing else. +If used as part of a database creation command, .Nm will send the signal only after the new database has been successfully @@ -105,39 +110,47 @@ Cause .Nm to add a special entry to the database with a key of .Em YP_INTERDOMAIN -and an empty data field. If this key is present in a map, it alters the +and an empty data field. +If this key is present in a map, it alters the behavior of the 'match' procedure in .Xr ypserv 8 -slightly. If a match query fails (because the server couldn't find +slightly. +If a match query fails (because the server couldn't find a record that matched the supplied key), and the .Em YP_INTERDOMAIN key exists within the queried map, .Xr ypserv 8 -will try to match the entry again using a DNS lookup. Note that this +will try to match the entry again using a DNS lookup. +Note that this special behavior only applies to the .Em hosts -maps. Using the +maps. +Using the .Fl b flag for other maps has no effect. .It Fl s This flag is used to add a special entry to the database with a key of .Em YP_SECURE -and an empty data field. If this key is present in a map, +and an empty data field. +If this key is present in a map, .Xr ypserv 8 will deny access to the map to any client that is not using a -reserved port for its query. This is used mainly for the +reserved port for its query. +This is used mainly for the .Em master.passwd maps, which should be restricted to privileged access only. .It Fl f This flag is used to turn on filtering of lines in the source file -input that start with ``+'' or ``-'' characters. These characters +input that start with ``+'' or ``-'' characters. +These characters have special meaning for the .Pa group , .Pa passwd and .Pa master.passwd maps and hence should not be allowed to appear in them as the first -character of a key or datum. If the +character of a key or datum. +If the .Fl f flag is used, .Nm @@ -145,7 +158,8 @@ will reject any source line that starts with a ``+'' or ``-'' character and issue a warning message displaying the line that was dropped. .It Fl u Ar dbname -Dump (or 'unwind') an NIS database. This option can be used to +Dump (or 'unwind') an NIS database. +This option can be used to inspect the contents of an existing NIS database. .It Fl i Ar inputfile When generating an NIS map, encode @@ -168,7 +182,8 @@ When generating an NIS map, encode as a special entry in the database with a key of .Em YP_MASTER_NAME . This entry in the database is frequently used by various NIS utilities -to determine the name of an NIS master server for a domain. By default, +to determine the name of an NIS master server for a domain. +By default, .Nm assumes that the local host is the NIS master; the .Fl m diff --git a/usr.sbin/ypbind/ypbind.8 b/usr.sbin/ypbind/ypbind.8 index bead672..2e56371 100644 --- a/usr.sbin/ypbind/ypbind.8 +++ b/usr.sbin/ypbind/ypbind.8 @@ -46,7 +46,8 @@ .Op Fl S Ar domainname,server1,server2,... .Sh DESCRIPTION .Nm Ypbind -is the process that maintains NIS binding information. At startup, +is the process that maintains NIS binding information. +At startup, it searches for an NIS server responsible for serving the system's default domain (as set by the .Xr domainname 1 @@ -56,14 +57,16 @@ it will store the address of the server and other information in a special file located in .Pa /var/yp/binding . The NIS routines in the standard C library can then use this file -when processing NIS requests. There may be several such files +when processing NIS requests. +There may be several such files since it is possible for an NIS client to be bound to more than one domain. .Pp After a binding has been established, .Nm will send DOMAIN_NONACK requests to the NIS server at one minute -intervals. If it fails to receive a reply to one of these requests, +intervals. +If it fails to receive a reply to one of these requests, .Nm assumes that the server is no longer running and resumes its network broadcasts until another binding is established. @@ -80,14 +83,17 @@ It is possible to force .Nm to bind to a particular NIS server host for a given domain by using the .Xr ypset 8 -command. However, +command. +However, .Nm refuses YPBINDPROC_SETDOM requests by default since it has no way of -knowing exactly who is sending them. Using the +knowing exactly who is sending them. +Using the .Fl ypset flag causes .Nm -to accept YPBINDPROC_SETDOM requests from any host. This option should only +to accept YPBINDPROC_SETDOM requests from any host. +This option should only be used for diagnostic purposes and only for limited periods since allowing arbitrary users to reset the binding of an NIS client poses a severe security risk. @@ -106,9 +112,11 @@ TCP ports). Allow the system administrator to lock .Nm to a particular -domain and group of NIS servers. Up to ten servers can be specified. +domain and group of NIS servers. +Up to ten servers can be specified. There must not be any spaces between the commas in the domain/server -specification. This option is used to insure that the system binds +specification. +This option is used to insure that the system binds only to one domain and only to one of the specified servers, which is useful for systems that are both NIS servers and NIS clients: it provides a way to restrict what machines the system can @@ -116,10 +124,12 @@ bind to without the need for specifying the .Fl ypset or .Fl ypsetme -options, which are often considered to be security holes. The specified +options, which are often considered to be security holes. +The specified servers must have valid entries in the local .Pa /etc/hosts -file. IP addresses may be specified in place of hostnames. If +file. IP addresses may be specified in place of hostnames. +If .Nm can't make sense ouf of the arguments, it will ignore the @@ -135,13 +145,15 @@ flag to be the system default domain. Cause .Nm to use a 'many-cast' rather than a broadcast for choosing a server -from the restricted mode server list. In many-cast mode, +from the restricted mode server list. +In many-cast mode, .Nm will transmit directly to the YPPROC_DOMAIN_NONACK procedure of the servers specified in the restricted list and bind to the server that responds the fastest. This mode of operation is useful for NIS clients on remote subnets -where no local NIS servers are available. The +where no local NIS servers are available. +The .Fl m flag can only be used in conjunction with the .Fl S @@ -155,10 +167,12 @@ The program will not make continuous attempts to keep secondary domains bound. If a server for a secondary domain fails to respond to a ping, .Nm -will broadcast for a new server only once before giving up. If a +will broadcast for a new server only once before giving up. +If a client program attempts to reference the unbound domain, .Nm -will try broadcasting again. By contrast, +will try broadcasting again. +By contrast, .Nm will automatically maintain a binding for the default domain whether client programs reference it ot not. diff --git a/usr.sbin/yppush/yppush.8 b/usr.sbin/yppush/yppush.8 index 7ec99ea..595a74d 100644 --- a/usr.sbin/yppush/yppush.8 +++ b/usr.sbin/yppush/yppush.8 @@ -51,9 +51,11 @@ distributes updated NIS databases (or .Pa maps ) from an NIS master server to NIS slave servers within an NIS -domain. It is normally only run on the NIS master by +domain. +It is normally only run on the NIS master by .Pa /var/yp/Makefile -whenever any of the NIS maps are updated. Note that +whenever any of the NIS maps are updated. +Note that .Pa /var/yp/Makefile does not invoke .Nm @@ -82,7 +84,8 @@ and some special information required by .Xr ypxfr 8 to successfully 'callback' to .Nm -and carry out the transfer. Any error messages +and carry out the transfer. +Any error messages .Nm receives from .Xr ypxfr 8 @@ -91,11 +94,14 @@ via callback will be printed to stderr. The following options are available: .Bl -tag -width indent .It Fl d Ar domain -Specify a particular domain. The NIS domain of -the local host system is used by default. If the local host's domain +Specify a particular domain. +The NIS domain of +the local host system is used by default. +If the local host's domain name is not set, the domain name must be specified with this flag. .It Fl t Ar timeout -Specify a timeout value in seconds. This timeout +Specify a timeout value in seconds. +This timeout controls how long .Nm will wait for a response from a slave server before sending a @@ -104,14 +110,17 @@ map transfer request to the next slave server in its list. .Nm Yppush normally performs transfers serially, meaning that it will send a map transfer request to one slave server and then wait for -it to respond before moving on to the next slave server. In environments +it to respond before moving on to the next slave server. +In environments with many slaves, it is more efficient to initiate several map transfers -at once so that the transfers can take place in parallel. The +at once so that the transfers can take place in parallel. +The .Fl j flag is used to specify the desired number of parallel jobs: .Nm will initiate the specified number of transfers immediately and -listen for responses. If the number of specified parallel jobs is +listen for responses. +If the number of specified parallel jobs is less than the number of slave servers, .Nm will initiate only the number of specified jobs and then wait @@ -145,7 +154,8 @@ the system administrator decides to store the NIS maps somewhere else. .It Fl v Verbose mode: causes .Nm -to print debugging messages as it runs. Specifying this flag twice +to print debugging messages as it runs. +Specifying this flag twice makes .Nm even more verbose. diff --git a/usr.sbin/ypserv/ypinit.8 b/usr.sbin/ypserv/ypinit.8 index 8e560d5..dc4565ce 100644 --- a/usr.sbin/ypserv/ypinit.8 +++ b/usr.sbin/ypserv/ypinit.8 @@ -61,10 +61,12 @@ directory, the .Pa /var/yp/ypservers file, and calls .Pa /var/yp/Makefile -to create and populate an initial set of NIS maps. The maps are +to create and populate an initial set of NIS maps. +The maps are created from local source files using the .Xr yp_mkdb 8 -command. The script will prompt the user for a list of servers +command. +The script will prompt the user for a list of servers that support the specified domain; this list is used to populate the ypservers map. .Pp @@ -72,10 +74,12 @@ On a slave server, .Nm creates the .Pa /var/yp/$DOMAINNAME , -populates it with copies of the NIS maps from the master. The maps +populates it with copies of the NIS maps from the master. +The maps are obtained from the master using the .Xr ypxfr 8 -command. The +command. +The .Nm script obtains the list of maps to transfer in one of two ways: if the system is configured as an NIS client and is bound to the master @@ -87,8 +91,10 @@ command to obtain a list of maps exported by the master server. If the system is not configured as a client of the NIS master, .Nm uses a hardcoded list of maps, some of which may or may not actually -exist on the master. The system administrator can edit the script and -modify the map list if necessary. Otherwise, indivudual maps can +exist on the master. +The system administrator can edit the script and +modify the map list if necessary. +Otherwise, indivudual maps can be transfered manually from the master using .Xr ypxfr 8 . .Sh OPTIONS @@ -96,8 +102,10 @@ be transfered manually from the master using supports the following options: .Bl -tag -width indent .It Fl m Op Ar domainname -Set up a master server. By default, the script sets up a server for -the system default domain. The user can override this default by specifying +Set up a master server. +By default, the script sets up a server for +the system default domain. +The user can override this default by specifying .Ar domainname explicitly. Maps are constructed from scratch using local files as templates using @@ -107,16 +115,19 @@ command. .It Fl s Ar master_server Op Ar domainname Set up a slave server using .Ar master_name -as the master. Maps are copied from +as the master. +Maps are copied from .Ar master_server to the slave using .Xr ypxfr 8 . By default, the script sets up a server for -the system default domain. The user can override this default by specifying +the system default domain. +The user can override this default by specifying .Ar domainname explicitly. .It Fl u Op Ar domainname -Update the ypservers map on the master server. When a new slave +Update the ypservers map on the master server. +When a new slave server is added to a domain, its hostname must be added to the ypservers map so that .Xr yppush 8 diff --git a/usr.sbin/ypserv/ypserv.8 b/usr.sbin/ypserv/ypserv.8 index e6a06bd..08d82f8 100644 --- a/usr.sbin/ypserv/ypserv.8 +++ b/usr.sbin/ypserv/ypserv.8 @@ -44,7 +44,8 @@ .Sh DESCRIPTION .Tn NIS is an RPC-based service designed to allow a number of UNIX-based -machines to share a common set of configuration files. Rather than +machines to share a common set of configuration files. +Rather than requiring a system administrator to update several copies of files such as .Pa /etc/hosts , @@ -70,7 +71,8 @@ one of the domains served by .Nm using the .Xr domainname 1 -command. The clients must also run +command. +The clients must also run .Xr ypbind 8 in order to attach to a particular server, since it is possible to have several servers within a single @@ -83,7 +85,8 @@ are stored in .Pa /var/yp/[domainname] where .Pa domainname -is the name of the domain being served. There can be several +is the name of the domain being served. +There can be several such directories with different domainnames, and you need only one .Nm daemon to handle them all. @@ -93,13 +96,15 @@ The databases, or as they are often called, are created by .Pa /var/yp/Makefile -using several system files as source. The database files are in +using several system files as source. +The database files are in .Xr db 3 format to help speed retrieval when there are many records involved. In .Fx , the maps are always readable and writable only by root for security -reasons. Technically this is only necessary for the password +reasons. +Technically this is only necessary for the password maps, but since the data in the other maps can be found in other world-readable files anyway, it doesn't hurt and it's considered good general practice. @@ -120,7 +125,8 @@ database via normally only stores encrypted passwords in .Pa /etc/master.passwd , -which is readable and writable only by root. By turning this file +which is readable and writable only by root. +By turning this file into an .Tn NIS map, this security feature would be completely defeated. @@ -133,7 +139,8 @@ handles the .Pa master.passwd.byname and .Pa master.basswd.byuid -maps in a special way. When the server receives a request to access +maps in a special way. +When the server receives a request to access either of these two maps, it will check the TCP port from which the request originated and return an error if the port number is greater than 1023. Since only the superuser is allowed to bind to TCP ports @@ -155,12 +162,14 @@ the standard .Pa passwd.byname and .Pa passwd.byuid -maps will be accessed instead. The latter two maps are constructed by +maps will be accessed instead. +The latter two maps are constructed by .Pa /var/yp/Makefile by parsing the .Pa master.passwd file and stripping out the password fields, and are therefore -safe to pass on to unprivileged users. In this way, the shadow password +safe to pass on to unprivileged users. +In this way, the shadow password aspect of the protected .Pa master.passwd database is maintained through @@ -213,7 +222,8 @@ In general, any remote user can issue an RPC to and retrieve the contents of your .Tn NIS maps, provided the remote user -knows your domain name. To prevent such unauthorized transactions, +knows your domain name. +To prevent such unauthorized transactions, .Nm supports a feature called .Pa securenets @@ -231,7 +241,8 @@ that consist of a network specification and a network mask separated by white space. Lines starting with .Dq \&# -are considered to be comments. A +are considered to be comments. +A sample securenets file might look like this: .Bd -unfilled -offset indent # allow connections from local host -- mandatory @@ -247,9 +258,11 @@ sample securenets file might look like this: If .Nm receives a request from an address that matches one of these rules, -it will process the request normally. If the address fails to match +it will process the request normally. +If the address fails to match a rule, the request will be ignored and a warning message will be -logged. If the +logged. +If the .Pa /var/yp/securenets file does not exist, .Nm @@ -270,7 +283,8 @@ and .Pa tcpd.h , you can easily recompile .Nm -with them. This allows the administrator to use the tcpwrapper +with them. +This allows the administrator to use the tcpwrapper configuration files ( .Pa /etc/hosts.allow and @@ -297,7 +311,8 @@ implementation only uses the .Tn NIS v2 protocol, however other implementations include support for the v1 protocol for backwards compatibility -with older systems. The +with older systems. +The .Xr ypbind 8 daemons supplied with these systems will try to establish a binding to an @@ -311,14 +326,16 @@ does not handle v1 map transfer requests; consequently, it can not be used as a master or slave in conjunction with older .Tn NIS servers that -only support the v1 protocol. Fortunately, there probably aren't any +only support the v1 protocol. +Fortunately, there probably aren't any such servers still in use today. .Ss NIS servers that are also NIS clients Care must be taken when running .Nm in a multi-server domain where the server machines are also .Tn NIS -clients. It is generally a good idea to force the servers to +clients. +It is generally a good idea to force the servers to bind to themselves rather than allowing them to broadcast bind requests and possibly become bound to each other: strange failure modes can result if one server goes down and @@ -342,16 +359,19 @@ handles yp_match requests for the .Pa hosts.byname and .Pa hosts.byaddress -maps. By default, if +maps. +By default, if .Nm can't find an entry for a given host in its hosts maps, it will -return an error and perform no further processing. With the +return an error and perform no further processing. +With the .Fl n flag, .Nm will go one step further: rather than giving up immediately, it will try to resolve the hostname or address using a DNS nameserver -query. If the query is successful, +query. +If the query is successful, .Nm will construct a fake database record and return it to the client, thereby making it seem as though the client's yp_match request @@ -371,14 +391,17 @@ option when serving only .Tn NIS clients. .It Fl d -Cause the server to run in debugging mode. Normally, +Cause the server to run in debugging mode. +Normally, .Nm reports only unusual errors (access violations, file access failures) using the .Xr syslog 3 -facility. In debug mode, the server does not background +facility. +In debug mode, the server does not background itself and prints extra status messages to stderr for each -request that it receives. Also, while running in debug mode, +request that it receives. +Also, while running in debug mode, .Nm will not spawn any additional subprocesses as it normally does when handling yp_all requests or doing DNS lookups. (These actions |
