From 2fb4b1db523be5192a022df0dfc49f14648cc750 Mon Sep 17 00:00:00 2001 From: wiz Date: Tue, 1 Oct 2002 13:40:23 +0000 Subject: [PATCH] New sentence, new line. By Robert Elz with minimal fixes. --- sbin/atactl/atactl.8 | 102 ++--- sbin/bim/bim.8 | 52 +-- sbin/brconfig/brconfig.8 | 86 ++-- sbin/ccdconfig/ccdconfig.8 | 23 +- sbin/chkconfig/chkconfig.8 | 8 +- sbin/dkctl/dkctl.8 | 12 +- sbin/dump/dump.8 | 62 +-- sbin/dump_lfs/dump_lfs.8 | 17 +- sbin/fdisk/fdisk.8 | 5 +- sbin/fsck/fsck.8 | 16 +- sbin/fsck_ext2fs/fsck_ext2fs.8 | 19 +- sbin/fsck_ffs/fsck_ffs.8 | 23 +- sbin/fsck_lfs/fsck_lfs.8 | 11 +- sbin/fsck_msdos/fsck_msdos.8 | 6 +- sbin/fsdb/fsdb.8 | 39 +- sbin/init/init.8 | 5 +- sbin/ldconfig/ldconfig.8 | 33 +- sbin/lmcctl/lmcctl.8 | 21 +- sbin/modload/modload.8 | 23 +- sbin/mount/mount.8 | 42 +- sbin/mount_ados/mount_ados.8 | 5 +- sbin/mount_cd9660/mount_cd9660.8 | 9 +- sbin/mount_ffs/mount_ffs.8 | 7 +- sbin/mount_filecore/mount_filecore.8 | 12 +- sbin/mount_msdos/mount_msdos.8 | 17 +- sbin/mount_nfs/mount_nfs.8 | 70 ++-- sbin/mount_ntfs/mount_ntfs.8 | 18 +- sbin/mount_null/mount_null.8 | 54 +-- sbin/mount_overlay/mount_overlay.8 | 5 +- sbin/mount_portal/mount_portal.8 | 45 +- sbin/mount_procfs/mount_procfs.8 | 32 +- sbin/mount_umap/mount_umap.8 | 15 +- sbin/newfs/mount_mfs.8 | 5 +- sbin/newfs/newfs.8 | 5 +- sbin/newfs_lfs/newfs_lfs.8 | 61 +-- sbin/newfs_msdos/newfs_msdos.8 | 43 +- sbin/ping/ping.8 | 49 ++- sbin/pppoectl/pppoectl.8 | 114 ++--- sbin/raidctl/raidctl.8 | 597 +++++++++++++++------------ 39 files changed, 995 insertions(+), 773 deletions(-) diff --git a/sbin/atactl/atactl.8 b/sbin/atactl/atactl.8 index 01e92bf0159b..b219925af8ed 100644 --- a/sbin/atactl/atactl.8 +++ b/sbin/atactl/atactl.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: atactl.8,v 1.12 2002/08/06 00:44:36 wiz Exp $ +.\" $NetBSD: atactl.8,v 1.13 2002/10/01 13:40:23 wiz Exp $ .\" .\" Copyright (c) 1998 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -51,13 +51,12 @@ .Sh DESCRIPTION .Nm allows a user or system administrator to issue commands to and otherwise -control devices which reside on standard IDE and ATA controllers. It is -used by specifying -a device to manipulate, the command to perform, and any arguments -the command may require. +control devices which reside on standard IDE and ATA controllers. +It is used by specifying a device to manipulate, +the command to perform, and any arguments the command may require. .Sh DEVICE COMMANDS -The following commands may be used on IDE and ATA devices. Note -that not all devices support all commands. +The following commands may be used on IDE and ATA devices. +Note that not all devices support all commands. .Pp .Cm identify .Pp @@ -66,38 +65,41 @@ revision strings, and the device's capabilities. .Pp .Cm idle .Pp -Place the specified device into Idle mode. This mode may consume less -power than Active mode. +Place the specified device into Idle mode. +This mode may consume less power than Active mode. .Pp .Cm standby .Pp -Place the specified device into Standby mode. This mode will consume -less power than Idle mode. +Place the specified device into Standby mode. +This mode will consume less power than Idle mode. .Pp .Cm sleep .Pp -Place the specified device into Sleep mode. This mode will consume -less power than Standby mode, but requires a device reset to resume -operation. Typically the +Place the specified device into Sleep mode. +This mode will consume less power than Standby mode, +but requires a device reset to resume operation. +Typically the .Xr wd 4 -driver performs this reset automatically, but this should still be -used with caution. +driver performs this reset automatically, +but this should still be used with caution. .Pp .Cm setidle .Ar idle-timer .Pp -Places the specified device into Idle mode, and sets the Idle timer -to +Places the specified device into Idle mode, +and sets the Idle timer to .Ar idle-timer -seconds. A value of 0 will disable the Idle timer. +seconds. +A value of 0 will disable the Idle timer. .Pp .Cm setstandby .Ar standby-timer .Pp -Places the specified device into Standby mode, and sets the Standby timer -to +Places the specified device into Standby mode, +and sets the Standby timer to .Ar standby-timer -seconds. A value of 0 will disable the Standby timer. +seconds. +A value of 0 will disable the Standby timer. .Pp .Cm checkpower .Pp @@ -107,22 +109,24 @@ management mode. .Cm smart .Ar [enable | disable | status] .Pp -Controls SMART feature set of the specified device. SMART stands for -Self-Monitoring, Analysis, and Reporting Technology. It provides an -early warning system by comparing subtle operation characteristics to -those determined in vendor testing to precede device failures. +Controls SMART feature set of the specified device. +SMART stands for Self-Monitoring, Analysis, and Reporting Technology. +It provides an early warning system by comparing subtle operation +characteristics to those determined in vendor testing +to precede device failures. .Pp .Ar enable .Pp -Enables access to SMART capabilities within the device. Prior to being -enabled, a SMART capable device neither monitors nor saves SMART -attribute values. The state of SMART, either enabled or disabled, will +Enables access to SMART capabilities within the device. +Prior to being enabled, a SMART capable device neither +monitors nor saves SMART attribute values. +The state of SMART, either enabled or disabled, will be preserved by the device across power cycles. .Pp .Ar disable .Pp -Disables access to SMART capabilities within the device. Attribute values -will be saved, and will no longer be monitored. +Disables access to SMART capabilities within the device. +Attribute values will be saved, and will no longer be monitored. .Pp .Ar status .Pp @@ -130,29 +134,32 @@ Reports whether SMART is supported by the device, and whether SMART is enabled on the device (can only be determined on ATA6 or better devices). If SMART is enabled, then a table of attribute information is printed. Attributes are the specific performance or calibration parameters that -are used in analyzing the status of the device. The specific set of -attributes being used and the identity of these attributes is vendor -specific and proprietary. +are used in analyzing the status of the device. +The specific set of attributes being used and the identity of +these attributes is vendor specific and proprietary. .Pp Attribute values are used to represent the relative reliability of -individual performance or calibration parameters. The valid range of -attribute values is from 1 to 253 decimal. Lower values indicate that the -analysis algorithms being used by the device are predicting a higher -probability of a degrading or faulty condition. +individual performance or calibration parameters. +The valid range of attribute values is from 1 to 253 decimal. +Lower values indicate that the analysis algorithms being used by the device +are predicting a higher probability of a degrading or faulty condition. .Pp Each attribute value has a corresponding threshold limit which is used for direct comparison to the attribute value to indicate the existence of a -degrading or faulty condition. The numerical value of the attribute -thresholds are determined by the device manufacturer through design and -reliability testing and analysis. Each attribute threshold represents the -lowest limit to which its corresponding attribute value can equal while -still retaining a positive reliability status. +degrading or faulty condition. +The numerical value of the attribute thresholds are determined by the +device manufacturer through design and reliability testing and analysis. +Each attribute threshold represents the lowest limit to which its +corresponding attribute value can equal while still retaining a +positive reliability status. .Pp If the crit field is "yes" then negative reliability of this attribute -predicts imminent data loss. Otherwise it merely indicates that the -intended design life period of usage or age has been exceeded. +predicts imminent data loss. +Otherwise it merely indicates that the intended design life period +of usage or age has been exceeded. The collect field indicates whether this attribute is updated while the -device is online. The reliability field indicates whether the attribute +device is online. +The reliability field indicates whether the attribute value is within the acceptable threshold. .Sh SEE ALSO .Xr ioctl 2 , @@ -165,7 +172,8 @@ command first appeared in .Sh AUTHORS The .Nm -command was written by Ken Hornstein. It was based heavily on the +command was written by Ken Hornstein. +It was based heavily on the .Xr scsictl 8 command written by Jason R. Thorpe. .Sh BUGS diff --git a/sbin/bim/bim.8 b/sbin/bim/bim.8 index c908aafc920f..531bea27e990 100644 --- a/sbin/bim/bim.8 +++ b/sbin/bim/bim.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: bim.8,v 1.7 2001/04/21 14:44:13 wiz Exp $ +.\" $NetBSD: bim.8,v 1.8 2002/10/01 13:40:25 wiz Exp $ .\" .\" Copyright 1997 Piermont Information Systems Inc. .\" All rights reserved. @@ -45,55 +45,60 @@ bim .Op Fl c Ar command .Op Ar device .Sh DESCRIPTION -The pc532 has available an autoboot ROM monitor. This ROM monitor understands -the +The pc532 has available an autoboot ROM monitor. +This ROM monitor understands the .Bx -disklabel and expects a boot image directory following the -disklabel. Also, it expects an image partition for the storage of bootable -images. The image directory and the image partition is managed by +disklabel and expects a boot image directory following the disklabel. +Also, it expects an image partition for the storage of bootable images. +The image directory and the image partition is managed by .Nm "" . The .Ar device -is the raw disk partition that includes the disklabel. The default -value of +is the raw disk partition that includes the disklabel. +The default value of .Ar device is .Pa /dev/rsd0c . .Nm directly accesses both the disklabel and the image partition directly -from the raw disk device. It does not open the device corresponding -to the boot partition. +from the raw disk device. +It does not open the device corresponding to the boot partition. .Pp The .Fl y argument assumes a yes response to any questions .Nm -would normally ask the user. It is mainly useful for -scripting. +would normally ask the user. +It is mainly useful for scripting. .Pp The .Cm -c command argument allows .Nm -to execute commands given via the command line. This allows +to execute commands given via the command line. +This allows .Nm -to be used from scripts. The +to be used from scripts. +The .Cm -c command -argument may be repeated up to 20 times. The commands -will be executed in the order given. +argument may be repeated up to 20 times. +The commands will be executed in the order given. .Sh DISK INITIALIZATION .Nm is typically used as part of the initial setup on a disk. The disk must be partitioned by using .Xr disklabel 8 , -making sure there is a boot boot partition. This boot -partition is often just after the disklabel. It must not include -the disklabel. If +making sure there is a boot boot partition. +This boot partition is often just after the disklabel. +It must not include the disklabel. +If .Nm -does not detect a boot image directory, it asks if the user wants -one created. From there, the operation of +does not detect a boot image directory, +it asks if the user wants one created. +From there, the operation of .Nm -is completely command driven. The command interpreter is +is completely command driven. +The command interpreter is .Sh COMMANDS .Nm supports the following commands. @@ -132,7 +137,8 @@ For the details on these commands, ask for help from .Xr disklabel 8 .Sh AUTHORS Bruce Culbertson wrote the basic command interpreter for the pc532 -ROM monitor. Philip A. Nelson took the command interpreter, modified +ROM monitor. +Philip A. Nelson took the command interpreter, modified it to be a more generic command interpreter and added the .Nm specific code. diff --git a/sbin/brconfig/brconfig.8 b/sbin/brconfig/brconfig.8 index 8aac9af24af8..41fc57ab8638 100644 --- a/sbin/brconfig/brconfig.8 +++ b/sbin/brconfig/brconfig.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: brconfig.8,v 1.3 2001/11/16 11:26:53 wiz Exp $ +.\" $NetBSD: brconfig.8,v 1.4 2002/10/01 13:40:26 wiz Exp $ .\" .\" Copyright 2001 Wasabi Systems, Inc. .\" All rights reserved. @@ -52,15 +52,16 @@ The .Nm utility is used to configure network bridge parameters and retrieve -network bridge parameters and status from the kernel. The bridging -function is implemented by the +network bridge parameters and status from the kernel. +The bridging function is implemented by the .Xr bridge 4 driver. .Pp A network bridge creates a logical link between two or more IEEE 802 networks that use the same (or .Dq similar enough ) -framing format. For example, it is possible to bridge Ethernet +framing format. +For example, it is possible to bridge Ethernet and 802.11 networks together, but it is not possible to bridge Ethernet and Token Ring together. .Pp @@ -68,19 +69,21 @@ Bridge interfaces are created using the .Xr ifconfig 8 command's .Dq create -sub-command. All other bridge configuration is performed using +sub-command. +All other bridge configuration is performed using .Nm "" . .Pp The options are as follows: .Bl -tag -width indent .It Fl a -Display the status of all bridge devices present on the system. This -flag is mutually exclusive with all other sub-commands. +Display the status of all bridge devices present on the system. +This flag is mutually exclusive with all other sub-commands. .El .Pp -All other operations require that a bridge be specified. If a -bridge is specified with no sub-commands, the status of that bridge -is displayed. The following sub-commands are available: +All other operations require that a bridge be specified. +If a bridge is specified with no sub-commands, +the status of that bridge is displayed. +The following sub-commands are available: .Pp .Bl -tag -width indent .It Cm up @@ -90,12 +93,14 @@ Stop forwarding packets on the bridge. .It Cm add Ar interface Add the interface named by .Ar interface -as a member of the bridge. The interface is put into promiscuous mode +as a member of the bridge. +The interface is put into promiscuous mode so that it can receive every packet sent on the network. .It Cm delete Ar interface Remove the interface named by .Ar interface -from the bridge. Promiscuous mode is disabled on the interface when +from the bridge. +Promiscuous mode is disabled on the interface when it is removed from the bridge. .It Cm maxaddr Ar size Set the size of the bridge address cache to @@ -104,10 +109,11 @@ The default is 100 entries. .It Cm timeout Ar seconds Set the timeout of address cache entries to .Ar seconds -seconds. If +seconds. +If .Ar seconds -is zero, then address cache entries will not be expired. The -default is 240 seconds. +is zero, then address cache entries will not be expired. +The default is 240 seconds. .It Cm deladdr Ar address Delete .Ar address @@ -119,16 +125,19 @@ Delete all addresses, including static addresses, from the address cache. .It Cm discover Ar interface Mark an interface as a .Dq discovering -interface. When the bridge has no -address cache entry (either dynamic or static) for the destination address -of a packet, the bridge will forward the packet to all member interfaces -marked as +interface. +When the bridge has no address cache entry +(either dynamic or static) +for the destination address of a packet, +the bridge will forward the packet to all +member interfaces marked as .Dq discovering . This is the default for all interfaces added to a bridge. .It Cm -discover Ar interface Clear the .Dq discovering -attribute on a member interface. For packets without the +attribute on a member interface. +For packets without the .Dq discovering attribute, the only packets forwarded on the interface are broadcast or multicast packets and packets for which the destination address @@ -136,10 +145,11 @@ is known to be on the interface's segment. .It Cm learn Ar interface Mark an interface as a .Dq learning -interface. When a packet arrives on such an interface, the source +interface. +When a packet arrives on such an interface, the source address of the packet is entered into the address cache as being a -destination address on the interface's segment. This is the default -for all interfaces added to a bridge. +destination address on the interface's segment. +This is the default for all interfaces added to a bridge. .It Cm -learn Ar interface Clear the .Dq learning @@ -156,26 +166,30 @@ Disable Spanning Tree protocol on .Ar interface . This is the default for all interfaces added to a bridge. .It Cm maxage Ar seconds -Set the time that a Spanning Tree protocol configuration is valid. The -default is 20 seconds. The mininum is 1 second and the maximum is 255 -seconds. +Set the time that a Spanning Tree protocol configuration is valid. +The default is 20 seconds. +The mininum is 1 second and the maximum is 255 seconds. .It Cm fwddelay Ar seconds Set the time that must pass before an interface begins forwarding -packets when Spanning Tree is enabled. The default is 15 seconds. The -mininum is 1 second and the maximum is 255 seconds. +packets when Spanning Tree is enabled. +The default is 15 seconds. +The mininum is 1 second and the maximum is 255 seconds. .It Cm hellotime Ar seconds Set the time between broadcasting of Spanning Tree protocol -configuration messages. The default is 2 seconds. The minimum is 1 -second and the maximum is 255 seconds. +configuration messages. +The default is 2 seconds. +The minimum is 1 second and the maximum is 255 seconds. .It Cm priority Ar value -Set the bridge priority for Spanning Tree. The default is 32768. +Set the bridge priority for Spanning Tree. +The default is 32768. The minimum is 0 and the maximum is 65536. .It Cm ifpriority Ar interface Ar value Set the Spanning Tree priority of .Ar interface to .Ar value . -The default is 128. The minimum is 0 and the maximum is 255. +The default is 128. +The minimum is 0 and the maximum is 255. .El .Sh EXAMPLES The following then placed in the file @@ -186,8 +200,8 @@ to be created, and will add the interfaces .Sq ray0 and .Sq fxp0 -to the bridge, and then enable packet forwarding. Such a -configuration could be used to implement a simple +to the bridge, and then enable packet forwarding. +Such a configuration could be used to implement a simple 802.11-to-Ethernet bridge (assuming the 802.11 interface is in ad-hoc mode). .Bd -literal -offset indent @@ -195,8 +209,8 @@ create !brconfig $int add ray0 add fxp0 up .Ed .Pp -Consider a system with two 4-port Ethernet boards. The following -placed in the file +Consider a system with two 4-port Ethernet boards. +The following placed in the file .Pa /etc/ifconfig.bridge0 will cause a bridge consisting of all 8 ports with Spanning Tree enabled to be created: diff --git a/sbin/ccdconfig/ccdconfig.8 b/sbin/ccdconfig/ccdconfig.8 index a3496f369edf..5883aec47b5a 100644 --- a/sbin/ccdconfig/ccdconfig.8 +++ b/sbin/ccdconfig/ccdconfig.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: ccdconfig.8,v 1.20 2002/06/11 13:33:48 grant Exp $ +.\" $NetBSD: ccdconfig.8,v 1.21 2002/10/01 13:40:26 wiz Exp $ .\" .\" Copyright (c) 1996, 1997 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -72,13 +72,15 @@ .Sh DESCRIPTION .Nm is used to dynamically configure and unconfigure concatenated disk -devices, or ccds. For more information about the ccd, see +devices, or ccds. +For more information about the ccd, see .Xr ccd 4 . .Pp The options are as follows: .Bl -tag -width indent .It Fl c -Configure a ccd. This is the default behavior of +Configure a ccd. +This is the default behavior of .Nm "" . .It Fl C Configure all ccd devices listed in the ccd configuration file. @@ -88,9 +90,10 @@ When configuring or unconfiguring all devices, read the file instead of the default .Pa /etc/ccd.conf . .It Fl g -Dump the current ccd configuration in a format suitable for use as the -ccd configuration file. If no arguments are specified, every configured -ccd is dumped. Otherwise, the configuration of each listed ccd is dumped. +Dump the current ccd configuration in a format suitable +for use as the ccd configuration file. +If no arguments are specified, every configured ccd is dumped. +Otherwise, the configuration of each listed ccd is dumped. .It Fl M Ar core Extract values associated with the name list from .Pa core @@ -112,10 +115,10 @@ to be verbose. .El .Pp A ccd is described on the command line and in the ccd configuration -file by the name of the ccd, the interleave factor, the ccd configuration -flags, and a list of one or more devices. The flags may be represented -as a decimal number, a hexadecimal number, a comma-separated list -of strings, or the word +file by the name of the ccd, the interleave factor, +the ccd configuration flags, and a list of one or more devices. +The flags may be represented as a decimal number, a hexadecimal number, +a comma-separated list of strings, or the word .Dq none . The flags are as follows: .Bd -unfilled -offset indent diff --git a/sbin/chkconfig/chkconfig.8 b/sbin/chkconfig/chkconfig.8 index 070491d5b90a..43768c281a26 100644 --- a/sbin/chkconfig/chkconfig.8 +++ b/sbin/chkconfig/chkconfig.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: chkconfig.8,v 1.4 2001/11/16 11:26:54 wiz Exp $ +.\" $NetBSD: chkconfig.8,v 1.5 2002/10/01 13:40:27 wiz Exp $ .\" .\" Copyright (c) 2001 Zembu Labs, Inc. .\" All rights reserved. @@ -99,12 +99,14 @@ keyword .Dq chkconfig present in the .Xr rc.d 8 -script for that service. If a service's script does not contain +script for that service. +If a service's script does not contain this keyword, it may still be managed by .Nm using the .Fl f -flag. When this flag is used, +flag. +When this flag is used, .Nm will automatically add the .Dq chkconfig diff --git a/sbin/dkctl/dkctl.8 b/sbin/dkctl/dkctl.8 index cd0761eb7093..1b12342c6b14 100644 --- a/sbin/dkctl/dkctl.8 +++ b/sbin/dkctl/dkctl.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: dkctl.8,v 1.3 2002/07/01 18:49:57 yamt Exp $ +.\" $NetBSD: dkctl.8,v 1.4 2002/10/01 13:40:29 wiz Exp $ .\" .\" Copyright 2002 Wasabi Systems, Inc. .\" All rights reserved. @@ -50,7 +50,8 @@ .Sh DESCRIPTION .Nm allows a user or system administrator to manipulate and configure disks -in various ways. It is used by specifying a disk to manipulate, the command +in various ways. +It is used by specifying a disk to manipulate, the command to perform, and any arguments the command may require. .Sh COMMANDS The following commands are supported: @@ -63,8 +64,8 @@ Get and display the cache enables for the specified device. .Ar none | r | w | rw .Op Ar save .Pp -Set the cache enables for the specified device. The enables are -as follows: +Set the cache enables for the specified device. +The enables are as follows: .Bl -tag -width indent .It none Disable all caches on the disk. @@ -83,7 +84,8 @@ enables in the disk's non-volatile parameter storage. .Op Ar force .Pp Causes the cache on the disk to be synchronized, flushing all dirty -write cache blocks to the media. If +write cache blocks to the media. +If .Ar force is specified, the cache synchronization command will be issued even if the kernel does not believe that there are any dirty cache blocks diff --git a/sbin/dump/dump.8 b/sbin/dump/dump.8 index 61ed14234592..581251f13687 100644 --- a/sbin/dump/dump.8 +++ b/sbin/dump/dump.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: dump.8,v 1.47 2002/02/26 02:00:16 wiz Exp $ +.\" $NetBSD: dump.8,v 1.48 2002/10/01 13:40:27 wiz Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 .\" Regents of the University of California. @@ -98,14 +98,12 @@ A dump that is larger than the output medium is broken into multiple volumes. On most media the size is determined by writing until an end-of-media indication is returned. -This can be enforced -by using the +This can be enforced by using the .Fl a option. .Pp On media that cannot reliably return an end-of-media indication -(such as some cartridge tape drives) -each volume is of a fixed size; +(such as some cartridge tape drives) each volume is of a fixed size; the actual size is determined by the tape size and density and/or block count options below. By default, the same output file name is used for each volume @@ -135,15 +133,12 @@ The following options are supported by .Bl -tag -width Ds .It Fl 0\-9 Dump levels. -A level 0, full backup, -guarantees the entire file system is copied +A level 0, full backup, guarantees the entire file system is copied (but see also the .Fl h option below). -A level number above 0, -incremental backup, -tells dump to -copy all files new or modified since the +A level number above 0, incremental backup, +tells dump to copy all files new or modified since the last dump of a lower level. The default level is 9. .It Fl a @@ -178,14 +173,12 @@ is a file system image. Write the backup to .Ar file ; .Ar file -may be a special device file -like +may be a special device file like .Pa /dev/rst0 (a tape drive), .Pa /dev/rsd1c (a disk drive), -an ordinary file, -or +an ordinary file, or .Ql Fl (the standard output). Multiple file names may be given as a single argument separated by commas. @@ -222,15 +215,17 @@ so that incremental backups omit such files but full backups retain them. .It Fl k Ar read blocksize The size in kilobyte of the read buffers, rounded up to a multiple of the -file system block size. Default is 32k. +file system block size. +Default is 32k. .It Fl l Ar timeout If a tape change is required, eject the tape and wait for the drive to -be ready again. This is to be used with tape changers which automatically load -the next tape when the tape is ejected. If after the timeout (in seconds) the -drive is not ready +be ready again. +This is to be used with tape changers which automatically load +the next tape when the tape is ejected. +If after the timeout (in seconds) the drive is not ready .Nm -falls back to the default behavior, and prompts the operator for the next -tape. +falls back to the default behavior, +and prompts the operator for the next tape. .It Fl L Ar label The user-supplied text string .Ar label @@ -239,9 +234,8 @@ is placed into the dump header, where tools like and .Xr file 1 can access it. -Note that this label is limited -to be at most LBLSIZE (currently 16) characters, which must include -the terminating +Note that this label is limited to be at most LBLSIZE +(currently 16) characters, which must include the terminating .Ql \e0 . .It Fl n Whenever @@ -255,9 +249,11 @@ by means similar to a Use that many buffers for read cache operations. A value of zero disables the read cache altogether, higher values improve read performance by reading larger data blocks from the -disk and maintaining them in an LRU cache. See the +disk and maintaining them in an LRU cache. +See the .Fl k -option for the size of the buffers. Maximum is 512, the size of the cache is +option for the size of the buffers. +Maximum is 512, the size of the cache is limited to 15% of the avail RAM by default. .It Fl s Ar feet Attempt to calculate the amount of tape needed @@ -273,8 +269,9 @@ required, and exit without actually performing the dump. .It Fl t All informational log messages printed by .Nm -will have the time prepended to them. Also, the completion time -interval estimations will have the estimated time at which the dump +will have the time prepended to them. +Also, the completion time interval estimations +will have the estimated time at which the dump will complete printed at the end of the line. .It Fl T Ar date Use the specified date as the starting time for the dump @@ -343,7 +340,8 @@ flag .Pq Dv UF_NODUMP , files with the .Qq nodump -flag will not be backed up. If a directory has the +flag will not be backed up. +If a directory has the .Qq nodump flag, this directory and any file or directory under it will not be backed up. .Pp @@ -480,7 +478,8 @@ limit is exceeded then .Qo ERROR: TIMEFORMAT too long, reverting to default .Qc -will be printed and the time format will revert to the default one. If +will be printed and the time format will revert to the default one. +If .Ev TIMEFORMAT is not set then the format string defaults to .Qo @@ -490,7 +489,8 @@ is not set then the format string defaults to .Sh FILES .Bl -tag -width /etc/dumpdates -compact .It Pa /dev/nrst0 -default tape unit to use. Taken from +default tape unit to use. +Taken from .Dv _PATH_DEFTAPE in .Pa /usr/include/paths.h . diff --git a/sbin/dump_lfs/dump_lfs.8 b/sbin/dump_lfs/dump_lfs.8 index 59eededdb56d..da964bb55253 100644 --- a/sbin/dump_lfs/dump_lfs.8 +++ b/sbin/dump_lfs/dump_lfs.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: dump_lfs.8,v 1.6 2002/01/21 18:15:08 wiz Exp $ +.\" $NetBSD: dump_lfs.8,v 1.7 2002/10/01 13:40:28 wiz Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 .\" Regents of the University of California. @@ -173,7 +173,8 @@ so that incremental backups omit such files but full backups retain them. .It Fl k Ar read blocksize The size in kilobyte of the read buffers, rounded up to a multiple of the -filesystem block size. Default is 32k. +filesystem block size. +Default is 32k. .It Fl L Ar label The user-supplied text string .Ar label @@ -198,9 +199,11 @@ by means similar to a Use that many buffers for read cache operations. A value of zero disables the read cache altogether, higher values improve read performance by reading larger data blocks from the -disk and maintaining them in an LRU cache. See the +disk and maintaining them in an LRU cache. +See the .Fl k -option for the size of the buffers. Maximum is 512, the size of the cache is +option for the size of the buffers. +Maximum is 512, the size of the cache is limited to 15% of the avail RAM by default. .It Fl s Ar feet Attempt to calculate the amount of tape needed @@ -280,7 +283,8 @@ flag .Pq Dv UF_NODUMP , files with the .Qq nodump -flag will not be backed up. If a directory has the +flag will not be backed up. +If a directory has the .Qq nodump flag, this directory and any file or directory under it will not be backed up. .Pp @@ -409,7 +413,8 @@ on the remote machine. .Sh FILES .Bl -tag -width /etc/dumpdates -compact .It Pa /dev/nrst0 -default tape unit to use. Taken from +default tape unit to use. +Taken from .Dv _PATH_DEFTAPE in .Pa /usr/include/paths.h . diff --git a/sbin/fdisk/fdisk.8 b/sbin/fdisk/fdisk.8 index c5d014c63859..5312c666c373 100644 --- a/sbin/fdisk/fdisk.8 +++ b/sbin/fdisk/fdisk.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: fdisk.8,v 1.30 2002/03/26 23:56:05 christos Exp $ +.\" $NetBSD: fdisk.8,v 1.31 2002/10/01 13:40:29 wiz Exp $ .\" .Dd December 19, 2000 .Dt FDISK 8 @@ -86,7 +86,8 @@ The various fields in each partition are: is used to label the partition. .Nx reserves the magic number 169 decimal (A9 in hex). -The number 0 is used to mark a partition as unused. See the +The number 0 is used to mark a partition as unused. +See the .Fl l flag. .It Xo diff --git a/sbin/fsck/fsck.8 b/sbin/fsck/fsck.8 index 0ed6ab537132..84289a3e3b81 100644 --- a/sbin/fsck/fsck.8 +++ b/sbin/fsck/fsck.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: fsck.8,v 1.26 2001/12/20 20:10:36 soren Exp $ +.\" $NetBSD: fsck.8,v 1.27 2002/10/01 13:40:30 wiz Exp $ .\" .\" Copyright (c) 1996 Christos Zoulas. All rights reserved. .\" @@ -72,15 +72,17 @@ to be the partition designator. The options are as follows: .Bl -tag -width indent .It Fl d -Debugging mode. Just print the commands without executing them. +Debugging mode. +Just print the commands without executing them. .It Fl f Force checking of file systems, even when they are marked clean (for file systems that support this), or when they are mounted read-write. .It Fl l Ar maxparallel Limit the number of parallel checks to the number specified in -the following argument. By default, the limit is the number of -disks, running one process per disk. If a smaller limit is giv- -en, the disks are checked round-robin, one file system at a time. +the following argument. +By default, the limit is the number of disks, running one process per disk. +If a smaller limit is given, the disks are checked round-robin, +one file system at a time. .It Fl n Causes .Nm @@ -102,8 +104,8 @@ intervention is required. .It Fl t Ar fstype Invoke .Nm -only for the comma separated list of file system types. If the -list starts with +only for the comma separated list of file system types. +If the list starts with .Dq no then invoke .Nm diff --git a/sbin/fsck_ext2fs/fsck_ext2fs.8 b/sbin/fsck_ext2fs/fsck_ext2fs.8 index 62ff17145f72..fef1d2657213 100644 --- a/sbin/fsck_ext2fs/fsck_ext2fs.8 +++ b/sbin/fsck_ext2fs/fsck_ext2fs.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: fsck_ext2fs.8,v 1.9 2002/02/07 03:15:07 ross Exp $ +.\" $NetBSD: fsck_ext2fs.8,v 1.10 2002/10/01 13:40:30 wiz Exp $ .\" .\" Copyright (c) 1997 Manuel Bouyer. .\" Copyright (c) 1980, 1989, 1991, 1993 @@ -54,7 +54,8 @@ .Sh DESCRIPTION .Nm performs interactive filesystem consistency checks and repair for each of -the filesystems specified on the command line. It is normally invoked from +the filesystems specified on the command line. +It is normally invoked from .Xr fsck 8 . .Pp The kernel takes care that only a restricted class of innocuous filesystem @@ -83,7 +84,8 @@ option) will correct; if it encounters other inconsistencies, it exits with an abnormal return status. For each corrected inconsistency one or more lines will be printed identifying the filesystem on which the correction will take place, -and the nature of the correction. After successfully correcting a filesystem, +and the nature of the correction. +After successfully correcting a filesystem, .Nm will print the number of files on that filesystem and the number of used and free blocks. @@ -123,17 +125,18 @@ The following flags are interpreted by .Bl -tag -width indent .It Fl b Use the block specified immediately after the flag as -the super block for the filesystem. Block 8193 is usually -an alternate super block. +the super block for the filesystem. +Block 8193 is usually an alternate super block. .It Fl d Print debugging output. .It Fl f -Force checking of file systems. Normally, if a file system is cleanly -unmounted, the kernel will set a +Force checking of file systems. +Normally, if a file system is cleanly unmounted, the kernel will set a .Dq clean flag in the file system superblock, and .Nm -will not check the file system. This option forces +will not check the file system. +This option forces .Nm to check the file system, regardless of the state of the clean flag. .It Fl m diff --git a/sbin/fsck_ffs/fsck_ffs.8 b/sbin/fsck_ffs/fsck_ffs.8 index ef6ccb81d4c0..bc9ddefa6bf1 100644 --- a/sbin/fsck_ffs/fsck_ffs.8 +++ b/sbin/fsck_ffs/fsck_ffs.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: fsck_ffs.8,v 1.30 2002/09/28 20:11:06 dbj Exp $ +.\" $NetBSD: fsck_ffs.8,v 1.31 2002/10/01 13:40:31 wiz Exp $ .\" .\" Copyright (c) 1980, 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -56,7 +56,8 @@ .Sh DESCRIPTION .Nm performs interactive file system consistency checks and repair for each of -the file systems specified on the command line. It is normally invoked from +the file systems specified on the command line. +It is normally invoked from .Xr fsck 8 . .Pp The kernel takes care that only a restricted class of innocuous file system @@ -85,8 +86,8 @@ option) will correct; if it encounters other inconsistencies, it exits with an abnormal return status. For each corrected inconsistency one or more lines will be printed identifying the file system on which the correction will take place, -and the nature of the correction. After successfully correcting a file -system, +and the nature of the correction. +After successfully correcting a file system, .Nm will print the number of files on that file system, the number of used and free blocks, @@ -151,7 +152,8 @@ Interpret the filesystem as an Apple UFS filesystem, even if there is no Apple UFS volume label present. .It Fl B Convert the file system metadata to the specified byte order if needed. -Valid byte order are `be' and `le'. If +Valid byte order are `be' and `le'. +If .Nm "" is interrupted while swapping the metadata byte order, the file system cannot be recovered. @@ -160,8 +162,8 @@ will print a message in interactive mode if the file system is not in host byte order. .It Fl b Use the block specified immediately after the flag as -the super block for the file system. Block 32 is usually -an alternative super block. +the super block for the file system. +Block 32 is usually an alternative super block. .It Fl c Convert the file system to the specified level. Note that the level of a file system can only be raised. @@ -206,12 +208,13 @@ will be accessed .Sq as-is , and no attempts will be made to read a disklabel. .It Fl f -Force checking of file systems. Normally, if a file system is cleanly -unmounted, the kernel will set a +Force checking of file systems. +Normally, if a file system is cleanly unmounted, the kernel will set a .Dq clean flag in the file system superblock, and .Nm -will not check the file system. This option forces +will not check the file system. +This option forces .Nm to check the file system, regardless of the state of the clean flag. .It Fl m diff --git a/sbin/fsck_lfs/fsck_lfs.8 b/sbin/fsck_lfs/fsck_lfs.8 index b0e49557cbf7..30cfff42a0db 100644 --- a/sbin/fsck_lfs/fsck_lfs.8 +++ b/sbin/fsck_lfs/fsck_lfs.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: fsck_lfs.8,v 1.9 2002/02/08 01:30:43 ross Exp $ +.\" $NetBSD: fsck_lfs.8,v 1.10 2002/10/01 13:40:31 wiz Exp $ .\" .\" Copyright (c) 1980, 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -53,7 +53,8 @@ .Sh DESCRIPTION .Nm performs interactive filesystem consistency checks and repair for each of -the filesystems specified on the command line. It is normally invoked from +the filesystems specified on the command line. +It is normally invoked from .Xr fsck 8 . .Pp The design of LFS takes care that no filesystem inconsistencies can @@ -63,7 +64,8 @@ will report and optionally correct any such inconsistencies. .Pp For each corrected inconsistency one or more lines will be printed identifying the filesystem on which the correction will take place, -and the nature of the correction. After successfully correcting a filesystem, +and the nature of the correction. +After successfully correcting a filesystem, .Nm will print the number of files on that filesystem, the number of used and free blocks, @@ -130,7 +132,8 @@ except for which is assumed to be affirmative; do not open the filesystem for writing. .It Fl p -Specify ``preen'' mode. Currently, in this mode +Specify ``preen'' mode. +Currently, in this mode .Nm simply checks validity of the newer checkpoint. .It Fl y diff --git a/sbin/fsck_msdos/fsck_msdos.8 b/sbin/fsck_msdos/fsck_msdos.8 index 66252608fc72..c200dd5d2f8c 100644 --- a/sbin/fsck_msdos/fsck_msdos.8 +++ b/sbin/fsck_msdos/fsck_msdos.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: fsck_msdos.8,v 1.12 2001/11/16 11:36:33 wiz Exp $ +.\" $NetBSD: fsck_msdos.8,v 1.13 2002/10/01 13:40:32 wiz Exp $ .\" .\" Copyright (C) 1995 Wolfgang Solfrank .\" Copyright (c) 1995 Martin Husemann @@ -65,8 +65,8 @@ run from during automatic reboot, when a FAT filesystem is detected. When preening file systems, .Nm -will fix common inconsistencies non-interactively. If -more serious problems are found, +will fix common inconsistencies non-interactively. +If more serious problems are found, .Nm does not try to fix them, indicates that it was not successful, and exits. diff --git a/sbin/fsdb/fsdb.8 b/sbin/fsdb/fsdb.8 index 261e3d55d4b2..b8268df36dfe 100644 --- a/sbin/fsdb/fsdb.8 +++ b/sbin/fsdb/fsdb.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: fsdb.8,v 1.13 2002/02/08 01:30:43 ross Exp $ +.\" $NetBSD: fsdb.8,v 1.14 2002/10/01 13:40:33 wiz Exp $ .\" .\" Copyright (c) 1996 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -50,13 +50,13 @@ opens .Ar fsname (usually a raw disk partition) and runs a command loop -allowing manipulation of the file system's inode data. You are prompted -to enter a command with +allowing manipulation of the file system's inode data. +You are prompted to enter a command with .Dq "fsdb (inum X)\*[Gt]" where .Va X -is the currently selected i-number. The initial selected inode is the -root of the filesystem (i-number 2). +is the currently selected i-number. +The initial selected inode is the root of the filesystem (i-number 2). The command processor uses the .Xr editline 3 library, so you can use command line editing to reduce typing if desired. @@ -102,9 +102,9 @@ Find in the current directory and make its inode the current inode. .Ar Name may be a multi-component name or may begin with slash to indicate that -the root inode should be used to start the lookup. If some component -along the pathname is not found, the last valid directory encountered is -left as the active inode. +the root inode should be used to start the lookup. +If some component along the pathname is not found, +the last valid directory encountered is left as the active inode. .br This command is valid only if the starting inode is a directory. .Pp @@ -123,8 +123,8 @@ Set the active inode's link count to .Ar number . .Pp .It Cm ls -List the current inode's directory entries. This command is valid only -if the current inode is a directory. +List the current inode's directory entries. +This command is valid only if the current inode is a directory. .Pp .It Cm blks List the current inode's blocks numbers. @@ -133,16 +133,16 @@ List the current inode's blocks numbers. .It Cm del Ar name Remove the entry .Ar name -from the current directory inode. This command is valid only -if the current inode is a directory. +from the current directory inode. +This command is valid only if the current inode is a directory. .Pp .It Cm ln Ar ino Ar name Create a link to inode .Ar ino under the name .Ar name -in the current directory inode. This command is valid only -if the current inode is a directory. +in the current directory inode. +This command is valid only if the current inode is a directory. .Pp .It Cm chinum Ar dirslot Ar inum Change the i-number in directory entry @@ -155,8 +155,9 @@ Change the name in directory entry .Ar dirslot to .Ar name . -This command cannot expand a directory entry. You can only rename an -entry if the name will fit into the existing directory slot. +This command cannot expand a directory entry. +You can only rename an entry if the name will fit into +the existing directory slot. .Pp .It Cm chtype Ar type Change the type of the current inode to @@ -203,7 +204,8 @@ should be in the format .Em YYYYMMDDHHMMSS[.nsec] where .Em nsec -is an optional nanosecond specification. If no nanoseconds are specified, the +is an optional nanosecond specification. +If no nanoseconds are specified, the .Va mtimensec , .Va ctimensec , or @@ -222,7 +224,8 @@ Exit the program. .Nm uses the source code for .Xr fsck 8 -to implement most of the file system manipulation code. The remainder of +to implement most of the file system manipulation code. +The remainder of .Nm first appeared in .Nx 1.1 . diff --git a/sbin/init/init.8 b/sbin/init/init.8 index 8e2a56c91962..c5299f94e223 100644 --- a/sbin/init/init.8 +++ b/sbin/init/init.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: init.8,v 1.24 2001/11/16 11:37:04 wiz Exp $ +.\" $NetBSD: init.8,v 1.25 2002/10/01 13:40:34 wiz Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -61,7 +61,8 @@ may be passed .Fl s from the boot program to prevent the system from going multi-user and to instead execute a single user shell without starting the normal -daemons. The system is then quiescent for maintenance work and may +daemons. +The system is then quiescent for maintenance work and may later be made to go to state 2 (multi-user) by exiting the single-user shell (with ^D). .It diff --git a/sbin/ldconfig/ldconfig.8 b/sbin/ldconfig/ldconfig.8 index 0906e129ac7b..61137fd9fcb2 100644 --- a/sbin/ldconfig/ldconfig.8 +++ b/sbin/ldconfig/ldconfig.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: ldconfig.8,v 1.13 2001/11/16 11:37:40 wiz Exp $ +.\" $NetBSD: ldconfig.8,v 1.14 2002/10/01 13:40:34 wiz Exp $ .\" .\" Copyright (c) 1998 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -73,8 +73,8 @@ directory search operations would have to perform to load required shared libraries. .Pp The shared libraries so found will be automatically available for loading -if needed by the program being prepared for execution. This obviates the need -for storing search paths within the executable. +if needed by the program being prepared for execution. +This obviates the need for storing search paths within the executable. .Pp The .Ev LD_LIBRARY_PATH @@ -86,8 +86,8 @@ is a .Sq \&: separated list of directory paths that are searched by .Nm ld.so -when it needs to load a shared library. It can be viewed as the run-time -equivalent of the +when it needs to load a shared library. +It can be viewed as the run-time equivalent of the .Fl L switch of .Nm ld . @@ -104,11 +104,13 @@ Do not scan directories listed in for shared libraries. .It Fl m Merge the result of the scan of the directories given as arguments into -the existing hints file. The default action is to build the hints file afresh. +the existing hints file. +The default action is to build the hints file afresh. .It Fl r Lists the current contents of .Pa ld.so.hints -on the standard output. The hints file will not be modified. +on the standard output. +The hints file will not be modified. .It Fl s Do not scan the built-in system directory .Pq Pa /usr/lib , @@ -118,7 +120,8 @@ for shared libraries. .It Fl S Do not scan the built-in system directory .Pq Pa /usr/lib , -for shared libraries. (Directories listed in +for shared libraries. +(Directories listed in .Pa /etc/ld.so.conf are still scanned.) .It Fl v @@ -142,18 +145,22 @@ in Special care must be taken when loading shared libraries into the address space of .Em set-user-ID -programs. Whenever such a program is run, +programs. +Whenever such a program is run, .Nm ld.so will only load shared libraries from the .Pa ld.so.hints -file. In particular, the +file. +In particular, the .Ev LD_LIBRARY_PATH and .Ev LD_PRELOAD -is not used to search for libraries. Thus, the role of ldconfig is dual. In -addition to building a set of hints for quick lookup, it also serves to +is not used to search for libraries. +Thus, the role of ldconfig is dual. +In addition to building a set of hints for quick lookup, it also serves to specify the trusted collection of directories from which shared objects can -be safely loaded. It is presumed that the set of directories specified to +be safely loaded. +It is presumed that the set of directories specified to .Nm is under control of the system's administrator. .Nm ld.so diff --git a/sbin/lmcctl/lmcctl.8 b/sbin/lmcctl/lmcctl.8 index 853cf3a534cb..773317c6c880 100644 --- a/sbin/lmcctl/lmcctl.8 +++ b/sbin/lmcctl/lmcctl.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: lmcctl.8,v 1.8 2001/11/16 11:38:15 wiz Exp $ +.\" $NetBSD: lmcctl.8,v 1.9 2002/10/01 13:40:35 wiz Exp $ .\" .\" Copyright (c) 1997-1999 LAN Media Corporation (LMC) .\" All rights reserved. www.lanmedia.com @@ -47,9 +47,10 @@ .Sh DESCRIPTION .Nm "" is the user-land control program for the Lan Media SSI, -HSSI, and DS3 network interfaces. The SSI is the LMC1000, and runs at -various speeds up to 10Mbps. The DS3 is the LMC5245 and runs at a speed of -45Mbps. The HSSI is the LMC5200, and has no internal clock generator. +HSSI, and DS3 network interfaces. +The SSI is the LMC1000, and runs at various speeds up to 10Mbps. +The DS3 is the LMC5245 and runs at a speed of 45Mbps. +The HSSI is the LMC5200, and has no internal clock generator. .Nm "" is used to configure various media and protocol options dealing with HDLC serial links and hardware configurations. @@ -76,8 +77,9 @@ Set the interface to use external clocking. This is the default. .It Fl C (SSI, HSSI) -Set the interface to use internal clocking. On the SSI card this uses the -internal baud rate generator. On the HSSI card it uses the PCI bus clock. +Set the interface to use internal clocking. +On the SSI card this uses the internal baud rate generator. +On the HSSI card it uses the PCI bus clock. .It Fl e Select 16-bit CRC. This is the default. @@ -97,9 +99,10 @@ This is the default. Enable the DS3 scrambler function. .It Fl o (DS3) -Program the card for cable lengths of less than 100 feet. In this mode, -the card uses lower power to transmit data for short cable runs, which might -otherwise overdrive a receiver. This is the default, and will work in most +Program the card for cable lengths of less than 100 feet. +In this mode, the card uses lower power to transmit data +for short cable runs, which might otherwise overdrive a receiver. +This is the default, and will work in most situations even with runs more than 100 feet. .It Fl O (DS3) diff --git a/sbin/modload/modload.8 b/sbin/modload/modload.8 index a7136d230bf7..ec78ffdf6da6 100644 --- a/sbin/modload/modload.8 +++ b/sbin/modload/modload.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: modload.8,v 1.19 2002/09/13 15:32:21 gehenna Exp $ +.\" $NetBSD: modload.8,v 1.20 2002/10/01 13:40:35 wiz Exp $ .\" .\" Copyright (c) 1993 Christopher G. Demetriou .\" All rights reserved. @@ -57,7 +57,8 @@ The options to are as follows: .Bl -tag -width indent .It Fl d -Debug. Used to debug +Debug. +Used to debug .Nm itself. .It Fl n @@ -68,7 +69,8 @@ Print comments about the loading process. .It Fl s Load the symbol table. .It Fl S -Do not remove the temporary object file. By default, the +Do not remove the temporary object file. +By default, the .Xr ld 1 output is removed after being loaded into the kernel. .It Fl A Ar kernel @@ -83,21 +85,20 @@ This is passed by to .Xr ld 1 when the module is linked. -The default module entry point name is `xxxinit'. If `xxxinit' cannot be -found, an attempt to use `\*[Lt]module_name\*[Gt]_lkmentry' will be made, where +The default module entry point name is `xxxinit'. +If `xxxinit' cannot be found, an attempt to +use `\*[Lt]module_name\*[Gt]_lkmentry' will be made, where \*[Lt]module_name\*[Gt] is the filename being loaded without the `.o'. .It Fl p Ar postinstall Specify the name of a shell script or program that will -be executed if the module is successfully loaded. It -is always passed the module id (in decimal) and module +be executed if the module is successfully loaded. +It is always passed the module id (in decimal) and module type (in hexadecimal) as the first two arguments. For loadable drivers, the third argument is the character major device number and the fourth argument is the block major device number. -For a loadable system call, the third argument is the system -call number. +For a loadable system call, the third argument is the system call number. .It Fl o Ar output_file -Specify the name of the output file that is produced by -the linker. +Specify the name of the output file that is produced by the linker. .El .Sh FILES .Bl -tag -width /usr/include/sys/lkm.h -compact diff --git a/sbin/mount/mount.8 b/sbin/mount/mount.8 index 9cc57d944739..a72d44742839 100644 --- a/sbin/mount/mount.8 +++ b/sbin/mount/mount.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount.8,v 1.35 2002/09/21 18:43:32 christos Exp $ +.\" $NetBSD: mount.8,v 1.36 2002/10/01 13:40:36 wiz Exp $ .\" .\" Copyright (c) 1980, 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -64,7 +64,8 @@ or .Ar node are not provided, the appropriate information is taken from the .Xr fstab 5 -file. The provided argument is looked up first in the +file. +The provided argument is looked up first in the .Dq fs_file , then in the .Dq fs_spec @@ -82,7 +83,8 @@ point .Ar node and has access to the .Ar special -device (at least read permissions). In addition, the +device (at least read permissions). +In addition, the .Em vfs.generic.usermount .Xr sysctl 3 must be set to 1 to permit file system mounting by ordinary users. @@ -170,8 +172,9 @@ Do not interpret character or block special devices on the file system. This option is useful for a server that has file systems containing special devices for architectures other than its own. .It Cm nodevmtime -Do not update modification times on device special files. This option -is useful on laptops or other systems that perform power management. +Do not update modification times on device special files. +This option is useful on laptops +or other systems that perform power management. .It Cm nocoredump Do not allow programs to create crash dumps (core files) on the file system. This option can be used to help protect sensitive @@ -192,14 +195,16 @@ The same as .Fl r ; mount the file system read-only (even the super-user may not write it). .It Cm softdep -(FFS only) Mount the filesystem using soft-dependencies. This means that -metadata will not be written immediately, but is written in an ordered fashion -to keep the on-disk state of the filesystem consistent. This results -in significant speedups for file create/delete operations. This option -will be ignored when using the +(FFS only) Mount the filesystem using soft-dependencies. +This means that metadata will not be written immediately, +but is written in an ordered fashion to keep the +on-disk state of the filesystem consistent. +This results in significant speedups for file create/delete operations. +This option will be ignored when using the .Fl u -flag and a filesystem is already mounted read/write. This option has gone -through moderate to heavy testing, but should still be used with care. +flag and a filesystem is already mounted read/write. +This option has gone through moderate to heavy testing, +but should still be used with care. It requires the .Dv SOFTDEP option to be enabled in the running kernel. @@ -208,8 +213,9 @@ Recognize permission of symbolic link when reading or traversing link. .It Cm sync All .Tn I/O -to the file system should be done synchronously. This is not equivalent to the -normal mode in which only metadata is written synchronously. +to the file system should be done synchronously. +This is not equivalent to the normal mode in which only +metadata is written synchronously. .It Cm nosync Clear .Cm sync @@ -261,9 +267,8 @@ is used to indicate the file system type. The type .Ar ffs is the default. -The \fI-t\fP option can be used -to indicate that the actions should only be taken on -filesystems of the specified type. +The \fI-t\fP option can be used to indicate that the actions +should only be taken on filesystems of the specified type. More than one type may be specified in a comma separated list. The list of filesystem types can be prefixed with .Dq no @@ -317,7 +322,8 @@ or .Fl w option. .It Fl v -Verbose mode. If this flag is specified more than once, then the +Verbose mode. +If this flag is specified more than once, then the filesystem-specific mount arguments are printed for the given mounted filesystem. .It Fl w diff --git a/sbin/mount_ados/mount_ados.8 b/sbin/mount_ados/mount_ados.8 index dde7f7fcbbb2..83db09d22afc 100644 --- a/sbin/mount_ados/mount_ados.8 +++ b/sbin/mount_ados/mount_ados.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount_ados.8,v 1.14 2001/11/16 11:26:55 wiz Exp $ +.\" $NetBSD: mount_ados.8,v 1.15 2002/10/01 13:40:37 wiz Exp $ .\" .\" Copyright (c) 1993, 1994 Christopher G. Demetriou .\" All rights reserved. @@ -113,7 +113,8 @@ filesystem currently supports the Amiga fast file system. .Pp The .Sq ados -filesystem implementation currently is read-only. The +filesystem implementation currently is read-only. +The .Nm utility silently retries the mount read-only, as if the .Ar ro diff --git a/sbin/mount_cd9660/mount_cd9660.8 b/sbin/mount_cd9660/mount_cd9660.8 index 285e06b48967..8a0c50d06d36 100644 --- a/sbin/mount_cd9660/mount_cd9660.8 +++ b/sbin/mount_cd9660/mount_cd9660.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount_cd9660.8,v 1.16 2001/11/16 11:26:55 wiz Exp $ +.\" $NetBSD: mount_cd9660.8,v 1.17 2002/10/01 13:40:38 wiz Exp $ .\" .\" Copyright (c) 1993, 1994 .\" The Regents of the University of California. All rights reserved. @@ -91,7 +91,8 @@ currently does not support Unicode characters present in some Joliet filesystems. .It Cm nomaplcase File names on cd9660 cdrom without Rock Ridge extension present -should be uppercase only. By default, cd9660 recodes file +should be uppercase only. +By default, cd9660 recodes file names read from a non-Rock Ridge disk to all lowercase characters. .Cm nomaplcase turns off this mapping. @@ -147,8 +148,8 @@ were added in .Nx 1.5 . .Sh BUGS For some cdroms the information in the Rock Ridge extension is wrong -and the cdrom needs to be mounted with "norrip". A sign that something -is wrong is that the +and the cdrom needs to be mounted with "norrip". +A sign that something is wrong is that the .Xr stat 2 system call returns .Er EBADF diff --git a/sbin/mount_ffs/mount_ffs.8 b/sbin/mount_ffs/mount_ffs.8 index f3482ab48456..d62c8f47427e 100644 --- a/sbin/mount_ffs/mount_ffs.8 +++ b/sbin/mount_ffs/mount_ffs.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount_ffs.8,v 1.9 2001/11/16 11:21:38 wiz Exp $ +.\" $NetBSD: mount_ffs.8,v 1.10 2002/10/01 13:40:39 wiz Exp $ .\" .\" Copyright (c) 1980, 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -54,9 +54,8 @@ device on to the file system tree at point .Pp The .Nm mount_ufs -form of the command is meant for backward -compatibility only. Fast File Systems should no longer -be listed as type +form of the command is meant for backward compatibility only. +Fast File Systems should no longer be listed as type .Dq ufs in .Xr fstab 5 diff --git a/sbin/mount_filecore/mount_filecore.8 b/sbin/mount_filecore/mount_filecore.8 index 2e9f27a515b0..5f0d01df8bf8 100644 --- a/sbin/mount_filecore/mount_filecore.8 +++ b/sbin/mount_filecore/mount_filecore.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount_filecore.8,v 1.7 2001/11/16 11:58:28 wiz Exp $ +.\" $NetBSD: mount_filecore.8,v 1.8 2002/10/01 13:40:39 wiz Exp $ .\" .\" Copyright (c) 1998 Mark Brinicombe .\" Copyright (c) 1993,1994 Christopher G. Demetriou @@ -49,9 +49,10 @@ The .Nx FILECORE filesystem is a read only implementation of the filecore file system -found in Acorn Computers RISC OS operating system. This operating system -is the ROM based operating system found on their ARM 6, ARM7 and -StrongARM 110 based RiscPC machines that are supported by the arm32 port. +found in Acorn Computers RISC OS operating system. +This operating system is the ROM based operating system +found on their ARM 6, ARM7 and StrongARM 110 based RiscPC machines +that are supported by the arm32 port. Under RISC OS, filecore will have multiple instantiations for file systems on different block devices such as floppies, IDE discs, SCSI discs etc. and these frquently are considered to be different filesystems @@ -96,7 +97,8 @@ Give all files owner access. .It Fl R Give all files owner read access. .It Fl f -Append the filetype to each filename. This option currently has no effect. +Append the filetype to each filename. +This option currently has no effect. .El .Sh SEE ALSO .Xr mount 2 , diff --git a/sbin/mount_msdos/mount_msdos.8 b/sbin/mount_msdos/mount_msdos.8 index cf8677fbb4ea..fa4a10bafd25 100644 --- a/sbin/mount_msdos/mount_msdos.8 +++ b/sbin/mount_msdos/mount_msdos.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount_msdos.8,v 1.22 2001/11/16 11:26:56 wiz Exp $ +.\" $NetBSD: mount_msdos.8,v 1.23 2002/10/01 13:40:40 wiz Exp $ .\" .\" Copyright (c) 1993, 1994 Christopher G. Demetriou .\" All rights reserved. @@ -119,17 +119,21 @@ searches the root directory of the filesystem to be mounted for any existing Win'95 long filenames. If no such entries are found, .Fl s -is the default. Otherwise +is the default. +Otherwise .Fl l is assumed. .It Fl 9 Ignore the special Win'95 directory entries even -if deleting or renaming a file. This forces +if deleting or renaming a file. +This forces .Fl s . .It Fl G This option causes the filesystem to be interpreted as an Atari-Gemdos -filesystem. The differences to the msdos filesystem are minimal and -limited to the boot block. This option enforces +filesystem. +The differences to the msdos filesystem are minimal and +limited to the boot block. +This option enforces .Fl s . .El .Sh SEE ALSO @@ -163,6 +167,7 @@ The default handling for and .Fl l will result in empty filesystems to be populated -with short filenames only. To generate long filenames +with short filenames only. +To generate long filenames on empty DOS filesystems use .Fl l . diff --git a/sbin/mount_nfs/mount_nfs.8 b/sbin/mount_nfs/mount_nfs.8 index 00a4298c6493..663fd4bf98da 100644 --- a/sbin/mount_nfs/mount_nfs.8 +++ b/sbin/mount_nfs/mount_nfs.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount_nfs.8,v 1.18 2002/05/15 01:58:16 simonb Exp $ +.\" $NetBSD: mount_nfs.8,v 1.19 2002/10/01 13:40:41 wiz Exp $ .\" .\" Copyright (c) 1992, 1993, 1994, 1995 .\" The Regents of the University of California. All rights reserved. @@ -101,7 +101,8 @@ The options are: .It Fl 2 Use the NFS Version 2 protocol. .It Fl 3 -Use the NFS Version 3 protocol. The default is to try version 3 first, and +Use the NFS Version 3 protocol. +The default is to try version 3 first, and fall back to version 2 if the mount fails. .It Fl D Used with NQNFS to set the @@ -117,7 +118,8 @@ Values may be set in the range of 1 - 9, with 9 referring to an This option is not generally recommended and is really an experimental feature. .It Fl I -Set the readdir read size to the specified value. The value should normally +Set the readdir read size to the specified value. +The value should normally be a multiple of DIRBLKSIZ that is \*[Le] the read size for the mount. .It Fl K Pass Kerberos authenticators to the server for client-to-server @@ -131,14 +133,16 @@ Used with NQNFS to set the lease term to the specified number of seconds. Only use this argument for mounts with a large round trip delay. Values are normally in the 10-30 second range. .It Fl P -Use a reserved socket port number. This is the default, and available +Use a reserved socket port number. +This is the default, and available for backwards compatibility purposes only. .It Fl R Set the retry count for doing the mount to the specified value. .It Fl T Use TCP transport instead of UDP. This is recommended for servers that are not on the same physical network as -the client. Not all NFS servers, especially not old ones, support this. +the client. +Not all NFS servers, especially not old ones, support this. .It Fl U Force the mount protocol to use UDP transport, even for TCP NFS mounts. (Necessary for some old @@ -148,10 +152,11 @@ servers.) Perform 32 \*[Lt]-\*[Gt] 64 bit directory cookie translation for version 3 mounts. This may be need in the case of a server using the upper 32 bits of v3 directory cookies, and when you are running emulated binaries -that access such a filesystem. Native +that access such a filesystem. +Native .Nx -binaries will never need this -option. This option introduces some overhead. +binaries will never need this option. +This option introduces some overhead. .It Fl a Set the read-ahead count to the specified value. This may be in the range of 0 - 4, and determines how many blocks @@ -174,7 +179,8 @@ For UDP mount points, do a Although this flag increases the efficiency of UDP mounts it cannot be used for servers that do not reply to requests from the standard NFS port number 2049, or for servers with multiple network -interfaces. In these cases if the socket is connected and the server +interfaces. +In these cases if the socket is connected and the server replies from a different port number or a different network interface the client will get ICMP port unreachable and the mount will hang. .It Fl d @@ -199,9 +205,9 @@ be used. This option reduces RPC traffic for cases such as .Dq "ls -l" , but tends to flood the attribute and name caches with prefetched entries. -Try this option and see whether performance improves or degrades. Probably -most useful for client to server network interconnects with a large bandwidth -times delay product. +Try this option and see whether performance improves or degrades. +Probably most useful for client to server network +interconnects with a large bandwidth times delay product. .It Fl m Set the Kerberos realm to the string argument. Used with the @@ -215,9 +221,9 @@ See the .Xr mount 8 man page for possible options and their meanings. .It Fl p -Do not use a reserved port number for RPCs. This option is provided only -to be able to mimic the old default behavior of not using a reserved -port, and should rarely be useful. +Do not use a reserved port number for RPCs. +This option is provided only to be able to mimic the old +default behavior of not using a reserved port, and should rarely be useful. .It Fl q Use the leasing extensions to the NFS Version 3 protocol to maintain cache consistency. @@ -228,9 +234,8 @@ that was part of the first release of .Bx 4.4 Lite . To interoperate with a first release .Bx 4.4 Lite -NFS system you will have to -avoid this option until you have had an opportunity to upgrade the NFS code -to release 2 of +NFS system you will have to avoid this option until you have had +an opportunity to upgrade the NFS code to release 2 of .Bx 4.4 Lite on all your systems. .It Fl r @@ -267,7 +272,7 @@ tune the timeout interval.) .It Fl w Set the write data size to the specified value. -Ditto the comments w.r.t. the +Ditto the comments with respect to the .Fl r option, but using the .Dq "fragments dropped after timeout" @@ -297,7 +302,8 @@ by using a line like: .Dl "remotehost:/home /home nfs rw 0 0 .Sh PERFORMANCE As can be derived from the comments accompanying the options, performance -tuning of NFS can be a non-trivial task. Here are some common points +tuning of NFS can be a non-trivial task. +Here are some common points to watch: .Bl -bullet -offset indent .It @@ -306,19 +312,25 @@ Increasing the read and write size with the and .Fl w options respectively will increase throughput if the hardware can handle -the larger packet sizes. The default size for version 2 is 8k when -using UDP, 64k when using TCP. The default size for v3 is platform dependent: -on i386, the default is 32k, for other platforms it is 8k. Values over -32k are only supported for TCP, where 64k is the maximum. Any value +the larger packet sizes. +The default size for version 2 is 8k when +using UDP, 64k when using TCP. +The default size for v3 is platform dependent: +on i386, the default is 32k, for other platforms it is 8k. +Values over +32k are only supported for TCP, where 64k is the maximum. +Any value over 32k is unlikely to get you more performance, unless you have a very fast network. .It If the hardware can not handle larger packet sizes, you may see low performance figures or even temporary hangups during NFS activity. -This can especially happen with older ethernet cards. What happens +This can especially happen with older ethernet cards. +What happens is that either the buffer on the card on the client side is overflowing, or that similar events occur on the server, leading to a lot -of dropped packets. In this case, decreasing the read and write size, +of dropped packets. +In this case, decreasing the read and write size, using TCP, or a combination of both will usually lead to better throughput. Should you need to decrease the read and write size for all your NFS mounts because of a slow ethernet card, you can use @@ -344,11 +356,13 @@ the filesystem you requested, or is not exporting it to your host. If you believe the remote host is indeed exporting a filesystem to you, make sure the .Xr exports 5 -file is exporting the proper directories. A common mistake is that +file is exporting the proper directories. +A common mistake is that mountd will not export a filesystem with the .Fl alldirs option, unless it -is a mount point on the exporting host. It is not possible to remotely +is a mount point on the exporting host. +It is not possible to remotely mount a subdirectory of an exported mount, unless it is exported with the .Fl alldirs option. diff --git a/sbin/mount_ntfs/mount_ntfs.8 b/sbin/mount_ntfs/mount_ntfs.8 index 6d6512495a8b..7b8d01b93eb0 100644 --- a/sbin/mount_ntfs/mount_ntfs.8 +++ b/sbin/mount_ntfs/mount_ntfs.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount_ntfs.8,v 1.10 2001/11/16 11:59:47 wiz Exp $ +.\" $NetBSD: mount_ntfs.8,v 1.11 2002/10/01 13:40:41 wiz Exp $ .\" .\" Copyright (c) 1993,1994 Christopher G. Demetriou .\" Copyright (c) 1999 Semen Ustimenko @@ -93,10 +93,11 @@ foo[[:ATTRTYPE]:ATTRNAME] .Ed .Pp .Sq ATTRTYPE -is one of identifier listed in $AttrDef file of -volume. Default is $DATA. +is one of identifier listed in $AttrDef file of volume. +Default is $DATA. .Sq ATTRNAME -is an attribute name. Default is none. +is an attribute name. +Default is none. .Pp .Sy Examples : .Pp @@ -110,7 +111,8 @@ To read directory raw data: # cat /mnt/foodir:\\$INDEX_ROOT:\\$I30 .Ed .Ss Limited support for writing -There is limited writing ability for files. Limitations: +There is limited writing ability for files. +Limitations: .Bl -bullet -compact .It file must be nonresident @@ -126,9 +128,9 @@ Note that that it's not currently possible to create or remove files on NTFS filesystem. .Pp .Sy Warning : -do not mount NTFS filesystems read-write. The write support is -not very useful and is not tested well. It's not safe to write to any file -on NTFS, you might damage the filesystem. +do not mount NTFS filesystems read-write. +The write support is not very useful and is not tested well. +It's not safe to write to any file on NTFS, you might damage the filesystem. Unless you want to debug NTFS filesystem code, mount the NTFS filesystem read-only. .Sh SEE ALSO diff --git a/sbin/mount_null/mount_null.8 b/sbin/mount_null/mount_null.8 index be224a05ab6e..46e7b3888abf 100644 --- a/sbin/mount_null/mount_null.8 +++ b/sbin/mount_null/mount_null.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount_null.8,v 1.16 2002/03/30 15:28:35 groo Exp $ +.\" $NetBSD: mount_null.8,v 1.17 2002/10/01 13:40:42 wiz Exp $ .\" .\" Copyright (c) 1992, 1993, 1994 .\" The Regents of the University of California. All rights reserved. @@ -107,23 +107,24 @@ New null layers are created with .Nm takes two arguments, the pathname of the lower vfs (target-pn) and the pathname where the null -layer will appear in the namespace (mount-point-pn). After -the null layer is put into place, the contents +layer will appear in the namespace (mount-point-pn). +After the null layer is put into place, the contents of target-pn subtree will be aliased under mount-point-pn. .\" .\" .Sh OPERATION OF A NULL LAYER The null layer is the minimum file system layer, simply passing all possible operations to the lower layer -for processing there. The majority of its activity centers -on the bypass routine, through which nearly all vnode operations -pass. +for processing there. +The majority of its activity centers on the bypass routine, +through which nearly all vnode operations pass. .Pp The bypass routine accepts arbitrary vnode operations for -handling by the lower layer. It begins by examining vnode -operation arguments and replacing any null-nodes by their -lower-layer equivalents. It then invokes the operation -on the lower layer. Finally, it replaces the null-nodes +handling by the lower layer. +It begins by examining vnode operation arguments and replacing +any null-nodes by their lower-layer equivalents. +It then invokes the operation on the lower layer. +Finally, it replaces the null-nodes in the arguments and, if a vnode is returned by the operation, stacks a null-node on top of the returned vnode. .Pp @@ -146,11 +147,13 @@ information. .\" .Sh INSTANTIATING VNODE STACKS Mounting associates the null layer with a lower layer, -in effect stacking two VFSes. Vnode stacks are instead +in effect stacking two VFSes. +Vnode stacks are instead created on demand as files are accessed. .Pp The initial mount creates a single vnode stack for the -root of the new null layer. All other vnode stacks +root of the new null layer. +All other vnode stacks are created as a result of vnode operations on this or other null vnode stacks. .Pp @@ -169,19 +172,16 @@ will assign the root null-node (which was created when the null layer was mounted). Now consider opening .Pa sys . -A vop_lookup would be -done on the root null-node. This operation would bypass through -to the lower layer which would return a vnode representing -the UFS +A vop_lookup would be done on the root null-node. +This operation would bypass through to the lower layer +which would return a vnode representing the UFS .Pa sys . -null_bypass then builds a null-node -aliasing the UFS +null_bypass then builds a null-node aliasing the UFS .Pa sys and returns this to the caller. Later operations on the null-node .Pa sys -will repeat this -process when constructing other vnode stacks. +will repeat this process when constructing other vnode stacks. .\" .\" .Sh CREATING OTHER FILE SYSTEM LAYERS @@ -197,16 +197,16 @@ null layer. .\" .Sh INVOKING OPERATIONS ON LOWER LAYERS There are two techniques to invoke operations on a lower layer -when the operation cannot be completely bypassed. Each method -is appropriate in different situations. In both cases, -it is the responsibility of the aliasing layer to make +when the operation cannot be completely bypassed. +Each method is appropriate in different situations. +In both cases, it is the responsibility of the aliasing layer to make the operation arguments "correct" for the lower layer by mapping any vnode arguments to the lower layer. .Pp The first approach is to call the aliasing layer's bypass routine. This method is most suitable when you wish to invoke the operation -currently being handled on the lower layer. It has the advantage -that the bypass routine already must do argument mapping. +currently being handled on the lower layer. +It has the advantage that the bypass routine already must do argument mapping. An example of this is .Em null_getattrs in the null layer. @@ -216,8 +216,8 @@ the lower layer with the .Em VOP_OPERATIONNAME interface. The advantage of this method is that it is easy to invoke -arbitrary operations on the lower layer. The disadvantage -is that vnode arguments must be manually mapped. +arbitrary operations on the lower layer. +The disadvantage is that vnode arguments must be manually mapped. .\" .\" .Sh SEE ALSO diff --git a/sbin/mount_overlay/mount_overlay.8 b/sbin/mount_overlay/mount_overlay.8 index 8a5665bc439f..f7ce745c9250 100644 --- a/sbin/mount_overlay/mount_overlay.8 +++ b/sbin/mount_overlay/mount_overlay.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount_overlay.8,v 1.5 2001/06/07 13:58:24 wiz Exp $ +.\" $NetBSD: mount_overlay.8,v 1.6 2002/10/01 13:40:42 wiz Exp $ .\" .\" Copyright (c) 1992, 1993, 1994 .\" The Regents of the University of California. All rights reserved. @@ -78,7 +78,8 @@ file system can be created very easily by starting with an overlay layer. .Pp The internal operation of the overlay layer is identical to that of the -null layer. See its documentation for details. +null layer. +See its documentation for details. .Sh SEE ALSO .Xr mount 8 , .Xr mount_null 8 diff --git a/sbin/mount_portal/mount_portal.8 b/sbin/mount_portal/mount_portal.8 index 8b58494c4ebc..f21ab5e315ec 100644 --- a/sbin/mount_portal/mount_portal.8 +++ b/sbin/mount_portal/mount_portal.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount_portal.8,v 1.15 2002/02/08 01:30:44 ross Exp $ +.\" $NetBSD: mount_portal.8,v 1.16 2002/10/01 13:40:43 wiz Exp $ .\" .\" Copyright (c) 1993, 1994 .\" The Regents of the University of California. All rights reserved. @@ -108,18 +108,20 @@ The and .Pa wfilter namespaces open a pipe to a process, typically a data-filter such -as compression or decompression programs. The +as compression or decompression programs. +The .Pa rfilter namespace opens a read-only pipe, while the .Pa wfilter -namespace opens a write-only pipe. See the EXAMPLES section -below for more examples. +namespace opens a write-only pipe. +See the EXAMPLES section below for more examples. .Sh CONFIGURATION FILE 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. @@ -133,15 +135,15 @@ and .Pa wfilter namespaces have additional meanings for the remaining fields. The third field specifies a prefix that is to be stripped off of -the passed name before passing it on to the pipe program. If the -prefix does not match, no stripping is performed. The fourth -argument specifies the program to use for the pipe. Any -remaining fields are passed to the pipe program. If the -string +the passed name before passing it on to the pipe program. +If the prefix does not match, no stripping is performed. +The fourth argument specifies the program to use for the pipe. +Any remaining fields are passed to the pipe program. +If the string .Dq Li "%s" exists within these remaining fields, it will be replaced by the -path after stripping is performed. If there is no field after -the program name, +path after stripping is performed. +If there is no field after the program name, .Dq Li "%s" will be assumed, to maintain similarity with the .Pa tcp @@ -154,8 +156,8 @@ namespaces. .El .Sh EXAMPLES A tutorial and several examples are provided in -/usr/share/examples/mount_portal. The following is an example -configuration file. +/usr/share/examples/mount_portal. +The following is an example configuration file. .Pp .Bd -literal # @(#)portal.conf 5.1 (Berkeley) 7/13/92 @@ -174,16 +176,19 @@ bzcat/ rfilter bzcat/ bzcat %s nroff/ rfilter nroff/ nroff -man %s .Ed .Pp -As is true with many other filesystems, a weird sense of humor is -handy. +As is true with many other filesystems, +a weird sense of humor is handy. .Pp Notice that after the keynames, like nroff/ and bzcat/, we -typically use another slash. In reality, the +typically use another slash. +In reality, the .Nm process changes directory to /, which makes the subsequent slash -unnecessary. However, the extra slash provides a visual hint -that we are not operating on an ordinary file. An alternative -would be to change the configuration file to something like: +unnecessary. +However, the extra slash provides a visual hint +that we are not operating on an ordinary file. +An alternative would be to change the configuration +file to something like: .Bd -literal nroff% rfilter nroff% nroff -man .Ed diff --git a/sbin/mount_procfs/mount_procfs.8 b/sbin/mount_procfs/mount_procfs.8 index 7ecadf9d7881..e1d6b7b72006 100644 --- a/sbin/mount_procfs/mount_procfs.8 +++ b/sbin/mount_procfs/mount_procfs.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount_procfs.8,v 1.22 2002/05/31 16:48:28 atatat Exp $ +.\" $NetBSD: mount_procfs.8,v 1.23 2002/10/01 13:40:44 wiz Exp $ .\" .\" Copyright (c) 1992, 1993 .\" The Regents of the University of California. All rights reserved. @@ -68,13 +68,14 @@ Options are specified with a flag followed by a comma separated string of options. See the .Xr mount 8 -man page for possible generic options and their meanings. Currently, one -procfs-specific option is defined, the +man page for possible generic options and their meanings. +Currently, one procfs-specific option is defined, the .Cm linux -option. This option enables a few extra features that are compatible -with the proc filesystem as implemented in Linux. This option can -be used if you run Linux binaries that need Linux-specific features -in the proc filesystem (see also +option. +This option enables a few extra features that are compatible +with the proc filesystem as implemented in Linux. +This option can be used if you run Linux binaries that need +Linux-specific features in the proc filesystem (see also .Xr compat_linux 8 ) . .El .Pp @@ -86,7 +87,8 @@ In addition, the special entries .Pa curproc and .Pa self -reference the current process. The +reference the current process. +The .Pa self symlink appears for compatibility with the Linux procfs implementation. .Pp @@ -94,12 +96,11 @@ Each directory contains several files. .Bl -tag -width status .It Pa cmdline This file is readonly and returns null-terminated strings -corresponding to the process' command line arguments. For -a system or zombie process, this file contains only a string +corresponding to the process' command line arguments. +For a system or zombie process, this file contains only a string with the name of the process. .It Pa ctl -a writeonly file which supports a variety -of control operations. +a writeonly file which supports a variety of control operations. Control commands are written as strings to the .Pa ctl file. @@ -138,9 +139,10 @@ or to start another copy of the process. A map of the process' virtual memory. .It Pa maps A map of the process' virtual memory in a form like the -proc filesystem as implemented in Linux. Note that the paths -corresponding to file backed mappings will not be present unless -the kernel was built with the NAMECACHE_ENTER_REVERSE option. +proc filesystem as implemented in Linux. +Note that the paths corresponding to file backed mappings will +not be present unless the kernel was built with the +NAMECACHE_ENTER_REVERSE option. .It Pa mem The complete virtual memory image of the process. Only those addresses which exist in the process can be accessed. diff --git a/sbin/mount_umap/mount_umap.8 b/sbin/mount_umap/mount_umap.8 index 8dcb52341399..6627d2690539 100644 --- a/sbin/mount_umap/mount_umap.8 +++ b/sbin/mount_umap/mount_umap.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount_umap.8,v 1.14 2001/11/16 11:21:38 wiz Exp $ +.\" $NetBSD: mount_umap.8,v 1.15 2002/10/01 13:40:44 wiz Exp $ .\" .\" Copyright (c) 1992, 1993, 1994 .\" The Regents of the University of California. All rights reserved. @@ -87,9 +87,10 @@ The .Nm command uses a set of files provided by the user to make correspondences between uids and gids in the sub-tree's original environment and -some other set of ids in the local environment. For instance, user -smith might have uid 1000 in the original environment, while having -uid 2000 in the local environment. The +some other set of ids in the local environment. +For instance, user smith might have uid 1000 in the original environment, +while having uid 2000 in the local environment. +The .Nm command allows the subtree from smith's original environment to be mapped in such a way that all files with owning uid 1000 look like @@ -108,7 +109,8 @@ describe the mappings to be made between identifiers. .Pp The format of the user and group ID mapping files is very simple. The first line of the file is the total number of mappings present -in the file. The remaining lines each consist of two numbers: the +in the file. +The remaining lines each consist of two numbers: the ID in the mapped subtree and the ID in the original subtree. .Pp For example, to map uid 1000 in the original subtree to uid 2000 @@ -131,7 +133,8 @@ The mapfiles can be located anywhere in the file hierarchy, but they must be owned by root, and they must be writable only by root. .Nm will refuse to map the sub-tree if the ownership or permissions on -these files are improper. It will also report an error if the count +these files are improper. +It will also report an error if the count of mappings in the first line of the map files is not correct. .Sh SEE ALSO .Xr mount 8 , diff --git a/sbin/newfs/mount_mfs.8 b/sbin/newfs/mount_mfs.8 index c9e31ec625da..7d81ecdc04b1 100644 --- a/sbin/newfs/mount_mfs.8 +++ b/sbin/newfs/mount_mfs.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: mount_mfs.8,v 1.5 2002/08/20 16:07:45 wiz Exp $ +.\" $NetBSD: mount_mfs.8,v 1.6 2002/10/01 13:40:46 wiz Exp $ .\" .\" Copyright (c) 1983, 1987, 1991, 1993, 1994 .\" The Regents of the University of California. All rights reserved. @@ -77,7 +77,8 @@ Options with numeric arguments may contain an optional (case-insensitive) suffix: .Bl -tag -width 3n -offset indent -compact .It b -Bytes; causes no modification. (Default) +Bytes; causes no modification. +(Default) .It k Kilo; multiply the argument by 1024 .It m diff --git a/sbin/newfs/newfs.8 b/sbin/newfs/newfs.8 index c68809c053b0..0989a45868e0 100644 --- a/sbin/newfs/newfs.8 +++ b/sbin/newfs/newfs.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: newfs.8,v 1.44 2002/09/28 20:11:07 dbj Exp $ +.\" $NetBSD: newfs.8,v 1.45 2002/10/01 13:40:45 wiz Exp $ .\" .\" Copyright (c) 1983, 1987, 1991, 1993, 1994 .\" The Regents of the University of California. All rights reserved. @@ -85,7 +85,8 @@ Options with numeric arguments may contain an optional (case-insensitive) suffix: .Bl -tag -width 3n -offset indent -compact .It b -Bytes; causes no modification. (Default) +Bytes; causes no modification. +(Default) .It k Kilo; multiply the argument by 1024 .It m diff --git a/sbin/newfs_lfs/newfs_lfs.8 b/sbin/newfs_lfs/newfs_lfs.8 index 8837a7b150ee..2f850d33b88c 100644 --- a/sbin/newfs_lfs/newfs_lfs.8 +++ b/sbin/newfs_lfs/newfs_lfs.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: newfs_lfs.8,v 1.17 2002/01/21 18:24:06 wiz Exp $ +.\" $NetBSD: newfs_lfs.8,v 1.18 2002/10/01 13:40:46 wiz Exp $ .\" .\" Copyright (c) 1993 .\" The Regents of the University of California. All rights reserved. @@ -51,7 +51,8 @@ Before running .Nm the disk must be labeled using .Xr disklabel 8 , -the proper fstype is 4.4LFS. Reasonable values for the +the proper fstype is 4.4LFS. +Reasonable values for the .Li fsize , .Li bsize , and @@ -66,56 +67,66 @@ Attempt to compute the appropriate segment size using the formula The disk is tested for twenty seconds to discover its bandwidth and seek time. .It Fl B Ar logical-segment-size -The logical segment size of the file system in bytes. If not specified, -the segment size is computed by left-shifting the partition label's block -size by the amount indicated in the partition table's segshift. If the -disklabel indicates a zero block size or segment shift, a compile-time default -segment size of 1M is used. +The logical segment size of the file system in bytes. +If not specified, the segment size is computed by left-shifting +the partition label's block size by the amount indicated in the +partition table's segshift. +If the disklabel indicates a zero block size or segment shift, +a compile-time default segment size of 1M is used. .It Fl b Ar block-size -The block size of the file system in bytes. If not specified, the block -size is taken from the partition label, or if the partition label -indicates 0, a compile-time default of 8K is used. +The block size of the file system in bytes. +If not specified, the block size is taken from the partition label, +or if the partition label indicates 0, +a compile-time default of 8K is used. .It Fl F Force creation of an LFS even on a partition labeled as another type. .Nm will use compile-time default values for block and fragment size, and segment shift, unless these are overridden by command-line flags. .It Fl f Ar fragment-size -The fragment size of the file system in bytes. If not specified, -the fragment size is taken from the partition label, or if the partition -label indicates 0, a compile-time default of 1K is used. +The fragment size of the file system in bytes. +If not specified, the fragment size is taken from the partition label, +or if the partition label indicates 0, +a compile-time default of 1K is used. .It Fl I Ar interleave -Specify the interleave between segments. The default is zero. +Specify the interleave between segments. +The default is zero. .It Fl i -The size of an inode block, in bytes. The default is to use the same -size as a fragment, or in a v1 filesystem, the same size as a data block. +The size of an inode block, in bytes. +The default is to use the same size as a fragment, +or in a v1 filesystem, the same size as a data block. .It Fl L -Create a log-structured file system (LFS). This is the default, and this +Create a log-structured file system (LFS). +This is the default, and this option is provided for compatibility only. .It Fl M Ar nsegs Reserve this many segments for use exclusively by the cleaner, instead of letting .Nm -do the computation. Do not use this option. +do the computation. +Do not use this option. .It Fl m Ar free space \&% The percentage of space reserved from normal users; the minimum -free space threshold. The default value used is 10%. +free space threshold. +The default value used is 10%. .It Fl N Do not actually create the filesystem. .It Fl O Ar offset Start the first segment this many sectors from the beginning of the -partition. The default is zero. +partition. +The default is zero. .It Fl r Ar ident For a v2 filesystem, specify the roll-forward identifier for the -filesystem. This identifier, a 32-bit numeric quantity, +filesystem. +This identifier, a 32-bit numeric quantity, should be different from that of any LFS that may previously -have existed on the same disk. By default the -identifier is chosen at random. +have existed on the same disk. +By default the identifier is chosen at random. .It Fl s Ar size The size of the file system in sectors. .It Fl v Ar version -Make a filesystem with the specified disk layout version. Valid options -are 1 or 2 (the default). +Make a filesystem with the specified disk layout version. +Valid options are 1 or 2 (the default). .El .Sh SEE ALSO .Xr disktab 5 , diff --git a/sbin/newfs_msdos/newfs_msdos.8 b/sbin/newfs_msdos/newfs_msdos.8 index d40f1630938a..65b5d41a17e3 100644 --- a/sbin/newfs_msdos/newfs_msdos.8 +++ b/sbin/newfs_msdos/newfs_msdos.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: newfs_msdos.8,v 1.8 2001/11/16 11:21:38 wiz Exp $ +.\" $NetBSD: newfs_msdos.8,v 1.9 2002/10/01 13:40:47 wiz Exp $ .\" Copyright (c) 1998 Robert Nordier .\" All rights reserved. .\" @@ -79,42 +79,45 @@ FAT type (one of 12, 16, or 32). .It Fl I Ar volid Volume ID. .It Fl L Ar label -Volume label (up to 11 characters). The label should consist of -only those characters permitted in regular DOS (8+3) filenames. +Volume label (up to 11 characters). +The label should consist of only those characters permitted +in regular DOS (8+3) filenames. .It Fl O Ar OEM -OEM string (up to 8 characters). The default is +OEM string (up to 8 characters). +The default is .Qq Li "BSD 4.4" . .It Fl S Ar sector-size -Number of bytes per sector. Acceptable values are powers of 2 -in the range 128 through 32768. +Number of bytes per sector. +Acceptable values are powers of 2 in the range 128 through 32768. .It Fl a Ar FAT-size Number of sectors per FAT. .It Fl b Ar block-size -File system block size (bytes per cluster). This should resolve to an -acceptable number of sectors per cluster (see below). +File system block size (bytes per cluster). +This should resolve to an acceptable number of sectors +per cluster (see below). .It Fl c Ar cluster-size -Sectors per cluster. Acceptable values are powers of 2 in the range -1 through 128. +Sectors per cluster. +Acceptable values are powers of 2 in the range 1 through 128. .It Fl e Ar dirents Number of root directory entries (FAT12 and FAT16 only). .It Fl f Ar format -Specify a standard (floppy disk) format. The standard formats -are (capacities in kilobytes): 160, 180, 320, 360, 640, 720, 1200, -1232, 1440, 2880. +Specify a standard (floppy disk) format. +The standard formats are (capacities in kilobytes): +160, 180, 320, 360, 640, 720, 1200, 1232, 1440, 2880. .It Fl h Ar heads Number of drive heads. .It Fl i Ar info Location of the file system info sector (FAT32 only). A value of 0xffff signifies no info sector. .It Fl k Ar backup -Location of the backup boot sector (FAT32 only). A value -of 0xffff signifies no backup sector. +Location of the backup boot sector (FAT32 only). +A value of 0xffff signifies no backup sector. .It Fl m Ar media Media descriptor (acceptable range 0xf0 to 0xff). .It Fl n Ar FATs -Number of FATs. Acceptable values are 1 to 16 inclusive. -The default -is 2. +Number of FATs. +Acceptable values are 1 to 16 inclusive. +The default is 2. .It Fl o Ar hidden Number of hidden sectors. .It Fl r Ar reserved @@ -127,8 +130,8 @@ Number of sectors per track. .Sh NOTES FAT file system parameters occupy a "Boot Sector BPB (BIOS Parameter Block)" in the first of the "reserved" sectors which precede the actual -file system. For reference purposes, this structure is presented -below. +file system. +For reference purposes, this structure is presented below. .Bd -literal struct bsbpb { u_int16_t bps; /* [-S] bytes per sector */ diff --git a/sbin/ping/ping.8 b/sbin/ping/ping.8 index 2f9dd5838a2b..7e2dfbe4913b 100644 --- a/sbin/ping/ping.8 +++ b/sbin/ping/ping.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: ping.8,v 1.39 2002/04/06 15:49:30 bjh21 Exp $ +.\" $NetBSD: ping.8,v 1.40 2002/10/01 13:40:48 wiz Exp $ .\" .\" Copyright (c) 1985, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -237,7 +237,8 @@ packets other than that are received are listed. .It Fl w Ar maxwait Specifies the number of seconds to wait for a response to a packet -before transmitting the next one. The default is 10.0. +before transmitting the next one. +The default is 10.0. .El .Pp When using @@ -254,8 +255,8 @@ in calculating the minimum/average/maximum round-trip time numbers. When the specified number of packets have been sent (and received) or if the program is terminated with a .Dv SIGINT , -a brief summary is displayed. The summary information can be displayed -while +a brief summary is displayed. +The summary information can be displayed while .Nm is running by sending it a .Dv SIGINFO @@ -267,27 +268,32 @@ for more information). .Pp .Nm continually sends one datagram per second, and prints one line of -output for every ECHO_RESPONSE returned. On a trusted system with IP +output for every ECHO_RESPONSE returned. +On a trusted system with IP Security Options enabled, if the network idiom is not MONO, .Nm also prints a second line containing the hexadecimal representation -of the IP security option in the ECHO_RESPONSE. If the +of the IP security option in the ECHO_RESPONSE. +If the .Fl c -count option is given, only that number of requests is sent. No -output is produced if there is no response. Round-trip times and -packet loss statistics are computed. If duplicate packets are -received, they are not included in the packet loss calculation, +count option is given, only that number of requests is sent. +No output is produced if there is no response. +Round-trip times and packet loss statistics are computed. +If duplicate packets are received, +they are not included in the packet loss calculation, although the round trip time of these packets is used in calculating -the minimum/average/maximum round-trip time numbers. When the -specified number of packets have been sent (and received) or if +the minimum/average/maximum round-trip time numbers. +When the specified number of packets have been sent (and received) or if the program is terminated with an interrupt (SIGINT), a brief -summary is displayed. When not using the +summary is displayed. +When not using the .Fl f (flood) option, the first interrupt, usually generated by control-C or DEL, causes .Nm -to wait for its outstanding requests to return. It will wait no longer -than the longest round trip time encountered by previous, successful pings. +to wait for its outstanding requests to return. +It will wait no longer than the longest round trip time +encountered by previous, successful pings. The second interrupt stops ping immediately. .Pp This program is intended for use in network testing, measurement and @@ -300,8 +306,7 @@ An IP header without options is 20 bytes. An .Tn ICMP .Tn ECHO_REQUEST -packet contains an additional 8 bytes worth -of +packet contains an additional 8 bytes worth of .Tn ICMP header followed by an arbitrary amount of data. When a @@ -311,8 +316,7 @@ default is 56). Thus the amount of data received inside of an IP packet of type .Tn ICMP .Tn ECHO_REPLY -will always be 8 bytes more than the requested data space -(the +will always be 8 bytes more than the requested data space (the .Tn ICMP header). .Pp @@ -320,8 +324,8 @@ If the data space is at least eight bytes large, .Nm uses the first eight bytes of this space to include a timestamp to compute round trip times. -If less than eight bytes of pad are specified, no round trip times are -given. +If less than eight bytes of pad are specified, +no round trip times are given. .Sh DUPLICATE AND DAMAGED PACKETS .Nm will report duplicate and damaged packets. @@ -462,7 +466,8 @@ The .Nm program has evolved differently under different operating systems, and in some cases the same flag performs a different function -under different operating systems. The +under different operating systems. +The .Fl t flag conflicts with .Fx . diff --git a/sbin/pppoectl/pppoectl.8 b/sbin/pppoectl/pppoectl.8 index 5270e84c0276..2d16f636b332 100644 --- a/sbin/pppoectl/pppoectl.8 +++ b/sbin/pppoectl/pppoectl.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: pppoectl.8,v 1.14 2002/09/01 09:44:58 wiz Exp $ +.\" $NetBSD: pppoectl.8,v 1.15 2002/10/01 13:40:49 wiz Exp $ .\" .\" Copyright (C) 1997 by Joerg Wunsch, Dresden .\" All rights reserved. @@ -26,7 +26,7 @@ .\" .\" From: spppcontrol.1,v 1.1.1.1 1997/10/11 11:30:30 joerg Exp .\" -.\" $Id: pppoectl.8,v 1.14 2002/09/01 09:44:58 wiz Exp $ +.\" $Id: pppoectl.8,v 1.15 2002/10/01 13:40:49 wiz Exp $ .\" .\" last edit-date: [Thu Aug 31 10:47:33 2000] .\" @@ -73,7 +73,8 @@ dump the current connection state information (this parameter is typically used alone, for informational purposes, not during interface configuration). .It Fl n Ar 1 \&| 2 print the IP address of the primary or secondary DNS name server for this -PPP connection. This is only available if DNS query is enabled, see +PPP connection. +This is only available if DNS query is enabled, see .Ar query-dns . .El .Pp @@ -88,7 +89,8 @@ drivers require a number of additional arguments or optional parameters besides the settings that can be adjusted with .Xr ifconfig 8 . These are things like authentication protocol parameters, but also -other tunable configuration variables. The +other tunable configuration variables. +The .Nm utility can be used to display the current settings, or adjust these parameters as required. @@ -98,7 +100,8 @@ For whatever intent is being called, at least the parameter .Ar ifname needs to be specified, naming the interface for which the settings -are to be performed or displayed. Use +are to be performed or displayed. +Use .Xr ifconfig 8 or .Xr netstat 1 @@ -108,7 +111,8 @@ If no other parameter is given, .Nm will just list the current settings for .Ar ifname -and exit. The reported settings include the current PPP phase the +and exit. +The reported settings include the current PPP phase the interface is in, which can be one of the names .Em dead , .Em establish , @@ -119,7 +123,8 @@ or If an authentication protocol is configured for the interface, the name of the protocol to be used, as well as the system name to be used or expected will be displayed, plus any possible options to the -authentication protocol if applicable. Note that the authentication +authentication protocol if applicable. +Note that the authentication secrets (sometimes also called .Em keys ) are not being returned by the underlying system call, and are thus not @@ -128,12 +133,13 @@ displayed. If any additional parameter is supplied, superuser privileges are required, and the command works in .Ql set -mode. This is normally done quietly, unless the option +mode. +This is normally done quietly, unless the option .Fl v is also enabled, which will cause a final printout of the settings as -described above once all other actions have been taken. Use of this -mode will be rejected if the interface is currently in any other phase -than +described above once all other actions have been taken. +Use of this mode will be rejected if the interface is currently in any +other phase than .Em dead . Note that you can force an interface into .Em dead @@ -153,28 +159,33 @@ The protocol name can be one of or .Ql none . In the latter case, the use of an authentication protocol will be -turned off for the named interface. This has the side-effect of +turned off for the named interface. +This has the side-effect of clearing the other authentication-related parameters for this -interface as well (i. e., system name and authentication secret will +interface as well (i. +e., system name and authentication secret will be forgotten). .It Ar myauthproto Ns \&= Ns Em protoname -Same as above, but only for my end of the link. I. e., this is the -protocol when remote is authenticator, and I am the peer required to -authenticate. +Same as above, but only for my end of the link. +I. e., this is the protocol when remote is authenticator, +and I am the peer required to authenticate. .It Ar hisauthproto Ns \&= Ns Em protoname Same as above, but only for his end of the link. .It Ar myauthname Ns \&= Ns Em name Set my system name for the authentication protocol. .It Ar hisauthname Ns \&= Ns Em name -Set his system name for the authentication protocol. For CHAP, this -will only be used as a hint, causing a warning message if remote did -supply a different name. For PAP, it's the name remote must use to +Set his system name for the authentication protocol. +For CHAP, this will only be used as a hint, causing +a warning message if remote did supply a different name. +For PAP, it's the name remote must use to authenticate himself (in connection with his secret). .It Ar myauthsecret Ns \&= Ns Em secret Set my secret (key, password) for use in the authentication phase. For CHAP, this will be used to compute the response hash value, based -on remote's challenge. For PAP, it will be transmitted as plaintext -together with the system name. Don't forget to quote the secrets from +on remote's challenge. +For PAP, it will be transmitted as plaintext +together with the system name. +Don't forget to quote the secrets from the shell if they contain shell metacharacters (or whitespace). .It Ar myauthkey Ns \&= Ns Em secret Same as above. @@ -185,46 +196,51 @@ needs to authenticate. Same as above. .It Ar callin Require remote to authenticate himself only when he's calling in, but -not when we are caller. This is required for some peers that do not +not when we are caller. +This is required for some peers that do not implement the authentication protocols symmetrically (like Ascend routers, for example). .It Ar always The opposite of .Ar callin . Require remote to always authenticate, regardless of which side is -placing the call. This is the default, and will not be explicitly -displayed in +placing the call. +This is the default, and will not be explicitly displayed in .Ql list mode. .It Ar norechallenge -Only meaningful with CHAP. Do not re-challenge peer once the initial -CHAP handshake was successful. Used to work around broken peer -implementations that can't grok being re-challenged once the -connection is up. +Only meaningful with CHAP. +Do not re-challenge peer once the initial +CHAP handshake was successful. +Used to work around broken peer implementations that can't grok +being re-challenged once the connection is up. .It Ar rechallenge With CHAP, send re-challenges at random intervals while the connection -is in network phase. (The intervals are currently in the range of 300 -through approximately 800 seconds.) This is the default, and will not -be explicitly displayed in +is in network phase. +(The intervals are currently in the range of 300 +through approximately 800 seconds.) +This is the default, and will not be explicitly displayed in .Ql list mode. .It Ar idle-timeout Ns \&= Ns Em idle-seconds For services that are charged by connection time the interface can optionally -disconnect after a configured idle time. If set to 0, this feature is disabled. +disconnect after a configured idle time. +If set to 0, this feature is disabled. Note: for ISDN devices, it is preferable to use the .Xr isdnd 8 based timeout mechanism, as isdnd can predict the next charging unit for ISDN connections and optimize the timeout with this information. .It Ar lcp-timeout Ns \&= Ns Em timeout-value -Allows to change the value of the LCP timeout. The default value of the LCP -timeout is currently set to 1 second. The timeout-value must be specified in -milliseconds. +Allows to change the value of the LCP timeout. +The default value of the LCP timeout is currently set to 1 second. +The timeout-value must be specified in milliseconds. .It Ar max-auth-failure Ns \&= Ns Em count Since some ISPs disable accounts after too many unsuccessful authentication attempts, there is a maximum number of authentication failures before we will -stop retrying without manual intervention. Manual intervention is either -changing the authentication data (name, password) or setting the maximum -retry count. If +stop retrying without manual intervention. +Manual intervention is either changing the authentication data +(name, password) or setting the maximum retry count. +If .Em count is set to .Em 0 @@ -234,8 +250,9 @@ If an authentication failure has been caused by remote problems and you want to retry connecting using unchanged local settings, this command can be used to reset the failure count to zero. .It Ar query-dns Ns \&= Ns Em flags -During PPP protocol negotiation we can query the peer for addresses of two name -servers. If +During PPP protocol negotiation we can query the peer +for addresses of two name servers. +If .Ar flags is .Em 1 @@ -243,7 +260,8 @@ only the first server address will be requested, if .Ar flags is .Em 2 -the second will be requested. Setting +the second will be requested. +Setting .Ar flags to .Em 3 @@ -262,16 +280,18 @@ ippp0: phase=dead lcp timeout: 3.000 s .Ed .Pp -Display the settings for ippp0. The interface is currently in +Display the settings for ippp0. +The interface is currently in .Em dead -phase, i. e. the LCP layer is down, and no traffic is possible. Both -ends of the connection use the CHAP protocol, my end tells remote the -system name +phase, i. e. the LCP layer is down, and no traffic is possible. +Both ends of the connection use the CHAP protocol, +my end tells remote the system name .Ql uriah , and remote is expected to authenticate by the name .Ql ifb-gw . Once the initial CHAP handshake was successful, no further CHAP -challenges will be transmitted. There are supposedly some known CHAP +challenges will be transmitted. +There are supposedly some known CHAP secrets for both ends of the link which are not being shown. .Pp .Bd -literal @@ -303,7 +323,7 @@ pppoectl pppoe0 \\ myauthsecret=YYYYY \\ hisauthproto=none -# Configure the pppoe0 interface itself. These addresses are magic, +# Configure the pppoe0 interface itself. These addresses are magic, # meaning we don't care about either address and let the remote # ppp choose them. ifconfig pppoe0 0.0.0.0 0.0.0.1 up diff --git a/sbin/raidctl/raidctl.8 b/sbin/raidctl/raidctl.8 index f9989228eb99..56c58f139ad5 100644 --- a/sbin/raidctl/raidctl.8 +++ b/sbin/raidctl/raidctl.8 @@ -1,4 +1,4 @@ -.\" $NetBSD: raidctl.8,v 1.30 2002/07/11 15:06:04 wiz Exp $ +.\" $NetBSD: raidctl.8,v 1.31 2002/10/01 13:40:49 wiz Exp $ .\" .\" Copyright (c) 1998 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -129,7 +129,8 @@ is the user-land control program for the RAIDframe disk device. .Nm "" is primarily used to dynamically configure and unconfigure RAIDframe disk -devices. For more information about the RAIDframe disk device, see +devices. +For more information about the RAIDframe disk device, see .Xr raid 4 . .Pp This document assumes the reader has at least rudimentary knowledge of @@ -145,25 +146,25 @@ Add as a hot spare for the device .Ar dev . .It Fl A Ic yes Ar dev -Make the RAID set auto-configurable. The RAID set will be -automatically configured at boot +Make the RAID set auto-configurable. +The RAID set will be automatically configured at boot .Ar before -the root file system is -mounted. Note that all components of the set must be of type RAID in the -disklabel. +the root file system is mounted. +Note that all components of the set must be of type RAID in the disklabel. .It Fl A Ic no Ar dev Turn off auto-configuration for the RAID set. .It Fl A Ic root Ar dev Make the RAID set auto-configurable, and also mark the set as being -eligible to be the root partition. A RAID set configured this way -will +eligible to be the root partition. +A RAID set configured this way will .Ar override -the use of the boot disk as the root device. All components of the -set must be of type RAID in the disklabel. Note that the kernel being -booted must currently reside on a non-RAID set. +the use of the boot disk as the root device. +All components of the set must be of type RAID in the disklabel. +Note that the kernel being booted must currently reside on a non-RAID set. .It Fl B Ar dev Initiate a copyback of reconstructed data from a spare disk to -its original disk. This is performed after a component has failed, +its original disk. +This is performed after a component has failed, and the failed drive has been reconstructed onto a spare drive. .It Fl c Ar config_file Ar dev Configure the RAIDframe device @@ -176,8 +177,8 @@ is given later. .It Fl C Ar config_file Ar dev As for .Ar -c , -but forces the configuration to take place. This is required the -first time a RAID set is configured. +but forces the configuration to take place. +This is required the first time a RAID set is configured. .It Fl f Ar component Ar dev This marks the specified .Ar component @@ -187,7 +188,8 @@ component. Fails the specified .Ar component of the device, and immediately begin a reconstruction of the failed -disk onto an available hot spare. This is one of the mechanisms used to start +disk onto an available hot spare. +This is one of the mechanisms used to start the reconstruction process if a component does have a hardware failure. .It Fl g Ar component Ar dev Get the component label for the specified component. @@ -199,8 +201,9 @@ use with or .Fl C . .It Fl i Ar dev -Initialize the RAID device. In particular, (re-write) the parity on -the selected device. This +Initialize the RAID device. +In particular, (re-write) the parity on the selected device. +This .Ar MUST be done for .Ar all @@ -210,14 +213,16 @@ file systems are created on the RAID device. Initialize the component labels on each component of the device. .Ar serial_number is used as one of the keys in determining whether a -particular set of components belong to the same RAID set. While not -strictly enforced, different serial numbers should be used for -different RAID sets. This step +particular set of components belong to the same RAID set. +While not strictly enforced, different serial numbers should be used for +different RAID sets. +This step .Ar MUST be performed when a new RAID set is created. .It Fl p Ar dev -Check the status of the parity on the RAID set. Displays a status -message, and returns successfully if the parity is up-to-date. +Check the status of the parity on the RAID set. +Displays a status message, +and returns successfully if the parity is up-to-date. .It Fl P Ar dev Check the status of the parity on the RAID set, and initialize (re-write) the parity if the parity is not known to be up-to-date. @@ -240,12 +245,14 @@ Display the status of the RAIDframe device for each of the components and spares. .It Fl S Ar dev Check the status of parity re-writing, component reconstruction, and -component copyback. The output indicates the amount of progress +component copyback. +The output indicates the amount of progress achieved in each of these areas. .It Fl u Ar dev Unconfigure the RAIDframe device. .It Fl v -Be more verbose. For operations such as reconstructions, parity +Be more verbose. +For operations such as reconstructions, parity re-writing, and copybacks, provide a progress indicator. .El .Pp @@ -259,35 +266,36 @@ for the i386 architecture, and /dev/rraid0c for all others, or just simply raid0 (for /dev/rraid0d). .Ss Configuration file The format of the configuration file is complex, and -only an abbreviated treatment is given here. In the configuration -files, a +only an abbreviated treatment is given here. +In the configuration files, a .Sq # indicates the beginning of a comment. .Pp There are 4 required sections of a configuration file, and 2 -optional sections. Each section begins with a +optional sections. +Each section begins with a .Sq START , -followed by -the section name, and the configuration parameters associated with that -section. The first section is the +followed by the section name, +and the configuration parameters associated with that section. +The first section is the .Sq array section, and it specifies -the number of rows, columns, and spare disks in the RAID set. For -example: +the number of rows, columns, and spare disks in the RAID set. +For example: .Bd -literal -offset indent START array 1 3 0 .Ed .Pp -indicates an array with 1 row, 3 columns, and 0 spare disks. Note -that although multi-dimensional arrays may be specified, they are +indicates an array with 1 row, 3 columns, and 0 spare disks. +Note that although multi-dimensional arrays may be specified, they are .Ar NOT supported in the driver. .Pp The second section, the .Sq disks -section, specifies the actual -components of the device. For example: +section, specifies the actual components of the device. +For example: .Bd -literal -offset indent START disks /dev/sd0e @@ -295,31 +303,31 @@ START disks /dev/sd2e .Ed .Pp -specifies the three component disks to be used in the RAID device. If -any of the specified drives cannot be found when the RAID device is +specifies the three component disks to be used in the RAID device. +If any of the specified drives cannot be found when the RAID device is configured, then they will be marked as .Sq failed , -and the system will -operate in degraded mode. Note that it is +and the system will operate in degraded mode. +Note that it is .Ar imperative that the order of the components in the configuration file does not -change between configurations of a RAID device. Changing the order -of the components will result in data loss if the set is configured -with the +change between configurations of a RAID device. +Changing the order of the components will result in data loss +if the set is configured with the .Fl C -option. In normal circumstances, the RAID set will not configure if -only +option. +In normal circumstances, the RAID set will not configure if only .Fl c is specified, and the components are out-of-order. .Pp The next section, which is the .Sq spare -section, is optional, and, if -present, specifies the devices to be used as +section, is optional, and, if present, specifies the devices to be used as .Sq hot spares --- devices -which are on-line, but are not actively used by the RAID driver unless -one of the main components fail. A simple +\(em devices which are on-line, +but are not actively used by the RAID driver unless +one of the main components fail. +A simple .Sq spare section might be: .Bd -literal -offset indent @@ -327,18 +335,21 @@ START spare /dev/sd3e .Ed .Pp -for a configuration with a single spare component. If no spare drives -are to be used in the configuration, then the +for a configuration with a single spare component. +If no spare drives are to be used in the configuration, then the .Sq spare section may be omitted. .Pp The next section is the .Sq layout -section. This section describes the -general layout parameters for the RAID device, and provides such -information as sectors per stripe unit, stripe units per parity unit, -stripe units per reconstruction unit, and the parity configuration to -use. This section might look like: +section. +This section describes the general layout parameters for the RAID device, +and provides such information as +sectors per stripe unit, +stripe units per parity unit, +stripe units per reconstruction unit, +and the parity configuration to use. +This section might look like: .Bd -literal -offset indent START layout # sectPerSU SUsPerParityUnit SUsPerReconUnit RAID_level @@ -347,25 +358,32 @@ START layout .Pp The sectors per stripe unit specifies, in blocks, the interleave factor; i.e. the number of contiguous sectors to be written to each -component for a single stripe. Appropriate selection of this value -(32 in this example) is the subject of much research in RAID -architectures. The stripe units per parity unit and +component for a single stripe. +Appropriate selection of this value (32 in this example) +is the subject of much research in RAID architectures. +The stripe units per parity unit and stripe units per reconstruction unit are normally each set to 1. While certain values above 1 are permitted, a discussion of valid values and the consequences of using anything other than 1 are outside -the scope of this document. The last value in this section (5 in this -example) indicates the parity configuration desired. Valid entries -include: +the scope of this document. +The last value in this section (5 in this example) +indicates the parity configuration desired. +Valid entries include: .Bl -tag -width inde .It 0 -RAID level 0. No parity, only simple striping. +RAID level 0. +No parity, only simple striping. .It 1 -RAID level 1. Mirroring. The parity is the mirror. +RAID level 1. +Mirroring. +The parity is the mirror. .It 4 -RAID level 4. Striping across components, with parity stored on the +RAID level 4. +Striping across components, with parity stored on the last component. .It 5 -RAID level 5. Striping across components, parity distributed across +RAID level 5. +Striping across components, parity distributed across all components. .El .Pp @@ -377,8 +395,8 @@ those parity operations has not been tested with .Pp The next required section is the .Sq queue -section. This is most often -specified as: +section. +This is most often specified as: .Bd -literal -offset indent START queue fifo 100 @@ -391,9 +409,9 @@ is beyond the scope of this document. .Pp The final section, the .Sq debug -section, is optional. For more details -on this the reader is referred to the RAIDframe documentation -discussed in the +section, is optional. +For more details on this the reader is referred to +the RAIDframe documentation discussed in the .Sx HISTORY section. .Pp @@ -412,7 +430,8 @@ file systems that the system administrator(s) become quite familiar with the use of .Nm "" , and that they understand how the component reconstruction process -works. The examples in this section will focus on configuring a +works. +The examples in this section will focus on configuring a number of different RAID sets of varying degrees of redundancy. By working through these examples, administrators should be able to develop a good feel for how to configure a RAID set, and how to @@ -420,8 +439,8 @@ initiate reconstruction of failed components. .Pp In the following examples .Sq raid0 -will be used to denote the RAID device. Depending on the -architecture, +will be used to denote the RAID device. +Depending on the architecture, .Sq /dev/rraid0c or .Sq /dev/rraid0d @@ -429,8 +448,9 @@ may be used in place of .Sq raid0 . .Ss Initialization and Configuration The initial step in configuring a RAID set is to identify the components -that will be used in the RAID set. All components should be the same -size. Each component should have a disklabel type of +that will be used in the RAID set. +All components should be the same size. +Each component should have a disklabel type of .Dv FS_RAID , and a typical disklabel entry for a RAID component might look like: @@ -443,8 +463,9 @@ While will also work as the component type, the type .Dv FS_RAID is preferred for RAIDframe use, as it is required for features such as -auto-configuration. As part of the initial configuration of each RAID -set, each component will be given a +auto-configuration. +As part of the initial configuration of each RAID set, +each component will be given a .Sq component label . A .Sq component label @@ -452,18 +473,22 @@ contains important information about the component, including a user-specified serial number, the row and column of that component in the RAID set, the redundancy level of the RAID set, a 'modification counter', and whether the parity information (if any) on that -component is known to be correct. Component labels are an integral -part of the RAID set, since they are used to ensure that components +component is known to be correct. +Component labels are an integral part of the RAID set, +since they are used to ensure that components are configured in the correct order, and used to keep track of other -vital information about the RAID set. Component labels are also -required for the auto-detection and auto-configuration of RAID sets at -boot time. For a component label to be considered valid, that +vital information about the RAID set. +Component labels are also required for the auto-detection +and auto-configuration of RAID sets at boot time. +For a component label to be considered valid, that particular component label must be in agreement with the other -component labels in the set. For example, the serial number, +component labels in the set. +For example, the serial number, .Sq modification counter , -number of rows and number of columns must all -be in agreement. If any of these are different, then the component is -not considered to be part of the set. See +number of rows and number of columns must all be in agreement. +If any of these are different, then the component is +not considered to be part of the set. +See .Xr raid 4 for more information about component labels. .Pp @@ -472,8 +497,9 @@ appropriate labels, .Nm "" is then used to configure the .Xr raid 4 -device. To configure the device, a configuration -file which looks something like: +device. +To configure the device, a configuration file +which looks something like: .Bd -literal -offset indent START array # numRow numCol numSpare @@ -495,13 +521,13 @@ START queue fifo 100 .Ed .Pp -is created in a file. The above configuration file specifies a RAID 5 +is created in a file. +The above configuration file specifies a RAID 5 set consisting of the components /dev/sd1e, /dev/sd2e, and /dev/sd3e, with /dev/sd4e available as a .Sq hot spare -in case one of -the three main drives should fail. A RAID 0 set would be specified in -a similar way: +in case one of the three main drives should fail. +A RAID 0 set would be specified in a similar way: .Bd -literal -offset indent START array # numRow numCol numSpare @@ -522,9 +548,9 @@ fifo 100 .Ed .Pp In this case, devices /dev/sd10e, /dev/sd11e, /dev/sd12e, and /dev/sd13e -are the components that make up this RAID set. Note that there are no -hot spares for a RAID 0 set, since there is no way to recover data if -any of the components fail. +are the components that make up this RAID set. +Note that there are no hot spares for a RAID 0 set, +since there is no way to recover data if any of the components fail. .Pp For a RAID 1 (mirror) set, the following configuration might be used: .Bd -literal -offset indent @@ -545,11 +571,13 @@ fifo 100 .Ed .Pp In this case, /dev/sd20e and /dev/sd21e are the two components of the -mirror set. While no hot spares have been specified in this +mirror set. +While no hot spares have been specified in this configuration, they easily could be, just as they were specified in -the RAID 5 case above. Note as well that RAID 1 sets are currently -limited to only 2 components. At present, n-way mirroring is not -possible. +the RAID 5 case above. +Note as well that RAID 1 sets are currently +limited to only 2 components. +At present, n-way mirroring is not possible. .Pp The first time a RAID set is configured, the .Fl C @@ -560,15 +588,18 @@ raidctl -C raid0.conf raid0 .Pp where .Sq raid0.conf -is the name of the RAID configuration file. The +is the name of the RAID configuration file. +The .Fl C forces the configuration to succeed, even if any of the component -labels are incorrect. The +labels are incorrect. +The .Fl C option should not be used lightly in situations other than initial configurations, as if the system is refusing to configure a RAID set, there is probably a -very good reason for it. After the initial configuration is done (and +very good reason for it. +After the initial configuration is done (and appropriate component labels are added with the .Fl I option) then raid0 can be configured normally with: @@ -578,31 +609,33 @@ raidctl -c raid0.conf raid0 .Pp When the RAID set is configured for the first time, it is necessary to initialize the component labels, and to initialize the -parity on the RAID set. Initializing the component labels is done with: +parity on the RAID set. +Initializing the component labels is done with: .Bd -literal -offset indent raidctl -I 112341 raid0 .Ed .Pp where .Sq 112341 -is a user-specified serial number for the RAID set. This -initialization step is +is a user-specified serial number for the RAID set. +This initialization step is .Ar required -for all RAID sets. As well, using different -serial numbers between RAID sets is +for all RAID sets. +As well, using different serial numbers between RAID sets is .Ar strongly encouraged , as using the same serial number for all RAID sets will only serve to decrease the usefulness of the component label checking. .Pp Initializing the RAID set is done via the .Fl i -option. This initialization +option. +This initialization .Ar MUST be done for .Ar all RAID sets, since among other things it verifies that the parity (if -any) on the RAID set is correct. Since this initialization may be -quite time-consuming, the +any) on the RAID set is correct. +Since this initialization may be quite time-consuming, the .Fl v option may be also used in conjunction with .Fl i : @@ -626,7 +659,8 @@ to completion of the operation. Since it is the parity that provides the .Sq redundancy part of RAID, it is critical that the parity is correct -as much as possible. If the parity is not correct, then there is no +as much as possible. +If the parity is not correct, then there is no guarantee that data will not be lost if a component fails. .Pp Once the parity is known to be correct, @@ -641,11 +675,13 @@ for use. Under certain circumstances (e.g. the additional component has not arrived, or data is being migrated off of a disk destined to become a component) it may be desirable to configure a RAID 1 set with only -a single component. This can be achieved by configuring the set with +a single component. +This can be achieved by configuring the set with a physically existing component (as either the first or second component) and with a .Sq fake -component. In the following: +component. +In the following: .Bd -literal -offset indent START array # numRow numCol numSpare @@ -664,36 +700,39 @@ fifo 100 .Ed .Pp /dev/sd0e is the real component, and will be the second disk of a RAID 1 -set. The component /dev/sd6e, which must exist, but have no physical +set. +The component /dev/sd6e, which must exist, but have no physical device associated with it, is simply used as a placeholder. Configuration (using .Fl C and .Fl I Ar 12345 as above) proceeds normally, but initialization of the RAID set will -have to wait until all physical components are present. After -configuration, this set can be used normally, but will be operating -in degraded mode. Once a second physical component is obtained, it -can be hot-added, the existing data mirrored, and normal operation -resumed. +have to wait until all physical components are present. +After configuration, this set can be used normally, but will be operating +in degraded mode. +Once a second physical component is obtained, it can be hot-added, +the existing data mirrored, and normal operation resumed. .Ss Maintenance of the RAID set After the parity has been initialized for the first time, the command: .Bd -literal -offset indent raidctl -p raid0 .Ed .Pp -can be used to check the current status of the parity. To check the -parity and rebuild it necessary (for example, after an unclean -shutdown) the command: +can be used to check the current status of the parity. +To check the parity and rebuild it necessary (for example, +after an unclean shutdown) the command: .Bd -literal -offset indent raidctl -P raid0 .Ed .Pp -is used. Note that re-writing the parity can be done while +is used. +Note that re-writing the parity can be done while other operations on the RAID set are taking place (e.g. while doing a .Xr fsck 8 -on a file system on the RAID set). However: for maximum effectiveness -of the RAID set, the parity should be known to be correct before any +on a file system on the RAID set). +However: for maximum effectiveness of the RAID set, +the parity should be known to be correct before any data on the set is modified. .Pp To see how the RAID set is doing, the following command can be used to @@ -740,14 +779,14 @@ Parity Re-write is 100% complete. Copyback is 100% complete. .Ed .Pp -This indicates that all is well with the RAID set. Of importance here -are the component lines which read +This indicates that all is well with the RAID set. +Of importance here are the component lines which read .Sq optimal , and the .Sq Parity status -line which indicates that the parity is up-to-date. Note that if -there are file systems open on the RAID set, the individual components -will not be +line which indicates that the parity is up-to-date. +Note that if there are file systems open on the RAID set, +the individual components will not be .Sq clean but the set as a whole can still be clean. .Pp @@ -789,8 +828,8 @@ Spares: .Pp Note that with the use of .Fl f -a reconstruction has not been started. To both fail the disk and -start a reconstruction, the +a reconstruction has not been started. +To both fail the disk and start a reconstruction, the .Fl F option must be used: .Bd -literal -offset indent @@ -817,12 +856,13 @@ Parity Re-write is 100% complete. Copyback is 100% complete. .Ed .Pp -This indicates that a reconstruction is in progress. To find out how -the reconstruction is progressing the +This indicates that a reconstruction is in progress. +To find out how the reconstruction is progressing the .Fl S -option may be used. This will indicate the progress in terms of the -percentage of the reconstruction that is completed. When the -reconstruction is finished the +option may be used. +This will indicate the progress in terms of the +percentage of the reconstruction that is completed. +When the reconstruction is finished the .Fl s option will show: .Bd -literal -offset indent @@ -839,16 +879,19 @@ Parity Re-write is 100% complete. Copyback is 100% complete. .Ed .Pp -At this point there are at least two options. First, if /dev/sd2e is -known to be good (i.e. the failure was either caused by +At this point there are at least two options. +First, if /dev/sd2e is known to be good (i.e. the failure +was either caused by .Fl f or .Fl F , or the failed disk was replaced), then a copyback of the data can be initiated with the .Fl B -option. In this example, this would copy the entire contents of -/dev/sd4e to /dev/sd2e. Once the copyback procedure is complete, the +option. +In this example, this would copy the entire contents of +/dev/sd4e to /dev/sd2e. +Once the copyback procedure is complete, the status of the device would be (in part): .Bd -literal -offset indent Components: @@ -862,8 +905,8 @@ Spares: and the system is back to normal operation. .Pp The second option after the reconstruction is to simply use /dev/sd4e -in place of /dev/sd2e in the configuration file. For example, the -configuration file (in part) might now look like: +in place of /dev/sd2e in the configuration file. +For example, the configuration file (in part) might now look like: .Bd -literal -offset indent START array 1 3 0 @@ -875,11 +918,12 @@ START drives .Ed .Pp This can be done as /dev/sd4e is completely interchangeable with -/dev/sd2e at this point. Note that extreme care must be taken when -changing the order of the drives in a configuration. This is one of -the few instances where the devices and/or their orderings can be -changed without loss of data! In general, the ordering of components -in a configuration file should +/dev/sd2e at this point. +Note that extreme care must be taken when +changing the order of the drives in a configuration. +This is one of the few instances where the devices and/or +their orderings can be changed without loss of data! +In general, the ordering of components in a configuration file should .Ar never be changed. .Pp @@ -893,8 +937,8 @@ Components: No spares. .Ed .Pp -In this case there are a number of options. The first option is to add a hot -spare using: +In this case there are a number of options. +The first option is to add a hot spare using: .Bd -literal -offset indent raidctl -a /dev/sd4e raid0 .Ed @@ -913,14 +957,15 @@ Reconstruction could then take place using .Fl F as describe above. .Pp -A second option is to rebuild directly onto /dev/sd2e. Once the disk -containing /dev/sd2e has been replaced, one can simply use: +A second option is to rebuild directly onto /dev/sd2e. +Once the disk containing /dev/sd2e has been replaced, +one can simply use: .Bd -literal -offset indent raidctl -R /dev/sd2e raid0 .Ed .Pp -to rebuild the /dev/sd2e component. As the rebuilding is in progress, -the status will be: +to rebuild the /dev/sd2e component. +As the rebuilding is in progress, the status will be: .Bd -literal -offset indent Components: /dev/sd1e: optimal @@ -940,7 +985,8 @@ No spares. .Pp In circumstances where a particular component is completely unavailable after a reboot, a special component name will be used to -indicate the missing component. For example: +indicate the missing component. +For example: .Bd -literal -offset indent Components: /dev/sd2e: optimal @@ -949,10 +995,11 @@ No spares. .Ed .Pp indicates that the second component of this RAID set was not detected -at all by the auto-configuration code. The name +at all by the auto-configuration code. +The name .Sq component1 -can be used anywhere a normal component name would be used. For -example, to add a hot spare to the above set, and rebuild to that hot +can be used anywhere a normal component name would be used. +For example, to add a hot spare to the above set, and rebuild to that hot spare, the following could be done: .Bd -literal -offset indent raidctl -a /dev/sd3e raid0 @@ -967,33 +1014,38 @@ When more than one component is marked as .Sq failed due to a non-component hardware failure (e.g. loss of power to two components, adapter problems, termination problems, or cabling issues) it -is quite possible to recover the data on the RAID set. The first -thing to be aware of is that the first disk to fail will almost certainly -be out-of-sync with the remainder of the array. If any IO was -performed between the time the first component is considered +is quite possible to recover the data on the RAID set. +The first thing to be aware of is that the first disk to fail will +almost certainly be out-of-sync with the remainder of the array. +If any IO was performed between the time the first component is considered .Sq failed and when the second component is considered .Sq failed , then the first component to fail will .Ar not -contain correct data, and should be ignored. When the second -component is marked as failed, however, the RAID device will -(currently) panic the system. At this point the data on the RAID set +contain correct data, and should be ignored. +When the second component is marked as failed, however, the RAID device will +(currently) panic the system. +At this point the data on the RAID set (not including the first failed component) is still self consistent, and will be in no worse state of repair than had the power gone out in the middle of a write to a filesystem on a non-RAID device. The problem, however, is that the component labels may now have 3 different 'modification counters' (one value on the first component that failed, one value on the second component that failed, and a -third value on the remaining components). In such a situation, the -RAID set will not autoconfigure, and can only be forcibly re-configured +third value on the remaining components). +In such a situation, the RAID set will not autoconfigure, +and can only be forcibly re-configured with the .Fl C -option. To recover the RAID set, one must first remedy whatever physical -problem caused the multiple-component failure. After that is done, -the RAID set can be restored by forcibly configuring the raid set +option. +To recover the RAID set, one must first remedy whatever physical +problem caused the multiple-component failure. +After that is done, the RAID set can be restored by forcibly +configuring the raid set .Ar without -the component that failed first. For example, if /dev/sd1e and +the component that failed first. +For example, if /dev/sd1e and /dev/sd2e fail (in that order) in a RAID set of the following configuration: .Bd -literal -offset indent @@ -1039,20 +1091,24 @@ fifo 100 raidctl -C recover_raid0.conf raid0 .Ed .Pp -to force the configuration of raid0. A +to force the configuration of raid0. +A .Bd -literal -offset indent raidctl -I 12345 raid0 .Ed .Pp will be required in order to synchronize the component labels. At this point the filesystems on the RAID set can then be checked and -corrected. To complete the re-construction of the RAID set, +corrected. +To complete the re-construction of the RAID set, /dev/sd1e is simply hot-added back into the array, and reconstructed as described earlier. .Ss RAID on RAID RAID sets can be layered to create more complex and much larger RAID -sets. A RAID 0 set, for example, could be constructed from four RAID -5 sets. The following configuration file shows such a setup: +sets. +A RAID 0 set, for example, could be constructed from four RAID +5 sets. +The following configuration file shows such a setup: .Bd -literal -offset indent START array # numRow numCol numSpare @@ -1073,29 +1129,30 @@ fifo 100 .Ed .Pp A similar configuration file might be used for a RAID 0 set -constructed from components on RAID 1 sets. In such a configuration, -the mirroring provides a high degree of redundancy, while the striping -provides additional speed benefits. +constructed from components on RAID 1 sets. +In such a configuration, the mirroring provides a high degree +of redundancy, while the striping provides additional speed benefits. .Ss Auto-configuration and Root on RAID -RAID sets can also be auto-configured at boot. To make a set -auto-configurable, simply prepare the RAID set as above, and then do -a: +RAID sets can also be auto-configured at boot. +To make a set auto-configurable, +simply prepare the RAID set as above, and then do a: .Bd -literal -offset indent raidctl -A yes raid0 .Ed .Pp -to turn on auto-configuration for that set. To turn off -auto-configuration, use: +to turn on auto-configuration for that set. +To turn off auto-configuration, use: .Bd -literal -offset indent raidctl -A no raid0 .Ed .Pp RAID sets which are auto-configurable will be configured before the -root file system is mounted. These RAID sets are thus available for -use as a root file system, or for any other file system. A primary -advantage of using the auto-configuration is that RAID components -become more independent of the disks they reside on. For example, -SCSI ID's can change, but auto-configured sets will always be +root file system is mounted. +These RAID sets are thus available for +use as a root file system, or for any other file system. +A primary advantage of using the auto-configuration is that RAID components +become more independent of the disks they reside on. +For example, SCSI ID's can change, but auto-configured sets will always be configured correctly, even if the SCSI ID's of the component disks have become scrambled. .Pp @@ -1116,19 +1173,22 @@ To return raid0a to be just an auto-configuring set simply use the arguments. .Pp Note that kernels can only be directly read from RAID 1 components on -alpha and pmax architectures. On those architectures, the +alpha and pmax architectures. +On those architectures, the .Dv FS_RAID file system is recognized by the bootblocks, and will properly load the -kernel directly from a RAID 1 component. For other architectures, or -to support the root file system on other RAID sets, some other -mechanism must be used to get a kernel booting. For example, a small +kernel directly from a RAID 1 component. +For other architectures, or to support the root file system +on other RAID sets, some other mechanism must be used to get a kernel booting. +For example, a small partition containing only the secondary boot-blocks and an alternate -kernel (or two) could be used. Once a kernel is booting however, and -an auto-configuring RAID set is found that is eligible to be root, -then that RAID set will be auto-configured and used as the root -device. If two or more RAID sets claim to be root devices, then the -user will be prompted to select the root device. At this time, RAID -0, 1, 4, and 5 sets are all supported as root devices. +kernel (or two) could be used. +Once a kernel is booting however, and an auto-configuring RAID set is +found that is eligible to be root, then that RAID set will be +auto-configured and used as the root device. +If two or more RAID sets claim to be root devices, then the +user will be prompted to select the root device. +At this time, RAID 0, 1, 4, and 5 sets are all supported as root devices. .Pp A typical RAID 1 setup with root on RAID might be as follows: .Bl -enum @@ -1154,19 +1214,23 @@ or other data, if desired. wd0h and wd0h - a RAID 1 set, raid3, if desired. .El .Pp -RAID sets raid0, raid1, and raid2 are all marked as -auto-configurable. raid0 is marked as being a root file system. +RAID sets raid0, raid1, and raid2 are all marked as auto-configurable. +raid0 is marked as being a root file system. When new kernels are installed, the kernel is not only copied to .Pa / , -but also to wd0a and wd1a. The kernel on wd0a is required, since that -is the kernel the system boots from. The kernel on wd1a is also -required, since that will be the kernel used should wd0 fail. The -important point here is to have redundant copies of the kernel +but also to wd0a and wd1a. +The kernel on wd0a is required, since that +is the kernel the system boots from. +The kernel on wd1a is also +required, since that will be the kernel used should wd0 fail. +The important point here is to have redundant copies of the kernel available, in the event that one of the drives fail. .Pp There is no requirement that the root file system be on the same disk -as the kernel. For example, obtaining the kernel from wd0a, and using -sd0e and sd1e for raid0, and the root file system, is fine. It +as the kernel. +For example, obtaining the kernel from wd0a, and using +sd0e and sd1e for raid0, and the root file system, is fine. +It .Ar is critical, however, that there be multiple kernels available, in the event of media failure. @@ -1177,14 +1241,16 @@ up of RAID 1 sets) are supported as root devices or auto-configurable devices at this point. (Multi-layered RAID devices .Ar are -supported in general, however, as mentioned earlier.) Note that in +supported in general, however, as mentioned earlier.) +Note that in order to enable component auto-detection and auto-configuration of RAID devices, the line: .Bd -literal -offset indent options RAID_AUTOCONFIG .Ed .Pp -must be in the kernel configuration file. See +must be in the kernel configuration file. +See .Xr raid 4 for more details. .Ss Unconfiguration @@ -1192,7 +1258,8 @@ The final operation performed by .Nm is to unconfigure a .Xr raid 4 -device. This is accomplished via a simple: +device. +This is accomplished via a simple: .Bd -literal -offset indent raidctl -u raid0 .Ed @@ -1219,69 +1286,73 @@ CPU speed .El .Pp As with most performance tuning, benchmarking under real-life loads -may be the only way to measure expected performance. Understanding -some of the underlying technology is also useful in tuning. The goal -of this section is to provide pointers to those parameters which may +may be the only way to measure expected performance. +Understanding some of the underlying technology is also useful in tuning. +The goal of this section is to provide pointers to those parameters which may make significant differences in performance. .Pp -For a RAID 1 set, a SectPerSU value of 64 or 128 is typically -sufficient. Since data in a RAID 1 set is arranged in a linear +For a RAID 1 set, a SectPerSU value of 64 or 128 is typically sufficient. +Since data in a RAID 1 set is arranged in a linear fashion on each component, selecting an appropriate stripe size is -somewhat less critical than it is for a RAID 5 set. However: a stripe -size that is too small will cause large IO's to be broken up into a -number of smaller ones, hurting performance. At the same time, a -large stripe size may cause problems with concurrent accesses to -stripes, which may also affect performance. Thus values in the range -of 32 to 128 are often the most effective. +somewhat less critical than it is for a RAID 5 set. +However: a stripe size that is too small will cause large IO's to be +broken up into a number of smaller ones, hurting performance. +At the same time, a large stripe size may cause problems with +concurrent accesses to stripes, which may also affect performance. +Thus values in the range of 32 to 128 are often the most effective. .Pp -Tuning RAID 5 sets is trickier. In the best case, IO is presented to -the RAID set one stripe at a time. Since the entire stripe is -available at the beginning of the IO, the parity of that stripe can -be calculated before the stripe is written, and then the stripe data -and parity can be written in parallel. When the amount of data being -written is less than a full stripe worth, the +Tuning RAID 5 sets is trickier. +In the best case, IO is presented to the RAID set one stripe at a time. +Since the entire stripe is available at the beginning of the IO, +the parity of that stripe can be calculated before the stripe is written, +and then the stripe data and parity can be written in parallel. +When the amount of data being written is less than a full stripe worth, the .Sq small write -problem occurs. Since a +problem occurs. +Since a .Sq small write means only a portion of the stripe on the components is going to change, the data (and parity) on the components must be updated -slightly differently. First, the +slightly differently. +First, the .Sq old parity and .Sq old data -must be read from the components. Then the new parity is constructed, +must be read from the components. +Then the new parity is constructed, using the new data to be written, and the old data and old parity. -Finally, the new data and new parity are written. All this extra data -shuffling results in a serious loss of performance, and is typically 2 -to 4 times slower than a full stripe write (or read). To combat this -problem in the real world, it may be useful to ensure that stripe -sizes are small enough that a +Finally, the new data and new parity are written. +All this extra data shuffling results in a serious loss of performance, +and is typically 2 to 4 times slower than a full stripe write (or read). +To combat this problem in the real world, it may be useful +to ensure that stripe sizes are small enough that a .Sq large IO -from the system will use exactly one large stripe write. As is seen -later, there are some file system dependencies which may come into play -here as well. +from the system will use exactly one large stripe write. +As is seen later, there are some file system dependencies +which may come into play here as well. .Pp Since the size of a .Sq large IO is often (currently) only 32K or 64K, on a 5-drive RAID 5 set it may be desirable to select a SectPerSU value of 16 blocks (8K) or 32 -blocks (16K). Since there are 4 data sectors per stripe, the maximum -data per stripe is 64 blocks (32K) or 128 blocks (64K). Again, -empirical measurement will provide the best indicators of which +blocks (16K). +Since there are 4 data sectors per stripe, the maximum +data per stripe is 64 blocks (32K) or 128 blocks (64K). +Again, empirical measurement will provide the best indicators of which values will yeild better performance. .Pp -The parameters used for the file system are also critical to good -performance. For +The parameters used for the file system are also critical to good performance. +For .Xr newfs 8 , for example, increasing the block size to 32K or 64K may improve -performance dramatically. As well, changing the cylinders-per-group +performance dramatically. +As well, changing the cylinders-per-group parameter from 16 to 32 or higher is often not only necessary for -larger file systems, but may also have positive performance -implications. +larger file systems, but may also have positive performance implications. .Ss Summary Despite the length of this man-page, configuring a RAID set is a -relatively straight-forward process. All that needs to be done is the -following steps: +relatively straight-forward process. +All that needs to be done is the following steps: .Bl -enum .It Use @@ -1364,8 +1435,8 @@ Parallel Data Laboratory of Carnegie Mellon University. .Pp The .Nm -command first appeared as a program in CMU's RAIDframe v1.1 distribution. This -version of +command first appeared as a program in CMU's RAIDframe v1.1 distribution. +This version of .Nm is a complete re-write, and first appeared in .Nx 1.4 . @@ -1398,21 +1469,23 @@ rights to redistribute these changes. .Ed .Sh WARNINGS Certain RAID levels (1, 4, 5, 6, and others) can protect against some -data loss due to component failure. However the loss of two -components of a RAID 4 or 5 system, or the loss of a single component -of a RAID 0 system will result in the entire file system being lost. +data loss due to component failure. +However the loss of two components of a RAID 4 or 5 system, +or the loss of a single component of a RAID 0 system will +result in the entire file system being lost. RAID is .Ar NOT a substitute for good backup practices. .Pp Recomputation of parity .Ar MUST -be performed whenever there is a chance that it may have been -compromised. This includes after system crashes, or before a RAID -device has been used for the first time. Failure to keep parity -correct will be catastrophic should a component ever fail -- it is -better to use RAID 0 and get the additional space and speed, than it -is to use parity, but not keep the parity correct. At least with RAID -0 there is no perception of increased data security. +be performed whenever there is a chance that it may have been compromised. +This includes after system crashes, or before a RAID +device has been used for the first time. +Failure to keep parity correct will be catastrophic should a +component ever fail -- it is better to use RAID 0 and get the +additional space and speed, than it is to use parity, but +not keep the parity correct. +At least with RAID 0 there is no perception of increased data security. .Sh BUGS Hot-spare removal is currently not available.