diff options
Diffstat (limited to 'usr.sbin')
107 files changed, 1317 insertions, 681 deletions
diff --git a/usr.sbin/IPXrouted/IPXrouted.8 b/usr.sbin/IPXrouted/IPXrouted.8 index f9548fd..6c3bd54 100644 --- a/usr.sbin/IPXrouted/IPXrouted.8 +++ b/usr.sbin/IPXrouted/IPXrouted.8 @@ -163,7 +163,7 @@ conditions is satisfied: No routing table entry exists for the destination network or host, and the metric indicates the destination is .Dq reachable -(i.e. the hop count is not infinite). +(i.e., the hop count is not infinite). .It The source host of the packet is the same as the router in the existing routing table entry. diff --git a/usr.sbin/ac/ac.8 b/usr.sbin/ac/ac.8 index 4be5659..969e612 100644 --- a/usr.sbin/ac/ac.8 +++ b/usr.sbin/ac/ac.8 @@ -73,7 +73,8 @@ Display the connect times in 24 hour chunks. .It Fl p Print individual users' totals. .It Fl t Ar tty -Only do accounting logins on certain ttys. The +Only do accounting logins on certain ttys. +The .Ar tty specification can start with '!' to indicate not this .Ar tty @@ -105,7 +106,8 @@ by which rename and rotate the .Pa wtmp files, keeping a week's worth of data on -hand. No login or connect time accounting is performed if +hand. +No login or connect time accounting is performed if .Pa /var/log/wtmp does not exist. .Pp diff --git a/usr.sbin/apm/apm.8 b/usr.sbin/apm/apm.8 index 6067bee..255f9b6 100644 --- a/usr.sbin/apm/apm.8 +++ b/usr.sbin/apm/apm.8 @@ -47,7 +47,8 @@ If multiple display options are given, the values are displayed one per line in the order given here. .Bl -tag -width indent .It Fl a -Display the current AC-line status as an integer value. The values +Display the current AC-line status as an integer value. +The values 0 and 1 correspond to the .Dq off-line state or @@ -89,28 +90,35 @@ See .Xr apm 4 for details. .It Fl l -Display the remaining battery percentage. If your laptop does not +Display the remaining battery percentage. +If your laptop does not support this function, 255 is displayed. .It Fl r Ar delta -Enable the resume wakeup timer, if the laptop supports it. This +Enable the resume wakeup timer, if the laptop supports it. +This doesn't actually suspend the laptop, but if the laptop is suspended, and it supports resume from suspend, then it will be resumed after .Ar delta seconds (from when you run this command, not from when you suspend). .It Fl s -Display the status of the APM support as an integer value. The values +Display the status of the APM support as an integer value. +The values 0 and 1 correspond to the .Dq disabled state or .Dq enabled state respectively. .It Fl t -Display the estimated remaining battery lifetime in seconds. If +Display the estimated remaining battery lifetime in seconds. +If it is unknown, -1 is displayed. .It Fl Z -Transition the system into standby mode. This mode uses less power than -full power mode, but more than suspend mode. Some laptops support -resuming from this state on timer or Ring Indicator events. The +Transition the system into standby mode. +This mode uses less power than +full power mode, but more than suspend mode. +Some laptops support +resuming from this state on timer or Ring Indicator events. +The output of .Nm tells what your laptop claims to support. @@ -127,7 +135,8 @@ On such systems, displays them as unknown. .Pp Some APM implementations cannot handle events such as pushing the -power button or closing the cover. On such implementations, the system +power button or closing the cover. +On such implementations, the system .Ar must be suspended .Ar only diff --git a/usr.sbin/apmd/apmd.8 b/usr.sbin/apmd/apmd.8 index ae491d8..099eec6 100644 --- a/usr.sbin/apmd/apmd.8 +++ b/usr.sbin/apmd/apmd.8 @@ -47,10 +47,12 @@ utility monitors the occurrence of the specified Advanced Power Management .Pq Tn APM events and, if one of the events occurs, it executes the sequence of -commands corresponding to the event. Only the events specified in the +commands corresponding to the event. +Only the events specified in the configuration file are notified to .Nm ; -all other events are ignored. For each event posted by the APM BIOS, +all other events are ignored. +For each event posted by the APM BIOS, .Nm invokes the sequence of commands specified in the configuration file. When @@ -66,7 +68,8 @@ The utility recognizes the following runtime options: .Bl -tag -width -f_file .It Fl d -Starts in debug mode. This causes +Starts in debug mode. +This causes .Nm to execute in the foreground instead of in daemon mode. .It Fl f Ar file @@ -114,7 +117,8 @@ When .Nm receives an APM event, it forks a child process to execute the commands specified in the configuration file and then continues -listening for more events. The child process executes the commands +listening for more events. +The child process executes the commands specified, one at a time and in the order that they are listed. .Pp While @@ -135,7 +139,8 @@ This can be used to kill or reconfigure .Sh CONFIGURATION FILE The structure of the .Nm -configuration file is quite simple. For example: +configuration file is quite simple. +For example: .Pp .Bd -literal apm_event SUSPENDREQ { @@ -167,7 +172,8 @@ each events. APM events .Bd -ragged -offset indent If you wish to execute the same commands for different events, the -event names should be delimited by a comma. The following are +event names should be delimited by a comma. +The following are valid event names: .Bl -item .It @@ -241,7 +247,8 @@ The following built-in functions are currently supported: .It - reject: .Bd -ragged -offset indent -Reject last request posted by APM BIOS. This can be used to reject +Reject last request posted by APM BIOS. +This can be used to reject a SUSPEND request when the LCD is closed and put the system in a STANDBY state instead. .Ed diff --git a/usr.sbin/arp/arp.4 b/usr.sbin/arp/arp.4 index 4100b3b..e08e7d1 100644 --- a/usr.sbin/arp/arp.4 +++ b/usr.sbin/arp/arp.4 @@ -98,7 +98,7 @@ In the past, ARP was used to negotiate the use of a trailer encapsulation. This is no longer supported. .Pp -ARP watches passively for hosts impersonating the local host (i.e. a host +ARP watches passively for hosts impersonating the local host (i.e., a host which responds to an ARP mapping request for the local host's address). .Pp Proxy ARP is a feature whereby the local host will respond to requests diff --git a/usr.sbin/arp/arp.8 b/usr.sbin/arp/arp.8 index 7067338..855371b 100644 --- a/usr.sbin/arp/arp.8 +++ b/usr.sbin/arp/arp.8 @@ -161,7 +161,8 @@ Cause the file .Ar filename to be read and multiple entries to be set in the .Tn ARP -tables. Entries +tables. +Entries in the file should be of the form .Pp .Bd -ragged -offset indent -compact diff --git a/usr.sbin/atm/scspd/scspd.8 b/usr.sbin/atm/scspd/scspd.8 index d369f61..7d535fb 100644 --- a/usr.sbin/atm/scspd/scspd.8 +++ b/usr.sbin/atm/scspd/scspd.8 @@ -192,7 +192,7 @@ Some statements contain blocks, delimited by braces and .Dq Li } ) . Configuration statement keywords are not case-sensitive, -but some parameters (e.g. interface names) are. +but some parameters (e.g.\& interface names) are. Configuration statements can span multiple lines. .Ss Comments Three types of comments are allowed: @@ -332,7 +332,7 @@ statement must always be specified. The .Ic familyID statement specifies an identifier for a family -of parallel SCSP sessions running between a group of hosts (i.e. a +of parallel SCSP sessions running between a group of hosts (i.e., a set of SCSP sessions with different protocol IDs but the same set of servers). The diff --git a/usr.sbin/boot98cfg/boot98cfg.8 b/usr.sbin/boot98cfg/boot98cfg.8 index 6d24b19..5a27443 100644 --- a/usr.sbin/boot98cfg/boot98cfg.8 +++ b/usr.sbin/boot98cfg/boot98cfg.8 @@ -53,7 +53,8 @@ consists of the and .Sq HDD boot menu . The IPL occupies sector 0 of a disk and is followed by the partition -table. The IPL loads the HDD boot menu that starts from 0x400. +table. +The IPL loads the HDD boot menu that starts from 0x400. .Pp The .Nm @@ -67,12 +68,15 @@ than that in the format command. The options are: .Bl -tag -width indent .It Fl B -Install the IPL and HDD boot menu. This option causes the IPL and HDD +Install the IPL and HDD boot menu. +This option causes the IPL and HDD boot menu code to be replaced. .It Fl i Ar boot0 -Specify which IPL image to use. The default is /boot/boot0. +Specify which IPL image to use. +The default is /boot/boot0. .It Fl m Ar boot0.5 -Specify which HDD boot menu image to use. The default is +Specify which HDD boot menu image to use. +The default is /boot/boot0.5. .It Fl f Ar boot0.bak Specify that a backup copy of the preexisting IPL should be written to @@ -86,7 +90,8 @@ This file is created if it does not exist, and truncated if it does. .It Fl v Ar version Specify the version number. .It Fl s Ar secsize -Specify the sector size. The default sector size is 512 +Specify the sector size. +The default sector size is 512 (bytes/sector). .El .Sh SEE ALSO diff --git a/usr.sbin/btxld/btxld.8 b/usr.sbin/btxld/btxld.8 index 95dff0c..eee0355 100644 --- a/usr.sbin/btxld/btxld.8 +++ b/usr.sbin/btxld/btxld.8 @@ -72,7 +72,8 @@ or .It Fl l Ar file Specify the BTX loader to be bound with the client. .It Fl o Ar filename -Name the output file. The default is +Name the output file. +The default is .Dq a.out . .It Fl P Ar page Specify the first page of the client's segment to be marked diff --git a/usr.sbin/ckdist/ckdist.1 b/usr.sbin/ckdist/ckdist.1 index 5dc37b0..f784a07 100644 --- a/usr.sbin/ckdist/ckdist.1 +++ b/usr.sbin/ckdist/ckdist.1 @@ -48,10 +48,12 @@ formats are supported. .Pp The .Ar file -operands may refer to regular files or to directories. Regular files +operands may refer to regular files or to directories. +Regular files named "md5", or which have an ".md5" or an ".inf" extension, are assumed to be of the implied type, otherwise format is determined from -content. If a directory is specified, it is searched for +content. +If a directory is specified, it is searched for appropriately-named files only. .Pp Options are as follows: diff --git a/usr.sbin/cron/cron/cron.8 b/usr.sbin/cron/cron/cron.8 index 8ad0622..31b579f 100644 --- a/usr.sbin/cron/cron/cron.8 +++ b/usr.sbin/cron/cron/cron.8 @@ -57,7 +57,8 @@ The .Nm utility then wakes up every minute, examining all stored crontabs, checking each -command to see if it should be run in the current minute. When executing +command to see if it should be run in the current minute. +When executing commands, any output is mailed to the owner of the crontab (or to the user named in the .Ev MAILTO @@ -71,9 +72,11 @@ the modification time on has changed, and if it has, .Nm will then examine the modification time on all crontabs and reload those -which have changed. Thus +which have changed. +Thus .Nm -need not be restarted whenever a crontab file is modified. Note that the +need not be restarted whenever a crontab file is modified. +Note that the .Xr crontab 1 command updates the modification time of the spool directory whenever it changes a crontab. diff --git a/usr.sbin/cron/crontab/crontab.5 b/usr.sbin/cron/crontab/crontab.5 index d1eaa4a..0d9f9e7 100644 --- a/usr.sbin/cron/crontab/crontab.5 +++ b/usr.sbin/cron/crontab/crontab.5 @@ -30,19 +30,23 @@ file contains instructions to the .Xr cron 8 daemon of the general form: ``run this command at this time on this date''. Each user has their own crontab, and commands in any given crontab will be -executed as the user who owns the crontab. Uucp and News will usually have +executed as the user who owns the crontab. +Uucp and News will usually have their own crontabs, eliminating the need for explicitly running .Xr su 1 as part of a cron command. .Pp -Blank lines and leading spaces and tabs are ignored. Lines whose first +Blank lines and leading spaces and tabs are ignored. +Lines whose first non-space character is a pound-sign (#) are comments, and are ignored. Note that comments are not allowed on the same line as cron commands, since -they will be taken to be part of the command. Similarly, comments are not +they will be taken to be part of the command. +Similarly, comments are not allowed on the same line as environment variable settings. .Pp An active line in a crontab will be either an environment setting or a cron -command. An environment setting is of the form, +command. +An environment setting is of the form, .Bd -literal name = value .Ed @@ -102,7 +106,8 @@ and will look at .Ev MAILTO if it has any reason to send mail as a result of running -commands in ``this'' crontab. If +commands in ``this'' crontab. +If .Ev MAILTO is defined (and non-empty), mail is sent to the user so named. @@ -112,7 +117,9 @@ by seperating recipient users with a comma. If .Ev MAILTO is defined but empty (MAILTO=""), no -mail will be sent. Otherwise mail is sent to the owner of the crontab. This +mail will be sent. +Otherwise mail is sent to the owner of the crontab. +This option is useful if you decide on .Pa /bin/mail instead of @@ -124,11 +131,13 @@ doesn't do aliasing, and UUCP usually doesn't read its mail. .Pp The format of a cron command is very much the V7 standard, with a number of -upward-compatible extensions. Each line has five time and date fields, +upward-compatible extensions. +Each line has five time and date fields, followed by a user name (with optional ``:<group>'' and ``/<login-class>'' suffixes) if this is the system crontab file, -followed by a command. Commands are executed by +followed by a command. +Commands are executed by .Xr cron 8 when the minute, hour, and month of year fields match the current time, .Em and @@ -149,25 +158,35 @@ day of week 0-7 (0 or 7 is Sun, or use names) .Pp A field may be an asterisk (*), which always stands for ``first\-last''. .Pp -Ranges of numbers are allowed. Ranges are two numbers separated -with a hyphen. The specified range is inclusive. For example, +Ranges of numbers are allowed. +Ranges are two numbers separated +with a hyphen. +The specified range is inclusive. +For example, 8-11 for an ``hours'' entry specifies execution at hours 8, 9, 10 and 11. .Pp -Lists are allowed. A list is a set of numbers (or ranges) -separated by commas. Examples: ``1,2,5,9'', ``0-4,8-12''. +Lists are allowed. +A list is a set of numbers (or ranges) +separated by commas. +Examples: ``1,2,5,9'', ``0-4,8-12''. .Pp -Step values can be used in conjunction with ranges. Following +Step values can be used in conjunction with ranges. +Following a range with ``/<number>'' specifies skips of the number's value -through the range. For example, ``0-23/2'' can be used in the hours +through the range. +For example, ``0-23/2'' can be used in the hours field to specify command execution every other hour (the alternative -in the V7 standard is ``0,2,4,6,8,10,12,14,16,18,20,22''). Steps are +in the V7 standard is ``0,2,4,6,8,10,12,14,16,18,20,22''). +Steps are also permitted after an asterisk, so if you want to say ``every two hours'', just use ``*/2''. .Pp Names can also be used for the ``month'' and ``day of week'' -fields. Use the first three letters of the particular -day or month (case doesn't matter). Ranges or +fields. +Use the first three letters of the particular +day or month (case doesn't matter). +Ranges or lists of names are not allowed. .Pp The ``sixth'' field (the rest of the line) specifies the command to be @@ -185,10 +204,12 @@ after the first % will be sent to the command as standard input. .Pp Note: The day of a command's execution can be specified by two -fields \(em day of month, and day of week. If both fields are +fields \(em day of month, and day of week. +If both fields are restricted (ie, aren't *), the command will be run when .Em either -field matches the current time. For example, +field matches the current time. +For example, ``30 4 1,15 * 5'' would cause a command to be run at 4:30 am on the 1st and 15th of each month, plus every Friday. @@ -234,7 +255,8 @@ and .Tn ATT seem to disagree about this. .Pp -Lists and ranges are allowed to co-exist in the same field. "1-3,7-9" would +Lists and ranges are allowed to co-exist in the same field. +"1-3,7-9" would be rejected by .Tn ATT or @@ -245,7 +267,8 @@ Ranges can include "steps", so "1-9/2" is the same as "1,3,5,7,9". .Pp Names of months or days of the week can be specified by name. .Pp -Environment variables can be set in the crontab. In +Environment variables can be set in the crontab. +In .Bx or .Tn ATT , @@ -269,11 +292,13 @@ are extensions. .Sh BUGS If you're in one of the 70-odd countries that observe Daylight Savings Time, jobs scheduled during the rollback or advance will be -affected. In general, it's not a good idea to schedule jobs during +affected. +In general, it's not a good idea to schedule jobs during this period. .Pp For US timezones (except parts of IN, AZ, and HI) the time shift occurs at -2AM local time. For others, the output of the +2AM local time. +For others, the output of the .Xr zdump 8 program's verbose .Fl ( v ) diff --git a/usr.sbin/crunch/crunchide/crunchide.1 b/usr.sbin/crunch/crunchide/crunchide.1 index 24bd60a..ef9947d 100644 --- a/usr.sbin/crunch/crunchide/crunchide.1 +++ b/usr.sbin/crunch/crunchide/crunchide.1 @@ -46,14 +46,16 @@ Some symbols may be left visible via the .Fl k Ar keep-symbol and .Fl f Ar keep-list-file -options. The +options. +The .Ar keep-list-file must contain a list of symbols to keep visible, one symbol per line. The names given by .Ar keep-symbol or in .Ar keep-list-file -should be C names. For example, +should be C names. +For example, to keep the C function .Dq foo visible, the option @@ -70,12 +72,14 @@ multiple component programs. .Xr crunchgen 1 , .Xr ld 1 .Sh AUTHORS +.An -nosplit The .Nm crunch utility was written by .An James da Silva Aq jds@cs.umd.edu . .Pp -Copyright (c) 1994 University of Maryland. All Rights Reserved. +Copyright (c) 1994 University of Maryland. +All Rights Reserved. .Pp .An Chris Demetriou Aq cgd@netbsd.org reorganized @@ -83,4 +87,6 @@ reorganized so that it supported multiple object formats, and added ELF object support and ECOFF object recognition. .Pp -Copyright (c) 1997 Christopher G. Demetriou. All Rights Reserved. +Copyright (c) 1997 +.An Christopher G. Demetriou . +All Rights Reserved. diff --git a/usr.sbin/ctm/ctm/ctm.1 b/usr.sbin/ctm/ctm/ctm.1 index cdc75ab..f8ee9d7 100644 --- a/usr.sbin/ctm/ctm/ctm.1 +++ b/usr.sbin/ctm/ctm/ctm.1 @@ -42,21 +42,27 @@ The utility is now meant to be the definitive way to make and apply a delta between two versions of a directory tree. .Pp -There are two parts to this, making the delta and applying it. These are two +There are two parts to this, making the delta and applying it. +These are two entirely different things. .Ss Usage To apply a CTM delta, you pass it to the .Nm -command. You can pass a CTM delta on stdin, or you can give the -filename as an argument. If you do the latter, you make life a lot +command. +You can pass a CTM delta on stdin, or you can give the +filename as an argument. +If you do the latter, you make life a lot easier for your self, since the program can accept gzip'ed files and -since it will not have to make a temporary copy of your file. You can +since it will not have to make a temporary copy of your file. +You can specify multiple deltas at one time, they will be processed one at a -time. Deltas that are already applied will be ignored. +time. +Deltas that are already applied will be ignored. .Pp The .Nm -command runs in a number of passes. It will process the entire +command runs in a number of passes. +It will process the entire input file in each pass, before commencing with the next pass. .Pp Before working on a file @@ -68,13 +74,16 @@ If this file exists, .Nm works on it instead. .Pp -Pass 1 will verify that the input file is OK. The syntax, the data -and the global MD5 checksum will be checked. If any of these fail, +Pass 1 will verify that the input file is OK. +The syntax, the data +and the global MD5 checksum will be checked. +If any of these fail, .Nm will simply reject the input file. .Pp Pass 2 will validate that the directory tree is in the state expected by -the CTM delta. This is done by looking for files and directories which +the CTM delta. +This is done by looking for files and directories which should/should not exist and by checking the MD5 checksums of files. .Pp If a @@ -86,7 +95,8 @@ option, all files that would be modified by this invocation are backed up to this file using the archiver command specified by the .Fl t -option. The default archiver command is +option. +The default archiver command is .Nm "tar -rf %s -T -" . .Pp Pass 3 will actually apply the delta. @@ -103,7 +113,8 @@ The .Fl e and .Fl x -options are applied in order of appearance on the command line. The last +options are applied in order of appearance on the command line. +The last filter that matched a given file name determines whether the file would be operated on or left alone by .Nm . @@ -111,7 +122,8 @@ operated on or left alone by The .Nm utility -will extract the file hierarchy below its working directory. Absolute +will extract the file hierarchy below its working directory. +Absolute filenames or filenames containing references through .Sq Pa .\& and @@ -137,10 +149,13 @@ Check it out, don't do anything. .It Fl e Ar regular_expression Match each name in the CTM file against .Ar regular_expression , -and if it matches process the file, otherwise leave it alone. There may be -any number of these options. Use of this option disables the +and if it matches process the file, otherwise leave it alone. +There may be +any number of these options. +Use of this option disables the .Pa .ctm_status -sequence number checks. For example, the expression +sequence number checks. +For example, the expression .Ic ^usr.sbin/ctm for example, will select the .Pa usr.sbin/ctm @@ -153,16 +168,19 @@ option. Force. .It Fl k Keep files and directories and don't remove them even if the CTM file -specifies they are to be removed. If the +specifies they are to be removed. +If the .Fl B option is specified, these files and directories will not be backed up. .It Fl l List files that would be modified by this invocation of CTM and the -actions that would be performed on them. Use of the +actions that would be performed on them. +Use of the .Fl l option disables the .Pa .ctm_status -checks and integrity checks on the source tree being operated on. The +checks and integrity checks on the source tree being operated on. +The .Fl l option can be combined with the .Fl e @@ -179,7 +197,8 @@ instead of the default archiver .Nm tar . This option takes effect only if a backup file had been specified using the .Fl B -option. A %s in the tar command will be replaced by the name of the backup +option. +A %s in the tar command will be replaced by the name of the backup file. .It Fl T Ar tmpdir Put temporary files under @@ -196,8 +215,10 @@ is the level of verbosity. .It Fl x Ar regular_expression Match each name in the CTM file against .Ar regular_expression -and if it matches, leave the file alone. There may be any number of these -options. Use of this option disables the +and if it matches, leave the file alone. +There may be any number of these +options. +Use of this option disables the .Pa .ctm_status sequence number checks. .Pp @@ -247,7 +268,8 @@ The same effect may be achieved with the flag. .Sh FILES .Pa .ctm_status -contains the sequence number of the last CTM delta applied. Changing +contains the sequence number of the last CTM delta applied. +Changing or removing this file will greatly confuse .Nm . .Pp @@ -256,7 +278,8 @@ Using the and .Fl x options can update a partial subset of the source tree and causes sources -to be in an inconsistent state. It is assumed that you know what you are +to be in an inconsistent state. +It is assumed that you know what you are doing when you use these options. .Sh EXAMPLES .Bd -literal @@ -270,7 +293,8 @@ cd ~/lib-srcs /usr/sbin/ctm -e '^lib' ~ctm/src-cur* .Ed .Sh DIAGNOSTICS -Numerous messages, hopefully self-explanatory. The +Numerous messages, hopefully self-explanatory. +The .Dq noise level can be adjusted with the .Fl q , diff --git a/usr.sbin/ctm/ctm/ctm.5 b/usr.sbin/ctm/ctm/ctm.5 index 6165c2e..10b0304 100644 --- a/usr.sbin/ctm/ctm/ctm.5 +++ b/usr.sbin/ctm/ctm/ctm.5 @@ -23,7 +23,8 @@ The .Nm transfers data in a specific file format, called a CTM delta. .Pp -CTM deltas consist of control lines and data chunks. Each control +CTM deltas consist of control lines and data chunks. +Each control line starts with the letters .Dq CTM , followed by a CTM statement and control data, and ends with a '\en' @@ -38,7 +39,8 @@ newline is not part of the chunk and isn't included in the count. The CTM statements are as follows. .Bl -tag -width indent .It _BEGIN Ar version name number timestamp prefix -This is the overall begin of a CTM delta file. The +This is the overall begin of a CTM delta file. +The .Ar version field must match the program version (currently 2.0). diff --git a/usr.sbin/ctm/ctm_rmail/ctm_rmail.1 b/usr.sbin/ctm/ctm_rmail/ctm_rmail.1 index 3943fd2..ed32729 100644 --- a/usr.sbin/ctm/ctm_rmail/ctm_rmail.1 +++ b/usr.sbin/ctm/ctm_rmail/ctm_rmail.1 @@ -49,7 +49,8 @@ The .Nm ctm_smail utility is given a compressed .Xr ctm -delta, and a mailing list to send it to. It splits the delta into manageable +delta, and a mailing list to send it to. +It splits the delta into manageable pieces, encodes them as mail messages and sends them to the mailing list (optionally queued to spread the mail load). Each recipient uses @@ -59,7 +60,8 @@ optionally call .Xr ctm to apply it to the source tree. At the moment, -several source trees are distributed, and by several sites. These include +several source trees are distributed, and by several sites. +These include the .Fx Ns -current source and CVS trees, distributed by @@ -77,16 +79,22 @@ are time stamped and written to the file .It Fl m Ar maxmsgsize Limit the maximum size mail message that .Nm ctm_smail -is allowed to send. It is approximate since mail headers and other niceties -are not counted in this limit. If not specified, it will default to 64000 +is allowed to send. +It is approximate since mail headers and other niceties +are not counted in this limit. +If not specified, it will default to 64000 bytes, leaving room for 1535 bytes of headers before the rumoured 64k mail limit. .It Fl c Ar maxctmsize -Limit the maximum size delta that will be sent. Deltas bigger that this +Limit the maximum size delta that will be sent. +Deltas bigger that this limit will cause an apology mail message to be sent to the mailing list. -This is to prevent massive changes overwhelming users' mail boxes. Note that -this is the size before encoding. Encoding causes a 4/3 size increase before -mail headers are added. If not specified, there is no limit. +This is to prevent massive changes overwhelming users' mail boxes. +Note that +this is the size before encoding. +Encoding causes a 4/3 size increase before +mail headers are added. +If not specified, there is no limit. .It Fl q Ar queue-dir Instead of mailing the delta pieces now, store them in the given directory to be mailed later using @@ -115,7 +123,8 @@ are time stamped and written to the file .It Fl n Ar numchunks Limit the number of mail messages that .Nm ctm_dequeue -will send per run. By default, +will send per run. +By default, .Nm ctm_dequeue will send one mail message per run. .El @@ -125,7 +134,8 @@ is the directory containing the mail messages stored by .Nm ctm_smail . Up to .Ar numchunks -mail messages will be sent in each run. The recipient mailing list is already +mail messages will be sent in each run. +The recipient mailing list is already encoded in the queued files. .Pp It is safe to run @@ -135,7 +145,8 @@ while is adding entries to the queue, or even to run .Nm ctm_smail multiple times concurrently, but a separate queue directory should be used -for each tree being distributed. This is because entries are served in +for each tree being distributed. +This is because entries are served in alphabetical order, and one tree will be unfairly serviced before any others, based on the delta names, not delta creation times. .Pp @@ -149,8 +160,10 @@ error diagnostics and informational messages (other than command line errors) are time stamped and written to the file .Em log . .It Fl p Ar piecedir -Collect pieces of deltas in this directory. Each piece corresponds to a -single mail message. Pieces are removed when complete deltas are built. +Collect pieces of deltas in this directory. +Each piece corresponds to a +single mail message. +Pieces are removed when complete deltas are built. If this flag is not given, no input files will be read, but completed deltas may still be applied with .Xr ctm @@ -158,11 +171,14 @@ if the .Fl b flag is given. .It Fl d Ar deltadir -Collect completed deltas in this directory. Deltas are built from one or +Collect completed deltas in this directory. +Deltas are built from one or more pieces when all pieces are present. .It Fl b Ar basedir -Apply any completed deltas to this source tree. If this flag is not given, -deltas will be stored, but not applied. The user may then apply the deltas +Apply any completed deltas to this source tree. +If this flag is not given, +deltas will be stored, but not applied. +The user may then apply the deltas manually, or by using .Nm ctm_rmail without the @@ -217,7 +233,8 @@ Pass the flag to the .Xr ctm command when applying the complete deltas, causing a more informative -output. All +output. +All .Xr ctm output appears in the .Nm ctm_rmail @@ -226,7 +243,8 @@ log file. .Pp The file arguments (or .Em stdin , -if there are none) are scanned for delta pieces. Multiple delta pieces +if there are none) are scanned for delta pieces. +Multiple delta pieces can be read from a single file, so an entire maildrop can be scanned and processed with a single command. .Pp @@ -235,7 +253,8 @@ It is safe to invoke multiple times concurrently (with different input files), as might happen when .Xr sendmail -is delivering mail asynchronously. This is because locking is used to +is delivering mail asynchronously. +This is because locking is used to keep things orderly. .Sh FILE FORMAT Following are the important parts of an actual (very small) delta piece: @@ -255,7 +274,8 @@ CTM_MAIL END 61065 The subject of the message always begins with .Dq ctm-mail followed by the name of the delta, which piece this is, and how many total -pieces there are. The data are bracketed by +pieces there are. +The data are bracketed by .Dq CTM_MAIL BEGIN and .Dq CTM_MAIL END @@ -429,7 +449,8 @@ The .Nm ctm_rmail utility is expected to be called from a mail transfer program, and thus signals failure only when the input mail message should be bounced (preferably into -your regular maildrop, not back to the sender). In short, failure to +your regular maildrop, not back to the sender). +In short, failure to apply a completed delta with .Xr ctm is not considered an error important enough to bounce the mail, and @@ -471,14 +492,17 @@ will report: ctm_rmail: message contains no delta .Ed .Pp -and return an exit status of 1. You can use this to redirect wayward messages +and return an exit status of 1. +You can use this to redirect wayward messages back into your real mailbox if your mail filter goes wonky. .Pp These messages go to .Em stderr -or to the log file. Messages from +or to the log file. +Messages from .Xr ctm 1 -turn up here too. Error messages should be self explanatory. +turn up here too. +Error messages should be self explanatory. .Sh SEE ALSO .Xr ctm 1 , .Xr ctm 5 diff --git a/usr.sbin/edquota/edquota.8 b/usr.sbin/edquota/edquota.8 index 5ec92e5..8687601 100644 --- a/usr.sbin/edquota/edquota.8 +++ b/usr.sbin/edquota/edquota.8 @@ -126,10 +126,11 @@ specified for each user specified. This is the normal mechanism used to initialize quotas for groups of users. If the user given to assign quotas to is a numerical uid -range (e.g. 1000-2000), then +range (e.g.\& 1000-2000), then .Nm will duplicate the quotas of the prototypical user -for each uid in the range specified. This allows +for each uid in the range specified. +This allows for easy setup of default quotas for a group of users. The uids in question do not have to be currently assigned in .Pa /etc/passwd . diff --git a/usr.sbin/fdcontrol/fdcontrol.8 b/usr.sbin/fdcontrol/fdcontrol.8 index 813956a..286cb8b 100644 --- a/usr.sbin/fdcontrol/fdcontrol.8 +++ b/usr.sbin/fdcontrol/fdcontrol.8 @@ -229,7 +229,7 @@ The sector interleave to be applied when formatting. 0 means no interleave, 1 means 1:1 etc. .It Ar offs2 -The offset of the sector numbers on side 2 (i.e. head number 1). +The offset of the sector numbers on side 2 (i.e., head number 1). Normally, sector numbering on both sides starts with 1. .It Ar flags A list from one of the following flag values: @@ -243,7 +243,7 @@ Use FM (single-density) encoding. Use 2 steps per each cylinder (for accessing 40-cylinder media in 80-cylinder drives). .It Cm -2step -Do not use 2 steps per cylinder, i.e. access each physical cylinder +Do not use 2 steps per cylinder, i.e., access each physical cylinder of the drive. .It Cm +perpend Use perpendicular recording (for 2.88 MB media, currently not diff --git a/usr.sbin/fdread/fdread.1 b/usr.sbin/fdread/fdread.1 index 438a268..090a91d 100644 --- a/usr.sbin/fdread/fdread.1 +++ b/usr.sbin/fdread/fdread.1 @@ -45,7 +45,8 @@ .Sh DESCRIPTION The .Nm -utility reads floppy disks. Effective read blocking based on the track +utility reads floppy disks. +Effective read blocking based on the track size is performed, and floppy-specific error recovery of otherwise bad blocks can be enabled. .Pp @@ -53,7 +54,8 @@ The .Nm utility will always read an entire floppy medium, and write its contents to -the respective output file. Unlike other tools like +the respective output file. +Unlike other tools like .Xr dd 1 , .Nm automatically uses a read block size that is more efficient than @@ -70,18 +72,22 @@ The utility accepts the following options: .Bl -tag -width indent .It Fl q -Turn on quiet mode. By default, the medium parameters of the device +Turn on quiet mode. +By default, the medium parameters of the device are being written to standard error output, progress will be indicated by the approximate number of kilobytes read so far, and errors will be printed out in detail, including the information about the location of -recovered data in the output. In quiet mode, none of these messages +recovered data in the output. +In quiet mode, none of these messages will be generated. .It Fl r -Enable error recovery. By default, +Enable error recovery. +By default, .Nm stops after the first unrecovered read error, much like .Xr dd 1 -does. In recovery mode, however, one of two recovery actions will be +does. +In recovery mode, however, one of two recovery actions will be taken: .Bl -bullet .It @@ -109,7 +115,8 @@ The parameter must be a valid floppy disk device. .It Fl f Ar fillbyte Value of the fill byte used for dummy blocks in the output file in -recovery mode. Defaults to +recovery mode. +Defaults to .Ql 0xf0 . (Mnemonic: .Dq foo . ) @@ -174,13 +181,16 @@ and as well as the location of the error (physical cylinder, head, and sector number, plus the .Dq sector shift value , -respectively). See the manual for the NE765 or compatible for details +respectively). +See the manual for the NE765 or compatible for details about the status register contents. .Pp The FDC's status is then examined to determine whether the error is -deemed to be recoverable. If error recovery was requested, the +deemed to be recoverable. +If error recovery was requested, the location of the bad block in the output file is indicated by its -(hexadecimal) bounds. Also, a summary line indicating the total number +(hexadecimal) bounds. +Also, a summary line indicating the total number of transfer errors will be printed before exiting. .Sh SEE ALSO .Xr dd 1 , @@ -206,7 +216,8 @@ Program and man page by Concurrent traffic on the second floppy drive located at the same FDC will make error recovery attempts pointless, since the FDC status obtained after a read error occurred cannot be guaranteed to actually -belong to the erroneous transfer. Thus using option +belong to the erroneous transfer. +Thus using option .Fl r is only reliable if .Ar device diff --git a/usr.sbin/fdwrite/fdwrite.1 b/usr.sbin/fdwrite/fdwrite.1 index 93de399..cb80dd6 100644 --- a/usr.sbin/fdwrite/fdwrite.1 +++ b/usr.sbin/fdwrite/fdwrite.1 @@ -58,9 +58,11 @@ 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. +Input file to read. +If none is given, stdin is assumed. .It Fl d Ar device -The name of the floppy device to write to. Default is +The name of the floppy device to write to. +Default is .Pa /dev/fd0 . .El .Pp diff --git a/usr.sbin/i4b/dtmfdecode/dtmfdecode.1 b/usr.sbin/i4b/dtmfdecode/dtmfdecode.1 index c1e296c..53f673a 100644 --- a/usr.sbin/i4b/dtmfdecode/dtmfdecode.1 +++ b/usr.sbin/i4b/dtmfdecode/dtmfdecode.1 @@ -48,7 +48,8 @@ It reads audio G.711 A-Law coded data from stdin and outputs the detected numbers values as ASCII characters to stdout. .Pp The detector is implemented as 8 narrow band-pass filters realized with -an integer double-cross recursive algorithm. Various ad-hoc methods are +an integer double-cross recursive algorithm. +Various ad-hoc methods are employed to provide hysteresis and anti-bounce for the detected signals. .Sh EXAMPLES The command: diff --git a/usr.sbin/i4b/g711conv/g711conv.1 b/usr.sbin/i4b/g711conv/g711conv.1 index ca3845b..c0f3023 100644 --- a/usr.sbin/i4b/g711conv/g711conv.1 +++ b/usr.sbin/i4b/g711conv/g711conv.1 @@ -46,7 +46,8 @@ The .Nm utility is part of the isdn4bsd package and is used to convert between the A-Law and -u-law formats as specified in ITU G.711. It is based on a freely available +u-law formats as specified in ITU G.711. +It is based on a freely available and freely usable reference implementation done by Sun Microsystems, Inc. .Pp The following options are available: @@ -66,7 +67,7 @@ doing the actual conversion. .Sh STANDARDS A-Law and u-Law conversions are specified in ITU Recommendation G.711. .Pp -The reference implementation done by Sun Microsystems, Inc. is available +The reference implementation done by Sun Microsystems, Inc.\& is available from http://www.itu.int/itudoc/itu-t/rec/g/g700-799/refimpl.txt .Sh EXAMPLES The command: @@ -89,4 +90,4 @@ The utility and this manpage were written by .An Hellmuth Michaelis Aq hm@kts.org based on the G.711 conversion reference code written by Sun Microsystems, -Inc. and code contributed to isdn4bsd by Stefan Bethke. +Inc.\& and code contributed to isdn4bsd by Stefan Bethke. diff --git a/usr.sbin/i4b/isdnd/isdnd.acct.5 b/usr.sbin/i4b/isdnd/isdnd.acct.5 index fdb30d3..b2db667 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 7ada783..b4542e0 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 @@ -69,9 +70,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 8fde2fd..1c4fd63 100644 --- a/usr.sbin/i4b/isdnd/isdnd.rc.5 +++ b/usr.sbin/i4b/isdnd/isdnd.rc.5 @@ -457,7 +457,7 @@ which is prepended to the string specified as a parameter to this keyword. The programs specified by connect and disconnect will get the following command line arguments: -d (device) -f (flag) [ -a (addr) ] where .Em device -is the name of device, e.g. "isp0", +is the name of device, e.g.\& "isp0", .Em flag will be "up" if connection just got up, or "down" if interface changed to down state and diff --git a/usr.sbin/i4b/isdndebug/isdndebug.8 b/usr.sbin/i4b/isdndebug/isdndebug.8 index 6a49367..0a9f24c 100644 --- a/usr.sbin/i4b/isdndebug/isdndebug.8 +++ b/usr.sbin/i4b/isdndebug/isdndebug.8 @@ -71,7 +71,8 @@ Set debugging mask for the selected layer(s) to display errors only. .It Fl g Get the debugging mask for the selected layer(s). .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). @@ -81,7 +82,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 36c5b6f..3027e2d 100644 --- a/usr.sbin/i4b/isdndecode/isdndecode.8 +++ b/usr.sbin/i4b/isdndecode/isdndecode.8 @@ -74,9 +74,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). @@ -126,7 +128,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 5e6d5c3..1fb1b70 100644 --- a/usr.sbin/i4b/isdnmonitor/isdnmonitor.8 +++ b/usr.sbin/i4b/isdnmonitor/isdnmonitor.8 @@ -53,17 +53,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 @@ -73,7 +76,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 7e1ed50..10a171e 100644 --- a/usr.sbin/i4b/isdntel/isdntel.8 +++ b/usr.sbin/i4b/isdntel/isdntel.8 @@ -51,11 +51,14 @@ 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 @@ -72,9 +75,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 .Dq Li cat %s \&| alaw2ulaw >/dev/audio . .It Fl t The value for @@ -83,7 +88,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 i4btel 4 , .Xr isdnd.rc 5 , diff --git a/usr.sbin/i4b/isdntelctl/isdntelctl.8 b/usr.sbin/i4b/isdntelctl/isdntelctl.8 index 2078825..b73c4be 100644 --- a/usr.sbin/i4b/isdntelctl/isdntelctl.8 +++ b/usr.sbin/i4b/isdntelctl/isdntelctl.8 @@ -56,7 +56,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/isdntest/isdntest.8 b/usr.sbin/i4b/isdntest/isdntest.8 index 639a9ac..e55d2e3 100644 --- a/usr.sbin/i4b/isdntest/isdntest.8 +++ b/usr.sbin/i4b/isdntest/isdntest.8 @@ -94,7 +94,8 @@ installed is connected to an S0 bus and that one of the valid MSN's (MSN = Multi The .Xr isdnd 8 .Em must -not currently running on that machine! Executing: +not currently running on that machine! +Executing: .Bd -literal -offset indent isdntest -i 42 -o 42 .Ed diff --git a/usr.sbin/i4b/isdntrace/isdntrace.8 b/usr.sbin/i4b/isdntrace/isdntrace.8 index 5c3011b..92ae2e4 100644 --- a/usr.sbin/i4b/isdntrace/isdntrace.8 +++ b/usr.sbin/i4b/isdntrace/isdntrace.8 @@ -89,9 +89,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). @@ -110,7 +112,8 @@ print layer 1 (I.430) INFO signals to monitor layer 1 activity (default off). switch displaying of Layer 2 (Q.921) frames off (default on). .It Fl n This option takes a numeric argument specifying the minimum -frame size in octets a frame must have to be displayed. (default 0) +frame size in octets a frame must have to be displayed. +(default 0) .It Fl o switch off writing trace output to a file (default on). .It Fl p @@ -133,7 +136,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 @@ -156,7 +160,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 @@ -167,7 +172,8 @@ ISDN D-channel layer 2 protocol description. .It Ar Q.931 ISDN D-channel layer 3 protocol description. .It Ar 1TR6 -German-specific ISDN layer 3 protocol description. (NOTICE: decoding +German-specific ISDN layer 3 protocol description. +(NOTICE: decoding of the 1TR6 protocol is included but not supported since i dont have any longer access to a 1TR6 based ISDN installation.) .El @@ -176,7 +182,7 @@ The .Nm utility automatically detects the layer 3 protocol being used by looking at the -Protocol Discriminator (see: Q.931/1993 pp. 53). +Protocol Discriminator (see: Q.931/1993 pp.\& 53). .Sh FILES .Bl -tag -width daddeldi -compact .It Pa /dev/i4btrc<n> diff --git a/usr.sbin/i4b/man/itjc.4 b/usr.sbin/i4b/man/itjc.4 index 8469fe9..82544b3 100644 --- a/usr.sbin/i4b/man/itjc.4 +++ b/usr.sbin/i4b/man/itjc.4 @@ -41,7 +41,7 @@ driver provides D-channel layer 1 supports as specified in ITU Recommendation I.430 and layer 1 support for the B-channel. .Pp The driver supports passive PCI ISDN cards based on the combination of -the Siemens/Infineon ISAC chip and the Tiger Jet Network Inc. Tiger 300/320 +the Siemens/Infineon ISAC chip and the Tiger Jet Network Inc.\& Tiger 300/320 chip. .Pp Currently supported cards are the Traverse Technologies NETjet-S PCI ISDN diff --git a/usr.sbin/inetd/inetd.8 b/usr.sbin/inetd/inetd.8 index fd4f4a2..0d4a557 100644 --- a/usr.sbin/inetd/inetd.8 +++ b/usr.sbin/inetd/inetd.8 @@ -60,7 +60,8 @@ utility should be run at boot time by (see .Xr rc 8 ) . It then listens for connections on certain -internet sockets. When a connection is found on one +internet sockets. +When a connection is found on one of its sockets, it decides what service the socket corresponds to, and invokes a program to service the request. The server program is invoked with the service socket @@ -69,7 +70,8 @@ After the program is finished, .Nm continues to listen on the socket (except in some cases which -will be described below). Essentially, +will be described below). +Essentially, .Nm allows running one daemon to invoke several others, reducing load on the system. @@ -152,10 +154,13 @@ file which, by default, is .Pa /etc/inetd.conf . There must be an entry for each field of the configuration file, with entries for each field separated by a tab or -a space. Comments are denoted by a +a space. +Comments are denoted by a .Dq # at the beginning -of a line. There must be an entry for each field. The +of a line. +There must be an entry for each field. +The fields of the configuration file are as follows: .Pp .Bd -unfilled -offset indent -compact @@ -409,13 +414,15 @@ In addition, you can specify the maximum number of simultaneous invocations of each service from a single IP address by appending a .Dq / followed by the number to the maximum number of outstanding child -processes. Once the maximum is reached, further connections from this +processes. +Once the maximum is reached, further connections from this IP address will be dropped. .Pp The .Em user entry should contain the user name of the user as whom the server -should run. This allows for servers to be given less permission +should run. +This allows for servers to be given less permission than root. Optional .Em group @@ -437,7 +444,8 @@ The entry should contain the pathname of the program which is to be executed by .Nm -when a request is found on its socket. If +when a request is found on its socket. +If .Nm provides this service internally, this entry should be @@ -447,7 +455,8 @@ The .Em server program arguments should be just as arguments normally are, starting with argv[0], which is the name of -the program. If the service is provided internally, the +the program. +If the service is provided internally, the .Em service-name of the service (and any arguments to it) or the word .Dq internal @@ -544,7 +553,8 @@ The utility also provides several other .Dq trivial services internally by use of -routines within itself. These services are +routines within itself. +These services are .Dq echo , .Dq discard , .Dq chargen @@ -553,7 +563,8 @@ routines within itself. These services are (human readable time), and .Dq time (machine readable time, in the form of the number of seconds since -midnight, January 1, 1900). All of these services are available in +midnight, January 1, 1900). +All of these services are available in both TCP and UDP versions; the UDP versions will refuse service if the request specifies a reply port corresponding to any internal service. (This is done as a defense against looping attacks; the remote IP address @@ -659,12 +670,16 @@ services. .Ss TCPMUX .Tn RFC 1078 describes the TCPMUX protocol: -``A TCP client connects to a foreign host on TCP port 1. It sends the -service name followed by a carriage-return line-feed <CRLF>. The -service name is never case sensitive. The server replies with a +``A TCP client connects to a foreign host on TCP port 1. +It sends the +service name followed by a carriage-return line-feed <CRLF>. +The +service name is never case sensitive. +The server replies with a single character indicating positive (+) or negative (\-) acknowledgment, immediately followed by an optional message of -explanation, terminated with a <CRLF>. If the reply was positive, +explanation, terminated with a <CRLF>. +If the reply was positive, the selected protocol begins; otherwise the connection is closed.'' The program is passed the TCP connection as file descriptors 0 and 1. .Pp diff --git a/usr.sbin/jail/jail.8 b/usr.sbin/jail/jail.8 index 6e159a1..a3b20d5 100644 --- a/usr.sbin/jail/jail.8 +++ b/usr.sbin/jail/jail.8 @@ -423,9 +423,11 @@ is set, the source IP addresses are enforced to comply with the IP address bound to the jail, regardless of whether or not the .Dv IP_HDRINCL -flag has been set on the socket. Since raw sockets can be used to configure +flag has been set on the socket. +Since raw sockets can be used to configure and interact with various network subsystems, extra caution should be used -where privileged access to jails is given out to untrusted parties. As such, +where privileged access to jails is given out to untrusted parties. +As such, by default this option is disabled. .It Va security.jail.getfsstatroot_only This MIB entry determines whether or not processes within a jail are able diff --git a/usr.sbin/kbdcontrol/kbdcontrol.1 b/usr.sbin/kbdcontrol/kbdcontrol.1 index 8ef617f..533abd6 100644 --- a/usr.sbin/kbdcontrol/kbdcontrol.1 +++ b/usr.sbin/kbdcontrol/kbdcontrol.1 @@ -64,7 +64,7 @@ which sets sound parameters back to normal values, .Cm off which disables the bell entirely, or .Cm visual -which sets the bell to visual mode, i.e. flashes the screen instead. +which sets the bell to visual mode, i.e., flashes the screen instead. If .Ar belltype is preceded by the word diff --git a/usr.sbin/kgzip/kgzip.8 b/usr.sbin/kgzip/kgzip.8 index 653a2ad..3537502 100644 --- a/usr.sbin/kgzip/kgzip.8 +++ b/usr.sbin/kgzip/kgzip.8 @@ -40,7 +40,8 @@ .Sh DESCRIPTION The .Nm -utility compresses a kernel or some other bootable binary. Operation +utility compresses a kernel or some other bootable binary. +Operation is in two phases as follows: .Bl -enum .It @@ -49,7 +50,8 @@ the .Sq text and .Sq data -segments. This image is compressed using +segments. +This image is compressed using .Xr gzip 1 and output as data in relocatable object format. .It diff --git a/usr.sbin/lastlogin/lastlogin.8 b/usr.sbin/lastlogin/lastlogin.8 index ce401ed..03a587d 100644 --- a/usr.sbin/lastlogin/lastlogin.8 +++ b/usr.sbin/lastlogin/lastlogin.8 @@ -45,14 +45,16 @@ The .Nm utility will list the last login session of each specified .Ar user , -or for all users by default. Each line of output contains +or for all users by default. +Each line of output contains the user name, the tty from which the session was conducted, any hostname, and the start time for the session. .Pp If more than one .Ar user is given, the session information for each user is printed in -the order given on the command line. Otherwise, information +the order given on the command line. +Otherwise, information for all users is printed, sorted by uid. .Pp The diff --git a/usr.sbin/lpr/chkprintcap/chkprintcap.8 b/usr.sbin/lpr/chkprintcap/chkprintcap.8 index e026662..c2524a1 100644 --- a/usr.sbin/lpr/chkprintcap/chkprintcap.8 +++ b/usr.sbin/lpr/chkprintcap/chkprintcap.8 @@ -64,7 +64,8 @@ capability). The .Nm utility exits with a status equal to the number of errors encountered before -processing stopped. (In some cases, processing can stop before the +processing stopped. +(In some cases, processing can stop before the entire file is scanned.) .Pp If the @@ -89,8 +90,10 @@ The utility was written by .An Garrett A. Wollman Aq wollman@lcs.mit.edu . .Sh BUGS -Not enough sanity-checking is done. At a minimum, the ownership and -mode of the spool directories should also be checked. Other +Not enough sanity-checking is done. +At a minimum, the ownership and +mode of the spool directories should also be checked. +Other parameters whose value could cause .Xr lpd 8 to fail should be diagnosed. diff --git a/usr.sbin/lpr/lp/lp.1 b/usr.sbin/lpr/lp/lp.1 index 0269971..8ed842d 100644 --- a/usr.sbin/lpr/lp/lp.1 +++ b/usr.sbin/lpr/lp/lp.1 @@ -51,7 +51,8 @@ The .Nm utility is a front-end to the print spooler as required by the .St -p1003.2 -specification. It effectively invokes +specification. +It effectively invokes .Xr lpr 1 with the proper set of arguments. .Pp @@ -63,7 +64,8 @@ The following options are available: Make the .Nm 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 +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. @@ -112,6 +114,7 @@ command has been written by .Sh BUGS The .St -p1003.2 -specification does not provide any means to print non-text files. It +specification does not provide any means to print non-text files. +It rather requires the files to be printed to be text files limited to reasonable line lengths and printable characters. diff --git a/usr.sbin/lpr/lpd/lpd.8 b/usr.sbin/lpr/lpd/lpd.8 index 55c6c33..5d6e2cd 100644 --- a/usr.sbin/lpr/lpd/lpd.8 +++ b/usr.sbin/lpr/lpd/lpd.8 @@ -49,7 +49,8 @@ utility is the line printer daemon (spool area handler) and is normally invoked at boot time from the .Xr rc 8 -file. It makes a single pass through 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. @@ -59,7 +60,8 @@ and .Xr accept 2 to receive requests to print files in the queue, transfer files to the spooling area, display the queue, -or remove jobs from the queue. In each case, it forks a child to handle +or remove jobs from the queue. +In each case, it forks a child to handle the request so the parent can continue to listen for more requests. .Pp Available options: @@ -169,33 +171,41 @@ for files beginning with Lines in each .Em cf file specify files to be printed or non-printing actions to be -performed. Each such line begins with a key character +performed. +Each such line begins with a key character to specify what to do with the remainder of the line. .Bl -tag -width Ds .It J -Job Name. String to be used for the job name on the burst page. +Job Name. +String to be used for the job name on the burst page. .It C -Classification. String to be used for the classification line +Classification. +String to be used for the classification line on the burst page. .It L -Literal. The line contains identification info from +Literal. +The line contains identification info from the password file and causes the banner page to be printed. .It T -Title. String to be used as the title for +Title. +String to be used as the title for .Xr pr 1 . .It H -Host Name. Name of the machine where +Host Name. +Name of the machine where .Xr lpr 1 was invoked. .It P -Person. Login name of the person who invoked +Person. +Login name of the person who invoked .Xr lpr 1 . This is used to verify ownership by .Xr lprm 1 . .It M Send mail to the specified user when the current print job completes. .It f -Formatted File. Name of a file to print which is already formatted. +Formatted File. +Name of a file to print which is already formatted. .It l Like ``f'' but passes control characters and does not make page breaks. .It p @@ -203,19 +213,23 @@ Name of a file to print using .Xr pr 1 as a filter. .It t -Troff File. The file contains +Troff File. +The file contains .Xr troff 1 output (cat phototypesetter commands). .It n -Ditroff File. The file contains device independent troff +Ditroff File. +The file contains device independent troff output. .It r -DVI File. The file contains +DVI File. +The file contains .Tn Tex l output DVI format from Stanford. .It g -Graph File. The file contains data produced by +Graph File. +The file contains data produced by .Xr plot 3 . .It c Cifplot File. @@ -227,29 +241,37 @@ The file contains a raster image. The file contains text data with FORTRAN carriage control characters. .It \&1 -Troff Font R. Name of the font file to use instead of the default. +Troff Font R. +Name of the font file to use instead of the default. .It \&2 -Troff Font I. Name of the font file to use instead of the default. +Troff Font I. +Name of the font file to use instead of the default. .It \&3 -Troff Font B. Name of the font file to use instead of the default. +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. +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 .Xr pr 1 and the text filters. .It I -Indent. The number of characters to indent the output by (in ASCII). +Indent. +The number of characters to indent the output by (in ASCII). .It U -Unlink. Name of file to remove upon completion of printing. +Unlink. +Name of file to remove upon completion of printing. .It N -File name. The name of the file which is being printed, or a blank +File name. +The name of the file which is being printed, or a blank for the standard input (when .Xr lpr 1 is invoked in a pipeline). .It Z -Locale. String to be used as the locale for +Locale. +String to be used as the locale for .Xr pr 1 . .El .Pp @@ -269,14 +291,16 @@ The utility uses .Xr flock 2 to provide exclusive access to the lock file and to prevent multiple -daemons from becoming active simultaneously. If the daemon should be killed +daemons from becoming active simultaneously. +If the daemon should be killed or die unexpectedly, the lock file need not be removed. The lock file is kept in a readable .Tn ASCII form and contains two lines. The first is the process id of the daemon and the second is the control -file name of the current job being printed. The second line is updated to +file name of the current job being printed. +The second line is updated to reflect the current status of .Nm for the programs diff --git a/usr.sbin/lpr/lpq/lpq.1 b/usr.sbin/lpr/lpq/lpq.1 index 170e9e2..c297ab1 100644 --- a/usr.sbin/lpr/lpq/lpq.1 +++ b/usr.sbin/lpr/lpq/lpq.1 @@ -65,7 +65,8 @@ Specify a particular printer, otherwise the default line printer is used (or the value of the .Ev PRINTER variable in the -environment). All other arguments supplied are interpreted as user +environment). +All other arguments supplied are interpreted as user names or job numbers to filter out only those jobs of interest. .It Fl l Information about each of the files comprising the job entry @@ -76,7 +77,7 @@ Report on the local queues for all printers, rather than just the specified printer. .El .Pp -For each job submitted (i.e. invocation of +For each job submitted (i.e., invocation of .Xr lpr 1 ) .Nm reports the user's name, current rank in the queue, the @@ -97,7 +98,7 @@ is indicated as ``(standard input)''. .Pp If .Nm -warns that there is no daemon present (i.e. due to some malfunction), +warns that there is no daemon present (i.e., due to some malfunction), the .Xr lpc 8 command can be used to restart the printer daemon. @@ -136,5 +137,7 @@ may report unreliably. Output formatting is sensitive to the line length of the terminal; this can results in widely spaced columns. .Sh DIAGNOSTICS -Unable to open various files. The lock file being malformed. Garbage +Unable to open various files. +The lock file being malformed. +Garbage files when there is no daemon active, but files in the spooling directory. diff --git a/usr.sbin/lpr/lpr/lpr.1 b/usr.sbin/lpr/lpr/lpr.1 index 2418485..1b72b9c 100644 --- a/usr.sbin/lpr/lpr/lpr.1 +++ b/usr.sbin/lpr/lpr/lpr.1 @@ -57,7 +57,8 @@ The .Nm utility uses a spooling daemon to print the named files when facilities -become available. If no names appear, the standard input is assumed. +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. @@ -118,7 +119,8 @@ These options apply to the handling of the print job: .Bl -tag -width indent .It Fl P -Force output to a specific printer. Normally, +Force output to a specific printer. +Normally, the default printer is used (site dependent), or the value of the environment variable .Ev PRINTER @@ -133,13 +135,15 @@ printing (with the .Fl s option). .It Fl s -Use symbolic links. Usually files are copied to the spool directory. +Use symbolic links. +Usually files are copied to the spool directory. The .Fl s option will use .Xr symlink 2 to link data files rather than trying to copy them so large files can be -printed. This means the files should +printed. +This means the files should not be modified or removed until they have been printed. .El .Pp @@ -148,12 +152,13 @@ The remaining options apply to copies, the page display, and headers: .It Fl \&# Ns Ar num The quantity .Ar num -is the number of copies desired of each file named. For example, +is the number of copies desired of each file named. +For example, .Bd -literal -offset indent lpr \-#3 foo.c bar.c more.c .Ed would result in 3 copies of the file foo.c, followed by 3 copies -of the file bar.c, etc. On the other hand, +of the file bar.c, etc.\& On the other hand, .Bd -literal -offset indent cat foo.c bar.c more.c \&| lpr \-#3 .Ed @@ -177,7 +182,8 @@ file referencing the font pathname. .It Fl C Ar class Job classification -to use on the burst page. For example, +to use on the burst page. +For example, .Bd -literal -offset indent lpr \-C EECS foo.c .Ed diff --git a/usr.sbin/lpr/lpr/printcap.5 b/usr.sbin/lpr/lpr/printcap.5 index dd3750a..1ea6fea 100644 --- a/usr.sbin/lpr/lpr/printcap.5 +++ b/usr.sbin/lpr/lpr/printcap.5 @@ -47,11 +47,14 @@ function is a simplified version of the .Xr termcap 5 data base -used to describe line printers. The spooling system accesses the +used to describe line printers. +The spooling system accesses the .Nm file every time it is used, allowing dynamic -addition and deletion of printers. Each entry in the data base -is used to describe one printer. This data base may not be +addition and deletion of printers. +Each entry in the data base +is used to describe one printer. +This data base may not be substituted for, as is possible for .Xr termcap 5 , because it may allow accounting to be bypassed. @@ -60,7 +63,8 @@ The default printer is normally .Em lp , though the environment variable .Ev PRINTER -may be used to override this. Each spooling utility supports an option, +may be used to override this. +Each spooling utility supports an option, .Fl P Ar printer , to allow explicit naming of a destination printer. .Pp @@ -309,9 +313,12 @@ or .Cm of . If both are specified, .Cm of -is ignored. Both filters behave the same except that they are passed -different arguments as above. Specifically, the output filter is -terminated and restarted for each file transmitted. This is necessary +is ignored. +Both filters behave the same except that they are passed +different arguments as above. +Specifically, the output filter is +terminated and restarted for each file transmitted. +This is necessary in order to pass the resulting size to the remote .Xr lpd 8 . .Pp @@ -362,13 +369,16 @@ on the given .Sh TRANSFER STATISTICS When a print job is transfered to a remote machine (which might be another unix box, or may be a network printer), it may be useful -to keep statistics on each transfer. The +to keep statistics on each transfer. +The .Cm sr and .Cm ss options indicate filenames that lpd should use to store such -statistics. A statistics line is written for each datafile of a -job as the file is successfully transferred. The format of the +statistics. +A statistics line is written for each datafile of a +job as the file is successfully transferred. +The format of the line is the same for both the sending and receiving side of a transfer. .Pp @@ -381,7 +391,8 @@ print job as it arrived on the server. Statistics on datafiles being sent might be used as a minimal accounting record, when you want to know who sent which jobs to a remote printer, when they were sent, and how large (in bytes) the -files were. This will not give include any idea of how many pages +files were. +This will not give include any idea of how many pages were printed, because there is no standard way to get that information back from a remote (network) printer in this case. .Sh LOGGING diff --git a/usr.sbin/lpr/lprm/lprm.1 b/usr.sbin/lpr/lprm/lprm.1 index 04cfbe0..89d2a59 100644 --- a/usr.sbin/lpr/lprm/lprm.1 +++ b/usr.sbin/lpr/lprm/lprm.1 @@ -68,13 +68,15 @@ If a single is given, .Nm will remove all jobs which a user -owns. If the super-user employs this flag, the spool queue will +owns. +If the super-user employs this flag, the spool queue will be emptied entirely. .It Ar user Cause .Nm to attempt to remove any jobs queued belonging to that user -(or users). This form of invoking +(or users). +This form of invoking .Nm is useful only to the super-user. .It Ar job\ \&# @@ -106,7 +108,8 @@ there are no jobs in the queue which match the request list. The .Nm utility will kill off an active daemon, if necessary, before removing -any spooling files. If a daemon is killed, a new one is +any spooling files. +If a daemon is killed, a new one is automatically restarted upon completion of file removals. .Sh ENVIRONMENT If the following environment variable exists, it is utilized by diff --git a/usr.sbin/lpr/pac/pac.8 b/usr.sbin/lpr/pac/pac.8 index 2d7bfe7..1cd4824 100644 --- a/usr.sbin/lpr/pac/pac.8 +++ b/usr.sbin/lpr/pac/pac.8 @@ -67,7 +67,8 @@ is used. Cause the output to be sorted by cost; usually the output is sorted alphabetically by name. .It Fl m -Cause the host name to be ignored in the accounting file. This +Cause the host name to be ignored in the accounting file. +This allows for a user on multiple machines to have all of his printing charges grouped together. .It Fl p Ns Ar price diff --git a/usr.sbin/lptcontrol/lptcontrol.8 b/usr.sbin/lptcontrol/lptcontrol.8 index 65d848b..88471ae 100644 --- a/usr.sbin/lptcontrol/lptcontrol.8 +++ b/usr.sbin/lptcontrol/lptcontrol.8 @@ -45,7 +45,7 @@ Turn on polled mode. .It Fl e Turn on extended mode. .It Fl s -Turn on standard mode, i.e. turn off extended mode. +Turn on standard mode, i.e., turn off extended mode. .It Fl d Ar device Set the mode of the printer device specified by .Ar device . diff --git a/usr.sbin/mailwrapper/mailwrapper.8 b/usr.sbin/mailwrapper/mailwrapper.8 index b45c018..36b5d89 100644 --- a/usr.sbin/mailwrapper/mailwrapper.8 +++ b/usr.sbin/mailwrapper/mailwrapper.8 @@ -154,7 +154,7 @@ utility first appeared in and then .Fx 4.0 . .Sh AUTHORS -Perry E. Metzger <perry@piermont.com> +.An Perry E. Metzger Aq perry@piermont.com .Sh BUGS The entire reason this program exists is a crock. Instead, a command diff --git a/usr.sbin/mergemaster/mergemaster.8 b/usr.sbin/mergemaster/mergemaster.8 index 359ffe2..699120b 100644 --- a/usr.sbin/mergemaster/mergemaster.8 +++ b/usr.sbin/mergemaster/mergemaster.8 @@ -100,7 +100,8 @@ it is not recommended. The .Nm utility checks your umask and issues a warning for anything -other than 022. While it is not mandatory to grant +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 @@ -294,7 +295,9 @@ comparison, use: .Pp The .Nm -utility will . (source) these files if they exist. +utility will +.Ic .\& +(source) these files if they exist. Command line options will override rc file options. .Pa $HOME/.mergemasterrc @@ -387,7 +390,8 @@ The utility was first publicly available on one of my web pages in a much simpler form under the name .Pa comproot -on 13 March 1998. The idea for creating the +on 13 March 1998. +The idea for creating the temporary root environment comes from Nik Clayton's make world tutorial which is referenced above. .Sh AUTHORS diff --git a/usr.sbin/mixer/mixer.8 b/usr.sbin/mixer/mixer.8 index 6cf8648..b9aa2c9 100644 --- a/usr.sbin/mixer/mixer.8 +++ b/usr.sbin/mixer/mixer.8 @@ -68,7 +68,8 @@ The .Nm utility 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 +also be used to start and stop recording from the soundcard. +The list of mixer devices that may be modified are: .Pp .Bd -ragged -offset indent @@ -93,11 +94,13 @@ To modify the mixer value .Ar dev , the optional left and right channel settings of .Ar lvol Ns Op : Ns Ar rvol -may be specified. The +may be specified. +The .Ar lvol and .Ar rvol -arguments may be from 0 - 100. Omitting +arguments may be from 0 - 100. +Omitting .Ar dev and including only the channel settings will change the main volume level. .Pp @@ -134,7 +137,8 @@ sets the recording device to .Ar rdev .El .Pp -The above commands work on an internal mask. After all the options +The above commands work on an internal mask. +After all the options have been parsed, it will set then read the mask from the sound card. This will let you see EXACTLY what the soundcard is using for the recording device(s). diff --git a/usr.sbin/mlxcontrol/mlxcontrol.8 b/usr.sbin/mlxcontrol/mlxcontrol.8 index 3803fb6..76692e1 100644 --- a/usr.sbin/mlxcontrol/mlxcontrol.8 +++ b/usr.sbin/mlxcontrol/mlxcontrol.8 @@ -91,7 +91,7 @@ This command returns 2 if one or more are offline. .It rescan Rescan one or more controllers for non-attached system drives -(eg. drives that have been +(e.g.\& drives that have been detached or created subsequent to driver initialisation). If the .Fl a @@ -105,7 +105,7 @@ If the flag is supplied, detach all system drives from the nominated controller. .It check Initiate a consistency check and repair pass on a redundant system drive -(eg. RAID1 or RAID5). +(e.g.\& RAID1 or RAID5). The controller will scan the system drive and repair any inconsistencies. This command returns immediately; use the diff --git a/usr.sbin/mount_portalfs/mount_portalfs.8 b/usr.sbin/mount_portalfs/mount_portalfs.8 index b747466..c7cab62 100644 --- a/usr.sbin/mount_portalfs/mount_portalfs.8 +++ b/usr.sbin/mount_portalfs/mount_portalfs.8 @@ -121,7 +121,8 @@ The configuration file contains a list of rules. Each rule takes one line and consists of two or more whitespace separated fields. A hash (``#'') character causes the remainder of a line to -be ignored. Blank lines are ignored. +be ignored. +Blank lines are ignored. .Pp The first field is a pathname prefix to match against the requested pathname. diff --git a/usr.sbin/moused/moused.8 b/usr.sbin/moused/moused.8 index 0636cb4..99699c2 100644 --- a/usr.sbin/moused/moused.8 +++ b/usr.sbin/moused/moused.8 @@ -171,7 +171,8 @@ Enable debugging messages. Do not become a daemon and instead run as a foreground process. Useful for testing and debugging. .It Fl i Ar info -Print specified information and quit. Available pieces of +Print specified information and quit. +Available pieces of information are: .Pp .Bl -tag -compact -width modelxxx @@ -193,11 +194,13 @@ if the driver supports the .Ar sysmouse data format standard. .It Ar model -Mouse model. The +Mouse model. +The .Nm utility may not always be able to identify the model. .It Ar all -All of the above items. Print port, interface, type and model in this order +All of the above items. +Print port, interface, type and model in this order in one line. .El .Pp @@ -259,7 +262,8 @@ always choose .Ar auto or .Ar ps/2 , -regardless of the brand and model of the mouse. Likewise, if your +regardless of the brand and model of the mouse. +Likewise, if your mouse is attached to the bus mouse port, choose .Ar auto or @@ -276,26 +280,32 @@ listed below. For the serial mouse: .Bl -tag -compact -width mousesystemsxxx .It Ar microsoft -Microsoft serial mouse protocol. Most 2-button serial mice use this protocol. +Microsoft serial mouse protocol. +Most 2-button serial mice use this protocol. .It Ar intellimouse -Microsoft IntelliMouse protocol. Genius NetMouse, +Microsoft IntelliMouse protocol. +Genius NetMouse, .Tn ASCII Mie Mouse, Logitech MouseMan+ and FirstMouse+ use this protocol too. Other mice with a roller/wheel may be compatible with this protocol. .It Ar mousesystems -MouseSystems 5-byte protocol. 3-button mice may use this protocol. +MouseSystems 5-byte protocol. +3-button mice may use this protocol. .It Ar mmseries MM Series mouse protocol. .It Ar logitech -Logitech mouse protocol. Note that this is for old Logitech models. +Logitech mouse protocol. +Note that this is for old Logitech models. .Ar mouseman or .Ar intellimouse should be specified for newer models. .It Ar mouseman -Logitech MouseMan and TrackMan protocol. Some 3-button mice may be compatible -with this protocol. Note that MouseMan+ and FirstMouse+ use +Logitech MouseMan and TrackMan protocol. +Some 3-button mice may be compatible +with this protocol. +Note that MouseMan+ and FirstMouse+ use .Ar intellimouse protocol rather than this one. .It Ar glidepoint @@ -406,7 +416,8 @@ The bus and InPort mice have either a D-Sub male 9-pin connector or a round DIN 9-pin connector. The PS/2 mouse is equipped with a small, round DIN 6-pin connector. Some mice come with adapters with which the connector can -be converted to another. If you are to use such an adapter, +be converted to another. +If you are to use such an adapter, remember the connector at the very end of the mouse/adapter pair is what matters. The USB mouse has a flat rectangular connector. @@ -418,7 +429,8 @@ the bus and InPort mice always use and the PS/2 mouse is always at .Pa /dev/psm0 . There may be more than one serial port to which the serial -mouse can be attached. Many people often assign the first, built-in +mouse can be attached. +Many people often assign the first, built-in serial port .Pa /dev/cuaa0 to the mouse. @@ -440,7 +452,8 @@ Run the .Nm utility with the .Fl i -option and see what it says. If the command can identify +option and see what it says. +If the command can identify the protocol type, no further investigation is necessary on your part. You may start the daemon without explicitly specifying a protocol type (see diff --git a/usr.sbin/mrouted/mrouted.8 b/usr.sbin/mrouted/mrouted.8 index ec699ac..1e30a59 100644 --- a/usr.sbin/mrouted/mrouted.8 +++ b/usr.sbin/mrouted/mrouted.8 @@ -42,9 +42,11 @@ routers that do not support IP multicasting, includes support for "tunnels", which are virtual point-to-point links between pairs of multicast routers -located anywhere in an internet. IP multicast packets are encapsulated for +located anywhere in an internet. +IP multicast packets are encapsulated for transmission through tunnels, so that they look like normal unicast datagrams -to intervening routers and subnets. The encapsulation +to intervening routers and subnets. +The encapsulation is added on entry to a tunnel, and stripped off on exit from a tunnel. The packets are encapsulated using the IP-in-IP protocol @@ -59,7 +61,8 @@ The tunnelling mechanism allows .Nm to establish a virtual internet, for the purpose of multicasting only, which is independent of the physical -internet, and which may span multiple Autonomous Systems. This capability +internet, and which may span multiple Autonomous Systems. +This capability is intended for experimental support of internet multicasting only, pending widespread support for multicast routing by the regular (unicast) routers. The @@ -90,12 +93,14 @@ If no .Fl d option is given, or if the debug level is specified as 0, .Nm -detaches from the invoking terminal. Otherwise, it remains attached to the +detaches from the invoking terminal. +Otherwise, it remains attached to the invoking terminal and responsive to signals from that terminal. Regardless of the debug level, .Nm always writes warning and error messages to the system -log daemon. The +log daemon. +The .Fl debug-level argument is a comma-separated list of any of the following: .Bl -tag -width indent @@ -106,7 +111,8 @@ Display more information about prunes sent or received. .It "routing" Display more information about routing update packets sent or received. .It "route_detail" -Display routing updates in excruciating detail. This is generally way too +Display routing updates in excruciating detail. +This is generally way too much information. .It "neighbors" Display information about neighbor discovery. @@ -141,7 +147,8 @@ The utility automatically configures itself to forward on all multicast-capable interfaces, i.e., interfaces that have the IFF_MULTICAST flag set (excluding the loopback "interface"), and it finds other DVMRP routers directly reachable -via those interfaces. To override the default configuration, or to add +via those interfaces. +To override the default configuration, or to add tunnel links to other multicast routers, configuration commands may be placed in .Pa /etc/mrouted.conf @@ -157,26 +164,35 @@ overall operation or set defaults. .Bl -tag -width indent .It cache_lifetime Ar secs Specifies, in seconds, the lifetime of a multicast forwarding cache -entry in the kernel. Multicast forwarding cache entries in the kernel +entry in the kernel. +Multicast forwarding cache entries in the kernel are checked every .Ar secs seconds, and are refreshed if the source is still -active or deleted if not. Care should be taken when setting this value, +active or deleted if not. +Care should be taken when setting this value, as a low value can keep the kernel cache small at the cost of "thrashing" the cache for periodic senders, but high values can cause the kernel -cache to grow unacceptably large. The default is 300 seconds (5 minutes). +cache to grow unacceptably large. +The default is 300 seconds (5 minutes). .It prune_lifetime Ar secs Specifies, in seconds, the average lifetime of prunes that are sent towards -parents. The actual lifetimes will be randomized in the range -[.5\fIsecs\fP,1.5\fIsecs\fP]. The default is 7200 (2 hours). Smaller values +parents. +The actual lifetimes will be randomized in the range +[.5\fIsecs\fP,1.5\fIsecs\fP]. +The default is 7200 (2 hours). +Smaller values cause less state to be kept both at this router and the parent, at the -cost of more frequent broadcasts. However, some routers (e.g.\& +cost of more frequent broadcasts. +However, some routers (e.g.\& .Nm <3.3 and all currently known versions of cisco's IOS) do not use the -DVMRP generation ID to determine that a neighbor has rebooted. Prunes +DVMRP generation ID to determine that a neighbor has rebooted. +Prunes sent towards these neighbors should be kept short, in order to shorten -the time to recover from a reboot. For use in this situation, the +the time to recover from a reboot. +For use in this situation, the prune_lifetime keyword may be specified on an interface as described below. .It noflood @@ -187,9 +203,11 @@ uses a DVMRP optimization to prevent having to keep individual routing tables for each neighbor; part of this optimization is that .Nm assumes that it is the forwarder for each of its attached subnets on -startup. This can cause duplicates for a short period (approximately +startup. +This can cause duplicates for a short period (approximately one full route report interval), since both the router that just -started up and the proper forwarder will be forwarding traffic. This +started up and the proper forwarder will be forwarding traffic. +This behavior can be turned off with the noflood keyword; .Nm will not assume that it is the forwarder on startup. @@ -198,7 +216,8 @@ last approximately one full route report interval. The noflood keyword can also be specified on individual interfaces. .It rexmit_prunes Ar [on|off] Default is to retransmit prunes on all point-to-point interfaces -(including tunnels) but no multi-access interfaces. This option +(including tunnels) but no multi-access interfaces. +This option may be used to make the default on (or off) for all interfaces. The rexmit_prunes keyword can also be specified on individual interfaces. .It name Ar "boundary-name scoped-addr/mask-len" @@ -215,26 +234,30 @@ be empty, describes options that apply to physical interfaces. .Bl -tag -width indent .It phyint Ar "local-addr|ifname" The phyint command does nothing by itself; it is simply a place holder -which interface-specific commands may follow. An interface address or +which interface-specific commands may follow. +An interface address or name may be specified. .It disable -Disables multicast forwarding on this interface. By default, +Disables multicast forwarding on this interface. +By default, .Nm discovers all locally attached multicast capable interfaces and forwards on all of them. .It netmask Ar netmask If the kernel's netmask does not accurately reflect -the subnet (e.g. you're using proxy-ARP in lieu of IP subnetting), use the +the subnet (e.g.\& you're using proxy-ARP in lieu of IP subnetting), use the netmask command to describe the real netmask. .It altnet Ar network/mask-len If a phyint is attached to multiple IP subnets, describe each additional subnet -with the altnet keyword. This command may be specified multiple times +with the altnet keyword. +This command may be specified multiple times to describe multiple subnets. .It igmpv1 If there are any IGMPv1 routers on the phyint, use the \fBigmpv1\fP keyword to force .Nm -into IGMPv1 mode. All routers on the phyint +into IGMPv1 mode. +All routers on the phyint must use the same version of IGMP. .It force_leaf Force @@ -268,11 +291,13 @@ A tunnel must be configured on both routers before it can be used. Be careful that the unicast route to the remote address goes out the interface specified by the .Ar "local-addr|ifname" -argument. Some UNIX +argument. +Some UNIX kernels rewrite the source address of .Nm Ns 's packets on their way out to contain the address of the transmission -interface. This is best assured via a static host route. +interface. +This is best assured via a static host route. .El .Pp The common vif commands described below @@ -281,19 +306,25 @@ may all be used on tunnels or phyints. .It metric Ar m The metric is the "cost" associated with receiving a datagram on the given interface or tunnel; it may be used to influence the choice of routes. -The metric defaults to 1. Metrics should be kept as small as possible, +The metric defaults to 1. +Metrics should be kept as small as possible, because DVMRP cannot route along paths with a sum of metrics greater than 31. .It advert_metric Ar m The advert_metric is the "cost" associated with sending a datagram on the given interface or tunnel; it may be used to influence the choice -of routes. The advert_metric defaults to 0. Note that the effective +of routes. +The advert_metric defaults to 0. +Note that the effective metric of a link is one end's metric plus the other end's advert_metric. .It threshold Ar t The threshold is the minimum IP time-to-live required for a multicast datagram -to be forwarded to the given interface or tunnel. It is used to control the -scope of multicast datagrams. (The TTL of forwarded packets is only compared -to the threshold, it is not decremented by the threshold. Every multicast +to be forwarded to the given interface or tunnel. +It is used to control the +scope of multicast datagrams. +(The TTL of forwarded packets is only compared +to the threshold, it is not decremented by the threshold. +Every multicast router decrements the TTL by exactly 1.) The default threshold is 1. .Pp In general, all multicast routers @@ -302,21 +333,26 @@ use the same metric and threshold for that subnet or tunnel. .It rate_limit Ar r The rate_limit option allows the network administrator to specify a certain bandwidth in Kbits/second which would be allocated to multicast -traffic. It defaults 0 (unlimited). +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 -be forwarded on a scoped interface. The boundary option accepts either -a name or a boundary spec. This command may be specified several times +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. .It passive No packets will be sent on this link or tunnel until we hear from the other -end. This is useful for the "server" end of a tunnel that goes over +end. +This is useful for the "server" end of a tunnel that goes over a dial-on-demand link; configure the "server" end as passive and it will not send its periodic probes until it hears one from the other -side, so will not keep the link up. If this option is specified on both +side, so will not keep the link up. +If this option is specified on both ends of a tunnel, the tunnel will never come up. .It noflood As described above, but only applicable to this interface/tunnel. @@ -331,18 +367,21 @@ multi-access links. By default, .Nm refuses to peer with DVMRP neighbors that -do not claim to support pruning. This option allows such peerings +do not claim to support pruning. +This option allows such peerings on this interface. .It notransit A specialized case of route filtering; no route learned from an interface marked "notransit" will be advertised on another interface marked -"notransit". Marking only a single interface "notransit" has no meaning. +"notransit". +Marking only a single interface "notransit" has no meaning. .It accept|deny Ar "(route/mask-len [exact])+" Op bidir The .Li accept and .Li deny -commands allow rudimentary route filtering. The +commands allow rudimentary route filtering. +The .Li accept command causes .Nm @@ -361,14 +400,17 @@ The list of routes follows the .Li accept or .Li deny -keyword. If the keyword +keyword. +If the keyword .Ar exact follows a route, then only that route is matched; otherwise, that route -and any more specific route is matched. For example, +and any more specific route is matched. +For example, .Li deny 0/0 denys all routes, while .Li deny 0/0 exact -denys only the default route. The default route may also be specified +denys only the default route. +The default route may also be specified with the .Li default keyword. @@ -376,13 +418,15 @@ keyword. The .Ar bidir keyword enables bidirectional route filtering; the filter will be applied -to routes on both output and input. Without the +to routes on both output and input. +Without the .Ar bidir keyword, .Li accept and .Li deny -filters are only applied on input. Poison reverse routes are never +filters are only applied on input. +Poison reverse routes are never filtered out. .El .Pp @@ -390,11 +434,12 @@ The .Nm utility will not initiate execution if it has fewer than two enabled vifs, where a vif (virtual interface) is either a physical multicast-capable -interface or a tunnel. It will log a warning if all of its vifs are +interface or a tunnel. +It will log a warning if all of its vifs are tunnels; such an .Nm configuration would be better replaced by more -direct tunnels (i.e. eliminate the middle man). +direct tunnels (i.e., eliminate the middle man). .Sh "EXAMPLE CONFIGURATION" This is an example configuration for a mythical multicast router at a big school. @@ -503,8 +548,11 @@ Multicast Routing Table (1136 entries) .Ed .Pp In this example, there are four vifs connecting to two subnets and two -tunnels. The vif 3 tunnel is not in use (no peer address). The vif 0 and -vif 1 subnets have some groups present; tunnels never have any groups. This +tunnels. +The vif 3 tunnel is not in use (no peer address). +The vif 0 and +vif 1 subnets have some groups present; tunnels never have any groups. +This instance of .Nm is the one responsible for sending periodic group @@ -512,14 +560,16 @@ 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 +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 is the address of the previous hop router (unless the subnet is directly- connected), the metric of the path back to the origin, the amount of time since we last received an update for this subnet, the incoming vif for -multicasts from that origin, and a list of outgoing vifs. "*" means that +multicasts from that origin, and a list of outgoing vifs. +"*" means that the outgoing vif is connected to a leaf of the broadcast tree rooted at the 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. @@ -551,17 +601,21 @@ Each entry is characterized by the origin subnet number and mask and the destination multicast group. .Pp The 'CTmr' field indicates the lifetime -of the entry. The entry is deleted from the cache table +of the entry. +The entry is deleted from the cache table (or refreshed, if traffic is flowing) -when the timer decrements to zero. The 'Age' field is the time since -this cache entry was originally created. Since cache entries get refreshed +when the timer decrements to zero. +The 'Age' field is the time since +this cache entry was originally created. +Since cache entries get refreshed if traffic is flowing, routing entries can grow very old. .Pp The 'Ptmr' field is simply a dash if no prune was sent upstream, or the amount of time until the upstream prune will time out. .Pp The 'Ivif' field indicates the -incoming vif for multicast packets from that origin. Each router also +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 @@ -578,11 +632,12 @@ 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 +indicates that it is a boundary interface, i.e., traffic will not be forwarded on the scoped address on that interface. .Pp An additional line with a ">" as the first character is printed for -each source on the subnet. Note that there can be many sources in +each source on the subnet. +Note that there can be many sources in one subnet. An additional line with a "<" as the first character is printed describing any prunes received from downstream dependent neighbors @@ -600,7 +655,8 @@ for this subnet and group. .Xr mtrace 8 .Pp DVMRP is described, along with other multicast routing algorithms, in the -paper "Multicast Routing in Internetworks and Extended LANs" by S. Deering, +paper "Multicast Routing in Internetworks and Extended LANs" by +.An S. Deering , in the Proceedings of the ACM SIGCOMM '88 Conference. .Sh AUTHORS .An Steve Deering , diff --git a/usr.sbin/mrouted/mtrace.8 b/usr.sbin/mrouted/mtrace.8 index 44d99d5..6226aa1 100644 --- a/usr.sbin/mrouted/mtrace.8 +++ b/usr.sbin/mrouted/mtrace.8 @@ -67,7 +67,8 @@ can be difficult. The .Nm utility utilizes a tracing feature implemented in multicast routers that is -accessed via an extension to the IGMP protocol. A trace query is +accessed via an extension to the IGMP protocol. +A trace query is passed hop-by-hop along the reverse path from the .Ar receiver to the @@ -77,15 +78,18 @@ along the path, and then the response is returned to the requestor. .Pp The only required parameter is the .Ar source -host name or address. The default +host name or address. +The default .Ar receiver is the host running mtrace, and the default .Ar group is 0.0.0.0, which is sufficient if packet loss -statistics for a particular multicast group are not needed. These two +statistics for a particular multicast group are not needed. +These two optional parameters may be specified to test the path to some other receiver in a particular group, subject to some constraints as -detailed below. The two parameters can be distinguished because the +detailed below. +The two parameters can be distinguished because the .Ar receiver is a unicast address and the .Ar group @@ -97,7 +101,8 @@ flag is specified, the source address defaults to the host running and the receiver defaults to the router being addressed with the .Fl g -flag. In this case, there are no required parameters. +flag. +In this case, there are no required parameters. .Pp NOTE: For Solaris 2.4/2.5, if the multicast interface is not the default interface, the @@ -127,7 +132,8 @@ unicast packet and .Nm mrouted has no route for the .Ar source -address. Therefore, do not use the +address. +Therefore, do not use the .Fl g option unless the target .Nm mrouted @@ -170,11 +176,13 @@ multicast traceroutes with IP options, so it may be necessary to use the flag if the last-hop router is a Cisco. .It Fl p Listen passively for multicast responses from traces initiated by -others. This works best when run on a multicast router. +others. +This works best when run on a multicast router. .It Fl P Loop indefinitely collecting the path every 10 seconds (see .Fl S Ar stat_int ) -and printing it when it changes. Do not print any statistics. +and printing it when it changes. +Do not print any statistics. .It Fl r Ar host Send the trace response to .Ar host @@ -193,7 +201,8 @@ seconds (default 10 seconds). Set the .Ar ttl (time-to-live, or number of hops) for multicast trace queries and -responses. The default is 127, except for local queries to the "all +responses. +The default is 127, except for local queries to the "all routers" multicast group which use ttl 1. .It Fl T "Tunnel statistics" mode; show loss rates for overall traffic. @@ -228,7 +237,8 @@ to the A trace query packet is sent to the last hop multicast router (the leaf router for the desired .Ar receiver -address). The last hop router builds a trace response packet, fills in +address). +The last hop router builds a trace response packet, fills in a report for its hop, and forwards the trace packet using unicast to the router it believes is the previous hop for packets originating from the specified @@ -241,9 +251,11 @@ the trace query. .Pp If some multicast router along the path does not implement the multicast traceroute feature or if there is some outage, then no -response will be returned. To solve this problem, the trace query +response will be returned. +To solve this problem, the trace query includes a maximum hop count field to limit the number of hops traced -before the response is returned. That allows a partial path to be +before the response is returned. +That allows a partial path to be traced. .Pp The reports inserted by each router contain not only the address of @@ -264,12 +276,15 @@ to the .Ar receiver . If the receiver is on the local subnet (as determined using the subnet mask), then the default method is to multicast the trace query to -all-routers.mcast.net (224.0.0.2) with a ttl of 1. Otherwise, the +all-routers.mcast.net (224.0.0.2) with a ttl of 1. +Otherwise, the trace query is multicast to the .Ar group address since the last hop router will be a member of that group if -the receiver is. Therefore it is necessary to specify a group that -the intended receiver has joined. This multicast is sent with a +the receiver is. +Therefore it is necessary to specify a group that +the intended receiver has joined. +This multicast is sent with a default ttl of 127, which may not be sufficient for all cases (changed with the .Fl t @@ -277,7 +292,8 @@ option). If the last hop router is known, it may also be addressed directly using the .Fl g -option). Alternatively, if it is desired to trace a group that the +option). +Alternatively, if it is desired to trace a group that the receiver has not joined, but it is known that the last-hop router is a member of another group, the .Fl g @@ -295,21 +311,26 @@ By default, first attempts to trace the full reverse path, unless the number of hops to trace is explicitly set with the .Fl m -option. If there is no response within a 3 second timeout interval +option. +If there is no response within a 3 second timeout interval (changed with the .Fl w option), a "*" is printed and the probing switches to hop-by-hop mode. Trace queries are issued starting with a maximum hop count of one and increasing by one until the full path is traced or no response is -received. At each hop, multiple probes are sent (default is three, +received. +At each hop, multiple probes are sent (default is three, changed with .Fl q -option). The first half of the attempts (default is two) are made with +option). +The first half of the attempts (default is two) are made with the reply address set to standard multicast address, mtrace.mcast.net (224.0.1.32) with the ttl set to 32 more than what's needed to pass the -thresholds seen so far along the path to the receiver. For each +thresholds seen so far along the path to the receiver. +For each additional attempt, the ttl is increased by another 32 each time up to -a maximum of 192. Since the desired router may not be able to send a +a maximum of 192. +Since the desired router may not be able to send a multicast reply, the remainder of the attempts request that the response be sent via unicast to the host running .Nm . @@ -324,8 +345,10 @@ instead with the option, or if you specify .Fl UM , .Nm -will first attempt using unicast and then multicast. For each attempt, -if no response is received within the timeout, a "*" is printed. After +will first attempt using unicast and then multicast. +For each attempt, +if no response is received within the timeout, a "*" is printed. +After the specified number of attempts have failed, .Nm will try to query the next hop router with a DVMRP_ASK_NEIGHBORS2 @@ -342,7 +365,8 @@ forwarding the request on. .Sh EXAMPLES The output of .Nm -is in two sections. The first section is a short listing of the hops +is in two sections. +The first section is a short listing of the hops in the order they are queried, that is, in the reverse of the order from the .Ar source @@ -353,11 +377,13 @@ negatively to indicate that this is the reverse path); the multicast routing protocol (DVMRP, MOSPF, PIM, etc.); the threshold required to forward data (to the previous hop in the listing as indicated by the up-arrow character); and the cumulative delay for the query to reach -that hop (valid only if the clocks are synchronized). This first +that hop (valid only if the clocks are synchronized). +This first section ends with a line showing the round-trip time which measures the interval from when the query is issued until the response is received, both derived from the local system clock, and the total -ttl required for a packet to travel along this path. A sample use and +ttl required for a packet to travel along this path. +A sample use and output might be: .Pp .Bd -literal @@ -377,7 +403,8 @@ Round trip time 124 ms; total ttl of 6 required. If a hop reports that it is using the default route to forward packets, the word .Em [default] -is printed after that hop. If the +is printed after that hop. +If the .Fl v flag is supplied, the route being used to forward packets is printed in the form @@ -385,7 +412,8 @@ in the form .Pp The second section provides a pictorial view of the path in the forward direction with data flow indicated by arrows pointing downward -and the query path indicated by arrows pointing upward. For each hop, +and the query path indicated by arrows pointing upward. +For each hop, both the entry and exit addresses of the router are shown if different, along with the initial ttl required on the packet in order to be forwarded at this hop and the propagation delay across the hop @@ -395,11 +423,14 @@ The first column contains the average packet rate for all traffic at each hop. The remaining columns are the number of packets lost, the number of packets sent, the percentage -lost, and the average packet rate at each hop. These statistics are +lost, and the average packet rate at each hop. +These statistics are calculated from differences between traces and from hop to hop as -explained above. The first group shows the statistics for all traffic +explained above. +The first group shows the statistics for all traffic flowing out the interface at one hop and in the interface at the next -hop. The second group shows the statistics only for traffic forwarded +hop. +The second group shows the statistics only for traffic forwarded from the specified .Ar source to the specified @@ -407,20 +438,26 @@ to the specified The first group of statistics may be expanded to include loss rates using the .Fl T -option. However, these numbers can be extremely misleading and require +option. +However, these numbers can be extremely misleading and require detailed knowledge of the routers involved to be interpreted properly. .Pp -These statistics are shown on one or two lines for each hop. Without +These statistics are shown on one or two lines for each hop. +Without any options, this second section of the output is printed only once, -approximately 10 seconds after the initial trace. One line is shown -for each hop showing the statistics over that 10-second period. If +approximately 10 seconds after the initial trace. +One line is shown +for each hop showing the statistics over that 10-second period. +If the .Fl l option is given, the second section is repeated every 10 seconds and -two lines are shown for each hop. The first line shows the statistics +two lines are shown for each hop. +The first line shows the statistics for the last 10 seconds, and the second line shows the cumulative statistics over the period since the initial trace, which is 101 -seconds in the example below. The second section of the output is +seconds in the example below. +The second section of the output is omitted if the .Fl s option is set or if no multicast group is specified. @@ -458,39 +495,47 @@ Waiting to accumulate statistics... Results after 101 seconds: .Pp Because the packet counts may be changing as the trace query is propagating, there may be small errors (off by 1 or 2) in these -statistics. However, those errors should not accumulate, so the +statistics. +However, those errors should not accumulate, so the cumulative statistics line should increase in accuracy as a new trace -is run every 10 seconds. There are two sources of larger errors, both +is run every 10 seconds. +There are two sources of larger errors, both of which show up as negative losses: .Pp If the input to a node is from a multi-access network with more than one other node attached, then the input count will be (close to) the sum of the output counts from all the attached nodes, but the output count from the previous hop on the traced path will be only part of -that. Hence the output count minus the input count will be negative. +that. +Hence the output count minus the input count will be negative. .Pp In release 3.3 of the DVMRP multicast forwarding software for SunOS and other systems, a multicast packet generated on a router will be -counted as having come in an interface even though it did not. This +counted as having come in an interface even though it did not. +This creates the negative loss that can be seen in the example above. .Pp Note that these negative losses may mask positive losses. .Pp -In the example, there is also one negative hop time. This simply +In the example, there is also one negative hop time. +This simply indicates a lack of synchronization between the system clocks across -that hop. This example also illustrates how the percentage loss is +that hop. +This example also illustrates how the percentage loss is shown as two dashes when the number of packets sent is less than 10 because the percentage would not be statistically valid. .Pp A second example shows a trace to a receiver that is not local; the query is sent to the last-hop router with the .Fl g -option. In this example, the trace of the full reverse path resulted +option. +In this example, the trace of the full reverse path resulted in no response because there was a node running an old version of .Nm mrouted that did not implement the multicast traceroute function, so .Nm -switched to hop-by-hop mode. The +switched to hop-by-hop mode. +The .Dq Output pruned error code indicates that traffic for group 224.2.143.24 would not be forwarded. diff --git a/usr.sbin/mtest/mtest.8 b/usr.sbin/mtest/mtest.8 index 5976dd1..4b1f299 100644 --- a/usr.sbin/mtest/mtest.8 +++ b/usr.sbin/mtest/mtest.8 @@ -15,7 +15,8 @@ The .Nm utility is a small program for testing the multicast membership socket operations -and ioctls. It accepts the following commands, interactively: +and ioctls. +It accepts the following commands, interactively: .Bl -tag -width "a ifname e.e.e.e.e.e" -compact -offset indent .It Ic j Ar g.g.g.g Ar i.i.i.i Join the IP group address diff --git a/usr.sbin/mtree/mtree.8 b/usr.sbin/mtree/mtree.8 index 3b76170..c3c525e 100644 --- a/usr.sbin/mtree/mtree.8 +++ b/usr.sbin/mtree/mtree.8 @@ -77,7 +77,8 @@ The options are as follows: Follow all symbolic links in the file hierarchy. .It Fl P Don't follow symbolic links in the file hierarchy, instead consider -the symbolic link itself in any comparisons. This is the default. +the symbolic link itself in any comparisons. +This is the default. .It Fl U Modify the owner, group, permissions, and modification time of existing files to match the specification and create any missing directories or @@ -101,13 +102,15 @@ This does not affect either the /set statements or the comment before each directory. It does however affect the comment before the close of each directory. .It Fl n -Do not emit pathname comments when creating a specification. Normally +Do not emit pathname comments when creating a specification. +Normally a comment is emitted before each directory and before the close of that directory when using the .Fl c option. .It Fl q -Quiet mode. Do not complain when a +Quiet mode. +Do not complain when a .Dq missing directory cannot be created because it already exists. This occurs when the directory is a symbolic link. @@ -164,13 +167,14 @@ If the pattern contains a .Ql \&/ character, it will be matched against entire pathnames (relative to the starting directory); otherwise, -it will be matched against basenames only. No comments are allowed in +it will be matched against basenames only. +No comments are allowed in the .Ar exclude-list file. .El .Pp -Specifications are mostly composed of ``keywords'', i.e. strings +Specifications are mostly composed of ``keywords'', i.e., strings that specify values relating to files. No keywords have default values, and if a keyword has no value set, no checks based on it are performed. @@ -183,9 +187,11 @@ the .Xr cksum 1 utility. .It Cm flags -The file flags as a symbolic name. See +The file flags as a symbolic name. +See .Xr chflags 1 -for information on these names. If no flags are to be set the string +for information on these names. +If no flags are to be set the string .Dq none may be used to override the current default. .It Cm ignore diff --git a/usr.sbin/newsyslog/newsyslog.8 b/usr.sbin/newsyslog/newsyslog.8 index bbfef2d..5899d7e 100644 --- a/usr.sbin/newsyslog/newsyslog.8 +++ b/usr.sbin/newsyslog/newsyslog.8 @@ -35,7 +35,8 @@ The .Nm utility should be scheduled to run periodically by .Xr cron 8 . -When it is executed it archives log files if necessary. If a log file +When it is executed it archives log files if necessary. +If a log file is determined to require archiving, .Nm rearranges the files so that @@ -47,7 +48,8 @@ the last period's logs in it, .Dq Va logfile Ns Li \&.1 has the next to last period's logs in it, and so on, up to a user-specified number of -archived logs. Optionally the archived logs can be compressed to save +archived logs. +Optionally the archived logs can be compressed to save space. .Pp A log can be archived for three reasons: @@ -100,7 +102,8 @@ is run. .It Fl v Place .Nm -in verbose mode. In this mode it will print out each log and its +in verbose mode. +In this mode it will print out each log and its reasons for either trimming that log or skipping it. .It Fl n Cause @@ -110,7 +113,8 @@ were not specified. .It Fl r Remove the restriction that .Nm -must be running as root. Of course, +must be running as root. +Of course, .Nm will not be able to send a HUP signal to .Xr syslogd 8 @@ -144,7 +148,8 @@ will only apply to those specific log files. .It Fl F Force .Nm -to trim the logs, even if the trim conditions have not been met. This +to trim the logs, even if the trim conditions have not been met. +This option is useful for diagnosing system problems by providing you with fresh logs that contain only the problems. .It Fl R Ar tagname @@ -216,7 +221,8 @@ distinguish the group name. Beginning with .Fx 3.3 , this has been changed to a colon (``:'') character so that user and group -names may contain the dot character. The dot (``.'') character is still +names may contain the dot character. +The dot (``.'') character is still accepted for backwards compatibility. .Sh "SEE ALSO" .Xr bzip 1 , diff --git a/usr.sbin/nfsd/nfsd.8 b/usr.sbin/nfsd/nfsd.8 index 512257b..64faf1d 100644 --- a/usr.sbin/nfsd/nfsd.8 +++ b/usr.sbin/nfsd/nfsd.8 @@ -90,9 +90,11 @@ options may be specified. Specifies that nfsd should bind to the wildcard IP address. This is the default if no .Fl h -options are given. It may also be specified in addition to any +options are given. +It may also be specified in addition to any .Fl h -options given. Note that NFS/UDP does not operate properly when +options given. +Note that NFS/UDP does not operate properly when bound to the wildcard IP address whether you use -a or do not use -h. .It Fl t Serve @@ -145,8 +147,10 @@ If is to be run on a host with multiple interfaces or interface aliases, use of the .Fl h -option is recommended. If you do not use the option NFS may not respond to -UDP packets from the same IP address they were sent to. Use of this option +option is recommended. +If you do not use the option NFS may not respond to +UDP packets from the same IP address they were sent to. +Use of this option is also recommended when securing NFS exports on a firewalling machine such that the NFS sockets can only be accessed by the inside interface. The diff --git a/usr.sbin/ngctl/ngctl.8 b/usr.sbin/ngctl/ngctl.8 index b98d507..121c0f1 100644 --- a/usr.sbin/ngctl/ngctl.8 +++ b/usr.sbin/ngctl/ngctl.8 @@ -133,7 +133,7 @@ commands, their usage and aliases, and a brief description. .Sh HISTORY The .Nm netgraph -system was designed and first implemented at Whistle Communications, Inc. in +system was designed and first implemented at Whistle Communications, Inc.\& in a version of .Fx 2.2 customized for the Whistle InterJet. diff --git a/usr.sbin/ntp/doc/ntp.conf.5 b/usr.sbin/ntp/doc/ntp.conf.5 index 1a20135..7c5123c 100644 --- a/usr.sbin/ntp/doc/ntp.conf.5 +++ b/usr.sbin/ntp/doc/ntp.conf.5 @@ -1292,13 +1292,13 @@ If this flag is specified neither queries nor time server polls will be responded to. .It Cm noquery -Ignore all NTP mode 6 and 7 packets (i.e. information queries +Ignore all NTP mode 6 and 7 packets (i.e., information queries and configuration requests) from the source. Time service is not affected. .It Cm nomodify Ignore all NTP mode 6 and 7 packets which attempt to modify the -state of the server (i.e. run time reconfiguration). +state of the server (i.e., run time reconfiguration). Queries which return information are permitted. .It Cm notrap diff --git a/usr.sbin/ntp/doc/ntptrace.8 b/usr.sbin/ntp/doc/ntptrace.8 index 82e1ff3..554a3c0 100644 --- a/usr.sbin/ntp/doc/ntptrace.8 +++ b/usr.sbin/ntp/doc/ntptrace.8 @@ -40,7 +40,8 @@ this is why it is not always zero for .Dq localhost ) , the host synchronization distance, -and (only for stratum-1 servers) the reference clock ID. All times +and (only for stratum-1 servers) the reference clock ID. +All times are given in seconds. Note that the stratum is the server hop count to the primary source, while the synchronization distance is the estimated error @@ -53,7 +54,8 @@ The following options are available: Turn on some debugging output. .It Fl n Turn off the printing of host names; instead, host IP addresses -are given. This may be necessary if a nameserver is down. +are given. +This may be necessary if a nameserver is down. .It Fl r Ar retries Set the number of retransmission attempts for each host; the default is 5. .It Fl t Ar timeout diff --git a/usr.sbin/ofwdump/ofwdump.8 b/usr.sbin/ofwdump/ofwdump.8 index f168e97..995d937 100644 --- a/usr.sbin/ofwdump/ofwdump.8 +++ b/usr.sbin/ofwdump/ofwdump.8 @@ -60,7 +60,7 @@ Only print properties of the given name. .It Fl R Print properties in .Dq raw -format, i.e. omit all headings and indentation and just write the +format, i.e., omit all headings and indentation and just write the property values unaltered to the standard output. This is intended to be used with the .Fl P diff --git a/usr.sbin/pccard/pccardc/pccardc.8 b/usr.sbin/pccard/pccardc/pccardc.8 index 008224e..b47a19c 100644 --- a/usr.sbin/pccard/pccardc/pccardc.8 +++ b/usr.sbin/pccard/pccardc/pccardc.8 @@ -42,7 +42,8 @@ The .Nm utility controls PC-CARD slots and configures and displays information -about PCMCIA cards. It understands the following subcommands: +about PCMCIA cards. +It understands the following subcommands: .Pp .Bl -tag -width dumpcisfile -compact .It Ic beep diff --git a/usr.sbin/pccard/pccardd/pccard.conf.5 b/usr.sbin/pccard/pccardd/pccard.conf.5 index 6536de8..4cb8e86 100644 --- a/usr.sbin/pccard/pccardd/pccard.conf.5 +++ b/usr.sbin/pccard/pccardd/pccard.conf.5 @@ -116,7 +116,8 @@ If a decimal number has .Em k or .Em K -appended to it, the value is multiplied by 1024. Names may be +appended to it, the value is multiplied by 1024. +Names may be quoted using double quotes if spaces are required. A hash character comments out the rest of the line. .Ss "Resource pool" @@ -184,7 +185,7 @@ An optional set of flags may be assigned. In .Ar index , -specify either +specify either .Dq auto or .Dq default @@ -252,11 +253,11 @@ matches .Dq Functional ID: Serial port/modem and .Em fixed_disk -matches +matches .Dq Fixed disk card . The syntax is the same as for .Em "card identifiers" -but uses +but uses .Dq generic instead of .Dq card diff --git a/usr.sbin/pccard/pccardd/pccardd.8 b/usr.sbin/pccard/pccardd/pccardd.8 index 649619c..34c95aa 100644 --- a/usr.sbin/pccard/pccardd/pccardd.8 +++ b/usr.sbin/pccard/pccardd/pccardd.8 @@ -141,7 +141,8 @@ Delays running as a daemon until after the cards have been probed and attached. .It Fl I Don't get a list of free IRQs from kernel. .It Fl i Ar IRQ -Configures an available IRQ. It overrides the "irq" line in +Configures an available IRQ. +It overrides the "irq" line in .Pa /etc/defaults/pccard.conf and .Pa /etc/pccard.conf . diff --git a/usr.sbin/pcvt/kcon/kcon.1 b/usr.sbin/pcvt/kcon/kcon.1 index 075937b..4e9185a 100644 --- a/usr.sbin/pcvt/kcon/kcon.1 +++ b/usr.sbin/pcvt/kcon/kcon.1 @@ -72,13 +72,14 @@ To be used in conjunction with the option. .It Fl p Uses 'pure' output when listing - the Escape character is displayed in either -octal or hexadecimal and not as 'ESC'. To be used in conjunction with the +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 -corresponding to rates of 30 characters/second ... 2 characters/second. +corresponding to rates of 30 characters/second ...\& 2 characters/second. .It Fl R Reset the Keyboard. .It Fl s diff --git a/usr.sbin/pcvt/scon/scon.1 b/usr.sbin/pcvt/scon/scon.1 index 76a4c0f..fa832d8 100644 --- a/usr.sbin/pcvt/scon/scon.1 +++ b/usr.sbin/pcvt/scon/scon.1 @@ -79,7 +79,7 @@ returned could be MDA, HGC, CGA, EGA, VGA or UNKNOWN. Specify the screen number the current (displayed) screen should be switched to. .It Fl d -Specify the device filename (i.e. /dev/ttyv2) further operations specified on +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 @@ -116,7 +116,8 @@ 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 -25, 28, 35, 40, 43 or 50. To use all this screen sizes, the fonts required +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. diff --git a/usr.sbin/pkg_install/create/pkg_create.1 b/usr.sbin/pkg_install/create/pkg_create.1 index 91d7d71..43a9fbf 100644 --- a/usr.sbin/pkg_install/create/pkg_create.1 +++ b/usr.sbin/pkg_install/create/pkg_create.1 @@ -59,11 +59,14 @@ The .Nm command is used to create packages that will subsequently be fed to -one of the package extraction/info utilities. The input description +one of the package extraction/info utilities. +The input description and command line arguments for the creation of a package are not really meant to be human-generated, though it is easy enough to -do so. It is more expected that you will use a front-end tool for -the job rather than muddling through it yourself. Nonetheless, a short +do so. +It is more expected that you will use a front-end tool for +the job rather than muddling through it yourself. +Nonetheless, a short description of the input syntax is included in this document. .Sh OPTIONS The following command line options are supported: @@ -89,7 +92,8 @@ from file .Ar desc or, if preceded by .Cm - , -the argument itself. This string should also +the argument itself. +This string should also give some idea of which version of the product (if any) the package represents. .It Fl d Xo @@ -105,7 +109,8 @@ Assume a default answer of `Yes' for any questions asked. .It Fl N Assume a default answer of `No' for any questions asked. .It Fl O -Go into a `packing list Only' mode. This is a custom hack for the +Go into a `packing list Only' mode. +This is a custom hack for the .Fx .Em "Ports Collection" and is used to do `fake pkg_add' operations when a port is installed. @@ -119,8 +124,10 @@ are dumped, rather than the links themselves. .It Fl i Ar iscript 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 +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 first argument. @@ -138,8 +145,10 @@ respectively, after the package's name. .It Fl I Ar piscript 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 +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 the first argument. @@ -181,8 +190,10 @@ the package. .It Fl k Ar dscript 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 +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 name as the first argument. @@ -200,8 +211,10 @@ respectively, along with the package's name. .It Fl K Ar pdscript 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 +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 first argument. @@ -210,8 +223,10 @@ Set .Ar rscript to be the .Dq requirements -procedure for the package. This can be any -executable program (or shell script). It will be invoked automatically +procedure for the package. +This can be any +executable program (or shell script). +It will be invoked automatically at installation/deinstallation time to determine whether or not installation/deinstallation should proceed. To differentiate between installation and deinstallation, the keywords @@ -239,7 +254,8 @@ By default, this is the string but it may be necessary to override it in the situation where space in your .Pa /tmp -directory is limited. Be sure to leave some number of `X' characters +directory is limited. +Be sure to leave some number of `X' characters for .Xr mktemp 3 to fill in with a unique ID. @@ -250,7 +266,8 @@ as a .Fl exclude-from argument to .Cm tar -when creating final package. See +when creating final package. +See .Cm tar man page (or run .Cm tar @@ -259,7 +276,8 @@ with flag) for further information on using this flag. .It Fl D Ar displayfile Display the file (by concatenating it to stdout) -after installing the package. Useful for things like +after installing the package. +Useful for things like legal notices on almost-free software, etc. .It Fl m Ar mtreefile Run @@ -325,12 +343,15 @@ format (see .Fl f ) is fairly simple, being nothing more than a single column of filenames to include in the -package. However, since absolute pathnames are generally a bad idea +package. +However, since absolute pathnames are generally a bad idea for a package that could be installed potentially anywhere, there is another method of specifying where things are supposed to go and, optionally, what ownership and mode information they should be -installed with. This is done by embedding specialized command sequences -in the packing list. Briefly described, these sequences are: +installed with. +This is done by embedding specialized command sequences +in the packing list. +Briefly described, these sequences are: .Bl -tag -width indent -compact .It Cm @cwd Ar directory Set the internal directory pointer to point to @@ -348,10 +369,12 @@ for package creation but not extraction. .It Cm @exec Ar command Execute .Ar command -as part of the unpacking process. If +as part of the unpacking process. +If .Ar command contains any of the following sequences somewhere in it, they will -be expanded inline. For the following examples, assume that +be expanded inline. +For the following examples, assume that .Cm @cwd is set to .Pa /usr/local @@ -371,7 +394,8 @@ Expand to the .Dq basename of the fully qualified filename, that is the current directory prefix, plus the last filespec, minus -the trailing filename. In the example case, that would be +the trailing filename. +In the example case, that would be .Pa /usr/local/bin . .It Cm "%f" Expand to the @@ -385,17 +409,20 @@ being in the example case, .It Cm @unexec Ar command Execute .Ar command -as part of the deinstallation process. Expansion of special +as part of the deinstallation process. +Expansion of special .Cm % sequences is the same as for .Cm @exec . This command is not executed during the package add, as .Cm @exec -is, but rather when the package is deleted. This is useful +is, but rather when the package is deleted. +This is useful for deleting links and other ancillary files that were created as a result of adding the package, but not directly known to the package's table of contents (and hence not automatically -removable). The advantage of using +removable). +The advantage of using .Cm @unexec over a deinstallation script is that you can use the .Dq special sequence expansion @@ -408,7 +435,8 @@ Set default permission for all subsequently extracted files to Format is the same as that used by the .Cm chmod command (well, considering that it's later handed off to it, that's -no surprise). Use without an arg to set back to default (extraction) +no surprise). +Use without an arg to set back to default (extraction) permissions. .It Cm @option Ar option Set internal package options, the only two currently supported ones @@ -433,7 +461,8 @@ Set default group ownership for all subsequently extracted files to Use without an arg to set back to default (extraction) group ownership. .It Cm @comment Ar string -Imbed a comment in the packing list. Useful in +Imbed a comment in the packing list. +Useful in trying to document some particularly hairy sequence that may trip someone up later. .It Cm @ignore @@ -442,27 +471,34 @@ copy it anywhere), as it's used for some special purpose. .It Cm @ignore_inst Similar to .Cm @ignore , -but the ignoring of the next file is delayed one evaluation cycle. This +but the ignoring of the next file is delayed one evaluation cycle. +This makes it possible to use this directive in the .Ar packinglist file, so you can pack a specialized datafile in with a distribution for your install script (or something) yet have the installer ignore it. .It Cm @name Ar name -Set the name of the package. This is mandatory and is usually -put at the top. This name is potentially different from the name of +Set the name of the package. +This is mandatory and is usually +put at the top. +This name is potentially different from the name of the file it came in, and is used when keeping track of the package -for later deinstallation. Note that +for later deinstallation. +Note that .Nm will derive this field from the package name and add it automatically if none is given. .It Cm @dirrm Ar name Declare directory .Pa name -to be deleted at deinstall time. By default, directories created by a +to be deleted at deinstall time. +By default, directories created by a package installation are not deleted when the package is deinstalled; -this provides an explicit directory cleanup method. This directive -should appear at the end of the package list. If more than one +this provides an explicit directory cleanup method. +This directive +should appear at the end of the package list. +If more than one .Cm @dirrm directives are used, the directories are removed in the order specified. The @@ -475,7 +511,8 @@ as an .Xr mtree 8 input file to be used at install time (see .Fl m -above). Only the first +above). +Only the first .Cm @mtree directive is honored. .It Cm @display Ar name @@ -487,12 +524,14 @@ above). .It Cm @pkgdep Ar pkgname Declare a dependency on the .Ar pkgname -package. The +package. +The .Ar pkgname package must be installed before this package may be installed, and this package must be deinstalled before the .Ar pkgname -package is deinstalled. Multiple +package is deinstalled. +Multiple .Cm @pkgdep directives may be used if the package depends on multiple other packages. .It Cm @conflicts Ar pkgcflname @@ -555,7 +594,8 @@ command first appeared in Hard links between files in a distribution must be bracketed by .Cm @cwd directives in order to be preserved as hard links when the package is -extracted. They additionally must not end up being split between +extracted. +They additionally must not end up being split between .Cm tar invocations due to exec argument-space limitations (this depends on the value returned by diff --git a/usr.sbin/pkg_install/delete/pkg_delete.1 b/usr.sbin/pkg_install/delete/pkg_delete.1 index 9c7cc86..92f22fa 100644 --- a/usr.sbin/pkg_install/delete/pkg_delete.1 +++ b/usr.sbin/pkg_install/delete/pkg_delete.1 @@ -49,7 +49,8 @@ or other subtle attacks from miscreants who create dangerous package files. .Pp You are advised to verify the competence and identity of those who -provide installable package files. For extra protection, examine all +provide installable package files. +For extra protection, examine all the package control files in the package record directory .Pa ( /var/db/pkg/<pkg-name>/ ) . Pay particular attention to any +INSTALL, +POST-INSTALL, +DEINSTALL, @@ -88,15 +89,18 @@ would be taken if it were. Set .Ar prefix as the directory in which to delete files from any installed packages -which do not explicitly set theirs. For most packages, the prefix will +which do not explicitly set theirs. +For most packages, the prefix will be set automatically to the installed location by .Xr pkg_add 1 . .It Fl d -Remove empty directories created by file cleanup. By default, only +Remove empty directories created by file cleanup. +By default, only files/directories explicitly listed in a package's contents (either as normal files/directories or with the .Cm @dirrm -directive) will be removed at deinstallation time. This option tells +directive) will be removed at deinstallation time. +This option tells .Nm to also remove any directories that were emptied as a result of removing the package. @@ -114,7 +118,8 @@ automatically expands shell glob patterns in the Treat the .Ar pkg-name as a regular expression and delete all packages whose names match -that regular expression. Multiple regular expressions could be +that regular expression. +Multiple regular expressions could be provided, in that case .Nm deletes all packages that match at least one @@ -126,14 +131,16 @@ but treats the .Ar pkg-name as an extended regular expression. .It Fl r -Recursive removal. In addition to specified packages, delete all +Recursive removal. +In addition to specified packages, delete all packages that depend on those packages as well. .El .Sh TECHNICAL DETAILS The .Nm utility -does pretty much what it says. It examines installed package records in +does pretty much what it says. +It examines installed package records in .Pa /var/db/pkg/<pkg-name> , deletes the package contents, and finally removes the package records. If the environment variable @@ -164,7 +171,8 @@ then this is executed first as is the name of the package in question and .Ar DEINSTALL is a keyword denoting that this is a deinstallation) -to see whether or not deinstallation should continue. A non-zero exit +to see whether or not deinstallation should continue. +A non-zero exit status means no, unless the .Fl f option is specified. @@ -205,7 +213,8 @@ If a .Cm post-deinstall script exists for the package, it is executed .Cm after -all files are removed. It is this script's responsibility to clean up any +all files are removed. +It is this script's responsibility to clean up any additional messy details around the package's installation, and leave the system (hopefully) in the same state that it was prior to the installation of the package. @@ -250,7 +259,8 @@ All scripts are called with the environment variable .Ev PKG_PREFIX set to the installation prefix (see the .Fl p -option above). This allows a package author to write a script +option above). +This allows a package author to write a script that reliably performs some action on the directory where the package is installed, even if the user might have changed it by specifying the .Fl p diff --git a/usr.sbin/pkg_install/info/pkg_info.1 b/usr.sbin/pkg_install/info/pkg_info.1 index 1fd2c11..b8f5259 100644 --- a/usr.sbin/pkg_install/info/pkg_info.1 +++ b/usr.sbin/pkg_install/info/pkg_info.1 @@ -51,14 +51,16 @@ command. The following command line options are supported: .Bl -tag -width indent .It Ar pkg-name ... -The named packages are described. A package name may either be the name of +The named packages are described. +A package name may either be the name of an installed package, the pathname to a package distribution file or a URL to an FTP available package. Package version numbers can also be matched in a relational manner using the .Pa \*[Ge], \*[Le], \*[Gt] and .Pa \*[Lt] -operators. For example, +operators. +For example, .Pa pkg_info 'portupgrade\*[Ge]20030723' will match versions 20030723 and later of the .Pa portupgrade @@ -97,7 +99,8 @@ Show files that don't match the recorded checksum. .It Fl i Show the install script (if any) for each package. .It Fl I -Show an index line for each package. This option takes +Show an index line for each package. +This option takes precedence over all other package formatting options. .It Fl j Show the requirements script (if any) for each package. @@ -110,7 +113,8 @@ Show the list of installed packages which require each package. .It Fl m Show the mtree file (if any) for each package. .It Fl L -Show the files within each package. This is different from just +Show the files within each package. +This is different from just viewing the packing list, since full pathnames for everything are generated. .It Fl s @@ -118,7 +122,8 @@ Show the total size occupied by files installed within each package. .It Fl o Show the .Dq origin -path recorded on package generation. This path +path recorded on package generation. +This path intended to give an idea as to where the underlying port, from which package was generated, is located in the .Fx @@ -133,7 +138,8 @@ automatically expands shell glob patterns in the .It Fl W For the specified .Ar filename -argument show which package it belongs to. If the file is not in the +argument show which package it belongs to. +If the file is not in the current directory, and does not have an absolute path, then the .Ev PATH is searched using @@ -146,7 +152,8 @@ argument list all packages having this origin. Treat the .Ar pkg-name as a regular expression and display information only for packages -whose names match that regular expression. Multiple regular +whose names match that regular expression. +Multiple regular expressions could be provided, in that case .Nm displays information about all packages that match at least one @@ -160,11 +167,13 @@ as an extended regular expression. .It Fl e Ar pkg-name If the package identified by .Ar pkg-name -is currently installed, return 0, otherwise return 1. This option +is currently installed, return 0, otherwise return 1. +This option allows you to easily test for the presence of another (perhaps prerequisite) package from a script. .It Fl E -Show only matching package names. This option takes +Show only matching package names. +This option takes precedence over all other package formatting options. If any packages match, return 0, otherwise return 1. .It Fl l Ar str @@ -175,7 +184,8 @@ shown with This is primarily of use to front-end programs who want to request a lot of different information fields at once for a package, but don't necessary want the output intermingled in such a way that they can't -organize it. This lets you add a special token to the start of +organize it. +This lets you add a special token to the start of each field. .It Fl t Ar template Use @@ -189,7 +199,8 @@ By default, this is the string but it may be necessary to override it in the situation where space in your .Pa /tmp -directory is limited. Be sure to leave some number of `X' characters +directory is limited. +Be sure to leave some number of `X' characters for .Xr mktemp 3 to fill in with a unique ID. @@ -224,7 +235,8 @@ Points to the directory where creates its temporary files. If this variable is not set, .Ev TMPDIR -is used. If both are unset, the builtin defaults are used. +is used. +If both are unset, the builtin defaults are used. .It Ev PKG_DBDIR Specifies an alternative location for the installed package database. .El diff --git a/usr.sbin/pkg_install/sign/pkg_sign.1 b/usr.sbin/pkg_install/sign/pkg_sign.1 index e8af93d..118d380 100644 --- a/usr.sbin/pkg_install/sign/pkg_sign.1 +++ b/usr.sbin/pkg_install/sign/pkg_sign.1 @@ -103,7 +103,8 @@ For the signing key or verification certificate may be specified with the .Fl k -option. If not specified, packages are signed or verified with the +option. +If not specified, packages are signed or verified with the default keys and certificates documented below. .Pp If diff --git a/usr.sbin/pkg_install/version/pkg_version.1 b/usr.sbin/pkg_install/version/pkg_version.1 index ac1ac91..6ef25ae 100644 --- a/usr.sbin/pkg_install/version/pkg_version.1 +++ b/usr.sbin/pkg_install/version/pkg_version.1 @@ -53,7 +53,8 @@ installed using the command. .Pp Each package's version number is checked against one of two sources to -see if that package may require updating. If the package contains +see if that package may require updating. +If the package contains information about its origin in the .Fx ports tree, and a version number can be determined from the port's @@ -155,7 +156,7 @@ The output consists of one of the single characters This flag is mostly useful for scripts or for testing. .It Fl T Test whether -.Ar pkgname +.Ar pkgname is matched by .Ar pattern and set the exit code accordingly. @@ -164,16 +165,21 @@ can also be used in `filter mode': When one of the arguments is `-', standard input is used, and lines with matching package names/patterns are echoed to standard output. .It Fl v -Enable verbose output. Verbose output includes some English-text +Enable verbose output. +Verbose output includes some English-text interpretations of the version number comparisons, as well as the -version numbers compared for each package. Non-verbose output is +version numbers compared for each package. +Non-verbose output is probably easier for programs or scripts to parse. .It Ar index -Specify the index to be used as a basis of comparison. This index can -be specified as a filename (in the local file system) or a URL. Any +Specify the index to be used as a basis of comparison. +This index can +be specified as a filename (in the local file system) or a URL. +Any URL understandable by .Xr fetch 1 -can be used here. If no +can be used here. +If no .Ar index file is specified on the command line, .Pa /usr/ports/INDEX-5 diff --git a/usr.sbin/ppp/ppp.8.m4 b/usr.sbin/ppp/ppp.8.m4 index 67b36cb..d5fe150 100644 --- a/usr.sbin/ppp/ppp.8.m4 +++ b/usr.sbin/ppp/ppp.8.m4 @@ -259,7 +259,7 @@ will force it to exit. can use either the standard LCP callback protocol or the Microsoft CallBack Control Protocol (ftp://ftp.microsoft.com/developr/rfc/cbcp.txt). .It Supports NAT or packet aliasing. -Packet aliasing (a.k.a. IP masquerading) allows computers on a +Packet aliasing (a.k.a.\& IP masquerading) allows computers on a private, unregistered network to access the Internet. The .Em PPP @@ -1624,7 +1624,7 @@ in your profile). .Sh NETWORK ADDRESS TRANSLATION (PACKET ALIASING) The .Fl nat -command line option enables network address translation (a.k.a. packet +command line option enables network address translation (a.k.a.\& packet aliasing). This allows the .Nm @@ -3473,9 +3473,11 @@ If no arguments are given, firewall punching is disabled. .It nat skinny_port Op Ar port This command tells .Nm -which TCP port is used by the Skinny Station protocol. Skinny is used by +which TCP port is used by the Skinny Station protocol. +Skinny is used by Cisco IP phones to communicate with Cisco Call Managers to setup voice -over IP calls. The typical port used by Skinny is 2000. +over IP calls. +The typical port used by Skinny is 2000. .Pp If no argument is given, skinny aliasing is disabled. .It nat same_ports yes|no @@ -5369,7 +5371,8 @@ keywords. .Pp .It RAD_FRAMED_IPV6_PREFIX If this attribute is supplied, the value is substituted for IPV6PREFIX -in a command. You may pass it to such as DHCPv6 for delegating an +in a command. +You may pass it to such as DHCPv6 for delegating an IPv6 prefix to a peer. .It RAD_FRAMED_IPV6_ROUTE The received string is expected to be in the format @@ -5410,7 +5413,8 @@ would result in a default route to .Dv HISADDR6 . .Pp All RADIUS IPv6 routes are applied after any sticky routes are -applied, making RADIUS IPv6 routes override configured routes. This +applied, making RADIUS IPv6 routes override configured routes. +This also applies for RADIUS IPv6 routes that don't {include} the .Dv MYADDR6 or @@ -5459,14 +5463,16 @@ encryption. If this .Dv RAD_VENDOR_MICROSOFT vendor specific attribute is supplied, it's value is used as the master -key for decryption of incoming data. When clients are authenticated using +key for decryption of incoming data. +When clients are authenticated using MSCHAPv2, the RADIUS server MUST provide this attribute if inbound MPPE is to function. .It RAD_MICROSOFT_MS_MPPE_SEND_KEY If this .Dv RAD_VENDOR_MICROSOFT vendor specific attribute is supplied, it's value is used as the master -key for encryption of outgoing data. When clients are authenticated using +key for encryption of outgoing data. +When clients are authenticated using MSCHAPv2, the RADIUS server MUST provide this attribute if outbound MPPE is to function. .El @@ -5758,7 +5764,7 @@ Word replacement is done in the same way as for the .Dq !bg command as described above. .Pp -Use of the ! character +Use of the !\& character requires a following space as with any of the other commands. You should note that this command is executed in the foreground; .Nm diff --git a/usr.sbin/pppctl/pppctl.8 b/usr.sbin/pppctl/pppctl.8 index c512591..3d807dc 100644 --- a/usr.sbin/pppctl/pppctl.8 +++ b/usr.sbin/pppctl/pppctl.8 @@ -21,24 +21,29 @@ .Sh DESCRIPTION This utility provides command line control of the .Xr ppp 8 -daemon. Its primary use is to facilitate simple scripts that +daemon. +Its primary use is to facilitate simple scripts that control a running daemon. .Pp The .Nm utility is passed at least one argument, specifying the socket on which .Nm ppp -is listening. Refer to the +is listening. +Refer to the .Sq set server command of .Nm ppp -for details. If the socket contains a leading '/', it +for details. +If the socket contains a leading '/', it is taken as an .Dv AF_LOCAL -socket. If it contains a colon, it is treated as a +socket. +If it contains a colon, it is treated as a .Ar host : Ns Ar port pair, otherwise it is treated as a TCP port specification on the -local machine (127.0.0.1). Both the +local machine (127.0.0.1). +Both the .Ar host and .Ar port @@ -50,7 +55,8 @@ All remaining arguments are concatenated to form the .Ar command Ns (s) that will be sent to the .Nm ppp -daemon. If any semi-colon characters are found, they are treated as +daemon. +If any semi-colon characters are found, they are treated as .Ar command delimiters, allowing more than one .Ar command @@ -73,7 +79,8 @@ When reading commands, the .Xr editline 3 library is used, allowing command-line editing (with .Xr editrc 5 -defining editing behaviour). The history size +defining editing behaviour). +The history size defaults to .Em 20 lines . .Pp @@ -82,19 +89,23 @@ The following command line options are available: .It Fl v Display all data sent to and received from the .Nm ppp -daemon. Normally, +daemon. +Normally, .Nm -displays only non-prompt lines received. This option is ignored in +displays only non-prompt lines received. +This option is ignored in interactive mode. .It Fl t Ar n Use a timeout of .Ar n -instead of the default 2 seconds when connecting. This may be required +instead of the default 2 seconds when connecting. +This may be required if you wish to control a daemon over a slow (or even a dialup) link. .It Fl p Ar passwd Specify the password required by the .Nm ppp -daemon. If this switch is not used, +daemon. +If this switch is not used, .Nm will prompt for a password once it has successfully connected to .Nm ppp . @@ -108,7 +119,8 @@ mode, .Nm can be used to automate many frequent tasks (you can actually control .Nm ppp -in any mode except interactive mode). Use of the +in any mode except interactive mode). +Use of the .Fl p option is discouraged (even in scripts that aren't readable by others) as a @@ -133,7 +145,8 @@ Refer to the .Xr ppp 8 man page for further details. .Pp -You can now create some easy-access scripts. To connect to the internet: +You can now create some easy-access scripts. +To connect to the internet: .Bd -literal -offset indent #! /bin/sh test $# -eq 0 && time=300 || time=$1 @@ -165,10 +178,12 @@ exec pppctl /var/run/internet "$@" .Pp You could also use .Nm -to control when dial-on-demand works. Suppose you want +to control when dial-on-demand works. +Suppose you want .Nm ppp to run all the time, but you want to prevent dial-out between 8pm and 8am -each day. However, any connections active at 8pm should continue to remain +each day. +However, any connections active at 8pm should continue to remain active until they are closed or naturally time out. .Pp A @@ -190,10 +205,14 @@ The following environment variables are understood by when in interactive mode: .Bl -tag -width XXXXXXXXXX .It Dv EL_SIZE -The number of history lines. The default is 20. +The number of history lines. +The default is 20. .It Dv EL_EDITOR -The edit mode. Only values of "emacs" and "vi" are accepted. Other values -are silently ignored. This environment variable will override the +The edit mode. +Only values of "emacs" and "vi" are accepted. +Other values +are silently ignored. +This environment variable will override the .Ar bind -v and .Ar bind -e diff --git a/usr.sbin/pstat/pstat.8 b/usr.sbin/pstat/pstat.8 index f816222..382e241 100644 --- a/usr.sbin/pstat/pstat.8 +++ b/usr.sbin/pstat/pstat.8 @@ -122,8 +122,10 @@ The file offset (see .It Fl s Print information about swap space usage on all the swap areas compiled into the kernel. -The first column is the device name of the partition. The next column is -the total space available in the partition. The +The first column is the device name of the partition. +The next column is +the total space available in the partition. +The .Ar Used column indicates the total blocks used so far; the .Ar Available diff --git a/usr.sbin/pw/pw.8 b/usr.sbin/pw/pw.8 index 0220564..2279501 100644 --- a/usr.sbin/pw/pw.8 +++ b/usr.sbin/pw/pw.8 @@ -814,7 +814,8 @@ The and .Ar unlock commands take a user name or uid of the account to lock or unlock, -respectively. The +respectively. +The .Fl V , .Fl C , and diff --git a/usr.sbin/pwd_mkdb/pwd_mkdb.8 b/usr.sbin/pwd_mkdb/pwd_mkdb.8 index e3dc642..9d47412 100644 --- a/usr.sbin/pwd_mkdb/pwd_mkdb.8 +++ b/usr.sbin/pwd_mkdb/pwd_mkdb.8 @@ -74,8 +74,10 @@ change, add, or remove any files. .It Fl N Tell .Nm -to exit with an error if it cannot obtain a lock on the file. By default, -we block waiting for a lock on the source file. The lock is held through +to exit with an error if it cannot obtain a lock on the file. +By default, +we block waiting for a lock on the source file. +The lock is held through the rebuilding of the database. .It Fl p Create a Version 7 style password file and install it into @@ -84,17 +86,20 @@ Create a Version 7 style password file and install it into Store databases into specified destination directory instead of .Pa /etc . .It Fl u Ar username -Only update the record for the specified user. Utilities that +Only update the record for the specified user. +Utilities that operate on a single user can use this option to avoid the overhead of rebuilding the entire database. .It Fl s Ar cachesize Specify in megabytes the size of the memory cache used by the -hashing library. On systems with a large user base, a small cache +hashing library. +On systems with a large user base, a small cache size can lead to prohibitively long database file rebuild times. As a rough guide, the memory usage of .Nm in megabytes will be a little bit more than twice the figure -specified here. The default is 2 megabytes. +specified here. +The default is 2 megabytes. .El .Pp The two databases differ in that the secure version contains the user's diff --git a/usr.sbin/quot/quot.8 b/usr.sbin/quot/quot.8 index ffa9971..eb4a9a7 100644 --- a/usr.sbin/quot/quot.8 +++ b/usr.sbin/quot/quot.8 @@ -66,7 +66,8 @@ By default, all sizes are reported in 512-byte block counts. .It Fl n Given a list of inodes (plus some optional data on each line) in the standard input, for each file print out the owner (plus -the remainder of the input line). This is traditionally used +the remainder of the input line). +This is traditionally used in the pipe: .Bd -literal -offset indent .\" ncheck filesystem | sort +0n | quot -n filesystem diff --git a/usr.sbin/rmt/rmt.8 b/usr.sbin/rmt/rmt.8 index ed7dcb2..be81be3 100644 --- a/usr.sbin/rmt/rmt.8 +++ b/usr.sbin/rmt/rmt.8 @@ -45,7 +45,8 @@ The .Nm utility is used by the remote dump and restore programs in manipulating a magnetic tape drive through an interprocess -communication connection. It is normally started up with an +communication connection. +It is normally started up with an .Xr rexec 3 or .Xr rcmd 3 @@ -55,7 +56,8 @@ The .Nm utility accepts requests specific to the manipulation of magnetic tapes, performs the commands, then responds with -a status indication. All responses are in +a status indication. +All responses are in .Tn ASCII and in one of two forms. @@ -118,7 +120,8 @@ closed before a new open is performed. .It Xo Sy C Ar device No \en .Xc .Sm on -Close the currently open device. The +Close the currently open device. +The .Ar device specified is ignored. .Sm off @@ -167,7 +170,8 @@ and responds with .Sm on if the read was successful; otherwise an error in the -standard format is returned. If the read +standard format is returned. +If the read was successful, the data read is then sent. .Sm off .It Xo Sy I Ar operation @@ -187,7 +191,8 @@ and .Ar mt_count fields of the structure used in the .Xr ioctl 2 -call. The return value is the +call. +The return value is the .Ar count parameter when the operation is successful. .It Sy S @@ -195,7 +200,8 @@ Return the status of the open device, as obtained with a .Dv MTIOCGET .Xr ioctl 2 -call. If the operation was successful, +call. +If the operation was successful, an ``ack'' is sent with the size of the status buffer, then the status buffer is sent (in binary). diff --git a/usr.sbin/rpc.statd/rpc.statd.8 b/usr.sbin/rpc.statd/rpc.statd.8 index 730f195..4d03546 100644 --- a/usr.sbin/rpc.statd/rpc.statd.8 +++ b/usr.sbin/rpc.statd/rpc.statd.8 @@ -49,13 +49,16 @@ utility is a daemon which co-operates with .Nm daemons on other hosts to provide -a status monitoring service. The daemon accepts requests from +a status monitoring service. +The daemon accepts requests from programs running on the local host (typically, .Xr rpc.lockd 8 , the NFS file locking daemon) to monitor the status of specified -hosts. If a monitored host crashes and restarts, the remote daemon will +hosts. +If a monitored host crashes and restarts, the remote daemon will notify the local daemon, which in turn will notify the local program(s) -which requested the monitoring service. Conversely, if this host crashes +which requested the monitoring service. +Conversely, if this host crashes and re-starts, when the .Nm re-starts, it will notify all of the hosts which were being monitored @@ -65,8 +68,10 @@ The following option is available: .Bl -tag -width indent .It Fl d Cause debugging information to be written to syslog, recording -all RPC transactions to the daemon. These messages are logged with level -LOG_DEBUG and facility LOG_DAEMON. Error conditions are logged irrespective +all RPC transactions to the daemon. +These messages are logged with level +LOG_DEBUG and facility LOG_DAEMON. +Error conditions are logged irrespective of this option, using level LOG_ERR. .El .Pp @@ -91,8 +96,9 @@ RPC protocol specification used by local applications to register monitoring req .Xr rpc.lockd 8 .Sh BUGS There is no means for the daemon to tell when a monitored host has -disappeared permanently (eg. catastrophic hardware failure), as opposed -to transient failure of the host or an intermediate router. At present, +disappeared permanently (e.g.\& catastrophic hardware failure), as opposed +to transient failure of the host or an intermediate router. +At present, it will re-try notification attempts at frequent intervals for 10 minutes, then hourly, and finally gives up after 24 hours. .Pp @@ -102,7 +108,8 @@ This is convenient for the NFS locking protocol, but probably reduces the usefulness of the monitoring system for other applications. .Pp The current implementation uses more than 1Kbyte per monitored host in -the status file (and also in VM). This may be inefficient for NFS servers +the status file (and also in VM). +This may be inefficient for NFS servers with large numbers of clients. .Sh STANDARDS The implementation is based on the specification in X/Open CAE Specification diff --git a/usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 b/usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 index ba85e57..7f0dce6 100644 --- a/usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 +++ b/usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 @@ -125,7 +125,8 @@ 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 -check is bypassed). Furthermore, if the server is invoked with the +check is bypassed). +Furthermore, if the server is invoked with the .Fl a flag, the super-user can even add new entries to the maps using .Xr ypchpass 1 . diff --git a/usr.sbin/rrenumd/rrenumd.conf.5 b/usr.sbin/rrenumd/rrenumd.conf.5 index fde2a92..b0f2887 100644 --- a/usr.sbin/rrenumd/rrenumd.conf.5 +++ b/usr.sbin/rrenumd/rrenumd.conf.5 @@ -222,12 +222,12 @@ for the assigned interface. If .Cm on is specified, the prefix have on-link nature -(e.g. the prefix +(e.g.\& the prefix belong to the link). If .Cm off is specified, the prefix have off-link nature -(e.g. the +(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 diff --git a/usr.sbin/rtprio/rtprio.1 b/usr.sbin/rtprio/rtprio.1 index 6d4d260..a8986fb 100644 --- a/usr.sbin/rtprio/rtprio.1 +++ b/usr.sbin/rtprio/rtprio.1 @@ -105,7 +105,8 @@ will be modified, else if is specified, that program is run with its arguments. .Pp .Ar Priority -is an integer between 0 and RTP_PRIO_MAX (usually 31). 0 is the +is an integer between 0 and RTP_PRIO_MAX (usually 31). +0 is the highest priority .Pp .Ar Pid diff --git a/usr.sbin/rtsold/rtsold.8 b/usr.sbin/rtsold/rtsold.8 index 1e2a3bf..d7e84a4 100644 --- a/usr.sbin/rtsold/rtsold.8 +++ b/usr.sbin/rtsold/rtsold.8 @@ -255,7 +255,8 @@ and reinserted, the corresponding interface index is changed. However, .Nm assumes such changes will not occur, and always uses the index that -it got at invocation. As a result, +it got at invocation. +As a result, .Nm may not work if you reinsert a network card. In such a case, diff --git a/usr.sbin/rwhod/rwhod.8 b/usr.sbin/rwhod/rwhod.8 index e072697..0d861cc 100644 --- a/usr.sbin/rwhod/rwhod.8 +++ b/usr.sbin/rwhod/rwhod.8 @@ -51,7 +51,8 @@ utility is the server which maintains the database used by the .Xr rwho 1 and .Xr ruptime 1 -programs. Its operation is predicated on the ability to +programs. +Its operation is predicated on the ability to .Em broadcast or .Em multicast @@ -82,7 +83,8 @@ to ignore the source port on incoming packets. .It Fl p Ignore all .Dv POINTOPOINT -interfaces. This is useful if you do not wish to keep dial on demand +interfaces. +This is useful if you do not wish to keep dial on demand interfaces permanently active. .It Fl l Enable listen mode, which causes @@ -97,7 +99,8 @@ Cause to use IP multicast (instead of broadcast) on all interfaces that have the IFF_MULTICAST flag set in their "ifnet" structs -(excluding the loopback interface). The multicast +(excluding the loopback interface). +The multicast reports are sent with a time-to-live of 1, to prevent forwarding beyond the directly-connected subnet(s). .Pp @@ -114,7 +117,8 @@ via a SINGLE interface rather than all interfaces. .Ar ttl must be between 0 and -32 (or MAX_MULTICAST_SCOPE). Note that +32 (or MAX_MULTICAST_SCOPE). +Note that .Fl m Ar 1 is different from .Fl m , @@ -128,14 +132,17 @@ is used without a .Ar ttl argument, the program accepts multicast .Nm -reports from all multicast-capable interfaces. If a +reports from all multicast-capable interfaces. +If a .Ar ttl argument is given, it accepts multicast reports from only one interface, the one on which reports are sent (which may be controlled via the host's routing -table). Regardless of the +table). +Regardless of the .Fl m option, the program accepts broadcast or -unicast reports from all interfaces. Thus, this program will hear the +unicast reports from all interfaces. +Thus, this program will hear the reports of old, non-multicasting .Nm Ns s , but, if multicasting is used, @@ -172,16 +179,19 @@ struct whod { .Ed .Pp All fields are converted to network byte order prior to -transmission. The load averages are as calculated by the +transmission. +The load averages are as calculated by the .Xr w 1 program, and represent load averages over the 5, 10, and 15 minute intervals prior to a server's transmission; they are multiplied by 100 -for representation in an integer. The host name +for representation in an integer. +The host name included is that returned by the .Xr gethostname 3 system call, with any trailing domain name omitted. The array at the end of the message contains information about -the users logged in to the sending machine. This information +the users logged in to the sending machine. +This information includes the contents of the .Xr utmp 5 entry for each non-idle terminal line and a value indicating the @@ -193,11 +203,13 @@ server are discarded unless they originated at an .Nm rwho server's port or the .Fl i -option was specified. In addition, if the host's name, as specified +option was specified. +In addition, if the host's name, as specified in the message, contains any unprintable .Tn ASCII characters, the -message is discarded. Valid messages received by +message is discarded. +Valid messages received by .Nm are placed in files named .Pa whod.hostname diff --git a/usr.sbin/sa/sa.8 b/usr.sbin/sa/sa.8 index 794626e..ac78d24 100644 --- a/usr.sbin/sa/sa.8 +++ b/usr.sbin/sa/sa.8 @@ -69,7 +69,8 @@ If file names are supplied, they are read instead of .Pa /var/account/acct . After each file is read, if the summary files are being updated, an updated summary will -be saved to disk. Only one report is printed, +be saved to disk. +Only one report is printed, after the last file is processed. .Pp The labels used in the output indicate the following, except @@ -102,7 +103,8 @@ are: .Bl -tag -width Ds .It Fl a List all command names, including those containing unprintable -characters and those used only once. By default, +characters and those used only once. +By default, .Nm places all names containing unprintable characters and those used only once under the name ``***other''. @@ -114,7 +116,8 @@ In addition to the number of calls and the user, system and real times for each command, print their percentage of the total over all commands. .It Fl d If printing command statistics, sort by the average number of disk -I/O operations. If printing user statistics, print the average number of +I/O operations. +If printing user statistics, print the average number of disk I/O operations per user. .It Fl D If printing command statistics, sort and print by the total number @@ -129,7 +132,8 @@ Do not read in the summary files. Instead of the total minutes per category, give seconds per call. .It Fl k If printing command statistics, sort by the cpu-time average memory -usage. If printing user statistics, print the cpu-time average +usage. +If printing user statistics, print the cpu-time average memory usage. .It Fl K If printing command statistics, print and sort by the cpu-storage integral. @@ -160,20 +164,25 @@ command name. For each command used .Ar cutoff times or fewer, print the command name and await a reply -from the terminal. If the reply begins with ``y'', add -the command to the category ``**junk**''. This flag is +from the terminal. +If the reply begins with ``y'', add +the command to the category ``**junk**''. +This flag is used to strip garbage from the report. .El .Pp -By default, per-command statistics will be printed. The number of +By default, per-command statistics will be printed. +The number of calls, the total elapsed time in minutes, total cpu and user time in minutes, average number of I/O operations, and CPU-time -averaged core usage will be printed. If the +averaged core usage will be printed. +If the .Fl m option is specified, per-user statistics will be printed, including the user name, the number of commands invoked, total cpu time used (in minutes), total number of I/O operations, and CPU storage integral -for each user. If the +for each user. +If the .Fl u option is specified, the uid, user and system time (in seconds), CPU storage integral, I/O usage, and command name will be printed @@ -183,7 +192,8 @@ If the .Fl u flag is specified, all flags other than .Fl q -are ignored. If the +are ignored. +If the .Fl m flag is specified, only the .Fl b , @@ -221,7 +231,8 @@ The VM system does not record the CPU storage integral. While the behavior of the options in this version of .Nm was modeled after the original version, there are some intentional -differences and undoubtedly some unintentional ones as well. In +differences and undoubtedly some unintentional ones as well. +In particular, the .Fl q option has been added, and the diff --git a/usr.sbin/sade/sade.8 b/usr.sbin/sade/sade.8 index b1b04bb..e708bbb 100644 --- a/usr.sbin/sade/sade.8 +++ b/usr.sbin/sade/sade.8 @@ -72,12 +72,14 @@ of the library) and install distributions or packages onto new and existing .Fx -systems. It also contains some extra intelligence +systems. +It also contains some extra intelligence for running as a replacement for .Xr init 8 when it's invoked by the .Fx -installation boot procedure. It +installation boot procedure. +It assumes very little in the way of additional utility support and performs most file system operations by calling the relevant syscalls (such as @@ -101,7 +103,8 @@ eventually be replaced. The .Nm utility may be either driven interactively through its various internal menus -or run in batch mode, driven by an external script. Such a script may +or run in batch mode, driven by an external script. +Such a script may be loaded and executed in one of 3 ways: .Bl -tag -width Ds .It Sy "LOAD_CONFIG_FILE" @@ -127,8 +130,9 @@ it then will attempt to load from a DOS or UFS formatted floppy. Each command line argument is treated as a script directive when .Nm -is run in multi-user mode. Execution ends either by explicit request -(e.g. calling the +is run in multi-user mode. +Execution ends either by explicit request +(e.g.\& calling the .Ar shutdown directive), upon reaching the end of the argument list or on error. .Pp @@ -157,14 +161,15 @@ Where .Ar var=value is the assignment of some internal .Nm -variable, e.g. "ftpPass=FuNkYChiKn", and +variable, e.g.\& "ftpPass=FuNkYChiKn", and .Ar function is the name of an internal .Nm -function, e.g. "mediaSetFTP", and +function, e.g.\& "mediaSetFTP", and .Ar #comment is a single-line comment for documentation purposes (ignored by -sysinstall). Each directive must be by itself on a single line, +sysinstall). +Each directive must be by itself on a single line, functions taking their arguments by examining known variable names. This requires that you be sure to assign the relevant variables before calling a function which requires them. @@ -253,7 +258,8 @@ Invokes the disk partition (MBR) editor. .Sy Variables : .Bl -tag -width findx .It geometry -The disk geometry, as a cyls/heads/sectors formatted string. Default: no +The disk geometry, as a cyls/heads/sectors formatted string. +Default: no change to geometry. .It partition Set to disk partitioning type or size, its value being @@ -305,13 +311,15 @@ function) to be written out. .Sy Variables : None .It diskLabelEditor -Invokes the disk label editor. This is a bit trickier from a script +Invokes the disk label editor. +This is a bit trickier from a script since you need to essentially label everything inside each .Fx (type 0xA5) partition created by the .Ar diskPartitionEditor function, and that requires knowing a few rules about how things are -laid out. When creating a script to automatically allocate disk space +laid out. +When creating a script to automatically allocate disk space and partition it up, it is suggested that you first perform the installation interactively at least once and take careful notes as to what the slice names will be, then and only then hardwiring them into @@ -327,7 +335,8 @@ for the whole partition .Ar ( da0s1 being your DOS primary -partition). Now let's further assume that you have 500MB in this +partition). +Now let's further assume that you have 500MB in this partition and you want to sub-partition that space into root, swap, var and usr file systems for .Fx . @@ -350,16 +359,19 @@ the mount point, if non-zero, means to set the soft updates flag). One can also use the .Ar diskLabelEditor for mounting or erasing existing partitions as well as creating new -ones. Using the previous example again, let's say that we also wanted +ones. +Using the previous example again, let's say that we also wanted to mount our DOS partition and make sure that an .Pa /etc/fstab -entry is created for it in the new installation. Before calling the +entry is created for it in the new installation. +Before calling the .Ar diskLabelEditor function, we simply add an additional line: .Pp .Dl "da0s1=/dos_c N" .Pp -before the call. This tells the label editor that you want to mount +before the call. +This tells the label editor that you want to mount the first slice on .Pa /dos_c and not to attempt to newfs it (not that @@ -392,13 +404,14 @@ Resets all selected distributions to the empty set (no distributions selected). .Sy Variables : None .It distSetCustom -Allows the selection of a custom distribution set (e.g. not just one of the +Allows the selection of a custom distribution set (e.g.\& not just one of the existing "canned" sets) with no user interaction. .Pp .Sy Variables : .Bl -tag -width indent .It dists -List of distributions to load. Possible distribution values are: +List of distributions to load. +Possible distribution values are: .Bl -tag -width indentxx .It Li base The base binary distribution. @@ -655,10 +668,12 @@ Defaults to latest links package. .It browserBinary The name of the browser binary itself (if overriding the .Ar browserPackage -variable). Defaults to links. +variable). +Defaults to links. .El .It installCommit -Commit any and all pending changes to disk. This function +Commit any and all pending changes to disk. +This function is essentially shorthand for a number of more granular "commit" functions. .Pp @@ -683,7 +698,8 @@ Start an upgrade installation. None .It installFixitHoloShell Start up the "emergency holographic shell" over on VTY4 -if running as init. This will also happen automatically +if running as init. +This will also happen automatically as part of the installation process unless .Ar noHoloShell is set. @@ -741,7 +757,7 @@ Select a pre-made floppy installation set as the installation media. None .It mediaSetDOS Select an existing DOS primary partition as the installation media. -The first primary partition found is used (e.g. C:). +The first primary partition found is used (e.g.\& C:). .Pp .Sy Variables : None @@ -766,7 +782,8 @@ Which host interface to use .Ar ( ed0 or .Ar ep0 , -for example. Non-optional). +for example. +Non-optional). .It netInteractive If set, bring up the interactive network setup form even if all relevant configuration variables are already set (optional). @@ -836,7 +853,8 @@ Which host interface to use .Ar ( ed0 or .Ar ep0 , -for example. Non-optional). +for example. +Non-optional). .It netInteractive If set, bring up the interactive network setup form even if all relevant configuration variables are already set (optional). @@ -887,7 +905,7 @@ that a media type be set), .Sy Variables : .Bl -tag -width indent .It package -The name of the package to add, e.g. bash-1.14.7 or ncftp-2.4.2. +The name of the package to add, e.g.\& bash-1.14.7 or ncftp-2.4.2. .El .It addGroup Invoke the interactive group editor. @@ -911,7 +929,8 @@ Execute an arbitrary command with .Sy Variables : .Bl -tag -width indent .It command -The name of the command to execute. When running +The name of the command to execute. +When running from a boot floppy, very minimal expectations should be made as to what's available until/unless a relatively full system installation has just been done. diff --git a/usr.sbin/setfmac/setfsmac.8 b/usr.sbin/setfmac/setfsmac.8 index ca4a918..1951d68 100644 --- a/usr.sbin/setfmac/setfsmac.8 +++ b/usr.sbin/setfmac/setfsmac.8 @@ -114,7 +114,8 @@ This software was contributed to the .Fx Project by Network Associates Labs, the Security Research Division of Network Associates -Inc. under DARPA/SPAWAR contract N66001-01-C-8035 +Inc. +under DARPA/SPAWAR contract N66001-01-C-8035 .Pq Dq CBOSS , as part of the DARPA CHATS research program. .Sh SEE ALSO diff --git a/usr.sbin/setpmac/setpmac.8 b/usr.sbin/setpmac/setpmac.8 index 345db64..e84a8bc6 100644 --- a/usr.sbin/setpmac/setpmac.8 +++ b/usr.sbin/setpmac/setpmac.8 @@ -59,6 +59,7 @@ This software was contributed to the .Fx Project by Network Associates Labs, the Security Research Division of Network Associates -Inc. under DARPA/SPAWAR contract N66001-01-C-8035 +Inc. +under DARPA/SPAWAR contract N66001-01-C-8035 .Pq Dq CBOSS , as part of the DARPA CHATS research program. diff --git a/usr.sbin/sicontrol/sicontrol.8 b/usr.sbin/sicontrol/sicontrol.8 index 5693922..5040d8a 100644 --- a/usr.sbin/sicontrol/sicontrol.8 +++ b/usr.sbin/sicontrol/sicontrol.8 @@ -38,8 +38,10 @@ The maximum number of host adapter interrupts per second is determined by: .Pp .Ar "controller CPU clock / (8 * int_throttle)" .Pp -The default value at boot time is 25000. The host adapter cpu clock is -25MHz. This gives a maximum interrupt rate of about 125 interrupts per +The default value at boot time is 25000. +The host adapter cpu clock is +25MHz. +This gives a maximum interrupt rate of about 125 interrupts per second. .Pp Lowering this value will increase the rate in which the host adapter can @@ -106,4 +108,5 @@ Specialix International do not support this device driver in any way. .Sh AUTHORS .An Peter Wemm Aq peter@FreeBSD.org .Sh BUGS -Bound to be many... :-) +Bound to be many... +:-) diff --git a/usr.sbin/sliplogin/sliplogin.8 b/usr.sbin/sliplogin/sliplogin.8 index 994df95..3bac659 100644 --- a/usr.sbin/sliplogin/sliplogin.8 +++ b/usr.sbin/sliplogin/sliplogin.8 @@ -48,7 +48,8 @@ utility is used to turn the terminal line on standard input (or .Ar device ) into a Serial Line IP .Pq Tn SLIP -link to a remote host. To do this, the program +link to a remote host. +To do this, the program searches the file .Pa /etc/sliphome/slip.hosts for an entry matching @@ -89,7 +90,8 @@ will be executed instead if it exists. The script is invoked with the parameters .Bl -tag -width slipunit .It Em slipunit -The unit number of the slip interface assigned to this line. E.g., +The unit number of the slip interface assigned to this line. +E.g., .Sy 0 for .Sy sl0 . @@ -102,17 +104,21 @@ entry, in order starting with .Ar loginname . .El .Pp -Only the super-user may attach a network interface. The interface is +Only the super-user may attach a network interface. +The interface is automatically detached when the other end hangs up or the .Nm -process dies. If the kernel slip +process dies. +If the kernel slip module has been configured for it, all routes through that interface will -also disappear at the same time. If there is other processing a site +also disappear at the same time. +If there is other processing a site would like done on hangup, the file .Pa /etc/sliphome/slip.logout or .Pa /etc/sliphome/slip.logout. Ns Ar loginname -is executed if it exists. It is given the same arguments as the login script. +is executed if it exists. +It is given the same arguments as the login script. .Ss Format of /etc/sliphome/slip.hosts Comments (lines starting with a `#') and blank lines (or started with space) are ignored. @@ -138,7 +144,8 @@ and are the IP host names or addresses of the local and remote ends of the slip line and .Em netmask -is the appropriate IP netmask. These arguments are passed +is the appropriate IP netmask. +These arguments are passed directly to .Xr ifconfig 8 . .Em Opt-args @@ -190,7 +197,8 @@ is to create a .Pa /etc/passwd entry for each legal, remote slip site with .Nm -as the shell for that entry. E.g., +as the shell for that entry. +E.g., .Bd -literal Sfoo:ikhuy6:2010:1:slip line to foo:/tmp:/usr/sbin/sliplogin .Ed @@ -219,7 +227,8 @@ Note that .Nm must be setuid to root and, while not a security hole, moral defectives can use it to place terminal lines in an unusable state and/or deny -access to legitimate users of a remote slip line. To prevent this, +access to legitimate users of a remote slip line. +To prevent this, .Nm is installed as user .Em root , diff --git a/usr.sbin/sysinstall/sysinstall.8 b/usr.sbin/sysinstall/sysinstall.8 index b1b04bb..e708bbb 100644 --- a/usr.sbin/sysinstall/sysinstall.8 +++ b/usr.sbin/sysinstall/sysinstall.8 @@ -72,12 +72,14 @@ of the library) and install distributions or packages onto new and existing .Fx -systems. It also contains some extra intelligence +systems. +It also contains some extra intelligence for running as a replacement for .Xr init 8 when it's invoked by the .Fx -installation boot procedure. It +installation boot procedure. +It assumes very little in the way of additional utility support and performs most file system operations by calling the relevant syscalls (such as @@ -101,7 +103,8 @@ eventually be replaced. The .Nm utility may be either driven interactively through its various internal menus -or run in batch mode, driven by an external script. Such a script may +or run in batch mode, driven by an external script. +Such a script may be loaded and executed in one of 3 ways: .Bl -tag -width Ds .It Sy "LOAD_CONFIG_FILE" @@ -127,8 +130,9 @@ it then will attempt to load from a DOS or UFS formatted floppy. Each command line argument is treated as a script directive when .Nm -is run in multi-user mode. Execution ends either by explicit request -(e.g. calling the +is run in multi-user mode. +Execution ends either by explicit request +(e.g.\& calling the .Ar shutdown directive), upon reaching the end of the argument list or on error. .Pp @@ -157,14 +161,15 @@ Where .Ar var=value is the assignment of some internal .Nm -variable, e.g. "ftpPass=FuNkYChiKn", and +variable, e.g.\& "ftpPass=FuNkYChiKn", and .Ar function is the name of an internal .Nm -function, e.g. "mediaSetFTP", and +function, e.g.\& "mediaSetFTP", and .Ar #comment is a single-line comment for documentation purposes (ignored by -sysinstall). Each directive must be by itself on a single line, +sysinstall). +Each directive must be by itself on a single line, functions taking their arguments by examining known variable names. This requires that you be sure to assign the relevant variables before calling a function which requires them. @@ -253,7 +258,8 @@ Invokes the disk partition (MBR) editor. .Sy Variables : .Bl -tag -width findx .It geometry -The disk geometry, as a cyls/heads/sectors formatted string. Default: no +The disk geometry, as a cyls/heads/sectors formatted string. +Default: no change to geometry. .It partition Set to disk partitioning type or size, its value being @@ -305,13 +311,15 @@ function) to be written out. .Sy Variables : None .It diskLabelEditor -Invokes the disk label editor. This is a bit trickier from a script +Invokes the disk label editor. +This is a bit trickier from a script since you need to essentially label everything inside each .Fx (type 0xA5) partition created by the .Ar diskPartitionEditor function, and that requires knowing a few rules about how things are -laid out. When creating a script to automatically allocate disk space +laid out. +When creating a script to automatically allocate disk space and partition it up, it is suggested that you first perform the installation interactively at least once and take careful notes as to what the slice names will be, then and only then hardwiring them into @@ -327,7 +335,8 @@ for the whole partition .Ar ( da0s1 being your DOS primary -partition). Now let's further assume that you have 500MB in this +partition). +Now let's further assume that you have 500MB in this partition and you want to sub-partition that space into root, swap, var and usr file systems for .Fx . @@ -350,16 +359,19 @@ the mount point, if non-zero, means to set the soft updates flag). One can also use the .Ar diskLabelEditor for mounting or erasing existing partitions as well as creating new -ones. Using the previous example again, let's say that we also wanted +ones. +Using the previous example again, let's say that we also wanted to mount our DOS partition and make sure that an .Pa /etc/fstab -entry is created for it in the new installation. Before calling the +entry is created for it in the new installation. +Before calling the .Ar diskLabelEditor function, we simply add an additional line: .Pp .Dl "da0s1=/dos_c N" .Pp -before the call. This tells the label editor that you want to mount +before the call. +This tells the label editor that you want to mount the first slice on .Pa /dos_c and not to attempt to newfs it (not that @@ -392,13 +404,14 @@ Resets all selected distributions to the empty set (no distributions selected). .Sy Variables : None .It distSetCustom -Allows the selection of a custom distribution set (e.g. not just one of the +Allows the selection of a custom distribution set (e.g.\& not just one of the existing "canned" sets) with no user interaction. .Pp .Sy Variables : .Bl -tag -width indent .It dists -List of distributions to load. Possible distribution values are: +List of distributions to load. +Possible distribution values are: .Bl -tag -width indentxx .It Li base The base binary distribution. @@ -655,10 +668,12 @@ Defaults to latest links package. .It browserBinary The name of the browser binary itself (if overriding the .Ar browserPackage -variable). Defaults to links. +variable). +Defaults to links. .El .It installCommit -Commit any and all pending changes to disk. This function +Commit any and all pending changes to disk. +This function is essentially shorthand for a number of more granular "commit" functions. .Pp @@ -683,7 +698,8 @@ Start an upgrade installation. None .It installFixitHoloShell Start up the "emergency holographic shell" over on VTY4 -if running as init. This will also happen automatically +if running as init. +This will also happen automatically as part of the installation process unless .Ar noHoloShell is set. @@ -741,7 +757,7 @@ Select a pre-made floppy installation set as the installation media. None .It mediaSetDOS Select an existing DOS primary partition as the installation media. -The first primary partition found is used (e.g. C:). +The first primary partition found is used (e.g.\& C:). .Pp .Sy Variables : None @@ -766,7 +782,8 @@ Which host interface to use .Ar ( ed0 or .Ar ep0 , -for example. Non-optional). +for example. +Non-optional). .It netInteractive If set, bring up the interactive network setup form even if all relevant configuration variables are already set (optional). @@ -836,7 +853,8 @@ Which host interface to use .Ar ( ed0 or .Ar ep0 , -for example. Non-optional). +for example. +Non-optional). .It netInteractive If set, bring up the interactive network setup form even if all relevant configuration variables are already set (optional). @@ -887,7 +905,7 @@ that a media type be set), .Sy Variables : .Bl -tag -width indent .It package -The name of the package to add, e.g. bash-1.14.7 or ncftp-2.4.2. +The name of the package to add, e.g.\& bash-1.14.7 or ncftp-2.4.2. .El .It addGroup Invoke the interactive group editor. @@ -911,7 +929,8 @@ Execute an arbitrary command with .Sy Variables : .Bl -tag -width indent .It command -The name of the command to execute. When running +The name of the command to execute. +When running from a boot floppy, very minimal expectations should be made as to what's available until/unless a relatively full system installation has just been done. diff --git a/usr.sbin/syslogd/syslog.conf.5 b/usr.sbin/syslogd/syslog.conf.5 index 789d63f..826c662 100644 --- a/usr.sbin/syslogd/syslog.conf.5 +++ b/usr.sbin/syslogd/syslog.conf.5 @@ -70,13 +70,13 @@ Note that if you use spaces as separators, your .Nm might be incompatible with other Unices or Unix-like systems. This functionality was added for ease of configuration -(e.g. it is possible to cut-and-paste into +(e.g.\& it is possible to cut-and-paste into .Nm ) , and to avoid possible mistakes. This change however preserves backwards compatibility with the old style of .Nm -(i.e. tab characters only). +(i.e., tab characters only). .Pp The .Em selectors @@ -352,10 +352,12 @@ Selected messages are written to all logged-in users. A vertical bar .Pq Dq \&| , followed by a command to pipe the selected -messages to. The command is passed to +messages to. +The command is passed to .Xr sh 1 for evaluation, so usual shell metacharacters or input/output -redirection can occur. (Note however that redirecting +redirection can occur. +(Note however that redirecting .Xr stdio 3 buffered output from the invoked command can cause additional delays, or even lost output data in case a logging subprocess exited with a @@ -368,23 +370,28 @@ redirected to Upon receipt of a .Dv SIGHUP , .Xr syslogd 8 -will close the pipe to the process. If the process didn't exit +will close the pipe to the process. +If the process didn't exit voluntarily, it will be sent a .Dv SIGTERM signal after a grace period of up to 60 seconds. .Pp The command will only be started once data arrives that should be piped -to it. If it exited later, it will be restarted as necessary. So if it +to it. +If it exited later, it will be restarted as necessary. +So if it is desired that the subprocess should get exactly one line of input only (which can be very resource-consuming if there are a lot of messages flowing quickly), this can be achieved by exiting after just one line of -input. If necessary, a script wrapper can be written to this effect. +input. +If necessary, a script wrapper can be written to this effect. .Pp Unless the command is a full pipeline, it's probably useful to start the command with .Em exec so that the invoking shell process does not wait for the command to -complete. Warning: the process is started under the UID invoking +complete. +Warning: the process is started under the UID invoking .Xr syslogd 8 , normally the superuser. .El @@ -477,9 +484,11 @@ or higher, not at the level of or higher. .Pp In networked environments, note that not all operating systems -implement the same set of facilities. The facilities +implement the same set of facilities. +The facilities authpriv, cron, ftp, and ntp that are known to this implementation -might be absent on the target system. Even worse, DEC UNIX uses +might be absent on the target system. +Even worse, DEC UNIX uses facility number 10 (which is authpriv in this implementation) to log events for their AdvFS file system. .Sh SEE ALSO diff --git a/usr.sbin/syslogd/syslogd.8 b/usr.sbin/syslogd/syslogd.8 index 80782d6..caef93d 100644 --- a/usr.sbin/syslogd/syslogd.8 +++ b/usr.sbin/syslogd/syslogd.8 @@ -77,7 +77,8 @@ Allow .Ar allowed_peer to log to this .Nm -using UDP datagrams. Multiple +using UDP datagrams. +Multiple .Fl a options may be specified. .Pp @@ -105,11 +106,13 @@ If specified, .Ar service is the name or number of an UDP service (see .Xr services 5 ) -the source packet must belong to. A +the source packet must belong to. +A .Ar service of .Ql \&* -allows packets being sent from any UDP port. The default +allows packets being sent from any UDP port. +The default .Ar service is .Ql syslog . @@ -120,7 +123,8 @@ is IPv4 address, a missing will be substituted by the historic class A or class B netmasks if .Ar ipaddr belongs into the address range of class A or B, respectively, or -by 24 otherwise. If +by 24 otherwise. +If .Ar ipaddr is IPv6 address, a missing .Ar masklen @@ -132,7 +136,8 @@ will be substituted by 128. .Xc Accept datagrams where the reverse address lookup yields .Ar domainname -for the sender address. The meaning of +for the sender address. +The meaning of .Ar service is as explained above. .It Xo @@ -165,7 +170,8 @@ If specified twice, disable this compression in all cases. .It Fl d Put .Nm -into debugging mode. This is probably only of use to developers working on +into debugging mode. +This is probably only of use to developers working on .Nm . .It Fl f Specify the pathname of an alternate configuration file; @@ -209,19 +215,24 @@ The primary use for this is to place additional log sockets in .Pa /var/run/log of various chroot filespaces. .It Fl s -Operate in secure mode. Do not log messages from remote machines. If +Operate in secure mode. +Do not log messages from remote machines. +If specified twice, no network socket will be opened at all, which also disables logging to remote machines. .It Fl u -Unique priority logging. Only log messages at the specified priority. +Unique priority logging. +Only log messages at the specified priority. Without this option, messages at the stated priority or higher are logged. This option changes the default comparison from .Dq => to .Dq = . .It Fl v -Verbose logging. If specified once, the numeric facility and priority are -logged with each locally-written message. If specified more than once, +Verbose logging. +If specified once, the numeric facility and priority are +logged with each locally-written message. +If specified more than once, the names of the facility and priority are logged with each locally-written message. .El @@ -307,9 +318,11 @@ extensions. .Sh BUGS The ability to log messages received in UDP packets is equivalent to an unauthenticated remote disk-filling service, and should probably be -disabled by default. Some sort of +disabled by default. +Some sort of .No inter- Ns Nm syslogd -authentication mechanism ought to be worked out. To prevent the worst +authentication mechanism ought to be worked out. +To prevent the worst abuse, use of the .Fl a option is therefore highly recommended. @@ -317,7 +330,8 @@ option is therefore highly recommended. The .Fl a matching algorithm doesn't pretend to be very efficient; use of numeric -IP addresses is faster than domain name comparison. Since the allowed +IP addresses is faster than domain name comparison. +Since the allowed peer list is being walked linearly, peer groups where frequent messages are being anticipated from should be put early into the .Fl a diff --git a/usr.sbin/tcpdump/tcpslice/tcpslice.1 b/usr.sbin/tcpdump/tcpslice/tcpslice.1 index d804cf6..2efecc7 100644 --- a/usr.sbin/tcpdump/tcpslice/tcpslice.1 +++ b/usr.sbin/tcpdump/tcpslice/tcpslice.1 @@ -46,8 +46,10 @@ The basic operation of is to copy to .Pa stdout all packets from its input file(s) whose timestamps fall -within a given range. The starting and ending times of the range -may be specified on the command line. All ranges are inclusive. +within a given range. +The starting and ending times of the range +may be specified on the command line. +All ranges are inclusive. The starting time defaults to the time of the first packet in the first input file; we call this the @@ -63,7 +65,8 @@ to (assuming the file does not include more than ten years' worth of data). .Pp -There are a number of ways to specify times. The first is using +There are a number of ways to specify times. +The first is using Unix timestamps of the form .Em sssssssss.uuuuuu (this is the format specified by @@ -73,7 +76,7 @@ flag). For example, .Em 654321098.7654 specifies 38 seconds and 765,400 microseconds -after 8:51PM PDT, Sept. 25, 1990. +after 8:51PM PDT, Sept.\& 25, 1990. .Pp All examples in this manual are given for PDT times, but when displaying times and interpreting times symbolically @@ -81,8 +84,10 @@ as discussed below, .Nm uses the local timezone, regardless of the timezone in which the .Xr tcpdump 1 -file was generated. The daylight-savings setting used is that which is -appropriate for the local timezone at the date in question. For example, +file was generated. +The daylight-savings setting used is that which is +appropriate for the local timezone at the date in question. +For example, times associated with summer months will usually include daylight-savings effects, and those with winter months will not. .Pp @@ -104,13 +109,15 @@ through 500 seconds after the .Em first time . .Pp Times may also be specified in terms of years (y), months (m), days (d), -hours (h), minutes (m), seconds (s), and microseconds(u). For example, +hours (h), minutes (m), seconds (s), and microseconds(u). +For example, the Unix timestamp 654321098.7654 discussed above could also be expressed as .Em 90y9m25d20h51m38s765400u . .Pp When specifying times using this style, fields that are omitted default -as follows. If the omitted field is a unit +as follows. +If the omitted field is a unit .Em greater than that of the first specified field, then its value defaults to the corresponding value taken from either @@ -123,7 +130,8 @@ than that of the first specified field, then it defaults to zero. For example, suppose that the input file has a .Em first time of the Unix timestamp mentioned above, i.e., 38 seconds and 765,400 microseconds -after 8:51PM PDT, Sept. 25, 1990. To specify 9:36PM PDT (exactly) on the +after 8:51PM PDT, Sept.\& 25, 1990. +To specify 9:36PM PDT (exactly) on the same date we could use .Em 21h36m . To specify a range from 9:36PM PDT through 1:54AM PDT the next day we @@ -132,21 +140,24 @@ could use .Pp Relative times can also be specified when using the .Em ymdhmsu -format. Omitted fields then default to 0 if the unit of the field is +format. +Omitted fields then default to 0 if the unit of the field is .Em greater than that of the first specified field, and to the corresponding value taken from either the .Em first time or the starting time if the omitted field's unit is .Em less -than that of the first specified field. Given a +than that of the first specified field. +Given a .Em first time of the Unix timestamp mentioned above, .Em 22h +1h10m specifies a range from 10:00PM PDT on that date through 11:10PM PDT, and .Em +1h +1h10m specifies a range from 38.7654 seconds after 9:51PM PDT through 38.7654 -seconds after 11:01PM PDT. The first hour of the file could be extracted +seconds after 11:01PM PDT. +The first hour of the file could be extracted using .Em +0 +1h . .Pp @@ -154,7 +165,8 @@ Note that with the .Em ymdhmsu format there is an ambiguity between using .Em m -for `month' or for `minute'. The ambiguity is resolved as follows: if an +for `month' or for `minute'. +The ambiguity is resolved as follows: if an .Em m field is followed by a .Em d @@ -166,11 +178,14 @@ If more than one input file is specified then first copies packets lying in the given range from the first file; it then increases the starting time of the range to lie just beyond the timestamp of the last packet in the first file, repeats the process -with the second file, and so on. Thus files with interleaved packets +with the second file, and so on. +Thus files with interleaved packets are .Em not -merged. For a given file, only packets that are newer than any in the -preceding files will be considered. This mechanism avoids any possibility +merged. +For a given file, only packets that are newer than any in the +preceding files will be considered. +This mechanism avoids any possibility of a packet occurring more than once in the output. .Sh OPTIONS If any of @@ -181,14 +196,17 @@ or are specified then .Nm reports the timestamps of the first and last packets in each input file -and exits. Only one of these three options may be specified. +and exits. +Only one of these three options may be specified. .Pp The following options are available: .Bl -tag -width indent .It Fl d Dump the start and end times specified by the given range and -exit. This option is useful for checking that the given range actually -specifies the times you think it does. If one of +exit. +This option is useful for checking that the given range actually +specifies the times you think it does. +If one of .Fl R , .Fl r or @@ -228,7 +246,8 @@ rather than of Lawrence Berkeley Laboratory, University of California, Berkeley, CA. .Sh BUGS An input filename that beings with a digit or a `+' can be confused -with a start/end time. Such filenames can be specified with a +with a start/end time. +Such filenames can be specified with a leading `./'; for example, specify the file `04Jul76.trace' as `./04Jul76.trace'. .Pp @@ -260,7 +279,8 @@ files spanning more than one year; with files containing portions of packets whose original length was more than 65,535 bytes; nor with files containing fewer than three packets. Such files result in -the error message: `couldn't find final packet in file'. These problems +the error message: `couldn't find final packet in file'. +These problems are due to the interpolation scheme used by .Nm to greatly speed up its processing when dealing with large trace files. diff --git a/usr.sbin/timed/timedc/timedc.8 b/usr.sbin/timed/timedc/timedc.8 index 7c43ad4..ecba759 100644 --- a/usr.sbin/timed/timedc/timedc.8 +++ b/usr.sbin/timed/timedc/timedc.8 @@ -67,7 +67,8 @@ will prompt for commands from the standard input. If arguments are supplied, .Nm interprets the first argument as a command and the remaining -arguments as parameters to the command. The standard input +arguments as parameters to the command. +The standard input may be redirected causing .Nm to read commands from a file. diff --git a/usr.sbin/tzsetup/tzsetup.8 b/usr.sbin/tzsetup/tzsetup.8 index 642be78..09d842f 100644 --- a/usr.sbin/tzsetup/tzsetup.8 +++ b/usr.sbin/tzsetup/tzsetup.8 @@ -38,7 +38,8 @@ The .Nm utility reads a database of timezone information and presents a menu allowing the user to select a specific zone without knowing the details -of the database layout. The selected zone is installed as the system +of the database layout. +The selected zone is installed as the system default zone. The .Nm @@ -78,7 +79,8 @@ beginning of the epoch (January 1, 1970, .Tn GMT ) . .It -Each zone is named for the most populous city therein. (Where possible, +Each zone is named for the most populous city therein. +(Where possible, the database includes pre-1970 history for its city.) .El The source code to the database diff --git a/usr.sbin/ugidfw/ugidfw.8 b/usr.sbin/ugidfw/ugidfw.8 index 0d97b01..9afb591 100644 --- a/usr.sbin/ugidfw/ugidfw.8 +++ b/usr.sbin/ugidfw/ugidfw.8 @@ -126,7 +126,7 @@ Rule number. Entries with a lower rule number are applied first; placing the most frequently-matched rules at the beginning of the list -(i.e. lower-numbered) +(i.e., lower-numbered) will yield a slight performance increase. .It Xo .Cm subject @@ -205,6 +205,6 @@ utility first appeared in This software was contributed to the .Fx Project by NAI Labs, the Security Research Division of Network Associates -Inc. under DARPA/SPAWAR contract N66001-01-C-8035 +Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035 .Pq Dq CBOSS , as part of the DARPA CHATS research program. diff --git a/usr.sbin/usbd/usbd.8 b/usr.sbin/usbd/usbd.8 index 65e7ba3..d6f9fa0 100644 --- a/usr.sbin/usbd/usbd.8 +++ b/usr.sbin/usbd/usbd.8 @@ -57,7 +57,7 @@ It does two things. Through opening the .Pa /dev/usb0 , .Pa /dev/usb1 , -etc. devices, it enables the kernel to handle change requests from +etc.\& devices, it enables the kernel to handle change requests from attached hubs. This functionality will be removed when the kernel has kernel threads. @@ -114,7 +114,8 @@ Do not handle the event queue on /dev/usb. .It Fl t Ar timeout 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. +A timeout of 0 means that there is no timeout. +The default is 30. .It Fl v Be verbose. Repeating the flag makes diff --git a/usr.sbin/vipw/vipw.8 b/usr.sbin/vipw/vipw.8 index 539a22f..9f0bca7 100644 --- a/usr.sbin/vipw/vipw.8 +++ b/usr.sbin/vipw/vipw.8 @@ -81,8 +81,10 @@ Once the information has been verified, .Nm uses .Xr pwd_mkdb 8 -to update the user database. This is run in the background, and, -at very large sites could take several minutes. Until this update +to update the user database. +This is run in the background, and, +at very large sites could take several minutes. +Until this update is completed, the password file is unavailable for other updates and the new information is not available to programs. .Sh ENVIRONMENT diff --git a/usr.sbin/watch/watch.8 b/usr.sbin/watch/watch.8 index 6cc0e11..da0ceb9 100644 --- a/usr.sbin/watch/watch.8 +++ b/usr.sbin/watch/watch.8 @@ -32,7 +32,8 @@ utility writes to standard output. The options are as follows: .Bl -tag -width indent .It Fl c -Reconnect on close. If the tty observed by +Reconnect on close. +If the tty observed by .Nm is closed, automatically reattach to the same tty. If this option is not specified, @@ -60,12 +61,15 @@ is started from a tty. If output is redirected to a file, interactive mode can still be requested by specifying this option. .It Fl n -Disable the ability to switch the watched tty interactively. This disables +Disable the ability to switch the watched tty interactively. +This disables both change requests made with <control-X> as well as automatic prompting -when the current tty is closed or overflows. In all cases where a prompt +when the current tty is closed or overflows. +In all cases where a prompt would be displayed, .Nm -will exit. The reconnect flags are unaffected by +will exit. +The reconnect flags are unaffected by this option. When this flag is used, <control-X> is passed through to the terminal. .It Fl o diff --git a/usr.sbin/wlconfig/wlconfig.8 b/usr.sbin/wlconfig/wlconfig.8 index f63b691..99a2942 100644 --- a/usr.sbin/wlconfig/wlconfig.8 +++ b/usr.sbin/wlconfig/wlconfig.8 @@ -14,11 +14,13 @@ The .Nm utility can be used to read and set parameters for the NCR/AT&T Wavelan -radio LAN card. Various parameters stored in the non-volatile Parameter +radio LAN card. +Various parameters stored in the non-volatile Parameter Storage Area (PSA) on the card can be modified with this program, replacing the DOS-based .Nm instconf.exe -program. It can also be used to interrogate the optional signal +program. +It can also be used to interrogate the optional signal strength cache which may have been compiled into the driver. .Pp The @@ -58,7 +60,8 @@ Packets with a different NWID are simply ignored by the modem. In the hardware, NWIDs are stored long-term in non-volatile memory (called the PSA or programmable storage area), and are loaded by software into the radio modem when the driver is -initialized. This sets the default NWID loaded at startup. +initialized. +This sets the default NWID loaded at startup. .It currnwid This sets the current operating NWID (but does not save it to the PSA). @@ -68,7 +71,8 @@ silence, and quality levels, which are indexed by sender MAC addresses. Input packets are stored in the cache, and when received, the values stored in the radio modem are interrogated and stored. There are also two sysctl values (iponly and multicast only) which -can be used for filtering out some input packets. By default, the +can be used for filtering out some input packets. +By default, the cache mechanism stores only non-unicast IP packets, but this can be changed with .Xr sysctl 8 . @@ -86,7 +90,8 @@ which clears out the cache in case you want to store new samples. .El .Pp Note that if the IRQ on the Wavelan card is incorrect, the interface -will be configured, but will not function. The +will be configured, but will not function. +The .Nm utility should then be used to reconfigure the card to a sensible value. diff --git a/usr.sbin/ypbind/ypbind.8 b/usr.sbin/ypbind/ypbind.8 index 080afa7..56dba21 100644 --- a/usr.sbin/ypbind/ypbind.8 +++ b/usr.sbin/ypbind/ypbind.8 @@ -113,7 +113,7 @@ if they originated from the local host. Cause .Nm to run in secure mode: it will refuse to bind to any NIS server -that is not running as root (i.e. that is not using privileged +that is not running as root (i.e., that is not using privileged TCP ports). .It Fl S Xo .Sm off @@ -139,7 +139,8 @@ 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. +file. +IP addresses may be specified in place of hostnames. If .Nm can't make sense out of the arguments, it will ignore diff --git a/usr.sbin/yppush/yppush.8 b/usr.sbin/yppush/yppush.8 index ca5e483..f88d49c 100644 --- a/usr.sbin/yppush/yppush.8 +++ b/usr.sbin/yppush/yppush.8 @@ -74,7 +74,8 @@ By default, .Nm determines the names of the slave servers for a domain by searching the .Pa ypservers -map. A destination host (or a list of hosts) can also be manually +map. +A destination host (or a list of hosts) can also be manually specified on the command line. Once it has a complete list of slave servers, it sends a 'map transfer' request to each slave, which in turn reads a copy of the map from @@ -140,7 +141,8 @@ Can be used to transfer a map to a user-specified machine or group of machines instead of the list of servers contained in the .Pa ypservers -map. A list of hosts can be specified by using multiple +map. +A list of hosts can be specified by using multiple instances of the .Fl h flag. @@ -174,7 +176,8 @@ a particular NIS domain .Xr ypxfr 8 .Sh BUGS The mechanism for transferring NIS maps in NIS v1 is different -than that in NIS version 2. This version of +than that in NIS version 2. +This version of .Nm has support for transferring maps to NIS v2 systems only. .Sh AUTHORS diff --git a/usr.sbin/ypserv/ypserv.8 b/usr.sbin/ypserv/ypserv.8 index f517302..e2e78ed 100644 --- a/usr.sbin/ypserv/ypserv.8 +++ b/usr.sbin/ypserv/ypserv.8 @@ -309,7 +309,8 @@ to an .Tn NIS v1 server even though they may never actually need it (and they may persist in broadcasting in search of one even after they receive a -response from a v2 server). Note that while +response from a v2 server). +Note that while support for normal client calls is provided, this version of .Nm does not handle v1 map transfer requests; consequently, it cannot diff --git a/usr.sbin/zic/zic.8 b/usr.sbin/zic/zic.8 index 3af09c0..aa58a56 100644 --- a/usr.sbin/zic/zic.8 +++ b/usr.sbin/zic/zic.8 @@ -34,9 +34,11 @@ The following options are available: .It Fl -version Output version information and exit. .It Fl D -Do not automatically create directories. If the input file(s) specify +Do not automatically create directories. +If the input file(s) specify an output file in a directory which does not already exist, the -default behavior is to attempt to create the directory. If +default behavior is to attempt to create the directory. +If .Fl D is specified, .Nm |
