From 09cbac4e7f8f34a8e5198b23957149649da982c4 Mon Sep 17 00:00:00 2001 From: wiz Date: Thu, 3 Oct 2002 15:41:44 +0000 Subject: [PATCH] New sentence, new line. From Robert Elz. --- sbin/rcorder/rcorder.8 | 18 +++++---- sbin/reboot/reboot.8 | 13 ++++--- sbin/rndctl/rndctl.8 | 11 +++--- sbin/route/route.8 | 6 +-- sbin/routed/routed.8 | 17 ++++---- sbin/savecore/savecore.8 | 5 ++- sbin/scsictl/scsictl.8 | 80 +++++++++++++++++++++----------------- sbin/slattach/slattach.8 | 20 +++++----- sbin/sysctl/sysctl.8 | 23 ++++++----- sbin/ttyflags/ttyflags.8 | 5 ++- sbin/wdogctl/wdogctl.8 | 52 +++++++++++++------------ sbin/wsconsctl/wsconsctl.8 | 11 ++++-- 12 files changed, 144 insertions(+), 117 deletions(-) diff --git a/sbin/rcorder/rcorder.8 b/sbin/rcorder/rcorder.8 index 8ae3d9299b22..b6be326feaaf 100644 --- a/sbin/rcorder/rcorder.8 +++ b/sbin/rcorder/rcorder.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: rcorder.8,v 1.4 2001/11/16 10:25:50 wiz Exp $ +.\" $NetBSD: rcorder.8,v 1.5 2002/10/03 15:41:44 wiz Exp $ .\" .\" Copyright (c) 1998 .\" Perry E. Metzger. All rights reserved. @@ -44,9 +44,9 @@ .Sh DESCRIPTION .Nm is designed to print out a dependency ordering of a set of -interdependent files. Typically it is used to find an execution -sequence for a set of shell scripts in which certain files must be -executed before others. +interdependent files. +Typically it is used to find an execution sequence for a set of +shell scripts in which certain files must be executed before others. .Pp Each file passed to .Nm @@ -65,7 +65,8 @@ Within each file, a block containing a series of and .Dq KEYWORD lines must appear. -The format of the lines is rigid. Each line must begin with a single +The format of the lines is rigid. +Each line must begin with a single .Dq # , followed by a single space, followed by .Dq PROVIDE: , @@ -75,7 +76,8 @@ or .Dq KEYWORD: . No deviation is permitted. Each dependency line is then followed by a series of conditions, -separated by whitespace. Multiple +separated by whitespace. +Multiple .Dq PROVIDE , .Dq REQUIRE , .Dq BEFORE @@ -154,5 +156,5 @@ The program first appeared in .Nx 1.5 . .Sh AUTHORS -Written by Perry E. Metzger (perry@piermont.com) and Matthew R. -Green (mrg@eterna.com.au). +Written by Perry E. Metzger (perry@piermont.com) and +Matthew R. Green (mrg@eterna.com.au). diff --git a/sbin/reboot/reboot.8 b/sbin/reboot/reboot.8 index 82a23c9a1370..53732a6badb6 100644 --- a/sbin/reboot/reboot.8 +++ b/sbin/reboot/reboot.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: reboot.8,v 1.16 2002/04/17 16:31:02 wiz Exp $ +.\" $NetBSD: reboot.8,v 1.17 2002/10/03 15:41:45 wiz Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -73,12 +73,13 @@ Suppress sending a message via before halting or restarting. .It Fl n Do not flush the file system cache. -This option should be used with extreme caution. It can be used if a disk -or the processor is on fire. +This option should be used with extreme caution. +It can be used if a disk or the processor is on fire. .It Fl p -Attempt to powerdown the system. If the powerdown fails, or the system -does not support software powerdown, the system will halt. This option -is only valid for +Attempt to powerdown the system. +If the powerdown fails, or the system does not support +software powerdown, the system will halt. +This option is only valid for .Nm halt . .It Fl q Do not give processes a chance to shut down before halting or restarting. diff --git a/sbin/rndctl/rndctl.8 b/sbin/rndctl/rndctl.8 index 2f1040f8b427..9e2b279ae215 100644 --- a/sbin/rndctl/rndctl.8 +++ b/sbin/rndctl/rndctl.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: rndctl.8,v 1.13 2002/10/01 14:39:51 wiz Exp $ +.\" $NetBSD: rndctl.8,v 1.14 2002/10/03 15:41:45 wiz Exp $ .\" .\" Copyright (c) 1997 Michael Graff .\" All rights reserved. @@ -67,9 +67,10 @@ See also .Fl t . .It Fl E Disable entropy estimation from the collected timing information for -the given device name or device type. If collection is still enabled, -timing information is still collected and mixed into the internal -entropy pool, but no entropy is assumed to be present. +the given device name or device type. +If collection is still enabled, timing information is still +collected and mixed into the internal entropy pool, +but no entropy is assumed to be present. .It Fl e Enable entropy estimation using the collected timing information for the given device name or device type. @@ -113,7 +114,7 @@ program was first made available in The .Nm program was written by -.An Michael Graff +.An Michael Graff .Aq explorer@flame.org . .Sh BUGS Turning on entropy estimation from unsafe or predictable sources will diff --git a/sbin/route/route.8 b/sbin/route/route.8 index 4258a6280cfd..77c2b06a645e 100644 --- a/sbin/route/route.8 +++ b/sbin/route/route.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: route.8,v 1.29 2002/02/08 13:32:32 hubertf Exp $ +.\" $NetBSD: route.8,v 1.30 2002/10/03 15:41:46 wiz Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -328,8 +328,8 @@ the routing tables. .Sh EXIT STATUS The .Nm -utility exits 0 on success, and \*[Gt]0 if an error occurs. This includes -the use of the +utility exits 0 on success, and \*[Gt]0 if an error occurs. +This includes the use of the .Cm get command to look up a route that is incomplete. .Sh EXAMPLES diff --git a/sbin/routed/routed.8 b/sbin/routed/routed.8 index d2610322c562..f9c342f66325 100644 --- a/sbin/routed/routed.8 +++ b/sbin/routed/routed.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: routed.8,v 1.37 2002/05/12 15:48:37 wiz Exp $ +.\" $NetBSD: routed.8,v 1.38 2002/10/03 15:41:46 wiz Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -206,10 +206,10 @@ It continues listening to RIP while using Router Discovery if multi-homed to ensure all interfaces are used. .Pp The Router Discovery standard requires that advertisements -have a default "lifetime" of 30 minutes. That means should -something happen, a client can be without a good route for -30 minutes. It is a good idea to reduce the default to 45 -seconds using +have a default "lifetime" of 30 minutes. +That means should something happen, +a client can be without a good route for 30 minutes. +It is a good idea to reduce the default to 45 seconds using .Fl P Cm rdisc_interval=45 on the command line or .Cm rdisc_interval=45 @@ -280,8 +280,8 @@ default route. This is typically used on a gateway to the Internet, or on a gateway that uses another routing protocol whose routes are not reported to other local routers. -Notice that because a metric of 1 is used, this feature is -dangerous. It is more commonly accidentally used to create chaos with a +Notice that because a metric of 1 is used, this feature is dangerous. +It is more commonly accidentally used to create chaos with a routing loop than to solve problems. .It Fl h cause host or point-to-point routes to not be advertised, @@ -528,7 +528,8 @@ This parameter must appear by itself on a line. The network number must specify a full, 32-bit value, as in 192.0.2.0 instead of 192.0.2. .Pp -Do not use this feature unless necessary. It is dangerous. +Do not use this feature unless necessary. +It is dangerous. .It Cm ripv1_mask Ns \&= Ns Ar nname/mask1,mask2 specifies that netmask of the network of which .Cm nname/mask1 diff --git a/sbin/savecore/savecore.8 b/sbin/savecore/savecore.8 index f0cd698ab895..c9eda4dec5db 100644 --- a/sbin/savecore/savecore.8 +++ b/sbin/savecore/savecore.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: savecore.8,v 1.26 2001/11/16 11:21:39 wiz Exp $ +.\" $NetBSD: savecore.8,v 1.27 2002/10/03 15:41:46 wiz Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -81,7 +81,8 @@ Crashes are usually the result of kernel bugs; if this is suspected, a full bug report should be filed using .Xr send-pr 1 , containing as much information as possible about the circumstances of -the crash. Since crash dumps are typically very large and may contain +the crash. +Since crash dumps are typically very large and may contain whatever (potentially confidential) information was in memory at the time of the crash, do .Em NOT diff --git a/sbin/scsictl/scsictl.8 b/sbin/scsictl/scsictl.8 index 07893efde701..566640e1a0c2 100644 --- a/sbin/scsictl/scsictl.8 +++ b/sbin/scsictl/scsictl.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: scsictl.8,v 1.16 2002/09/03 16:56:05 thorpej Exp $ +.\" $NetBSD: scsictl.8,v 1.17 2002/10/03 15:41:47 wiz Exp $ .\" .\" Copyright (c) 1998, 2002 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -52,9 +52,9 @@ .Sh DESCRIPTION .Nm allows a user or system administrator to issue commands to and otherwise -control SCSI devices and busses. It is used by specifying a device or -bus to manipulate, the command to perform, and any arguments the command -may require. +control SCSI devices and busses. +It is used by specifying a device or bus to manipulate, +the command to perform, and any arguments the command may require. .Nm determines if the specified device is an actual device or a SCSI bus automatically, and selects the appropriate command set. @@ -74,35 +74,39 @@ The following commands are supported for SCSI devices: .Oc .Oc .Pp -(Low level) format the named device. If the optional +(Low level) format the named device. +If the optional .Li blocksize parameter is provided, the device geometry will be modified to use the specified .Li blocksize . If this parameter is different form the Current or Default Mode Page 3 parameters, the device will update Mode Page 3 at the successful -completion of the Format. Device geometry may change as a result of -using a new device +completion of the Format. +Device geometry may change as a result of using a new device .Li blocksize . When the optional .Li blocksize parameter is specified, the Defect List on the drive will revert to the original primary defect list created at the time of manufacture -if available. The drive will usually recertify itself -during the Format and add any other defective blocks to the new Defect -List. Some disks may not support the ability to change the blocksize and -may enter a Degraded Mode when fed a Format command of this type. If this -happens the standard recovery for the drive requires issuing a correct -Format command, i.e. one without the blocksize parameter. +if available. +The drive will usually recertify itself during the Format +and add any other defective blocks to the new Defect List. +Some disks may not support the ability to change the blocksize and +may enter a Degraded Mode when fed a Format command of this type. +If this happens the standard recovery for the drive requires issuing +a correct Format command, i.e. one without the blocksize parameter. .Pp When the .Li immediate parameter is also specified, the disk is instructed to return from the -format command right away. It continues to format, and every ten seconds +format command right away. +It continues to format, and every ten seconds .Nm -issues a TEST UNIT READY command to check the associated sense data. This -associated sense data has a progress indicator which indicates how far -the format is progressing. Note well that most SCSI disk drives prior to +issues a TEST UNIT READY command to check the associated sense data. +This associated sense data has a progress indicator which indicates +how far the format is progressing. +Note well that most SCSI disk drives prior to a few years ago do not support this option. .Pp .Nm identify @@ -120,8 +124,8 @@ and revision strings. Issues a .Li REASSIGN BLOCKS command to the device, adding the specified blocks to the -grown defect list. This command is only supported on -direct access devices. +grown defect list. +This command is only supported on direct access devices. .Pp .Nm release .Pp @@ -137,8 +141,8 @@ command to the device to place a reservation on it. .Pp .Nm reset .Pp -Reset the device. This command is only supported for devices which -support the +Reset the device. +This command is only supported for devices which support the .Li SCIOCRESET ioctl. .Pp @@ -146,22 +150,22 @@ ioctl. .Pp Send a .Dq START -command to the device. This is useful typically only for -disk devices. +command to the device. +This is useful typically only for disk devices. .Pp .Nm stop .Pp Send a .Dq STOP -command to the device. This is useful typically only for -disk devices. +command to the device. +This is useful typically only for disk devices. .Pp .Nm tur .Pp Send a .Dq TEST UNIT READY -command to the device. This is useful for generating -current device status. +command to the device. +This is useful for generating current device status. .Pp .Nm getcache .Pp @@ -171,7 +175,8 @@ Returns basic cache parameters for the device. .Ar none|r|w|rw .Op Ar save .Pp -Set basic cache parameters for the device. The cache may be disabled +Set basic cache parameters for the device. +The cache may be disabled .Pq none , the read cache enabled .Pq r , @@ -188,8 +193,8 @@ The following commands are supported for SCSI busses: .Pp .Nm reset .Pp -Reset the SCSI bus. This command is only supported if the host adapter -supports the +Reset the SCSI bus. +This command is only supported if the host adapter supports the .Li SCBUSIORESET ioctl. .Pp @@ -197,8 +202,10 @@ ioctl. .Ar target .Ar lun .Pp -Scan the SCSI bus for devices. This is useful if a device was not -connected or powered on when the system was booted. The +Scan the SCSI bus for devices. +This is useful if a device was not connected or powered +on when the system was booted. +The .Ar target and .Ar lun @@ -212,8 +219,9 @@ or .Ar target .Ar lun .Pp -Detach the specified device from the bus. Useful if a device is powered down -after use. The +Detach the specified device from the bus. +Useful if a device is powered down after use. +The .Ar target and .Ar lun @@ -222,8 +230,8 @@ arguments have the same meaning as for the command, and may also be wildcarded. .Sh NOTES When scanning the SCSI bus, information about newly recognized devices -is printed to console. No information is printed for already probed -devices. +is printed to console. +No information is printed for already probed devices. .Sh FILES .Pa /dev/scsibus* - for commands operating on SCSI busses diff --git a/sbin/slattach/slattach.8 b/sbin/slattach/slattach.8 index ffbb3059c0e4..80cbccb260b0 100644 --- a/sbin/slattach/slattach.8 +++ b/sbin/slattach/slattach.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: slattach.8,v 1.24 2001/12/05 15:03:27 wiz Exp $ +.\" $NetBSD: slattach.8,v 1.25 2002/10/03 15:41:47 wiz Exp $ .\" .\" Copyright (c) 1986, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -54,23 +54,25 @@ The following operands are supported by .Nm "" : .Bl -tag -width Ar .It Fl H -Turn on DTR/CTS flow control. By default, no flow control is done. +Turn on DTR/CTS flow control. +By default, no flow control is done. .It Fl h -Turn on RTS/CTS flow control. By default, no flow control is done. +Turn on RTS/CTS flow control. +By default, no flow control is done. .It Fl l Turn on the CLOCAL flag, making it possible to run SLIP on a cable without modem control signals (e.g. DTR, DSR, DCD). .It Fl m -Maintain modem control signals after closing the line. Specifically, -this disables HUPCL. +Maintain modem control signals after closing the line. +Specifically, this disables HUPCL. .It Fl n Don't detach from invoking tty. .It Fl s Ar baudrate -Specifies the speed of the connection. If not specified, the -default of 9600 is used. +Specifies the speed of the connection. +If not specified, the default of 9600 is used. .It Fl t Ar ldisc -Specifies the line discipline to use for the tty. Supported line -disciplines are +Specifies the line discipline to use for the tty. +Supported line disciplines are .Dq slip (creates a .Xr sl 4 diff --git a/sbin/sysctl/sysctl.8 b/sbin/sysctl/sysctl.8 index 497cef8162d9..5222b2ca75fc 100644 --- a/sbin/sysctl/sysctl.8 +++ b/sbin/sysctl/sysctl.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: sysctl.8,v 1.80 2002/10/01 14:57:46 wiz Exp $ +.\" $NetBSD: sysctl.8,v 1.81 2002/10/03 15:41:47 wiz Exp $ .\" .\" Copyright (c) 1993 .\" The Regents of the University of California. All rights reserved. @@ -55,7 +55,7 @@ .Op Fl n .Fl A .Nm sysctl -.Op Fl n +.Op Fl n .Op Fl q .Fl f .Ar file @@ -97,12 +97,14 @@ by an equal sign and the new value to be used. .Pp The .Fl f -flag specifies the name of a file to read and process. Blank lines and -comments (beginning with +flag specifies the name of a file to read and process. +Blank lines and comments (beginning with .Ql # ) -are ignored. Line continuations with +are ignored. +Line continuations with .Ql \e -are permitted. Remaining lines are processed similarly to +are permitted. +Remaining lines are processed similarly to command line arguments of the form .Ar name or @@ -112,9 +114,9 @@ The flag is implied by .Fl f . .Pp -The +The .Fl q -flag may be used with +flag may be used with .Fl f and .Fl w @@ -124,8 +126,9 @@ detected. The .Ql proc top-level MIB has a special semantic: it represent per-process values -and as such may differ from one process to another. The second-level name -is the pid of the process (in decimal form), or the special word +and as such may differ from one process to another. +The second-level name is the pid of the process (in decimal form), +or the special word .Ql curproc . For variables below .Ql proc.\*[Lt]pid\*[Gt].rlimit , diff --git a/sbin/ttyflags/ttyflags.8 b/sbin/ttyflags/ttyflags.8 index b7133d54d8a7..b7f1aa8533d2 100644 --- a/sbin/ttyflags/ttyflags.8 +++ b/sbin/ttyflags/ttyflags.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: ttyflags.8,v 1.9 2001/11/16 10:25:51 wiz Exp $ +.\" $NetBSD: ttyflags.8,v 1.10 2002/10/03 15:41:48 wiz Exp $ .\" .\" Copyright (c) 1994 Christopher G. Demetriou .\" All rights reserved. @@ -61,7 +61,8 @@ The .Ar tty arguments are optional, but must not be specified if the .Fl a -flag is used. If specified, the +flag is used. +If specified, the .Ar tty arguments should be the base names of the ttys, as found in diff --git a/sbin/wdogctl/wdogctl.8 b/sbin/wdogctl/wdogctl.8 index 047ee5b72e71..f8ac98305a01 100644 --- a/sbin/wdogctl/wdogctl.8 +++ b/sbin/wdogctl/wdogctl.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: wdogctl.8,v 1.6 2002/07/29 21:08:30 wiz Exp $ +.\" $NetBSD: wdogctl.8,v 1.7 2002/10/03 15:41:48 wiz Exp $ .\" .\" Copyright (c) 2000 Zembu Labs, Inc. .\" All rights reserved. @@ -53,40 +53,43 @@ .Fl d .Sh DESCRIPTION .Nm -is used to manipulate watchdog timers. Watchdog timers provide a -means of ensuring that a system continues to make progress. This -is accomplished by use of a timer, provided by either hardware or +is used to manipulate watchdog timers. +Watchdog timers provide a means of ensuring that a system +continues to make progress. +This is accomplished by use of a timer, provided by either hardware or software; when the timer expires, the watchdog resets the system. In this case of a hardware watchdog timer, this is accomplished by -asserting the system's hardware reset signal. In the case of a -software watchdog timer, this is accomplished by calling the kernel's -normal reboot path. In order to prevent the system from rebooting, +asserting the system's hardware reset signal. +In the case of a software watchdog timer, +this is accomplished by calling the kernel's normal reboot path. +In order to prevent the system from rebooting, something must refresh the timer to prevent it from expiring. .Pp The .Nx kernel provides two basic modes in which watchdog timers may -operate: kernel tickle mode and user tickle mode. In kernel -tickle mode, a timer in the kernel refreshes the watchdog timer. +operate: kernel tickle mode and user tickle mode. +In kernel tickle mode, a timer in the kernel refreshes the watchdog timer. In user tickle mode, .Nm -runs in the background and refreshes the watchdog timer. In -kernel tickle mode, progress of the kernel is ensured. In user -tickle mode, the ability for user programs to run within a known -period of time is ensured. Note that user tickle mode must be -used with caution; on a heavily loaded system, the timer may +runs in the background and refreshes the watchdog timer. +In kernel tickle mode, progress of the kernel is ensured. +In user tickle mode, the ability for user programs to run within a known +period of time is ensured. +Note that user tickle mode must be used with caution; +on a heavily loaded system, the timer may expire accidentally, even though user programs may be making (very slow) progress. .Pp In both modes, an attempt is made to refresh the watchdog timer -in one half the timer's configured period. That is, if the -watchdog timer has a period of 30 seconds, a refresh attempt +in one half the timer's configured period. +That is, if the watchdog timer has a period of 30 seconds, a refresh attempt is made every 15 seconds. .Pp If called without arguments, .Nm -will list the timers available on the system. When arming a -watchdog timer, the +will list the timers available on the system. +When arming a watchdog timer, the .Ar timer argument is the name of the timer to arm. .Pp @@ -112,13 +115,14 @@ option will be silently ignored. .It Fl p Ar period When arming a timer, this flag configures the timer period to .Ar period -seconds. If the specified period it outside the timer's -range, an error message will be displayed and no action will -be taken. +seconds. +If the specified period it outside the timer's range, +an error message will be displayed and no action will be taken. .It Fl d -This flag disarms the currently active timer. Note that not all -watchdog timers can be disabled once armed. If the selected timer -can not be disabled, an error message will be displayed and the +This flag disarms the currently active timer. +Note that not all watchdog timers can be disabled once armed. +If the selected timer can not be disabled, +an error message will be displayed and the timer will remain armed. .El .Sh FILES diff --git a/sbin/wsconsctl/wsconsctl.8 b/sbin/wsconsctl/wsconsctl.8 index f5fde0ff4baf..24fe8e2dd38a 100644 --- a/sbin/wsconsctl/wsconsctl.8 +++ b/sbin/wsconsctl/wsconsctl.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: wsconsctl.8,v 1.8 2002/08/19 18:27:31 wiz Exp $ +.\" $NetBSD: wsconsctl.8,v 1.9 2002/10/03 15:41:48 wiz Exp $ .\" .\" Copyright (c) 1998 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -81,7 +81,8 @@ The value can be specified as either an absolute value, by using the symbol or as a relative value, by using the .Ql += -symbol. See the +symbol. +See the .Ar EXAMPLES section for more details. .It Fl f Ar file @@ -125,7 +126,8 @@ The keyboard types, and the height, width, depth (bits per pixel), color map size, and colormap are defined in the .Pa /usr/include/dev/wscons/wsconsio.h -file. There are also definitions relating to video +file. +There are also definitions relating to video control and cursor control, which are not applicable to all display types, and to text emulation and graphics (mapped) modes. @@ -169,7 +171,8 @@ sets a US keyboard encoding, with the .Ar Caps Lock and .Ar Left Control -keys swapped. The +keys swapped. +The .Ar .swapctrlcaps encoding does not work for all national keyboard encodings. For most purposes, the ability to set the value returned