diff options
author | Aaron Campbell <aaron@cvs.openbsd.org> | 1998-09-17 04:15:04 +0000 |
---|---|---|
committer | Aaron Campbell <aaron@cvs.openbsd.org> | 1998-09-17 04:15:04 +0000 |
commit | afa9f8ccda18c5ff879f432ae6f0b9a601b992b3 (patch) | |
tree | 8356bdc65590449d1a86d64a309c95681f802ad2 /sbin | |
parent | 90e9edeb57b7efe3b1aba0ddeda30341b7e9fd0c (diff) |
sbin/ man page fixes
Diffstat (limited to 'sbin')
66 files changed, 974 insertions, 809 deletions
diff --git a/sbin/badsect/badsect.8 b/sbin/badsect/badsect.8 index 8660a5130c4..1f05fd0df79 100644 --- a/sbin/badsect/badsect.8 +++ b/sbin/badsect/badsect.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: badsect.8,v 1.2 1996/06/23 14:29:54 deraadt Exp $ +.\" $OpenBSD: badsect.8,v 1.3 1998/09/17 04:14:51 aaron Exp $ .\" $NetBSD: badsect.8,v 1.8 1995/03/18 14:54:27 cgd Exp $ .\" .\" Copyright (c) 1985, 1991, 1993 @@ -42,9 +42,9 @@ .Nd create files to contain bad sectors .Sh SYNOPSIS .Nm /sbin/badsect -.Ar bbdir sector ... +.Ar bbdir sector Op Ar ... .Sh DESCRIPTION -.Nm Badsect +.Nm badsect makes a file to contain a bad sector. Normally, bad sectors are made inaccessible by the standard formatter, which provides a forwarding table for bad sectors to the driver; see @@ -71,7 +71,7 @@ do not support the bad-blocking standard .Nm badsect may be used to good effect. .Pp -.Nm Badsect +.Nm badsect is used on a quiet file system in the following way: First mount the file system, and change to its root directory. Make a directory @@ -100,7 +100,7 @@ This will leave the bad sectors in only the .Li BAD files. .Pp -.Nm Badsect +.Nm badsect works by giving the specified sector numbers in a .Xr mknod 2 system call, @@ -118,7 +118,7 @@ to convert the inode to a regular file containing the bad block. .Xr fsck 8 , .Xr format 8 .Sh DIAGNOSTICS -.Nm Badsect +.Nm badsect refuses to attach a block that resides in a critical area or is out of range of the file system. A warning is issued if the block is already in use. diff --git a/sbin/ccdconfig/ccdconfig.8 b/sbin/ccdconfig/ccdconfig.8 index de8a0b9cc6f..e74f2a57ac2 100644 --- a/sbin/ccdconfig/ccdconfig.8 +++ b/sbin/ccdconfig/ccdconfig.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ccdconfig.8,v 1.8 1997/11/27 01:20:36 deraadt Exp $ +.\" $OpenBSD: ccdconfig.8,v 1.9 1998/09/17 04:14:51 aaron Exp $ .\" $NetBSD: ccdconfig.8,v 1.4 1996/02/28 01:01:17 thorpej Exp $ .\" .\" Copyright (c) 1996 The NetBSD Foundation, Inc. @@ -71,7 +71,7 @@ .Oc .Oc .Sh DESCRIPTION -.Nm Ccdconfig +.Nm ccdconfig is used to dynamically configure and unconfigure concatenated disk devices, or ccds. For more information about the ccd, see .Xr ccd 4 . @@ -94,12 +94,12 @@ 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 +.Ar core instead of the default .Pa /dev/mem . .It Fl N Ar system Extract the name list from -.Pa system +.Ar system instead of the default .Pa /bsd . .It Fl u @@ -120,16 +120,16 @@ of strings, or the word .Dq none . The flags are as follows: .Bd -unfilled -offset indent -CCDF_SWAP 0x01 Interleave should be dmmax -CCDF_UNIFORM 0x02 Use uniform interleave -CCDF_MIRROR 0x04 Enable data mirroring -CCDF_OLD 0x08 Use old unoptimized I/O protocol +CCDF_SWAP 0x01 Interleave should be dmmax. +CCDF_UNIFORM 0x02 Use uniform interleave. +CCDF_MIRROR 0x04 Enable data mirroring. +CCDF_OLD 0x08 Use old unoptimized I/O protocol. .Ed .Pp The format in the configuration file appears exactly as if it were entered on the command line. Note that on the command line and in the configuration file, the -.Pa flags +.Ar flags argument is optional. .Bd -unfilled -offset indent # @@ -150,10 +150,13 @@ interleave factor of 32 blocks. .Ed .Pp .Sh FILES -/etc/ccd.conf - default ccd configuration file. +.Bl -tag -width /etc/ccd.conf -compact +.It Pa /etc/ccd.conf +default ccd configuration file +.El .Sh SEE ALSO .Xr ccd 4 , -.Xr rc 8 . +.Xr rc 8 .Sh HISTORY The .Nm ccdconfig diff --git a/sbin/clri/clri.8 b/sbin/clri/clri.8 index 937286022d1..44454675245 100644 --- a/sbin/clri/clri.8 +++ b/sbin/clri/clri.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: clri.8,v 1.4 1996/06/25 04:46:23 deraadt Exp $ +.\" $OpenBSD: clri.8,v 1.5 1998/09/17 04:14:51 aaron Exp $ .\" $NetBSD: clri.8,v 1.2 1995/03/18 14:54:31 cgd Exp $ .\" .\" Copyright (c) 1980, 1993 @@ -39,18 +39,18 @@ .Os BSD 4 .Sh NAME .Nm clri -.Nd clear an inode +.Nd clear inode(s) .Sh SYNOPSIS .Nm clri -.Ar special_device inode_number ... +.Ar special_device inode_number Op Ar ... .Sh DESCRIPTION .Bf -symbolic -.Nm Clri +.Nm clri is obsoleted for normal file system repair work by .Xr fsck 8 . .Ef .Pp -.Nm Clri +.Nm clri zeros out the inodes with the specified inode number(s) on the filesystem residing on the given .Ar special_device . diff --git a/sbin/disklabel/disklabel.5 b/sbin/disklabel/disklabel.5 index e96f1971e32..b66462bb01f 100644 --- a/sbin/disklabel/disklabel.5 +++ b/sbin/disklabel/disklabel.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: disklabel.5,v 1.4 1998/07/14 22:19:33 angelos Exp $ +.\" $OpenBSD: disklabel.5,v 1.5 1998/09/17 04:14:51 aaron Exp $ .\" $NetBSD: disklabel.5,v 1.3 1995/03/18 14:54:36 cgd Exp $ .\" .\" Copyright (c) 1987, 1991, 1993 @@ -105,7 +105,7 @@ All of these operations are normally done using .Xr disklabel . .Pp The format of the disk label, as specified in -.Aw Pa sys/disklabel.h , +.Pa sys/disklabel.h , is .Bd -literal /* @@ -379,4 +379,3 @@ struct partinfo { .Sh SEE ALSO .Xr disktab 5 , .Xr disklabel 8 -.Sh HISTORY diff --git a/sbin/disklabel/disklabel.8 b/sbin/disklabel/disklabel.8 index 00420f80a75..c0fd93d909f 100644 --- a/sbin/disklabel/disklabel.8 +++ b/sbin/disklabel/disklabel.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: disklabel.8,v 1.18 1998/08/06 18:08:09 millert Exp $ +.\" $OpenBSD: disklabel.8,v 1.19 1998/09/17 04:14:51 aaron Exp $ .\" $NetBSD: disklabel.8,v 1.9 1995/03/18 14:54:38 cgd Exp $ .\" .\" Copyright (c) 1987, 1988, 1991, 1993 @@ -105,7 +105,7 @@ .Ar disk Ar protofile .Oo Ar disktype Oc .Sh DESCRIPTION -.Nm Disklabel +.Nm disklabel can be used to install, examine or modify the label on a disk drive or pack. When writing the label, it can be used to change the drive identification, @@ -170,7 +170,7 @@ partitions, it will be necessary to have separate disktab entries describing each, or to edit the label after installation as described below. The optional argument is a pack identification string, up to 16 characters long. -The pack id must be quoted if it contains blanks. +The pack ID must be quoted if it contains blanks. If the .Fl r flag is given, the disk sectors containing the label and bootstrap @@ -211,7 +211,7 @@ With the flag, .Nm disklabel is capable of restoring a disk label that was formatted -in a prior operation and saved in an ascii file. +in a prior operation and saved in an ASCII file. The prototype file used to create the label should be in the same format as that produced when reading or editing a label. Comments are delimited by @@ -300,16 +300,16 @@ size, block fragment size, block size, and cylinders per group for the specified partition (not all parameters are configurable for non-BSD partitions). .It s Op path -Save the label to a file in ascii format (suitable for loading via +Save the label to a file in ASCII format (suitable for loading via the -.Op -R +.Fl R option). If no path is specified, the user will be prompted for one. .It w Write the label to disk. This option will commit any changes to the on-disk label. .It q -Quit the editor. If any changes have been made the user will be +Quit the editor. If any changes have been made, the user will be asked whether or not to save the changes to the on-disk label. .It x Exit the editor without saving any changes to the label. @@ -384,12 +384,16 @@ Create a label for sd0 based on information for ``sd2212'' found in .Pa /etc/disktab . Any existing bootstrap code will be clobbered. (Normally you do -not want to use the -r flag though.) +not want to use the +.Fl r +flag though.) .Pp .Dl disklabel -e -r sd0 .Pp Read the on-disk label for sd0, edit it and reinstall in-core as -well as on-disk. (Normally you do not want to use the -r flag +well as on-disk. (Normally you do not want to use the +.Fl r +flag though.) Existing bootstrap code is unaffected. .Pp .Dl disklabel -R sd0 mylabel @@ -458,7 +462,7 @@ mode, .Nm disklabel is far too quick to shuffle partitions around; it should keep a free block list and only move partitions around with the user's -permission. Also in +permission. Also, in .Fl E mode, partitions outside the OpenBSD portion of the disk should -be changeable.. +be changeable. diff --git a/sbin/dmesg/dmesg.8 b/sbin/dmesg/dmesg.8 index 7a483edb6ab..f069ac961ea 100644 --- a/sbin/dmesg/dmesg.8 +++ b/sbin/dmesg/dmesg.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dmesg.8,v 1.3 1996/07/08 22:09:31 ccappuc Exp $ +.\" $OpenBSD: dmesg.8,v 1.4 1998/09/17 04:14:51 aaron Exp $ .\" $NetBSD: dmesg.8,v 1.9 1995/03/18 14:54:47 cgd Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -45,17 +45,21 @@ .Op Fl M Ar core .Op Fl N Ar system .Sh DESCRIPTION -.Nm Dmesg +.Nm dmesg displays the contents of the system message buffer. .Pp The options are as follows: .Bl -tag -width Ds -.It Fl M -Extract values associated with the name list from the specified core -instead of the default ``/dev/kmem''. -.It Fl N -Extract the name list from the specified system instead of the default -``/bsd''. +.It Fl M Ar core +Extract values associated with the name list from the specified +.Ar core +instead of the default +.Pa /dev/kmem . +.It Fl N Ar system +Extract the name list from the specified +.Ar system +instead of the default +.Pa /bsd . .El .Sh SEE ALSO .Xr syslogd 8 diff --git a/sbin/dump/dump.8 b/sbin/dump/dump.8 index ef2f9fce36f..95d5234d42d 100644 --- a/sbin/dump/dump.8 +++ b/sbin/dump/dump.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dump.8,v 1.12 1998/05/06 14:35:09 deraadt Exp $ +.\" $OpenBSD: dump.8,v 1.13 1998/09/17 04:14:52 aaron Exp $ .\" $NetBSD: dump.8,v 1.17 1997/06/05 11:15:06 lukem Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -58,7 +58,7 @@ .in -\\n(iSu (The .Bx 4.3 -option syntax is implemented for backward compatibility, but +option syntax is implemented for backward compatibility but is not documented here.) .Sh DESCRIPTION .Nm @@ -79,18 +79,18 @@ by using the option. .Pp On media that cannot reliably return an end-of-media indication -(such as some cartridge tape drives) +(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 +the actual size is determined by the tape size, density and/or block count options below. By default, the same output file name is used for each volume after prompting the operator to change media. .Pp .Ar files-to-dump -is either a mountpoint of a filesystem, +is either a mountpoint of a filesystem or a list of files and directories on a single filesystem to be backed up as a subset of the filesystem. -In the former case, either the path to a mounted filesystem, +In the former case, either the path to a mounted filesystem or the device of an unmounted filesystem can be used. In the latter case, certain restrictions are placed on the backup: .Fl u @@ -110,7 +110,9 @@ guarantees the entire file system is copied option below). A level number above 0, incremental backup, -tells dump to +tells +.Nm dump +to copy all files new or modified since the last dump of a lower level. The default level is 0. @@ -163,7 +165,7 @@ if the dump requires more volumes than the number of names given, the last file name will used for all remaining volumes after prompting for media changes. If the name of the file is of the form -.Dq host:file , +.Dq host:file or .Dq user@host:file , .Nm @@ -199,7 +201,9 @@ The default tape length is 2300 feet. Use the specified date as the starting time for the dump instead of the time determined from looking in .Pa /etc/dumpdates . -The format of date is the same as that of +The format of +.Ar date +is the same as that of .Xr ctime 3 . This option is useful for automated dump scripts that wish to dump over a specific period of time. @@ -242,7 +246,7 @@ The flag causes .Nm to print out, for each file system in -.Pa /etc/dumpdates +.Pa /etc/dumpdates , the most recent dump date and level, and highlights those file systems that should be dumped. If the @@ -251,7 +255,9 @@ flag is set, all other options are ignored, and .Nm exits immediately. .It Fl w -Is like W, but prints only those filesystems which need to be dumped. +Same as +.Fl W , +but prints only those filesystems which need to be dumped. .El .Pp .Nm @@ -260,7 +266,7 @@ end of tape, end of dump, tape write error, tape open error or -disk read error (if there are more than a threshold of 32). +disk read error (if there is more than a threshold of 32). In addition to alerting all operators implied by the .Fl n flag, @@ -355,7 +361,7 @@ to the standard error output. .It Pa /dev/rst0 default tape unit to dump to .It Pa /dev/rst* -Raw SCSI tape interface +raw SCSI tape interface .It Pa /etc/dumpdates dump date records .It Pa /etc/fstab @@ -390,7 +396,7 @@ with the .Fl W or .Fl w -flags does not report filesystems that have never been recorded +flag does not report filesystems that have never been recorded in .Pa /etc/dumpdates , even if listed in diff --git a/sbin/dumplfs/dumplfs.8 b/sbin/dumplfs/dumplfs.8 index 42c429b490e..9e2cff7f3f6 100644 --- a/sbin/dumplfs/dumplfs.8 +++ b/sbin/dumplfs/dumplfs.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dumplfs.8,v 1.3 1997/05/31 06:04:36 deraadt Exp $ +.\" $OpenBSD: dumplfs.8,v 1.4 1998/09/17 04:14:52 aaron Exp $ .\" $NetBSD: dumplfs.8,v 1.2 1995/03/18 14:55:19 cgd Exp $ .\" .\" Copyright (c) 1993 @@ -44,7 +44,7 @@ .Nm dumplfs .Op Ar filesys No \&| Ar device .Sh DESCRIPTION -.Nm Dumplfs +.Nm dumplfs prints out the file system layout information for the LFS file system or special device specified. The listing is very long and detailed. diff --git a/sbin/fdisk/fdisk.8 b/sbin/fdisk/fdisk.8 index 70035ed3ada..36935ee05fe 100644 --- a/sbin/fdisk/fdisk.8 +++ b/sbin/fdisk/fdisk.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fdisk.8,v 1.15 1998/09/01 16:38:16 deraadt Exp $ +.\" $OpenBSD: fdisk.8,v 1.16 1998/09/17 04:14:52 aaron Exp $ .\" .\" Copyright (c) 1997 Tobias Weingartner .\" All rights reserved. @@ -45,12 +45,12 @@ .Sh DESCRIPTION In order for the BIOS to boot the kernel, certain conventions must be adhered to. Sector 0 of a bootable hard disk must contain boot code, -a MBR partition table, and a magic number. These MBR partitions (also +an MBR partition table, and a magic number. These MBR partitions (also known as BIOS partitions) can be used to break the disk up into several pieces. The BIOS loads sector 0 of the boot disk into memory, verifies the magic number, and begins executing the code at the first byte. The normal DOS MBR boot code searches the MBR partition table for an -`active' partition (indicated by a `*' in the fist column), and if one +`active' partition (indicated by a `*' in the first column), and if one is found, the boot block from that partition is loaded and executed in place of the original (MBR) boot block. .Pp @@ -63,7 +63,7 @@ Edit existing MBR sectors. .It Fl f Ar mbrname Specifies an alternate MBR template file. .It Fl c,h,s -Specify an alternate BIOS geometry for +Specifies an alternate BIOS geometry for .Nm to use. .El @@ -100,7 +100,7 @@ options. .Pp This disk is divided into two partitions that happen to fill the disk. The first partition overlaps the third partition. (Used for debugging -purposes) +purposes.) .Bl -tag -width "start/size" .It Em "#" Number of partition table entry. A '*' denotes the bootable partition. @@ -150,13 +150,13 @@ but is safe as long as you do not execute the .Em write command, or answer in the negative (the default) when .Nm -askes you about writing out changes. +asks you about writing out changes. .Sh COMMAND MODE When you first enter this mode, you are presented with a prompt, that looks like so: .Em "fdisk: 0>" . This prompt has two important pieces of information for you. It will tell -you if the in memory copy of the boot block has been modified or not. If it +you if the in-memory copy of the boot block has been modified or not. If it has been modified, the prompt will change to look like: .Em "fdisk:*0>" . The second piece of information pertains to the number given in the prompt. @@ -166,43 +166,49 @@ you are editing extended partitions. The list of commands and their explanations are given below. .Bl -tag -width "update" .It Em help -This command gives you a list of commands that +Display a list of commands that .Nm understands in the interactive edit mode. .It Em reinit -This command initializes the currently selected, in memory copy, of the +Initialize the currently selected, in-memory copy of the boot block. .It Em disk -This command will display the current drive geometry that fdisk has -probed. You are given a chance to edit them if you wish. +Display the current drive geometry that +.Nm fdisk +has +probed. You are given a chance to edit it if you wish. .It Em edit -This command is used to edit a given table entry in the memory copy of +Edit a given table entry in the memory copy of the current boot block. You may edit either in BIOS geometry mode, or in sector offsets and sizes. .It Em flag -This command makes the given partition table entry bootable. Only one +Make the given partition table entry bootable. Only one entry can be marked bootable. If you wish to boot from an extended partition, you will need to mark the partition table entry for the extended partition as bootable. .It Em update -This command will update the machine code in the memory copy of the +Update the machine code in the memory copy of the currently selected boot block. .It Em select -This command will select and load into memory the boot block pointed +Select and load into memory the boot block pointed to by the extended partition table entry in the current boot block. .It Em print -This command will print the currently selected in memory copy of the boot +Print the currently selected in-memory copy of the boot block and its MBR table to the terminal. .It Em write -This will write the in memory copy of the boot block to disk. You will +Write the in-memory copy of the boot block to disk. You will be asked to confirm this operation. .It Em exit -This will exit the current level of fdisk, either returning to the -previously selected in memory copy of a boot block, or exit the +Exit the current level of +.Nm fdisk , +either returning to the +previously selected in-memory copy of a boot block, or exiting the program if there is none. .It Em quit -This will exit the current level of fdisk, either returning to the -previously selected in memory copy of a boot block, or exit the +Exit the current level of +.Nm fdisk , +either returning to the +previously selected in-memory copy of a boot block, or exiting the program if there is none. Unlike .Em exit it does write the modified block out. @@ -214,7 +220,7 @@ Quit program without saving current changes. The automatic calculation of starting cylinder etc. uses a set of figures that represent what the BIOS thinks is the geometry of the drive. -These figures are by default taken from the incore disklabel, or +These figures are by default taken from the in-core disklabel, or values that .Em /boot has passed to the kernel, but @@ -233,15 +239,19 @@ Editing an existing partition is risky, and may cause you to lose all the data in that partition. .Pp You should run this program interactively once or twice to see how it works. -This is completely safe as long as you answer the write questions in the +This is completely safe as long as you answer the +.Dq write +questions in the negative. .Sh FILES -.Pa /usr/mdec/mbr -- the default MBR template +.Bl -tag -width /usr/mdec/mbr -compact +.It Pa /usr/mdec/mbr +default MBR template +.El .Sh SEE ALSO .Xr disklabel 8 , .Xr boot_i386 8 .Sh BUGS There are subtleties that the program detects that are not explained in -this manual page. Also, chances are that some of the subleties it should +this manual page. Also, chances are that some of the subtleties it should detect are being steamrolled. Caveat Emperor. diff --git a/sbin/fsck/fsck.8 b/sbin/fsck/fsck.8 index f3c0f3aee43..7f03c965b8c 100644 --- a/sbin/fsck/fsck.8 +++ b/sbin/fsck/fsck.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fsck.8,v 1.7 1998/08/30 05:41:24 deraadt Exp $ +.\" $OpenBSD: fsck.8,v 1.8 1998/09/17 04:14:52 aaron Exp $ .\" $NetBSD: fsck.8,v 1.14 1996/10/03 20:08:29 christos Exp $ .\" .\" Copyright (c) 1996 Christos Zoulas. All rights reserved. @@ -59,33 +59,39 @@ is compiled to support it. Force checking of filesystems, even when they are marked clean (for filesystems that support this). .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 filesystem at a time. +Limit the number of parallel checks to +.Ar maxparallel . +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 filesystem at a time. .It Fl n -Causes +Cause .Nm -to assume no as the answer to all operator questions, except "CONTINUE?". +to assume +.Dq no +as the answer to all operator questions, except "CONTINUE?". .It Fl p Enter preen mode. .It Fl t Ar fstype Invoke fsck only in the comma separated list of filesystem types. If the list starts with -.Dq no -then invoke fsck only in the filesystem types that are not specified in +.Dq no , +invoke fsck only in the filesystem types that are +.Em not +specified in the list. .It Fl v Print the commands before executing them. .It Fl y -Causes +Cause .Nm -to assume yes +to assume +.Dq yes as the answer to all operator questions. .It Fl T Ar fstype:fsoptions List of comma separated filesystem specific options for the specified filesystem type, in the same format as -.Xr mount 8 +.Xr mount 8 . .Sh FILES .Bl -tag -width /etc/fstab -compact .It Pa /etc/fstab diff --git a/sbin/fsck_ext2fs/fsck_ext2fs.8 b/sbin/fsck_ext2fs/fsck_ext2fs.8 index fbc3b88a776..bdb5cbc31a6 100644 --- a/sbin/fsck_ext2fs/fsck_ext2fs.8 +++ b/sbin/fsck_ext2fs/fsck_ext2fs.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fsck_ext2fs.8,v 1.3 1997/06/14 04:16:52 downsj Exp $ +.\" $OpenBSD: fsck_ext2fs.8,v 1.4 1998/09/17 04:14:52 aaron Exp $ .\" $NetBSD: fsck_ext2fs.8,v 1.1 1997/06/11 11:21:48 bouyer Exp $ .\" .\" Copyright (c) 1997 Manuel Bouyer. @@ -54,7 +54,7 @@ .Ar filesystem .Ar ... .Sh DESCRIPTION -.Nm Fsck_ext2fs +.Nm fsck_ext2fs performs interactive filesystem consistency checks and repair for each of the filesystems specified on the command line. It is normally invoked from .Xr fsck 8 . @@ -111,17 +111,17 @@ The amount and severity of data lost may be determined from the diagnostic output. The default action for each consistency correction is to wait for the operator to respond -.Li yes +.Dq yes or -.Li no . -If the operator does not have write permission on the filesystem +.Dq no . +If the operator does not have write permission on the filesystem, .Nm fsck_ext2fs will default to a .Fl n action. .Pp The following flags are interpreted by -.Nm fsck_ext2fs . +.Nm fsck_ext2fs : .Bl -tag -width indent .It Fl b Use the block specified immediately after the flag as @@ -133,7 +133,7 @@ Print debugging output. 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 +in the file system superblock and .Nm will not check the file system. This option forces .Nm @@ -147,7 +147,9 @@ In particular, systems that do not wish to have lost files accessible by all users on the system should use a more restrictive set of permissions such as 700. .It Fl n -Assume a no response to all questions asked by +Assume a +.Dq no +response to all questions asked by .Nm fsck_ext2fs except for .Ql CONTINUE? , @@ -156,7 +158,9 @@ do not open the filesystem for writing. .It Fl p Specify ``preen'' mode, described above. .It Fl y -Assume a yes response to all questions asked by +Assume a +.Dq yes +response to all questions asked by .Nm fsck_ext2fs ; this should be used with great caution as this is a free license to continue after essentially unlimited trouble has been encountered. @@ -164,6 +168,7 @@ to continue after essentially unlimited trouble has been encountered. .Pp .Bl -enum -indent indent -compact Inconsistencies checked are as follows: +.Pp .It Blocks claimed by more than one inode or the free map. .It diff --git a/sbin/fsck_ffs/fsck_ffs.8 b/sbin/fsck_ffs/fsck_ffs.8 index 365169d3809..16af05857bb 100644 --- a/sbin/fsck_ffs/fsck_ffs.8 +++ b/sbin/fsck_ffs/fsck_ffs.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fsck_ffs.8,v 1.2 1997/03/27 16:28:52 kstailey Exp $ +.\" $OpenBSD: fsck_ffs.8,v 1.3 1998/09/17 04:14:52 aaron Exp $ .\" $NetBSD: fsck_ffs.8,v 1.12 1996/09/23 16:18:34 christos Exp $ .\" .\" Copyright (c) 1980, 1989, 1991, 1993 @@ -66,8 +66,8 @@ Here reads the table .Pa /etc/fstab to determine which filesystems to check. -Only partitions in fstab that are mounted ``rw,'' ``rq'' or ``ro'' -and that have non-zero pass number are checked. +Only partitions in fstab that are mounted ``rw'', ``rq'' or ``ro'' +and have non-zero pass numbers are checked. Filesystems with pass number 1 (normally just the root filesystem) are checked one at a time. When pass 1 completes, all remaining filesystems are checked, @@ -79,6 +79,7 @@ to be the partition designator. The kernel takes care that only a restricted class of innocuous filesystem inconsistencies can happen unless hardware or software failures intervene. These are limited to the following: +.Pp .Bl -item -compact .It Unreferenced inodes @@ -131,16 +132,16 @@ The amount and severity of data lost may be determined from the diagnostic output. The default action for each consistency correction is to wait for the operator to respond -.Li yes +.Dq yes or -.Li no . -If the operator does not have write permission on the filesystem +.Dq no . +If the operator does not have write permission on the filesystem, .Nm fsck_ffs will default to a .Fl n action. .Pp -.Nm Fsck +.Nm fsck has more consistency checks than its predecessors .Em check , dcheck , fcheck , @@ -155,10 +156,10 @@ The following flags are interpreted by 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 +in the file system superblock and +.Nm fsck_ffs will not check the file system. This option forces -.Nm +.Nm fsck_ffs to check the file system, regardless of the state of the clean flag. .It Fl b Use the block specified immediately after the flag as @@ -173,12 +174,16 @@ In particular, systems that wish to have lost files accessible by all users on the system should use a less restrictive set of permissions such as 755. .It Fl y -Assume a yes response to all questions asked by +Assume a +.Dq yes +response to all questions asked by .Nm fsck_ffs ; this should be used with great caution as this is a free license to continue after essentially unlimited trouble has been encountered. .It Fl n -Assume a no response to all questions asked by +Assume a +.Dq no +response to all questions asked by .Nm fsck_ffs except for .Ql CONTINUE? , @@ -194,13 +199,17 @@ The filesystem is in the old (static table) format. .It 1 The filesystem is in the new (dynamic table) format. .It 2 -The filesystem supports 32-bit uid's and gid's, +The filesystem supports 32-bit UIDs and GIDs, short symbolic links are stored in the inode, and directories have an added field showing the file type. .It 3 -If maxcontig is greater than one, +If +.Va maxcontig +is greater than one, build the free segment maps to aid in finding contiguous sets of blocks. -If maxcontig is equal to one, delete any existing segment maps. +If +.Va maxcontig +is equal to one, delete any existing segment maps. .El .Pp In interactive mode, @@ -227,6 +236,7 @@ the file .Pp .Bl -enum -indent indent -compact Inconsistencies checked are as follows: +.Pp .It Blocks claimed by more than one inode or the free map. .It @@ -284,7 +294,7 @@ the raw device should always be used. .Sh FILES .Bl -tag -width /etc/fstab -compact .It Pa /etc/fstab -contains default list of filesystems to check. +contains default list of filesystems to check .El .Sh DIAGNOSTICS The diagnostics produced by diff --git a/sbin/fsck_msdos/fsck_msdos.8 b/sbin/fsck_msdos/fsck_msdos.8 index 1d8095e61fa..4b45f79ebab 100644 --- a/sbin/fsck_msdos/fsck_msdos.8 +++ b/sbin/fsck_msdos/fsck_msdos.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fsck_msdos.8,v 1.5 1998/01/11 20:40:34 provos Exp $ +.\" $OpenBSD: fsck_msdos.8,v 1.6 1998/09/17 04:14:53 aaron Exp $ .\" $NetBSD: fsck_msdos.8,v 1.4 1996/10/17 20:41:24 cgd Exp $ .\" .\" Copyright (C) 1995 Wolfgang Solfrank @@ -49,7 +49,6 @@ .Ar filesystem .Ar ... .Sh DESCRIPTION -.Pp The .Nm utility verifies and repairs @@ -91,7 +90,9 @@ check other file system types for consistency, such as .It Fl n Causes .Nm -to assume no as the answer to all operator +to assume +.Dq no +as the answer to all operator questions, except .Dq CONTINUE? . .It Fl p @@ -99,12 +100,14 @@ Preen the specified filesystems. .It Fl y Causes .Nm -to assume yes as the answer to all operator questions. +to assume +.Dq yes +as the answer to all operator questions. .El .Sh SEE ALSO .Xr fsck 8 , .Xr fsck_ffs 8 , .Xr mount_msdos 8 .Sh BUGS -.Nm Fsck_msdos +.Nm fsck_msdos is still under construction. diff --git a/sbin/fsdb/fsdb.8 b/sbin/fsdb/fsdb.8 index f140eaecd6e..71a1f235989 100644 --- a/sbin/fsdb/fsdb.8 +++ b/sbin/fsdb/fsdb.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fsdb.8,v 1.6 1997/01/16 04:57:04 millert Exp $ +.\" $OpenBSD: fsdb.8,v 1.7 1998/09/17 04:14:53 aaron Exp $ .\" $NetBSD: fsdb.8,v 1.5 1997/01/11 05:51:40 lukem Exp $ .\" .\" Copyright (c) 1996 The NetBSD Foundation, Inc. @@ -213,13 +213,13 @@ Exit the program. .Xr editline 3 , .Xr fs 5 , .Xr fsck 8 , -.Xr clri 8 . +.Xr clri 8 .Sh BUGS Manipulation of ``short'' symlinks doesn't work (in particular, don't try changing a symlink's type). -.br +.Pp You must specify modes as numbers rather than symbolic names. -.br +.Pp There are a bunch of other things that you might want to do which .Nm doesn't implement. diff --git a/sbin/fsirand/fsirand.8 b/sbin/fsirand/fsirand.8 index 29cffcc774c..179f05aa534 100644 --- a/sbin/fsirand/fsirand.8 +++ b/sbin/fsirand/fsirand.8 @@ -23,7 +23,7 @@ .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: fsirand.8,v 1.11 1998/08/29 21:11:04 deraadt Exp $ +.\" $OpenBSD: fsirand.8,v 1.12 1998/09/17 04:14:53 aaron Exp $ .\" .Dd January 25, 1997 .Dt FSIRAND 8 @@ -57,12 +57,12 @@ run by hand on a new filesystem. It is only used to re-randomize or report on an existing filesystem. .Pp -.Nm Fsirand +.Nm fsirand should only be used on an unmounted filesystem that has been checked with .Xr fsck 8 or a filesystem that is mounted read-only. -.Nm Fsirand +.Nm fsirand may be used on the root filesystem in single-user mode but the system should be rebooted via ``reboot -n'' afterwards. .Sh OPTIONS @@ -84,12 +84,12 @@ generating new ones. Since .Nm allocates enough memory to hold all the inodes in -a given cylinder group it may use a large amount +a given cylinder group, it may use a large amount of memory for large disks with few cylinder groups. .Sh SEE ALSO .Xr fs 5 , .Xr fsck 8 , -.Xr newfs 8 . +.Xr newfs 8 .Sh HISTORY The .Nm diff --git a/sbin/ifconfig/ifconfig.8 b/sbin/ifconfig/ifconfig.8 index 9fd17bc60c8..ae7c28f409d 100644 --- a/sbin/ifconfig/ifconfig.8 +++ b/sbin/ifconfig/ifconfig.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ifconfig.8,v 1.13 1998/09/03 23:08:09 jason Exp $ +.\" $OpenBSD: ifconfig.8,v 1.14 1998/09/17 04:14:53 aaron Exp $ .\" $NetBSD: ifconfig.8,v 1.11 1996/01/04 21:27:29 pk Exp $ .\" $FreeBSD: ifconfig.8,v 1.16 1998/02/01 07:03:29 steve Exp $ .\" @@ -55,7 +55,7 @@ .Nm ifconfig .Fl m .Ar interface -.Op address_family +.Op Ar address_family .Nm ifconfig .Op Fl a | am .Op Ar address_family @@ -63,11 +63,11 @@ .Op Fl A | Am .Op Ar address_family .Sh DESCRIPTION -.Nm Ifconfig +.Nm ifconfig is used to assign an address to a network interface and/or configure network interface parameters. -.Nm Ifconfig +.Nm ifconfig must be used at boot time to define the network address of each interface present on a machine; it may also be used at a later time to redefine an interface's address @@ -319,14 +319,14 @@ the hardware will be re-initialized. .El .Pp .Pp -.Nm Ifconfig +.Nm ifconfig displays the current configuration for a network interface when no optional parameters are supplied. If a protocol family is specified, ifconfig will report only the details specific to that protocol family. .Pp Using -.Fl a , +.Fl a causes .Nm ifconfig to print information on all interfaces. diff --git a/sbin/init/init.8 b/sbin/init/init.8 index f0b75564e89..390d9f7d68d 100644 --- a/sbin/init/init.8 +++ b/sbin/init/init.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: init.8,v 1.9 1998/08/29 21:11:08 deraadt Exp $ +.\" $OpenBSD: init.8,v 1.10 1998/09/17 04:14:53 aaron Exp $ .\" $NetBSD: init.8,v 1.6 1995/03/18 14:56:31 cgd Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -134,7 +134,7 @@ In multi-user operation, maintains processes for the terminal ports found in the file .Xr ttys 5 . -.Nm Init +.Nm init reads this file, and executes the command found in the second field. This command is usually .Xr getty 8 ; @@ -183,7 +183,9 @@ file. When a line is turned off in .Xr ttys , .Nm init -will send a SIGHUP signal to the controlling process +will send a +.Dv SIGHUP +signal to the controlling process for the session associated with the line. For any lines that were previously turned off in the .Xr ttys @@ -209,7 +211,7 @@ file and records in the file is out of sync, so this practice is not recommended. .Pp -.Nm Init +.Nm init will terminate multi-user operations and resume single-user mode if sent a terminate .Pq Dv TERM @@ -217,11 +219,11 @@ signal, for example, .Dq Li "kill \-s TERM 1" . If there are processes outstanding that are deadlocked (because of hardware or software failure), -.Xr init +.Nm init will not wait for them all to die (which might take forever), but will time out after 30 seconds and print a warning message. .Pp -.Nm Init +.Nm init will cease creating new .Xr getty Ns 's and allow the system to slowly die away, if it is sent a terminal stop @@ -240,7 +242,7 @@ The role of is so critical that if it dies, the system will reboot itself automatically. If, at bootstrap time, the -.Xr init +.Nm init process cannot be located, the system will panic with the message ``panic: "init died (signal %d, exit %d)''. .Sh DIAGNOSTICS @@ -262,18 +264,18 @@ a persistent device error condition. .Sh FILES .Bl -tag -width /var/log/wtmp -compact .It Pa /dev/console -System console device. +system console device .It Pa /dev/tty* -Terminal ports found in -.Xr ttys . +terminal ports found in +.Xr ttys .It Pa /var/run/utmp -Record of current users on the system. +record of users currently logged in .It Pa /var/log/wtmp -Record of all logins and logouts. +record of all logins and logouts .It Pa /etc/ttys -The terminal initialization information file. +terminal initialization information file .It Pa /etc/rc -System startup commands. +system startup commands .El .Sh SEE ALSO .Xr login 1 , diff --git a/sbin/kbd/kbd.8 b/sbin/kbd/kbd.8 index 1f7c5f8624f..1a94721d6c8 100644 --- a/sbin/kbd/kbd.8 +++ b/sbin/kbd/kbd.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: kbd.8,v 1.4 1998/06/20 06:49:46 marc Exp $ +.\" $OpenBSD: kbd.8,v 1.5 1998/09/17 04:14:54 aaron Exp $ .\" .\" Copyright (c) 1996 Juergen Hannken-Illjes .\" All rights reserved. @@ -43,7 +43,7 @@ .Op Fl q .Ar name .Sh DESCRIPTION -.Nm Kbd +.Nm kbd is used to change the keyboard encoding. The execution of .Nm kbd @@ -53,18 +53,18 @@ to set a national keyboard layout. .Pp If called as .Nm kbd -.Fl l +.Fl l , all available keyboard encodings are listed. .Pp If called as .Nm kbd -.Ar name +.Ar name , the keyboard encoding will be set to .Ar name and a short message will be printed to stdout. If the .Fl q -flag is present +flag is present, .Nm kbd will be quiet unless an error occurs. .Sh SEE ALSO diff --git a/sbin/modload/modload.8 b/sbin/modload/modload.8 index 84b1d442691..b96c24e23a9 100644 --- a/sbin/modload/modload.8 +++ b/sbin/modload/modload.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: modload.8,v 1.5 1996/10/08 01:20:24 michaels Exp $ +.\" $OpenBSD: modload.8,v 1.6 1998/09/17 04:14:54 aaron Exp $ .\" $NetBSD: modload.8,v 1.5 1995/03/18 14:56:43 cgd Exp $ .\" .\" Copyright (c) 1993 Christopher G. Demetriou @@ -102,8 +102,7 @@ file containing definitions of module types .Sh DIAGNOSTICS The .Nm -utility exits with a status of 0 on success -and with a nonzero status if an error occurs. +utility exits 0 on success or with a non-zero status if an error occurred. .Sh SEE ALSO .Xr ld 1 , .Xr lkm 4 , diff --git a/sbin/modunload/modunload.8 b/sbin/modunload/modunload.8 index cf513cf202e..b2e3d703749 100644 --- a/sbin/modunload/modunload.8 +++ b/sbin/modunload/modunload.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: modunload.8,v 1.4 1996/10/08 01:20:25 michaels Exp $ +.\" $OpenBSD: modunload.8,v 1.5 1998/09/17 04:14:54 aaron Exp $ .\" $NetBSD: modunload.8,v 1.3 1995/03/18 14:56:49 cgd Exp $ .\" .\" Copyright (c) 1993 Christopher G. Demetriou @@ -59,8 +59,7 @@ Unload the module with the name .Sh DIAGNOSTICS The .Nm -utility exits with a status of 0 on success -and with a nonzero status if an error occurs. +utility exits 0 on success or with a non-zero status if an error occurred. .Sh SEE ALSO .Xr lkm 4 , .Xr modload 8 , diff --git a/sbin/mount/getmntopts.3 b/sbin/mount/getmntopts.3 index dc59ffd6430..eec4fa725a1 100644 --- a/sbin/mount/getmntopts.3 +++ b/sbin/mount/getmntopts.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getmntopts.3,v 1.2 1996/06/23 14:31:09 deraadt Exp $ +.\" $OpenBSD: getmntopts.3,v 1.3 1998/09/17 04:14:54 aaron Exp $ .\" $NetBSD: getmntopts.3,v 1.2 1995/03/18 14:56:56 cgd Exp $ .\" .\" Copyright (c) 1994 @@ -46,22 +46,22 @@ .Fn getmntopts "char *options" "struct mntopt *mopts" "int *flagp" .Sh DESCRIPTION The -.Nm getmntopts +.Fn getmntopts function takes a comma separated option list and a list of valid option names, and computes the bitmask corresponding to the requested set of options. .Pp The string -.Dv options +.Ar options is broken down into a sequence of comma separated tokens. Each token is looked up in the table described by -.Dv mopts +.Ar mopts and the bits in the word referenced by -.Dv flagp +.Ar flagp are updated. The flag word is not initialized by -.Nm getmntopt . +.Fn getmntopts . The table, .Dv mopts , has the following format: @@ -80,8 +80,8 @@ the option name, for example .Dq suid . .It Fa m_inverse -tells -.Nm getmntopts +Tells +.Fn getmntopts that the name has the inverse meaning of the bit. For example, @@ -94,7 +94,7 @@ are inverted, so the .Dv m_inverse flag should be set. .It Fa m_flag -the value of the bit to be set or cleared in +The value of the bit to be set or cleared in the flag word when the option is recognized. The bit is set when the option is discovered, but cleared if the option name was preceded @@ -153,7 +153,7 @@ struct mntopt mopts[] = { .Ed .Sh DIAGNOSTICS The -.Nm getmntopts +.Fn getmntopts function displays an error message and exits if an unrecognized option is encountered. .Sh SEE ALSO diff --git a/sbin/mount/mount.8 b/sbin/mount/mount.8 index f7febcb46af..75c0a9aae86 100644 --- a/sbin/mount/mount.8 +++ b/sbin/mount/mount.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mount.8,v 1.8 1998/09/06 20:21:27 niklas Exp $ +.\" $OpenBSD: mount.8,v 1.9 1998/09/17 04:14:54 aaron Exp $ .\" $NetBSD: mount.8,v 1.11 1995/07/12 06:23:21 cgd Exp $ .\" .\" Copyright (c) 1980, 1989, 1991, 1993 @@ -91,7 +91,7 @@ flag, except that if a file system (other than the root file system) appears to be already mounted, .Nm mount will not try to mount it again. -.Nm Mount +.Nm mount assumes that a file system is already mounted if a file system with the same type is mounted on the given mount point. More stringent checks are not possible because some file system types @@ -175,7 +175,9 @@ distinguished by a leading .Dq \&- (dash). Options that take a value are specified using the syntax -option=value. -For example, the mount command: +For example, the +.Nm mount +command: .Bd -literal -offset indent mount -t mfs -o nosuid,-N,-s=4000 /dev/dk0b /tmp .Ed @@ -201,7 +203,9 @@ is used to indicate the file system type. The type .Ar ffs is the default. -The \fI-t\fP option can be used +The +.Fl t +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. @@ -222,7 +226,7 @@ mounts all filesystems except those of type and .Tn MFS . .Pp -.Nm Mount +.Nm mount will attempt to execute a program in .Pa /sbin/mount_ Ns Em XXX where @@ -266,7 +270,7 @@ The file system object is to be read and write. The options specific to the various file system types are described in the manual pages for those file systems' .Nm mount_XXX -commands. For instance the options specific to Berkeley +commands. For instance, the options specific to Berkekely Fast File Systems are described in the .Xr mount_ffs 8 manual page. diff --git a/sbin/mount_ados/mount_ados.8 b/sbin/mount_ados/mount_ados.8 index 2b4effa552f..dfdee3c565e 100644 --- a/sbin/mount_ados/mount_ados.8 +++ b/sbin/mount_ados/mount_ados.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mount_ados.8,v 1.3 1996/10/08 01:20:26 michaels Exp $ +.\" $OpenBSD: mount_ados.8,v 1.4 1998/09/17 04:14:54 aaron Exp $ .\" $NetBSD: mount_ados.8,v 1.3 1995/03/18 14:57:09 cgd Exp $ .\" .\" Copyright (c) 1993,1994 Christopher G. Demetriou @@ -41,17 +41,17 @@ .Op Fl u Ar uid .Op Fl g Ar gid .Op Fl m Ar mask -.Pa special -.Pa node +.Ar special +.Ar node .Sh DESCRIPTION The .Nm mount_ados command attaches the AmigaDOS filesystem residing on the device -.Pa special +.Ar special to the global filesystem namespace at the location indicated by -.Pa node . +.Ar node . This command is normally executed by .Xr mount 8 at boot time, but can be used by any user to mount an diff --git a/sbin/mount_cd9660/mount_cd9660.8 b/sbin/mount_cd9660/mount_cd9660.8 index 09f6837d211..131f23d312e 100644 --- a/sbin/mount_cd9660/mount_cd9660.8 +++ b/sbin/mount_cd9660/mount_cd9660.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mount_cd9660.8,v 1.4 1998/06/15 17:55:40 mickey Exp $ +.\" $OpenBSD: mount_cd9660.8,v 1.5 1998/09/17 04:14:55 aaron Exp $ .\" $NetBSD: mount_cd9660.8,v 1.3 1995/04/23 10:33:13 cgd Exp $ .\" .\" Copyright (c) 1993, 1994 @@ -47,14 +47,14 @@ .Nm mount_cd9660 .Op Fl egR .Op Fl o Ar options -.Ar special | node +.Ar special node .Sh DESCRIPTION The .Nm mount_cd9660 command attaches the ISO-9660 filesystem residing on the device -.Pa special +.Ar special to the global filesystem namespace at the location indicated by -.Pa node . +.Ar node . This command is normally executed by .Xr mount 8 at boot time. diff --git a/sbin/mount_kernfs/mount_kernfs.8 b/sbin/mount_kernfs/mount_kernfs.8 index 8950506f90d..8a5a883c61a 100644 --- a/sbin/mount_kernfs/mount_kernfs.8 +++ b/sbin/mount_kernfs/mount_kernfs.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mount_kernfs.8,v 1.4 1998/06/15 17:55:43 mickey Exp $ +.\" $OpenBSD: mount_kernfs.8,v 1.5 1998/09/17 04:14:55 aaron Exp $ .\" $NetBSD: mount_kernfs.8,v 1.6 1995/03/18 14:57:24 cgd Exp $ .\" .\" Copyright (c) 1992, 1993, 1994 @@ -79,48 +79,48 @@ man page for possible options and their meanings. .Sh FILES .Bl -tag -width copyright -compact .It Pa boottime -the time at which the system was last booted (decimal ASCII). +Time at which the system was last booted (decimal ASCII). .It Pa byteorder -the _BYTE_ORDER for this kernel. +_BYTE_ORDER for this kernel. .It Pa copyright -kernel copyright message. +Kernel copyright message. .It Pa hostname -the hostname, with a trailing newline. +The hostname, with a trailing newline. The hostname can be changed by writing to this file. A trailing newline will be stripped from the hostname being written. .It Pa domainname -the domainname, with a trailing newline, behaves like a hostname. +The domainname, with a trailing newline. Behaves like a hostname. .It Pa hz -the frequency of the system clock (decimal ASCII). +Frequency of the system clock (decimal ASCII). .It Pa loadavg -the 1, 5 and 15 minute load average in kernel fixed-point format. +The 1, 5 and 15 minute load average in kernel fixed-point format. The final integer is the fix-point scaling factor. All numbers are in decimal ASCII. .It Pa machine -the architecture this kernel compiled for. +Architecture this kernel compiled for. .It Pa model -the model of the processor this machine running on. +Model of the processor this machine running on. .It Pa msgbuf -the kernel message buffer, also read by +Kernel message buffer, also read by .Xr syslogd 8 , through the .Pa log device, and by .Xr dmesg 8 . .It Pa ncpu -the number of CPUs in this machine. +Number of CPUs in this machine. .It Pa ostype -the OS type for this kernel ("OpenBSD"). +OS type for this kernel ("OpenBSD"). .It Pa osrelease -the release number of the OS. +OS release number. .It Pa osrev -the revision number of the OS (BSD from <sys/param.h>). +OS revision number (BSD from <sys/param.h>). .It Pa pagesize -the machine pagesize (decimal ASCII). +Machine pagesize (decimal ASCII). .It Pa posix -the _POSIX_VERSION for this kernel. +_POSIX_VERSION for this kernel. .It Pa physmem -the number of pages of physical memory in the machine (decimal ASCII). +Number of pages of physical memory in the machine (decimal ASCII). .\" .It Pa root .\" the system root directory. .\" In a chroot'ed environment, @@ -131,20 +131,20 @@ the number of pages of physical memory in the machine (decimal ASCII). .\" .Pa /kern/root .\" will then refer to the system global root, not the current process root. .It Pa rootdev -the root device. +Root device. .It Pa rrootdev -the raw root device. +Raw root device. .It Pa time -the second and microsecond value of the system clock. +Second and microsecond value of the system clock. Both numbers are in decimal ASCII. .It Pa usermem -the number of pages of physical memory available for user processes. +Number of pages of physical memory available for user processes. .It Pa version -the kernel version string. +Kernel version string. The head line for .Pa /etc/motd can be generated by running: -.Dq Ic "sed 1q /kern/version" +.Dq Ic "sed 1q /kern/version" . .El .Sh SEE ALSO .Xr mount 2 , diff --git a/sbin/mount_msdos/mount_msdos.8 b/sbin/mount_msdos/mount_msdos.8 index 266bd2ab326..f73c17a14c7 100644 --- a/sbin/mount_msdos/mount_msdos.8 +++ b/sbin/mount_msdos/mount_msdos.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mount_msdos.8,v 1.5 1996/10/08 01:20:27 michaels Exp $ +.\" $OpenBSD: mount_msdos.8,v 1.6 1998/09/17 04:14:55 aaron Exp $ .\" $NetBSD: mount_msdos.8,v 1.10 1996/01/19 21:14:43 leo Exp $ .\" .\" Copyright (c) 1993,1994 Christopher G. Demetriou @@ -45,17 +45,17 @@ .Op Fl l .Op Fl 9 .Op Fl G -.Pa special -.Pa node +.Ar special +.Ar node .Sh DESCRIPTION The .Nm mount_msdos command attaches the MS-DOS filesystem residing on the device -.Pa special +.Ar special to the global filesystem namespace at the location indicated by -.Pa node . +.Ar node . This command is normally executed by .Xr mount 8 at boot time, but can be used by any user to mount an @@ -98,10 +98,10 @@ The default mask is taken from the directory on which the file system is being mounted. .It Fl s Force behaviour to -ignore and not generate Win'95 long filenames. +ignore and not generate Windows 95/98 long filenames. .It Fl l Force listing and generation of -Win'95 long filenames +Windows 95/98 long filenames and separate creation/modification/access dates. .Pp If neither @@ -111,14 +111,14 @@ nor are given, .Nm mount_msdos searches the root directory of the filesystem to -be mounted for any existing Win'95 long filenames. +be mounted for any existing Windows 95/98 long filenames. If no such entries are found, .Fl s is the default. Otherwise .Fl l is assumed. .It Fl 9 -Ignore the special Win'95 directory entries even +Ignore the special Windows 95/98 directory entries even if deleting or renaming a file. This forces .Fl s . .It Fl G @@ -137,7 +137,7 @@ The use of the .Fl 9 flag could result in damaged filesystems, albeit the damage is in part taken care of by -procedures similar to the ones used in Win'95. +procedures similar to the ones used in Windows 95/98. .Pp The default handling for .Fl s @@ -148,14 +148,19 @@ with short filenames only. To generate long filenames on empty DOS filesystems use .Fl l . .Pp -Note that Win'95 handles only access dates, +Note that Windows 95/98 handles only access dates, but not access times. +.Pp +Also note that +.Nm mount_msdos +will only handle FAT16 filesystems. FAT32 filesystems, as +provided by Windows 95 (OSR2) and Windows 98, are not supported. .Sh HISTORY The .Nm mount_msdos utility first appeared in NetBSD 0.9. Its predecessor, the .Nm mount_pcfs -utility appeared in NetBSD 0.8, and was abandoned in favor +utility, appeared in NetBSD 0.8, and was abandoned in favor of the more aptly-named .Nm mount_msdos . diff --git a/sbin/mount_nfs/mount_nfs.8 b/sbin/mount_nfs/mount_nfs.8 index 17aafecb99c..7001cf53943 100644 --- a/sbin/mount_nfs/mount_nfs.8 +++ b/sbin/mount_nfs/mount_nfs.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mount_nfs.8,v 1.8 1998/08/30 22:45:14 deraadt Exp $ +.\" $OpenBSD: mount_nfs.8,v 1.9 1998/09/17 04:14:55 aaron Exp $ .\" $NetBSD: mount_nfs.8,v 1.3 1996/02/18 11:59:10 fvdl Exp $ .\" .\" Copyright (c) 1992, 1993, 1994, 1995 @@ -78,7 +78,7 @@ Use the NFS Version 2 protocol. .It Fl 3 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 +.It Fl D Ar deadthresh Used with NQNFS to set the .Dq "dead server threshold" to the specified number of round trip timeout intervals. @@ -91,7 +91,7 @@ Values may be set in the range of 1 - 9, with 9 referring to an (i.e. never assume cached data still valid). This option is not generally recommended and is really an experimental feature. -.It Fl I +.It Fl I Ar readdirsize Set the readdir read size to the specified value. The value should normally be a multiple of DIRBLKSIZ that is <= the read size for the mount. .It Fl K @@ -101,7 +101,7 @@ This requires that the kernel be built with the NFSKERB option. (Refer to the INTERNET-DRAFT titled .%T "Authentication Mechanisms for ONC RPC" , for more information.) -.It Fl L +.It Fl L Ar leaseterm 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. @@ -109,7 +109,7 @@ Values are normally in the 10-30 second range. The kernel always uses a reserved port number to communicate with clients. This option is ignored, and exists solely for compatibility with older systems. -.It Fl R +.It Fl R Ar retrycnt Set the retry count for doing the mount to the specified value. .It Fl T Use TCP transport instead of UDP. @@ -119,7 +119,7 @@ the client. .It Fl U Force the mount protocol to use UDP transport, even for TCP NFS mounts. (Necessary for some old BSD servers.) -.It Fl a +.It Fl a Ar maxreadahead Set the read-ahead count to the specified value. This may be in the range of 0 - 4, and determines how many blocks will be read ahead when a large file is being read sequentially. @@ -143,7 +143,7 @@ Turn off the dynamic retransmit timeout estimator. This may be useful for UDP mounts that exhibit high retry rates, since it is possible that the dynamically estimated timeout interval is too short. -.It Fl g +.It Fl g Ar maxgroups Set the maximum size of the group list for the credentials to the specified value. This should be used for mounts on old servers that cannot handle a @@ -163,12 +163,12 @@ 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. -.It Fl m +.It Fl m Ar realm Set the Kerberos realm to the string argument. Used with the .Fl K option for mounts to other realms. -.It Fl o +.It Fl o Ar options Options are specified with a .Fl o flag followed by a comma separated string of options. @@ -191,7 +191,7 @@ that was part of the first release of 4.4BSD-Lite. To interoperate with a first release 4.4BSD-Lite NFS system you will have to avoid this option until you have had an oppurtunity to upgrade the NFS code to release 2 of 4.4BSD-Lite on all your systems. -.It Fl r +.It Fl r Ar readsize Set the read data size to the specified value. It should normally be a power of 2 greater than or equal to 1024. This should be used for UDP mounts when the @@ -210,7 +210,7 @@ option as well. .It Fl s A soft mount, which implies that file system calls will fail after \fBRetry\fR round trip timeout intervals. -.It Fl t +.It Fl t Ar timeout Set the initial retransmit timeout to the specified value. May be useful for fine tuning UDP mounts over internetworks with high packet loss rates or an overloaded server. @@ -218,10 +218,12 @@ Try increasing the interval if .Xr nfsstat 1 shows high retransmit rates while the file system is active or reducing the value if there is a low retransmit rate but long response delay observed. -(Normally, the -d option should be specified when using this option to manually +(Normally, the +.Fl d +option should be specified when using this option to manually tune the timeout interval.) -.It Fl w +.It Fl w Ar writesize Set the write data size to the specified value. Ditto the comments w.r.t. the .Fl r @@ -234,7 +236,7 @@ and .Fl w options should only be used as a last ditch effort at improving performance when mounting servers that do not support TCP mounts. -.It Fl x +.It Fl x Ar retrans Set the retransmit timeout count for soft mounts to the specified value. .El .Sh SEE ALSO diff --git a/sbin/mount_null/mount_null.8 b/sbin/mount_null/mount_null.8 index d1fb5661233..0210ab4fdaf 100644 --- a/sbin/mount_null/mount_null.8 +++ b/sbin/mount_null/mount_null.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mount_null.8,v 1.4 1998/06/15 17:55:47 mickey Exp $ +.\" $OpenBSD: mount_null.8,v 1.5 1998/09/17 04:14:55 aaron Exp $ .\" $NetBSD: mount_null.8,v 1.4 1996/04/10 20:57:19 thorpej Exp $ .\" .\" Copyright (c) 1992, 1993, 1994 @@ -47,13 +47,13 @@ .Nm mount_null .Op Fl o Ar options .Ar target -.Ar mount-point +.Ar mount_point .Sh DESCRIPTION The .Nm mount_null command creates a null layer, duplicating a sub-tree of the file system -name space under another part of the global file system namespace. +namespace under another part of the global file system namespace. It is implemented using a stackable layers technique, and its .Do null-nodes @@ -86,9 +86,9 @@ for constructing new layers. .\" .Sh INSTANTIATING NEW NULL LAYERS New null layers are created with -.Xr mount_null 8 . -.Xr Mount_null 8 -takes two arguments, the pathname +.Nm mount_null . +.Nm mount_null +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 @@ -99,11 +99,11 @@ of target-pn subtree will be aliased under mount-point-pn. The null layer is the minimum file system layer, simply bypassing all possible operations to the lower layer for processing there. The majority of its activity centers -on the bypass routine, though which nearly all vnode operations +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 examing vnode +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 @@ -117,12 +117,14 @@ Although bypass handles most operations, and .Em vop_print are not bypassed. -.Em Vop_getattr +.Em vop_getattr must change the fsid being returned. -.Em Vop_inactive -and vop_reclaim are not bypassed so that +.Em vop_inactive +and +.Em vop_reclaim +are not bypassed so that they can handle freeing null-layer specific data. -.Em Vop_print +.Em vop_print is not bypassed to avoid excessive debugging information. .\" @@ -146,13 +148,16 @@ For example, imagine mounting a null layer with .Bd -literal -offset indent mount_null /usr/include /dev/layer/null .Ed +.Pp Changing directory to .Pa /dev/layer/null 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 +A +.Em 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 @@ -170,7 +175,9 @@ process when constructing other vnode stacks. .Sh CREATING OTHER FILE SYSTEM LAYERS One of the easiest ways to construct new file system layers is to make a copy of the null layer, rename all files and variables, and -then begin modifyng the copy. Sed can be used to easily rename +then begin modifyng the copy. +.Xr sed 1 +can be used to easily rename all variables. .Pp The umap layer is an example of a layer descended from the diff --git a/sbin/mount_portal/mount_portal.8 b/sbin/mount_portal/mount_portal.8 index 1a8e022f874..38d81bea9db 100644 --- a/sbin/mount_portal/mount_portal.8 +++ b/sbin/mount_portal/mount_portal.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mount_portal.8,v 1.4 1998/07/16 16:52:11 mickey Exp $ +.\" $OpenBSD: mount_portal.8,v 1.5 1998/09/17 04:14:56 aaron Exp $ .\" $NetBSD: mount_portal.8,v 1.6 1995/08/18 15:01:19 pk Exp $ .\" .\" Copyright (c) 1993, 1994 @@ -84,7 +84,9 @@ The portal daemon works by being passed the full pathname of the object being opened. The daemon creates an appropriate descriptor according to the rules in the configuration file, and then passes the descriptor back -to the calling process as the result of the open system call. +to the calling process as the result of the +.Fn open +system call. .Sh NAMESPACE By convention, the portal daemon divides the namespace into sub-namespaces, each of which handles objects of a particular type. diff --git a/sbin/mount_procfs/mount_procfs.8 b/sbin/mount_procfs/mount_procfs.8 index 1b142bfe7b1..775af784a3c 100644 --- a/sbin/mount_procfs/mount_procfs.8 +++ b/sbin/mount_procfs/mount_procfs.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mount_procfs.8,v 1.5 1998/06/15 17:55:49 mickey Exp $ +.\" $OpenBSD: mount_procfs.8,v 1.6 1998/09/17 04:14:56 aaron Exp $ .\" $NetBSD: mount_procfs.8,v 1.6 1995/03/18 14:58:10 cgd Exp $ .\" .\" Copyright (c) 1992, 1993 @@ -74,7 +74,7 @@ man page for possible options and their meanings. The root of the process filesystem contains an entry for each active process. These processes are visible as a directory whose -name is the process' pid. +name is the process's PID. In addition, the special entry .Pa curproc references the current process. @@ -82,28 +82,29 @@ references the current process. Each directory contains several files. .Bl -tag -width status .It Pa ctl -a writeonly file which supports a variety +A write-only file which supports a variety of control operations. Control commands are written as strings to the .Pa ctl file. The control commands are: +.Pp .Bl -tag -width detach -compact .It attach -stops the target process and arranges for the sending +Stops the target process and arranges for the sending process to become the debug control process. .It detach -continue execution of the target process and -remove it from control by the debug process (which +Continues execution of the target process and +removes it from control by the debug process (which need not be the sending process). .It run -continue running the target process until +Continues running the target process until a signal is delivered, a breakpoint is hit, or the target process exits. .It step -single step the target process, with no signal delivery. +Single steps the target process, with no signal delivery. .It wait -wait for the target process to come to a steady +Waits for the target process to come to a steady state ready for debugging. The target process must be in this state before any of the other commands are allowed. @@ -118,7 +119,7 @@ in which case that signal is delivered to the process .Xr sigaction 2 ). .It Pa file A reference to the vnode from which the process text was read. -This can be used to gain access to the process' symbol table, +This can be used to gain access to the process's symbol table, or to start another copy of the process. .It Pa mem The complete virtual memory image of the process. @@ -130,7 +131,7 @@ Not implemented. .It Pa notepg Not implemented. .It Pa regs -Allows read and write access to the process' register set. +Allows read and write access to the process's register set. This file contains a binary data structure .Dv "struct regs" defined in @@ -147,49 +148,49 @@ is only implemented on machines which have distinct general purpose and floating point register sets. .It Pa status The process status. -This file is readonly and returns a single line containing +This file is read-only and returns a single line containing multiple space-separated fields as follows: .Pp .Bl -bullet -compact .It -command name +Command name. .It -process id +Process ID. .It -parent process id +Parent process ID. .It -process group id +Process group ID. .It -session id +Session ID. .It .Ar major,minor of the controlling terminal, or .Dv -1,-1 if there is no controlling terminal. .It -a list of process flags: +List of process flags: .Dv ctty if there is a controlling terminal, .Dv sldr -if the process is a session leader, +if the process is a session leader, or .Dv noflags if neither of the other two flags are set. .It -the process start time in seconds and microseconds, +Process start time in seconds and microseconds, comma separated. .It -the user time in seconds and microseconds, +User time in seconds and microseconds, comma separated. .It -the system time in seconds and microseconds, +System time in seconds and microseconds, comma separated. .It -the wait channel message +Wait channel message. .It -the process credentials consisting of -the effective user id +Process credentials consisting of +the effective user ID and the list of groups (whose first member -is the effective group id) +is the effective group ID), all comma separated. .El .El diff --git a/sbin/mount_umap/mount_umap.8 b/sbin/mount_umap/mount_umap.8 index dccfe32fda2..90e9bb6e7c1 100644 --- a/sbin/mount_umap/mount_umap.8 +++ b/sbin/mount_umap/mount_umap.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mount_umap.8,v 1.5 1998/06/15 17:55:50 mickey Exp $ +.\" $OpenBSD: mount_umap.8,v 1.6 1998/09/17 04:14:56 aaron Exp $ .\" $NetBSD: mount_umap.8,v 1.4 1996/03/05 02:36:42 thorpej Exp $ .\" .\" Copyright (c) 1992, 1993, 1994 @@ -52,12 +52,12 @@ -g .Ar gid-mapfile .Ar target -.Ar mount-point +.Ar mount_point .Sh DESCRIPTION The .Nm mount_umap -command is used to mount a sub-tree of an existing file system -that uses a different set of uids and gids than the local system. +command is used to mount a subtree of an existing file system +that uses a different set of UIDs and GIDs than the local system. Such a file system could be mounted from a remote site via NFS or it could be a file system on removable media brought from some foreign location that uses a different password file. @@ -76,19 +76,19 @@ man page for possible options and their meanings. The .Nm mount_umap 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 +between UIDs and GIDs in the subtree'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 .Nm mount_umap 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 -they are actually owned by uid 2000. +mapped in such a way that all files with owner UID 1000 look like +they are actually owned by UID 2000. .Pp .Em target -should be the current location of the sub-tree in the +should be the current location of the subtree in the local system's name space. -.Em mount-point +.Ar mount_point should be a directory where the mapped subtree is to be placed. .Em uid-mapfile @@ -97,27 +97,27 @@ and describe the mappings to be made between identifiers. Briefly, the format of these files is a count of the number of mappings on the first line, with each subsequent line containing -a single mapping. Each of these mappings consists of an id from -the original environment and the corresponding id in the local environment, +a single mapping. Each of these mappings consists of an ID from +the original environment and the corresponding ID in the local environment, separated by white space. .Em uid-mapfile -should contain all uid +should contain all UID mappings, and .Em gid-mapfile -should contain all gid mappings. -Any uids not mapped in +should contain all GID mappings. +Any UIDs not mapped in .Em uid-mapfile will be treated as user NOBODY, -and any gids not mapped in +and any GIDs not mapped in .Em gid-mapfile will be treated as group -NULLGROUP. At most 64 uids can be mapped for a given subtree, and +NULLGROUP. At most 64 UIDs can be mapped for a given subtree, and at most 16 groups can be mapped by a given subtree. .Pp 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 mount_umap -will refuse to map the sub-tree if the ownership or permissions on +will refuse to map the subtree if the ownership or permissions on these files are improper. It will also balk if the count of mappings in the first line of the map files is not correct. .Pp diff --git a/sbin/mount_union/mount_union.8 b/sbin/mount_union/mount_union.8 index 3f9ad2c6f1f..179c767a75f 100644 --- a/sbin/mount_union/mount_union.8 +++ b/sbin/mount_union/mount_union.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mount_union.8,v 1.3 1996/06/23 14:31:42 deraadt Exp $ +.\" $OpenBSD: mount_union.8,v 1.4 1998/09/17 04:14:56 aaron Exp $ .\" $NetBSD: mount_union.8,v 1.4 1995/09/29 06:44:02 jtc Exp $ .\" .\" Copyright (c) 1994 @@ -189,7 +189,7 @@ Without whiteout support from the filesystem backing the upper layer, there is no way that delete and rename operations on lower layer objects can be done. .Dv EROFS -is returned for this kind of operations along with any others +is returned for these kind of operations along with any others which would make modifications to the lower layer, such as .Xr chmod 1 . .Pp diff --git a/sbin/mountd/exports.5 b/sbin/mountd/exports.5 index 607aec32414..18c8f1992e6 100644 --- a/sbin/mountd/exports.5 +++ b/sbin/mountd/exports.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: exports.5,v 1.4 1998/07/20 17:04:52 deraadt Exp $ +.\" $OpenBSD: exports.5,v 1.5 1998/09/17 04:14:56 aaron Exp $ .\" $NetBSD: exports.5,v 1.9 1996/02/18 11:57:50 fvdl Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 @@ -86,7 +86,7 @@ different sets of hosts and export options. The second component of a line specifies how the filesystem is to be exported to the host set. The option flags specify whether the filesystem -is exported read-only or read-write and how the client uid is mapped to +is exported read-only or read-write and how the client UID is mapped to user credentials on the server. .Pp Export options are specified as follows: @@ -116,7 +116,7 @@ or .Sm off .Fl mapall No = Sy user:group1:group2:... .Sm on -specifies a mapping for all client uids (including root) +Specifies a mapping for all client UIDs (including root) using the same semantics as .Fl maproot . .Pp @@ -209,9 +209,11 @@ local filesystem mount points, the above example specifies the following: .Sy /usr is exported to hosts .Em friends -where friends is specified in the netgroup file +where +.Em friends +is specified in the netgroup file with users mapped to their remote credentials and -root mapped to uid 0 and group 10. +root mapped to UID 0 and GID 10. It is exported read-write and the hosts in ``friends'' can mount either /usr or /usr/local. It is exported to @@ -226,13 +228,13 @@ all users mapped to the user and groups associated with ``nobody''. .Sy /u is exported to all hosts on the subnetwork .Em 131.104.48 -with root mapped to the uid for ``bin'' and with no group access. +with root mapped to the UID for ``bin'' and with no group access. .Pp .Sy /u2 -is exported to the hosts in ``friends'' with root mapped to uid and groups +is exported to the hosts in ``friends'' with root mapped to UID and groups associated with ``root''; it is exported to all hosts on network ``cis-net'' allowing mounts at any -directory within /u2 and mapping all uids to credentials for the principal +directory within /u2 and mapping all UIDs to credentials for the principal that is authenticated by a Kerberos ticket. .Sh FILES .Bl -tag -width /etc/exports -compact diff --git a/sbin/mountd/mountd.8 b/sbin/mountd/mountd.8 index c5a6a1d24d4..5ae56a2c233 100644 --- a/sbin/mountd/mountd.8 +++ b/sbin/mountd/mountd.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mountd.8,v 1.9 1998/09/13 03:50:23 aaron Exp $ +.\" $OpenBSD: mountd.8,v 1.10 1998/09/17 04:14:56 aaron Exp $ .\" $NetBSD: mountd.8,v 1.11 1996/02/18 11:57:51 fvdl Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 @@ -47,11 +47,11 @@ mount requests .Op Fl dn .Op Ar exportsfile .Sh DESCRIPTION -.Nm Mountd +.Nm mountd is the server for .Tn NFS mount requests from other client machines. -.Nm Mountd +.Nm mountd listens for service requests at the port indicated in the .Tn NFS server specification; see @@ -65,13 +65,13 @@ Options and operands available for .Bl -tag -width Ds .It Fl d Enable debugging mode. -.Nm Mountd +.Nm mountd will not detach from the controlling terminal and will print debugging messages to stderr. .It Fl n Do not require that clients make mount requests from reserved ports. (Normally, only mount requests from reserved ports are accepted.) -This option should only be specified if there are clients, such as PC's, +This option should only be specified if there are clients, such as PCs, that need it. The use of .Fl n @@ -83,24 +83,32 @@ argument specifies an alternate location for the exports file. .El .Pp -When mountd is started, +When +.Nm mountd +is started, it loads the export host addresses and options into the kernel using the .Xr mount 2 system call. After changing the exports file, -a hangup signal should be sent to the mountd daemon +a hangup signal should be sent to the +.Nm mountd +daemon to get it to reload the export information. -After sending the SIGHUP +After sending the +.Dv SIGHUP (kill \-HUP `cat /var/run/mountd.pid`), -check the syslog output to see if mountd logged any parsing +check the syslog output to see if +.Nm mountd +logged any parsing errors in the exports file. .Sh FILES .Bl -tag -width /var/run/mountd.pid -compact .It Pa /etc/exports -the list of exported filesystems +list of exported filesystems .It Pa /var/run/mountd.pid -the pid of the currently running mountd +PID of the currently running +.Nm mountd .El .Sh SEE ALSO .Xr nfsstat 1 , diff --git a/sbin/ncheck_ffs/ncheck_ffs.8 b/sbin/ncheck_ffs/ncheck_ffs.8 index 70bbbc06722..d568e24db3e 100644 --- a/sbin/ncheck_ffs/ncheck_ffs.8 +++ b/sbin/ncheck_ffs/ncheck_ffs.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ncheck_ffs.8,v 1.2 1996/06/30 04:43:33 tholo Exp $ +.\" $OpenBSD: ncheck_ffs.8,v 1.3 1998/09/17 04:14:57 aaron Exp $ .\" .\" Copyright (c) 1995, 1996 SigmaSoft, Th. Lockert <tholo@sigmasoft.com> .\" All rights reserved. @@ -42,7 +42,7 @@ .Sh DESCRIPTION .Nm ncheck_ffs generates a list of filenames and inode numbers for the given -file system. Names of directories are followed by a `.' +file system. Names of directories are followed by a `.'. .Pp The report is not sorted. .Pp diff --git a/sbin/newfs/newfs.8 b/sbin/newfs/newfs.8 index 14f16d724ba..926f3dfe485 100644 --- a/sbin/newfs/newfs.8 +++ b/sbin/newfs/newfs.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: newfs.8,v 1.8 1998/08/30 22:45:12 deraadt Exp $ +.\" $OpenBSD: newfs.8,v 1.9 1998/09/17 04:14:57 aaron Exp $ .\" $NetBSD: newfs.8,v 1.12 1995/03/18 14:58:41 cgd Exp $ .\" .\" Copyright (c) 1983, 1987, 1991, 1993, 1994 @@ -45,7 +45,7 @@ .Nm newfs .Op Fl NO .Op Fl S Ar sector-size -.Op Fl a maxcontig +.Op Fl a Ar maxcontig .Op Fl b Ar block-size .Op Fl c Ar cylinders .Op Fl d Ar rotdelay @@ -67,7 +67,7 @@ .Ar special .Nm mount_mfs .Op Fl N -.Op Fl a maxcontig +.Op Fl a Ar maxcontig .Op Fl b Ar block-size .Op Fl c Ar cylinders .Op Fl d Ar rotdelay @@ -79,7 +79,7 @@ .Op Fl s Ar size .Ar special node .Sh DESCRIPTION -.Nm Newfs +.Nm newfs replaces the more obtuse .Xr mkfs 8 program. @@ -89,17 +89,19 @@ or .Nm mount_mfs , the disk must be labeled using .Xr disklabel 8 . -.Nm Newfs -builds a file system on the specified special device +.Nm newfs +builds a file system on the specified +.Ar special +device, basing its defaults on the information in the disk label. Typically the defaults are reasonable, however .Nm newfs has numerous options to allow the defaults to be selectively overridden. .Pp -.Nm Mount_mfs +.Nm mount_mfs is used to build a file system in virtual memory and then mount it on a specified node. -.Nm Mount_mfs +.Nm mount_mfs exits and the contents of the file system are lost when the file system is unmounted. If @@ -134,7 +136,7 @@ built-in so it is not necessary to run manually unless you wish to re-randomize the filesystem (or list the inode generation numbers). .Pp -The following options define the general layout policies. +The following options define the general layout policies: .Bl -tag -width Fl .It Fl N Causes the file system parameters to be printed out @@ -194,7 +196,7 @@ The number of distinct rotational positions. The default is 1. .Pq ``space'' or ``time'' The file system can either be instructed to try to minimize the time spent allocating blocks, or to try to minimize the space fragmentation on the disk. -Unless an optimizations has been specified, if the value of minfree +Unless an optimization has been specified, if the value of minfree (see above) is less than 5%, the default is to optimize for space; if the value of minfree is greater than or equal to 5%, the default is to optimize for time. @@ -214,7 +216,7 @@ different type of disk than the one on which it is initially created (for example on a write-once disk). Note that changing any of these values from their defaults will make it impossible for -.Xr fsck +.Xr fsck 8 to find the alternate superblocks if the standard superblock is lost. .Bl -tag -width Fl .It Fl S Ar sector-size diff --git a/sbin/newfs_msdos/newfs_msdos.8 b/sbin/newfs_msdos/newfs_msdos.8 index fa493dd0227..75bcf1fba6f 100644 --- a/sbin/newfs_msdos/newfs_msdos.8 +++ b/sbin/newfs_msdos/newfs_msdos.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: newfs_msdos.8,v 1.4 1997/01/10 19:04:09 kstailey Exp $ +.\" $OpenBSD: newfs_msdos.8,v 1.5 1998/09/17 04:14:57 aaron Exp $ .\" .\" Copyright (c) 1995, 1996 Joerg Wunsch .\" @@ -43,11 +43,11 @@ establishes a file system structure on .Ar device that is understood by -.Xr mount_msdos -and some ancient program loader. -.Ar Device +.Xr mount_msdos 8 +and some ancient program loaders. +.Ar device will typically be the character device node for a floppy disk drive, -.Pq e.\ g. Pa /dev/rfd0 , +.Pq e.g. Pa /dev/rfd0 , although any existing writable file or device is acceptable. In case of a regular file it is treated as a dumped image of an MS-DOS file system; only the file system structure will be written to it, and it @@ -97,7 +97,7 @@ as well as keeping pointer chains for the chunks constituting one file. There are usually two identical copies of the FAT. .It Em The root directory The final structure is the root directory for this medium. It is -merely a space reservation, padded with 0's, and unfortunately fixed +merely a space reservation, padded with 0s, and unfortunately fixed in its size. .Nm newfs_msdos initializes it to empty, and enters a volume label record into the @@ -110,7 +110,7 @@ appropriate information written to diagnostic output). .Sh SEE ALSO .Xr fdformat 1 , .Xr mount_msdos 8 , -.Xr newfs 8 . +.Xr newfs 8 .Sh BUGS There is currently no way to specify obscure file system parameters. Thus, only media with one of the supported capacity values can be diff --git a/sbin/newlfs/newlfs.8 b/sbin/newlfs/newlfs.8 index bcfb79115d2..94a885d6018 100644 --- a/sbin/newlfs/newlfs.8 +++ b/sbin/newlfs/newlfs.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: newlfs.8,v 1.2 1996/06/23 14:31:54 deraadt Exp $ +.\" $OpenBSD: newlfs.8,v 1.3 1998/09/17 04:14:59 aaron Exp $ .\" $NetBSD: newlfs.8,v 1.2 1995/03/18 14:58:54 cgd Exp $ .\" .\" Copyright (c) 1993 @@ -43,27 +43,31 @@ .Sh SYNOPSIS .Nm newlfs .Fl L -.Op Ar newlfs-options +.Op Fl B Ar segsize +.Op Fl b Ar blocksize +.Op Fl m Ar freespace\&% +.Op Fl s Ar size .Ar special .Sh DESCRIPTION -.Nm Newlfs -builds a log-structured file system on the specified special -device basing its defaults on the information in the disk label. +.Nm newlfs +builds a log-structured file system on the specified +.Ar special +device, basing its defaults on the information in the disk label. (Before running .Nm newlfs the disk must be labeled using .Xr disklabel 8 .) .Pp -The following options define the general layout policies. +The following options define the general layout policies: .Bl -tag -width Fl -.It Fl B +.It Fl B Ar segsize The logical segment size of the file system in bytes. -.It Fl b Ar block-size +.It Fl b Ar blocksize The block size of the file system in bytes. .It Fl L Create a log-structured file system (LFS). This flag is currently required. -.It Fl m Ar free space \&% +.It Fl m Ar freespace\&% The percentage of space reserved from normal users; the minimum free space threshold. The default value used is 10%. See diff --git a/sbin/nfsd/nfsd.8 b/sbin/nfsd/nfsd.8 index def8f7424c4..b0d8e4e37db 100644 --- a/sbin/nfsd/nfsd.8 +++ b/sbin/nfsd/nfsd.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: nfsd.8,v 1.4 1998/06/15 17:55:55 mickey Exp $ +.\" $OpenBSD: nfsd.8,v 1.5 1998/09/17 04:14:59 aaron Exp $ .\" $NetBSD: nfsd.8,v 1.7 1996/02/18 11:58:24 fvdl Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 @@ -47,7 +47,7 @@ server .Op Fl rut .Op Fl n Ar num_servers .Sh DESCRIPTION -.Nm Nfsd +.Nm nfsd runs on a server machine to service .Tn NFS requests from client machines. @@ -96,7 +96,7 @@ A server should run enough daemons to handle the maximum level of concurrency from its clients, typically four to six. .Pp -.Nm Nfsd +.Nm nfsd listens for service requests at the port indicated in the .Tn NFS server specification; see @@ -106,7 +106,7 @@ RFC1094 and .Pp The .Nm nfsd -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr nfsstat 1 , .Xr nfssvc 2 , diff --git a/sbin/nfsiod/nfsiod.8 b/sbin/nfsiod/nfsiod.8 index ed88a982c1f..b79ee056745 100644 --- a/sbin/nfsiod/nfsiod.8 +++ b/sbin/nfsiod/nfsiod.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: nfsiod.8,v 1.4 1998/06/15 17:55:56 mickey Exp $ +.\" $OpenBSD: nfsiod.8,v 1.5 1998/09/17 04:14:59 aaron Exp $ .\" $NetBSD: nfsiod.8,v 1.6 1995/03/18 14:59:04 cgd Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 @@ -46,7 +46,7 @@ asynchronous I/O server .Nm nfsiod .Op Fl n Ar num_servers .Sh DESCRIPTION -.Nm Nfsiod +.Nm nfsiod runs on an .Tn NFS client machine to service asynchronous I/O requests to its server. @@ -65,7 +65,7 @@ level of concurrency, typically four to six. The system maximum is twenty. .Pp The .Nm nfsiod -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr nfsstat 1 , .Xr nfssvc 2 , diff --git a/sbin/nologin/nologin.8 b/sbin/nologin/nologin.8 index 0bf3fcdf098..9649d4b72a6 100644 --- a/sbin/nologin/nologin.8 +++ b/sbin/nologin/nologin.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: nologin.8,v 1.4 1998/09/01 16:38:17 deraadt Exp $ +.\" $OpenBSD: nologin.8,v 1.5 1998/09/17 04:14:59 aaron Exp $ .\" $NetBSD: nologin.8,v 1.3 1995/03/18 14:59:09 cgd Exp $ .\" .\" Copyright (c) 1993 @@ -43,7 +43,7 @@ .Sh SYNOPSIS .Nm nologin .Sh DESCRIPTION -.Nm Nologin +.Nm nologin displays a message that an account is not available and exits non-zero. It is intended as a replacement shell field for accounts that diff --git a/sbin/pcmcia_cntrl/pcmcia_cntrl.8 b/sbin/pcmcia_cntrl/pcmcia_cntrl.8 index 1e9740a07a8..726146484a7 100644 --- a/sbin/pcmcia_cntrl/pcmcia_cntrl.8 +++ b/sbin/pcmcia_cntrl/pcmcia_cntrl.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pcmcia_cntrl.8,v 1.2 1997/12/21 00:56:05 millert Exp $ +.\" $OpenBSD: pcmcia_cntrl.8,v 1.3 1998/09/17 04:15:00 aaron Exp $ .\" Copyright (c) 1994 Stefan Grefen .\" All rights reserved. .\" @@ -46,7 +46,7 @@ .Ar slotid .Op on | off | unmap | probe .Sh DESCRIPTION -.Nm Pcmcia_cntrl +.Nm pcmcia_cntrl controls the operation of a PCMCIA card. It operates on the card in slot .Ar slotid . \. diff --git a/sbin/ping/ping.8 b/sbin/ping/ping.8 index 61623a2c459..34b31f45403 100644 --- a/sbin/ping/ping.8 +++ b/sbin/ping/ping.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ping.8,v 1.8 1998/09/06 22:23:18 aaron Exp $ +.\" $OpenBSD: ping.8,v 1.9 1998/09/17 04:15:00 aaron Exp $ .\" $NetBSD: ping.8,v 1.10 1995/12/31 04:55:35 ghudson Exp $ .\" .\" Copyright (c) 1985, 1991, 1993 @@ -56,7 +56,7 @@ packets to network hosts .Op Fl w Ar maxwait .Ar host .Sh DESCRIPTION -.Nm Ping +.Nm ping uses the .Tn ICMP protocol's mandatory @@ -101,7 +101,6 @@ Only the super-user may use this option. .Bf -emphasis This can be very hard on a network and should be used with caution. .Ef -Only root can do a flood ping. .It Fl I Ar ifaddr Specify the interface to transmit from on machines with multiple interfaces. For unicast and multicast pings. @@ -109,7 +108,7 @@ interfaces. For unicast and multicast pings. Wait .Ar wait seconds -.Em between sending each packet . +between sending each packet . The default is to wait for one second between each packet. This option is incompatible with the .Fl f @@ -145,7 +144,9 @@ packet and displays the route buffer on returned packets. Note that the IP header is only large enough for nine such routes. If more routes come back than should, such as due to an illegal spoofed -packet, ping will print the route list and then truncate it at the correct +packet, +.Nm ping +will print the route list and then truncate it at the correct spot. Many hosts ignore or discard this option. .It Fl r Bypass the normal routing tables and send directly to a host on an attached @@ -194,14 +195,14 @@ requests. .Pp When using .Nm ping -for fault isolation, it should first be run on the local host, to verify +for fault isolation, it should first be run on the local host to verify that the local network interface is up and running. Then, hosts and gateways further and further away should be ``pinged''. -Round-trip times and packet loss statistics are computed. +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 +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. @@ -222,7 +223,7 @@ of header followed by an arbitrary amount of data. When a .Ar packetsize -is given, this indicated the size of this extra piece of data (the +is given, this indicates the size of this extra piece of data (the default is 56). Thus the amount of data received inside of an IP packet of type .Tn ICMP @@ -239,7 +240,7 @@ it uses in the computation of round trip times. If less than eight bytes of pad are specified, no round trip times are given. .Sh DUPLICATE AND DAMAGED PACKETS -.Nm Ping +.Nm ping will report duplicate and damaged packets. Duplicate packets should never occur, and seem to be caused by inappropriate link-level retransmissions. @@ -308,7 +309,9 @@ with or .Xr ftp 1 . .Pp -In normal operation ping prints the ttl value from the packet it receives. +In normal operation, +.Nm ping +prints the TTL value from the packet it receives. When a remote system receives a ping packet, it can do one of three things with the .Tn TTL @@ -321,7 +324,7 @@ release. In this case the .Tn TTL value in the received packet will be 255 minus the -number of routers in the round-trip path. +number of routers in the round trip path. .It Set it to 255; this is what current Berkeley Unix systems do. In this case the @@ -329,11 +332,7 @@ In this case the value in the received packet will be 255 minus the number of routers in the path .Xr from -the remote system -.Em to -the -.Nm ping Ns Em ing -host. +the remote system to the pinging host. .It Set it to some other value. Some machines use the same value for @@ -344,7 +343,7 @@ packets, for example either 30 or 60. Others may use completely wild values. .El .Sh BUGS -Many Hosts and Gateways ignore the +Many hosts and gateways ignore the .Tn RECORD_ROUTE option. .Pp @@ -365,4 +364,5 @@ broadcast address should only be done under very controlled conditions. The .Nm command appeared in +A .Bx 4.3 . diff --git a/sbin/quotacheck/quotacheck.8 b/sbin/quotacheck/quotacheck.8 index 903264d7fb9..4dfbbaf4cc4 100644 --- a/sbin/quotacheck/quotacheck.8 +++ b/sbin/quotacheck/quotacheck.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: quotacheck.8,v 1.3 1997/01/03 16:22:10 mickey Exp $ +.\" $OpenBSD: quotacheck.8,v 1.4 1998/09/17 04:15:00 aaron Exp $ .\" $NetBSD: quotacheck.8,v 1.4 1995/03/18 14:59:20 cgd Exp $ .\" .\" Copyright (c) 1983, 1990, 1991, 1993 @@ -58,7 +58,7 @@ .Op Fl v .Fl a .Sh DESCRIPTION -.Nm Quotacheck +.Nm quotacheck examines each filesystem, builds a table of current disk usage, and compares this table against that recorded @@ -67,7 +67,7 @@ If any inconsistencies are detected, both the quota file and the current system copy of the incorrect quotas are updated (the latter only occurs if an active filesystem is checked). -By default both user and group quotas are checked. +By default, both user and group quotas are checked. .Pp Available options: .Bl -tag -width Ds @@ -79,11 +79,11 @@ flag is supplied in place of any filesystem names, will check all the filesystems indicated in .Pa /etc/fstab to be read-write with disk quotas. -By default only the types of quotas listed in +By default, only the types of quotas listed in .Pa /etc/fstab are checked. .It Fl d -Enable debugging mode, no actual data will be written on disk(s). +Enable debugging mode. No actual data will be written on disk(s). .It Fl g Only group quotas listed in .Pa /etc/fstab @@ -118,28 +118,28 @@ Normally .Nm quotacheck operates silently. .Pp -.Nm Quotacheck -expects each filesystem to be checked to have a +.Nm quotacheck +expects each filesystem to be checked to have quota files named .Pa quota.user and .Pa quota.group -which are located at the root of the associated file system. +located at the root of the associated file system. These defaults may be overridden in .Pa /etc/fstab . If a file is not present, .Nm quotacheck will create it. .Pp -.Nm Quotacheck +.Nm quotacheck is normally run at boot time from the .Pa /etc/rc.local -file, see -.Xr rc 8 , +file +.Pq see Xr rc 8 before enabling disk quotas with .Xr quotaon 8 . .Pp -.Nm Quotacheck +.Nm quotacheck accesses the raw device in calculating the actual disk usage for each user. Thus, the filesystems diff --git a/sbin/reboot/boot_atari.8 b/sbin/reboot/boot_atari.8 index ad20feb592f..f77b382e2d3 100644 --- a/sbin/reboot/boot_atari.8 +++ b/sbin/reboot/boot_atari.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: boot_atari.8,v 1.3 1998/09/01 16:38:19 deraadt Exp $ +.\" $OpenBSD: boot_atari.8,v 1.4 1998/09/17 04:15:00 aaron Exp $ .\" $NetBSD: boot_atari.8,v 1.1 1996/06/27 11:07:56 leo Exp $ .\" .\" Copyright (c) 1990, 1991 The Regents of the University of California. @@ -40,14 +40,14 @@ .\" @(#)boot_hp300.8 8.2 (Berkeley) 4/19/94 .\" .Dd June 21, 1996 -.Dt boot_atari 8 +.Dt BOOT_ATARI 8 .Os .Sh NAME .Nm boot .Nd system bootstrapping procedures .Sh DESCRIPTION -.Sy Power fail and crash recovery +.Ss Power fail and crash recovery .Pp When the .Tn OpenBSD @@ -60,39 +60,38 @@ to shut the system down is with the command. .Pp If the system crashes, it will enter the kernel debugger, -.Xr ddb 8 -,if it is configured in the kernel. If the debugger is not present, -or the debugger is exited, the system will attempt a dump to the +.Xr ddb 8 , +if it is configured in the kernel. If the debugger is not present +or has exited, the system will attempt a dump to the configured dump device (which will be automatically recovered with .Xr savecore 8 -during the next boot cycle). After the dump is complete (successful +during the next boot cycle). After the dump completes (successful or not), the system will attempt a reboot. .Pp -.Sy Booting OpenBSD using the bootloader +.Ss Booting OpenBSD using the bootloader .Pp When a bootable .Tn OpenBSD partition is created by means of -.Xr installboot 8 -, the Atari BIOS will automatically start the OpenBSD bootloader. By default +.Xr installboot 8 , +the Atari BIOS will automatically start the OpenBSD bootloader. By default, it will load the kernel image .Pa /bsd -and attempts to boot it into multi-user mode. This behaviour can be changed by +and attempt to boot it into multi-user mode. This behaviour can be changed by either keeping the -.Pa Alternate -or the -.Pa Right-Shift -key pressed during the boot. When +.Sq Alternate +or +.Sq Right-Shift +key pressed during the boot process. When the -.Pa Alternate +.Sq Alternate key is pressed, the bootstrap is aborted, causing the BIOS to continue scanning the disks for a bootable partition (this is compatible with AHDI 3.0). Pressing the -.Pa Right-Shift -key during the boot, causes the boot loader to enter the interactive mode. +.Sq Right-Shift +key during the boot causes the bootloader to enter interactive mode. In interactive mode, the command line looks like: .Bd -ragged -offset indent -.Pp .Op Ar OS-type .Op Ar boot-path .Op Ar boot-options @@ -112,28 +111,29 @@ indicated will be used. If something other than .Pa .OpenBSD is specified, control is returned to the BIOS with the boot preference set to -the selected type. Due to limitations of the BIOS however, the search for +the selected type. Due to limitations of the BIOS, however, the search for bootblocks is continued rather than restarted. -.It boot-path +.It Em boot-path This gives you the opportunity to boot another kernel, say: -.Pa /bsd.old. +.Pa /bsd.old . The default is -.Pa /bsd -.It boot-options +.Pa /bsd . +.It Em boot-options These options are a subset of the .Xr loadbsd options. +.Pp .Bl -tag -width flag -compact .It Fl a -Boot into multi-user mode (the default) +Boot into multi-user mode (the default). .It Fl b -Ask for a root device +Ask for a root device. .It Fl d -Enter the kernel debugger +Enter the kernel debugger. .El .El .Pp -.Sy Booting using the loadbsd program +.Ss Booting using the loadbsd program .Pp When you want (or have to) start OpenBSD from GEM, you have to use the .Xr loadbsd @@ -160,7 +160,7 @@ Print a help screen that tries to explain the same options as mentioned here. .It Fl o Ar outputfile Write all output to the file -.Ar outputfile. +.Ar outputfile . .It Fl s Tell OpenBSD only to use ST compatible RAM. .It Fl t @@ -186,7 +186,7 @@ This is a GEMDOS path specification of the kernel to boot. .Pp Note: Because the loadbsd program can only read kernels from a GEMDOS filesystem, the file -.Ar /bsd +.Pa /bsd is usually not the same as the actual kernel booted. This can cause some programs to fail. .Sh FILES diff --git a/sbin/reboot/boot_hp300.8 b/sbin/reboot/boot_hp300.8 index cebb5e64a23..da91bed4e0b 100644 --- a/sbin/reboot/boot_hp300.8 +++ b/sbin/reboot/boot_hp300.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: boot_hp300.8,v 1.3 1996/06/29 18:24:15 mickey Exp $ +.\" $OpenBSD: boot_hp300.8,v 1.4 1998/09/17 04:15:00 aaron Exp $ .\" $NetBSD: boot_hp300.8,v 1.3 1995/04/23 10:33:34 cgd Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 @@ -46,26 +46,26 @@ .Nd system bootstrapping procedures .Sh DESCRIPTION -.Sy Power fail and crash recovery. +.Ss Power fail and crash recovery +.Pp Normally, the system will reboot itself at power-up or after crashes. An automatic consistency check of the file systems will be performed, and unless this fails, the system will resume multi-user operations. .Pp -.Sy Cold starts. +.Ss Cold starts +.Pp On an HP300, the boot procedure uses the boot ROM to load a boot program from an .Tn LIF format directory at the beginning of an attached disk. The .Pa /usr/mdec -directory contains a disk boot programs which should be placed in a +directory contains a disk boot program which should be placed in a new pack automatically by .Xr newfs 8 when the ``a'' partition file system on the pack is created. .Pp -This -.Em boot -program +This boot program finds the corresponding file on the given device .Pf ( Ar bsd by default), @@ -95,10 +95,10 @@ Currently, ``rd'' and ``sd'' are the only valid specifiers. .Pp For example, -to boot from the `a' file system of unit 0 on HP-IB 2, +to boot from the ``a'' file system of unit 0 on HP-IB 2, type .Ql rd(16, 0)bsd -to the boot prompt. +at the boot prompt. For tapes, the minor device number gives a file offset. .Pp In an emergency, the bootstrap methods described in the paper diff --git a/sbin/reboot/boot_i386.8 b/sbin/reboot/boot_i386.8 index f648ab7386f..9652471c48d 100644 --- a/sbin/reboot/boot_i386.8 +++ b/sbin/reboot/boot_i386.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: boot_i386.8,v 1.5 1998/07/11 22:46:09 angelos Exp $ +.\" $OpenBSD: boot_i386.8,v 1.6 1998/09/17 04:15:00 aaron Exp $ .\" .\" Copyright (c) 1997 Tobias Weingartner .\" @@ -32,19 +32,21 @@ .\" .Dd September 4, 1997 -.Dt BOOT_i386 8 i386 +.Dt BOOT_I386 8 i386 .Os .Sh NAME .Nm boot .Nd system bootstrapping procedures .Sh DESCRIPTION -.Sy Power fail and crash recovery. +.Ss Power fail and crash recovery +.Pp Normally, the system will reboot itself at power-up or after crashes. An automatic consistency check of the file systems will be performed, and unless this fails, the system will resume multi-user operations. .Pp -.Sy Cold starts. +.Ss Cold starts +.Pp The .Tn "PC AT" clones will perform a POST (Power On Self Test) upon being booted cold. @@ -60,31 +62,31 @@ if it is an older BIOS, it will start with checking for a disk in floppy drive A (otherwise known as drive 0) first, and failing that, attempt to boot the hard disk C (otherwise known as hard disk controller 1, drive 0). .Pp -.Sy Warm starts. +.Ss Warm starts +.Pp The BIOS loads the first block (at physical location: track 0, head 0, sector 1) off the boot device into memory, and if the last two bytes in the block match the signature 0x55AA, the BIOS considers the block a valid bootable drive. The BIOS then proceeds to call the machine code program in this block. If the BIOS is current, it will also pass the boot drive -to the boot block in register -.Sy %dl. +to the boot block in register %dl. .Pp There are two different types of boot blocks on devices. There is the -MBR (master boot record), and the PBR (partition boot record). A digression +MBR (master boot record) and the PBR (partition boot record). A digression into a little piece of history will quickly give light as to why this is so. In the beginning, the PC ``architecture'' came with a single or dual floppy drives, and no hard drives. The only type of bootable sectors on any device were the PBRs. They were responsible for loading the rest of the operating -system from the right device. When hard disks came out, it was felt that +system from the correct device. When hard disks came out, it was felt that such a huge space should be able to be partitioned into separate drives, -and this is where the MBR was invented. +and this is when the MBR was invented. .Pp The MBR relocates itself upon being loaded and invoked by the BIOS. -Embeded within the MBR is a partition table, with four partitions table +Embeded within the MBR is a partition table, with four partition table entries. The MBR code traverses this table (which was loaded with the MBR by the BIOS), looking for an active entry, and then loads the MBR or PBR from the disk location specified by the partition table entry. So -in all reality, the MBR is nothing more than a fancy chaining PBR. +in reality, the MBR is nothing more than a fancy chaining PBR. .Pp Note: The MBR could load another MBR, which is the case when you are booting off an extended partition. In other words, the first block of an extended @@ -110,7 +112,7 @@ cylinder/head/sector of the real drive geometry into something that would allow the applications using the BIOS to access a larger portion of the drive, still using the restricted BIOS API. .Pp -The reason this has become a problem, is that any modern OS will use its own +The reason this has become a problem is that any modern OS will use its own drivers to access the disk drive, bypassing the BIOS completely. However, the MBR, PBR, and partition tables are all still written using the original BIOS access methods. This is for backwards compatibility to the original @@ -141,7 +143,7 @@ system second stage bootstrap .Xr boot 8 .Sh BUGS The ``PC BIOS Architecture'' makes this process very prone to weird and -wonderfull interactions between differing operating systems. There is +wonderful interactions between differing operating systems. There is no published standard to the MBR and PBR, which makes coding these a nightmare. Somebody *please* write me a decent BIOS, and make them (the masses) use it! diff --git a/sbin/reboot/boot_mac68k.8 b/sbin/reboot/boot_mac68k.8 index cf605e7cff9..bacff4a7fad 100644 --- a/sbin/reboot/boot_mac68k.8 +++ b/sbin/reboot/boot_mac68k.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: boot_mac68k.8,v 1.5 1998/02/26 16:32:40 gene Exp $ +.\" $OpenBSD: boot_mac68k.8,v 1.6 1998/09/17 04:15:00 aaron Exp $ .\" $NetBSD: boot_mac68k.8,v 1.1 1995/07/02 02:09:52 briggs Exp $ .\" .\" Copyright (c) 1990, 1991 The Regents of the University of California. @@ -47,7 +47,8 @@ .Nd system bootstrapping procedures .Sh DESCRIPTION -.Sy Power fail and crash recovery. +.Ss Power fail and crash recovery +.Pp Normally, the .Ox kernel on the mac68k architecture is booted from the native operating @@ -61,15 +62,15 @@ command. .Pp If the system crashes, it will enter the kernel debugger, .Xr ddb 8 , -if it is configured in the kernel. If the debugger is not present, -or the debugger is exited, the system will attempt a dump to the +if it is configured in the kernel. If the debugger is not present +or has exited, the system will attempt a dump to the configured dump device (which will be automatically recovered with .Xr savecore 8 -during the next boot cycle). After the dump is complete (successful +during the next boot cycle). After the dump completes (successful or not), the system will attempt a reboot. .Pp On most mac68k machines with "soft-power" after the IIcx, the power -switch can be physically rotated and locked in the 'on' position. +switch can be physically rotated and locked in the ``on'' position. The native OS can be configured to automatically start the .Ox boot program. Additionally, the OpenBSD boot program can be configured @@ -79,11 +80,12 @@ without intervention. When a system is so configured, it can crash or lose power and reboot back to a fully multi-user state without any intervention. .Pp -.Sy The boot application +.Ss The boot application +.Pp The boot application runs in the native OS on the system. It has a dialog where booting preferences may be changed and an option whereby these options may be saved. The preferences are stored in the program -itself, not in a preferences folder--thus allowing two separate copies +itself, not in a preferences folder, thus allowing two separate copies of the program to be configured differently (e.g. to boot different bsd or bsd.test, or to boot from two different drives). .Pp @@ -99,7 +101,7 @@ file. Another useful option that may be specified is the "serial console" option. This will allow a serial device (terminal or computer) to act as a console for the system. This device must be configured to -use 9600 baud, eight bits, no parity, and one stop bit (9600-N81). +use 9600 baud, eight bits, no parity, and one stop bit (9600-8N1). Either the printer port or the modem port (tty01 and tty00, respectively) may be used for this. .Pp @@ -108,7 +110,7 @@ in native OS rather than from the usual location in the .Ox file system. A radio button is supplied for this purpose. Note that some programs will not run properly if the kernel is not found as -.Ar /bsd +.Pa /bsd within the .Tn OpenBSD file system. diff --git a/sbin/reboot/boot_pmax.8 b/sbin/reboot/boot_pmax.8 index 532b979d910..cd9439b4ab9 100644 --- a/sbin/reboot/boot_pmax.8 +++ b/sbin/reboot/boot_pmax.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: boot_pmax.8,v 1.6 1998/07/24 20:49:08 deraadt Exp $ +.\" $OpenBSD: boot_pmax.8,v 1.7 1998/09/17 04:15:00 aaron Exp $ .\" $NetBSD: boot_pmax.8,v 1.1 1995/04/25 23:55:11 mellon Exp $ .\" .\" Copyright (c) 1990, 1991 The Regents of the University of California. @@ -52,31 +52,33 @@ Since the system is not reenterable, it is necessary to read it in from disk or tape each time it is to be bootstrapped. .Pp -.Sy Power fail and crash recovery. +.Ss Power fail and crash recovery +.Pp Normally, the system will boot itself at power-up or after crashes. An automatic consistency check of the file systems will be performed, and unless this fails, the system will resume multi-user operations. .Pp -.Sy Cold starts. +.Ss Cold starts +.Pp At power up, all DECstation ROMs consult the .Nm haltaction environment -variable in EEPROM to determine whether or not to attempt to boot -automatically. If this -variable is set to \fBh\fR, the ROM prints a prompt on the console and -waits for user commands. If set to \fBb\fR, the ROM attempts to autoboot. +variable in EEPROM to determine whether or not to attempt an automatic +boot. If this +variable is set to ``h'', the ROM prints a prompt on the console and +waits for user commands. If set to ``b'', the ROM attempts to autoboot. .Pp On the DECstation 2100 and 3100, the path used for automatic booting is stored in the .Nm bootpath -environment variable. The path is made up of a -device type specifier (e.g., rz, tz, mop or tftp) followed by +environment variable. The path is made up of a +device type specifier (e.g., rz, tz, mop or tftp), followed by a triplet in the form (x,y,z), followed by a filename to load. .Pp -Within the triplet, x is the controller (always 0), y is the SCSI id of +Within the triplet, ``x'' is the controller (always 0), ``y'' is the SCSI ID of the drive to -boot from or 0 for net boots, and z is the partition to boot from -(usually 0 for SCSI devices, always zero for network booting. +boot from or 0 for net boots, and ``z'' is the partition to boot from +(usually 0 for SCSI devices, always zero for network booting). For network boots, () may be specified instead of (0,0,0). .Pp The filename is optional for bootp/tftp and mop booting, since in @@ -84,9 +86,11 @@ these cases the network protocol can be used to determine which file to boot. When booting off the tape, no filename should be specified, and when booting off of disk, the filename of a kernel must be specified. Generally, the kernel is named -.Nm bsd. +.Pa bsd . .Pp -An example bootpath setting would be: +An example +.Nm bootpath +setting would be: .nf .sp 1 .ce 1 @@ -95,17 +99,17 @@ setenv bootpath rz(0,1,0)bsd .Pp For automatic boots, the ROM automatically passes a .Fl a -argument to the boot -loader, requesting that +argument to the bootloader, +requesting that .Tn OpenBSD -attempt to come up to multi-user mode. At the boot ROM prompt, +attempt to come up to multi-user mode. At the boot ROM prompt, the user may boot .Tn OpenBSD with either the .Nm auto or the .Nm boot -command. If the +command. If the .Nm auto command is used, the .Fl a @@ -120,8 +124,9 @@ When either the .Nm boot or the .Nm auto -command is issued with no arguments, the kernel specified in the bootpath -environment variable is booted. An alternate kernel may be specified +command is issued with no arguments, the kernel specified in the +.Nm bootpath +environment variable is booted. An alternate kernel may be specified with the .Fl f flag, followed by the path of the kernel to boot, as described above. @@ -130,14 +135,16 @@ For example: .ce 1 boot -f rz(0,4,0)bsd.new .Pp -On TurboChannel machines (all DECstation 5000 models), the boot path -is specified in the boot environment variable, along with any arguments -to be passed to the kernel. Note that to specify boot arguments (e.g., -.Fl a) +On TurboChannel machines (all DECstation 5000 models), the bootpath +is specified in the +.Nm boot +environment variable, along with any arguments +to be passed to the kernel. Note that to specify boot arguments (e.g., +.Fl a ) when setting the .Nm boot environment variable, the filename and arguments -must be enclosed in quotes. For example: +must be enclosed in quotes. For example: .nf .sp 1 .ce 1 @@ -146,19 +153,19 @@ setenv boot "3/rz4/bsd -a" .Pp The device from which to boot is specified as the TurboChannel slot number, a TurboChannel-option-specific device name, and a path to the -file to load, all separated by slashes. You can get a list of the +file to load, all separated by slashes. You can get a list of the devices installed in your TurboChannel slots (as well as any built-in devices which appear as TurboChannel slots) by typing the .Nm cnfg command -at the boot prompt. You can get more detailed information about a specific +at the boot prompt. You can get more detailed information about a specific TurboChannel option by typing .Nm cnfg followed by the slot number of that option. .Pp -For SCSI devices, the option-specific device identifier is either rz# for -disks or tz# for tapes, where # is the SCSI id of the device. For network +For SCSI devices, the option-specific device identifier is either ``rz#'' for +disks or ``tz#'' for tapes, where # is the SCSI ID of the device. For network devices, the option-specific protocol identifier is either mop or tftp. Filename requirements are as for the DECstation 2100 and 3100. .Pp @@ -166,18 +173,20 @@ To start .Tn OpenBSD from the boot prompt, the .Nm boot -command must be used. With no arguments, this simply boots the default +command must be used. With no arguments, this simply boots the default kernel with the default arguments as set with .Nm setenv -.Nm boot. -If no boot environment variable is set or if an alternate kernel is to be +.Nm boot . +If no +.Nm boot +environment variable is set, or if an alternate kernel is to be booted, the path of that kernel may be specified after the boot command as -described above, and any arguments may be passed similarly. For example: +described above, and any arguments may be passed similarly. For example: .sp 1 .ce 1 boot 3/rz4/bsd.new -a .Sh SEE ALSO -.Xr crash 8m , +.Xr crash 8 , .Xr fsck 8 , .Xr halt 8 , .Xr init 8 , diff --git a/sbin/reboot/boot_sparc.8 b/sbin/reboot/boot_sparc.8 index 87712f482db..d92e7f01c1f 100644 --- a/sbin/reboot/boot_sparc.8 +++ b/sbin/reboot/boot_sparc.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: boot_sparc.8,v 1.5 1998/07/11 22:46:12 angelos Exp $ +.\" $OpenBSD: boot_sparc.8,v 1.6 1998/09/17 04:15:00 aaron Exp $ .\" $NetBSD: boot_sparc.8,v 1.4 1995/04/25 11:37:25 pk Exp $ .\" .\" Copyright (c) 1992, 1993 @@ -35,7 +35,7 @@ .\" @(#)boot_sparc.8 8.2 (Berkeley) 4/19/94 .\" .Dd April 19, 1994 -.Dt boot_sparc 8 sparc +.Dt BOOT_SPARC 8 sparc .Os .Sh NAME .Nm reboot @@ -47,57 +47,57 @@ bootstrapping procedures .Op Fl n .Op Fl q .Sh DESCRIPTION -.Sy Power fail and crash recovery. +.Ss Power fail and crash recovery +.Pp Normally, the system will reboot itself at power-up or after crashes. An automatic consistency check of the file systems will be performed -as described in -.Xr fsck 8 . +(as described in +.Xr fsck 8 ), and unless this fails, the system will resume multi-user operations. .Pp -.Sy Cold starts +.Ss Cold starts +.Pp The SPARC system currently uses the SunOS bootstrap loaders. This will be changed in a future version of the system. The SunOS boot will attempt to load .Pa bsd -from partition A of the boot device, +from partition ``a'' of the boot device, which must currently be an ``sd'' disk. .Pp The -.Op Fl s -flag to the SunOS boot loader will being the system up in single-user mode. +.Fl s +flag to the SunOS bootloader will bring the system up in single-user mode. The -.Op Fl a +.Fl a flag instructs the system to prompt for the location of the root filesystem and the primary swap partition. .\"The .\".Op Fl d -.\"flag to the SunOS boot loader will bring the system up in debug mode. +.\"flag to the SunOS bootloader will bring the system up in debug mode. .\"Here it waits for a kernel debugger connect; see .\".Xr kgdb 8 . Other flags are currently ignored. .Pp -The Sparc boot rom comes in two flavours: an ``old-style'' rom is used in -sun4 machines, while A ``new-style'' rom can be found on sun4c and sun4m models. -The ``new-style'' Sparc boot rom is a full-featured Forth system with emacs +The SPARC boot ROM comes in two flavours: an ``old-style'' ROM is used in +sun4 machines, while a ``new-style'' ROM can be found on sun4c and sun4m models. +The ``new-style'' SPARC boot ROM is a full-featured Forth system with emacs key bindings. It can be put in ``old-style'' user-interface compatibility mode (in which case it shows a simple `>' prompt), but this is essentially -useless. However, by default the rom runs in old-mode; to enter new-mode type `n'. -The rom then shows a Forth-style `ok' prompt. It is recommended to have -the rom always start in its native ``new-style'' mode. Utter the following -incantation in new-mode to force the rom to always start in new-mode. +useless. However, by default the ROM runs in old-mode; to enter new-mode type `n'. +The ROM then shows a Forth-style `ok' prompt. It is recommended to have +the ROM always start in its native ``new-style'' mode. Utter the following +incantation in new-mode to force the ROM to always start in new-mode: .Pp -.Pa \ ok +.Em \ ok setenv sunmon-compat? false .Pp -The rom will normally load the kernel from "sd(0,0,0)bsd". To change the -default so that -.Pa OpenBSD -will be loaded type the following +The ROM will normally load the kernel from "sd(0,0,0)bsd". To change the +default so that OpenBSD will be loaded, type the following: .Pp -.Pa \ ok +.Em \ ok setenv boot-from sd(0,0,0)bsd .Pp -At any time you can break back to the rom by pressing the `L1' and `a' +At any time you can break back to the ROM by pressing the `L1' and `a' keys at the same time (if the console is a serial port the same is achieved by sending a `break'). If you do this accidentally you can continue whatever was in progress diff --git a/sbin/reboot/boot_sun3.8 b/sbin/reboot/boot_sun3.8 index 902dbcec9f6..8f050a286cc 100644 --- a/sbin/reboot/boot_sun3.8 +++ b/sbin/reboot/boot_sun3.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: boot_sun3.8,v 1.4 1998/07/11 22:46:13 angelos Exp $ +.\" $OpenBSD: boot_sun3.8,v 1.5 1998/09/17 04:15:01 aaron Exp $ .\" $NetBSD: boot_sun3.8,v 1.1 1995/08/08 20:46:20 gwr Exp $ .\" .\" Copyright (c) 1992, 1993 @@ -35,7 +35,7 @@ .\" @(#)boot_sparc.8 8.2 (Berkeley) 4/19/94 .\" .Dd April 19, 1994 -.Dt boot_sun3 8 sun3 +.Dt BOOT_SUN3 8 sun3 .Os .Sh NAME .Nm reboot @@ -47,38 +47,44 @@ bootstrapping procedures .Op Fl n .Op Fl q .Sh DESCRIPTION -.Sy Power fail and crash recovery. +.Ss Power fail and crash recovery +.Pp Normally, the system will reboot itself at power-up or after crashes. An automatic consistency check of the file systems will be performed as described in .Xr fsck 8 . and unless this fails, the system will resume multi-user operations. .Pp -.Sy Cold starts -A disk-boot program (/usr/mdec/ufsboot) will attempt to load +.Ss Cold starts +.Pp +A disk-boot program +.Pq Pa /usr/mdec/ufsboot +will attempt to load .Pa bsd -from partition A of the boot device, +from partition ``a'' of the boot device, which must currently be an ``sd'' disk. -Alternatively, network boot program (/usr/mdec/netboot) will load +Alternatively, the network boot program +.Pq Pa /usr/mdec/netboot +will load .Pa bsd from the NFS root as determined by the procedure described in .Xr diskless 8 . .Pp The -.Op Fl s -flag to the boot loader will being the system up in single-user mode. +.Fl s +flag to the bootloader will bring the system up in single-user mode. The -.Op Fl a +.Fl a flag instructs the system to prompt for the location of the root filesystem and the primary swap partition. The -.Op Fl d -flag to the boot loader will bring the system up in debug mode. +.Fl d +flag to the bootloader will bring the system up in debug mode. Here it waits for a kernel debugger connect; see .Xr ddb 8 . Other flags are currently ignored. .Pp -At any time you can break back to the rom by pressing the `L1' and `a' +At any time you can break back to the ROM by pressing the `L1' and `a' keys at the same time (if the console is a serial port the same is achieved by sending a `break'). If you do this accidentally you can continue whatever was in progress diff --git a/sbin/reboot/boot_vax.8 b/sbin/reboot/boot_vax.8 index f7e91dc89a9..beca7f8d00d 100644 --- a/sbin/reboot/boot_vax.8 +++ b/sbin/reboot/boot_vax.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: boot_vax.8,v 1.4 1998/07/11 22:46:14 angelos Exp $ +.\" $OpenBSD: boot_vax.8,v 1.5 1998/09/17 04:15:01 aaron Exp $ .\" $NetBSD: boot_vax.8,v 1.3 1995/04/23 10:33:39 cgd Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -35,25 +35,27 @@ .\" @(#)boot_vax.8 8.2 (Berkeley) 4/19/94 .\" .Dd April 19, 1994 -.Dt boot_vax 8 vax +.Dt BOOT_VAX 8 vax .Os .Sh NAME .Nm boot .Nd system bootstrapping procedures .Sh DESCRIPTION -.Sy Power fail and crash recovery. +.Ss Power fail and crash recovery +.Pp Normally, the system will reboot itself at power-up or after crashes. -Provided the auto-restart is enabled on the machine front panel, +Provided the auto-restart is enabled on the machine's front panel, an automatic consistency check of the file systems will be performed, and unless this fails, the system will resume multi-user operations. .Pp -.Sy Cold starts. +.Ss Cold starts +.Pp These are processor-type dependent. On an 11/780, there are two floppy files for each disk controller, both of which cause boots from unit 0 of the root file system of a controller located on mba0 or uba0. -One gives a single user shell, while the other invokes the multi-user +One gives a single-user shell, while the other invokes the multi-user automatic reboot. Thus these files are .Tn HPS @@ -124,9 +126,9 @@ The current encoding has a historical basis, and is shown in the following table: .Pp .Bd -unfilled -offset indent -compact -bits usage -0-7 boot device type (the device major number) -8-15 disk partition +bits usage +0-7 boot device type (the device major number) +8-15 disk partition 16-19 drive unit 20-23 controller number 24-27 adaptor number (UNIBUS or MASSBUS as appropriate) @@ -147,14 +149,14 @@ may specify .Li \&>>>B/ Ns Fl n No DMA0 .Ed .Pp -where, giving a +where, giving an .Ar n of 1 causes the boot program to ask for the name of the system to be bootstrapped, -giving a +giving an .Ar n -of 2 causes the boot program to come up single -user, and a +of 2 causes the boot program to come up single-user, +and an .Ar n of 3 causes both of these actions to occur. The ``DM'' specifies RK07, the ``A'' represents the adaptor number @@ -181,8 +183,10 @@ to autoboot or to halt. When halted, the processor may be booted using the same syntax as on the 11/750. .Pp -The 11/750 boot procedure uses the boot roms to load block 0 off of -the specified device. The /usr/mdec directory contains a number +The 11/750 boot procedure uses the boot ROMs to load block 0 off of +the specified device. The +.Pa /usr/mdec +directory contains a number of bootstrap programs for the various disks which should be placed in a new pack by .Xr disklabel 8 . @@ -199,7 +203,7 @@ disk such as the RD53. .Pp On any processor, the -.Em boot +.Nm boot program finds the corresponding file on the given device .Pf ( Pa bsd @@ -261,7 +265,7 @@ of unit 0 of a .Tn MASSBUS disk, type .Ql hp(0,0)bsd -to the boot prompt; +at the boot prompt; .Ql hp(2,0,1,0)bsd would specify drive 1 on .Tn MASSBUS @@ -292,7 +296,7 @@ at .Pp On an 11/750 with patchable control store, microcode patches will be installed by -.Em boot +.Nm boot if the file .Pa psc750.bin exists in the root of the filesystem from which the system is booted. diff --git a/sbin/reboot/boot_x68k.8 b/sbin/reboot/boot_x68k.8 index 5e3b32594d0..836f883e18e 100644 --- a/sbin/reboot/boot_x68k.8 +++ b/sbin/reboot/boot_x68k.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: boot_x68k.8,v 1.4 1996/07/10 03:52:56 ccappuc Exp $ +.\" $OpenBSD: boot_x68k.8,v 1.5 1998/09/17 04:15:01 aaron Exp $ .\" $NetBSD: boot_x68k.8,v 1.1 1996/06/15 18:54:22 oki Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -34,7 +34,7 @@ .\" .\" @(#)boot_x68k.8 8.2 (Berkeley) 4/19/94 .\" -.Dd Jun 16, 1996 +.Dd June 16, 1996 .Dt BOOT_X68K 8 x68k .Os .Sh NAME @@ -42,40 +42,44 @@ .Nd system bootstrapping procedures .Sh DESCRIPTION -.Sy Power fail and crash recovery. +.Ss Power fail and crash recovery +.Pp Normally, the system will reboot itself at power-up or after crashes. An automatic consistency check of the file systems will be performed, and unless this fails, the system will resume multi-user operations. .Pp -.Sy Cold starts. +.Ss Cold starts +.Pp The X68000/X68030 system boots from the device which is determined by the configuration of battery-backuped SRAM. -By default, the boot rom attempt to boot from +By default, the boot ROM attempts to boot from a floppy disk drive (from 0 to 3) first, -and then attempt to boot from hard disk (SASI or SCSI). -On the OpenBSD/X68k, booting from partition A of SCSI disks (sd?a) +and then from a hard disk (SASI or SCSI). +On the OpenBSD/X68k, booting from partition ``a'' of SCSI disks (sd?a) and 2HD floppy disks (fd?a, fd?c) is currently supported. .Pp First, the initial program loader of IOCS ROM or SCSI disk -(or equivalent) reads -.Pa boot +(or equivalent) reads the +.Nm boot program at the top of the disk, -and then the boot program loads the OpenBSD kernel +and then the +.Nm boot +program loads the OpenBSD kernel .Pa /bsd which is in the same partition of the disk. -If you press -.Pa [SHIFT] -key when booting, the boot program enables you to change +If you press the +.Sq SHIFT +key when booting, the boot program enables you to change the boot flag .Dv RB_SINGLE with the -.Pa [SHIFT] +.Sq SHIFT key, and to choose which kernel to be used with arrow keys. -If the LED of -.Pa [HIRAGANA] -key is turned on, the boot program adds +If the LED of the +.Sq HIRAGANA +key is turned on, the boot program adds the .Dv RB_KDB flag and tries to boot the system in debug mode; see .Xr ddb 8 @@ -87,9 +91,9 @@ other operating systems such as Human68k and OS-9. .Pp Note for X68030/040turbo(68040 accelerator by BEEPs) systems: OpenBSD can boot under 040 mode. -It can also boot under 030 mode if you have MC68030 on the board. +It can also boot under 030 mode if you have an MC68030 on the board. .Pp -Note for X68000/Xellent30(68030 accelerator by TSR)+MC68030 systems: +Note for X68000/Xellent30(68030 accelerator by TSR) + MC68030 systems: In order to boot OpenBSD, you must choose 030 mode by using .Pa CH30.SYS , which must reside in the battery-backuped SRAM. diff --git a/sbin/reboot/reboot.8 b/sbin/reboot/reboot.8 index 708a0caf354..02d29565974 100644 --- a/sbin/reboot/reboot.8 +++ b/sbin/reboot/reboot.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: reboot.8,v 1.9 1998/07/24 00:43:51 espie Exp $ +.\" $OpenBSD: reboot.8,v 1.10 1998/09/17 04:15:01 aaron Exp $ .\" $NetBSD: reboot.8,v 1.3 1995/10/05 05:36:21 mycroft Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 @@ -53,42 +53,28 @@ The and .Nm reboot utilities flush the file system cache to disk, run the system -shutdown script, send all running processes a SIGTERM (and -subsequently a SIGKILL) and, respectively, halt or restart the system. +shutdown script, send all running processes a +.Dv SIGTERM +.Pq and subsequently a Dv SIGKILL , +and, respectively, halt or restart the system. The action is logged, including entering a shutdown record into the login accounting file. .Pp The options are as follows: .Bl -tag -width Ds .It Fl d -If the -.Fl d -option is specified, -system will dump crash into swap partition. +Causes system to create a dump before rebooting. +This option is useful for debugging system dump procedures or +capturing the state of a corrupted or misbehaving system. .It Fl n -If the -.Fl n -option is specified, -the file system cache is not flushed. +Prevent file system cache from being flushed. This option should probably not be used. .It Fl q -If the -.Fl q -option is specified, -the system is halted or restarted quickly and ungracefully, and only +Quick. The system is halted or restarted quickly and ungracefully, and only the flushing of the file system cache is performed. This option should probably not be used. -.It Fl d -If the -.Fl d -option is specified, -the system will create a dump before rebooting. -This option is useful for debugging system dump procedures or -capturing the state of a corrupted or misbehaving system. .It Fl p -The -.Fl p -option causes the system to power down, if it is being halted, and the +Causes the system to power down, if it is being halted, and the hardware supports automatic power down. (Currently supported on some i386 and sparc platforms.) .El @@ -98,8 +84,9 @@ Normally, the utility is used when the system needs to be halted or restarted, giving users advance warning of their impending doom. .Sh FILES -.Pa /etc/rc.shutdown -- The script which is run at shutdown time. +.Bl -width /etc/rc.shutdown -compact +/etc/rc.shutdown +script which is run at shutdown time .Sh SEE ALSO .Xr sync 8 , .Xr utmp 5 , diff --git a/sbin/restore/restore.8 b/sbin/restore/restore.8 index d43208b3ce0..0eac9fc76a8 100644 --- a/sbin/restore/restore.8 +++ b/sbin/restore/restore.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: restore.8,v 1.8 1998/01/10 13:48:58 deraadt Exp $ +.\" $OpenBSD: restore.8,v 1.9 1998/09/17 04:15:01 aaron Exp $ .\" $NetBSD: restore.8,v 1.15 1997/07/01 05:37:53 lukem Exp $ .\" .\" Copyright (c) 1985, 1991, 1993 @@ -65,19 +65,19 @@ .Op Fl b Ar blocksize .Op Fl f Ar file .Op Fl s Ar fileno -.Op file ... +.Op Ar file Ar ... .Nm restore .Fl x .Op Fl chmvy .Op Fl b Ar blocksize .Op Fl f Ar file .Op Fl s Ar fileno -.Op file ... +.Op Ar file Ar ... .Pp .in -\\n(iSu (The .Bx 4.3 -option syntax is implemented for backward compatibility, but +option syntax is implemented for backward compatibility but is not documented here.) .Sh DESCRIPTION The @@ -139,12 +139,12 @@ The most expedient way to extract most of the files from a directory is to add the directory to the extraction list and then delete those files that are not needed. .It Ic extract -All the files that are on the extraction list are extracted +All files on the extraction list are extracted from the dump. .Nm will ask which volume the user wishes to mount. The fastest way to extract a few files is to -start with the last volume, and work towards the first volume. +start with the last volume and work towards the first volume. .It Ic help List a summary of the available commands. .It Ic \&ls Op Ar arg @@ -152,14 +152,14 @@ List the current or specified directory. Entries that are directories are appended with a ``/''. Entries that have been marked for extraction are prepended with a ``*''. If the verbose -flag is set the inode number of each entry is also listed. +flag is set, the inode number of each entry is also listed. .It Ic pwd Print the full pathname of the current working directory. .It Ic quit Restore immediately exits, even if the extraction list is not empty. .It Ic setmodes -All the directories that have been added to the extraction list +All directories that have been added to the extraction list have their owner, modes, and times set; nothing is extracted from the dump. This is useful for cleaning up after a restore has been prematurely aborted. @@ -176,17 +176,17 @@ to print out information about each file as it is extracted. .El .It Fl R .Nm -requests a particular tape of a multi volume set on which to restart +requests a particular tape of a multi-volume set on which to restart a full restore (see the .Fl r flag below). This is useful if the restore has been interrupted. .It Fl r -Restore (rebuild a file system). +Restore (rebuild) a file system. The target file system should be made pristine with .Xr newfs 8 , -mounted and the user +mounted, and the user .Xr cd Ns 'd into the pristine file system before starting the restoration of the initial level 0 backup. If the @@ -197,8 +197,8 @@ any necessary incremental backups on top of the level 0. The .Fl r flag precludes an interactive file extraction and can be -detrimental to one's health if not used carefully (not to mention -the disk). An example: +detrimental to one's health (not to mention the disk) if not used carefully. +An example: .Bd -literal -offset indent newfs /dev/rrp0g eagle mount /dev/rp0g /mnt @@ -227,7 +227,7 @@ such as size or block size. The names of the specified files are listed if they occur on the backup. If no file argument is given, -then the root directory is listed, +the root directory is listed, which results in the entire content of the backup being listed, unless the @@ -250,7 +250,7 @@ the directory is recursively extracted. The owner, modification time, and mode are restored (if possible). If no file argument is given, -then the root directory is extracted, +the root directory is extracted, which results in the entire content of the backup being extracted, unless the @@ -290,7 +290,7 @@ or .Ql Fl (the standard input). If the name of the file is of the form -.Dq host:file , +.Dq host:file or .Dq user@host:file , .Nm @@ -353,7 +353,7 @@ Most checks are self-explanatory or can ``never happen''. Common errors are given below. .Pp .Bl -tag -width Ds -compact -.It Converting to new file system format. +.It Converting to new file system format A dump tape created from the old file system has been loaded. It is automatically converted to the new file system format. .Pp @@ -368,12 +368,12 @@ A file that was not listed in the directory showed up. This can occur when using a dump created on an active file system. .Pp .It Incremental dump too low -When doing incremental restore, +When doing an incremental restore, a dump that was written before the previous incremental dump, or that has too low an incremental level has been loaded. .Pp .It Incremental dump too high -When doing incremental restore, +When doing an incremental restore, a dump that does not begin its coverage where the previous incremental dump left off, or that has too high an incremental level has been loaded. @@ -383,9 +383,9 @@ or that has too high an incremental level has been loaded. .It Tape read error while trying to resynchronize A tape (or other media) read error has occurred. If a file name is specified, -then its contents are probably partially wrong. +its contents are probably partially wrong. If an inode is being skipped or the tape is trying to resynchronize, -then no extracted files have been corrupted, +no extracted files have been corrupted, though files may not be found on the tape. .Pp .It resync restore, skipped <num> blocks @@ -397,9 +397,12 @@ This message lists the number of blocks that were skipped over. .Sh ENVIRONMENT If the following environment variable exists it will be utilized by .Nm restore : +.Pp .Bl -tag -width "TMPDIR" -compact -.It TMPDIR -The directory given in TMPDIR will be used +.It Ev TMPDIR +The directory given in +.Ev TMPDIR +will be used instead of .Pa /tmp to store temporary files. @@ -412,13 +415,13 @@ for more information. .It Pa /dev/rst0 the default tape drive .It Pa /dev/rst* -Raw SCSI tape interface +raw SCSI tape interface .It Pa /tmp/rstdir* -file containing directories on the tape. +file containing directories on the tape .It Pa /tmp/rstmode* -owner, mode, and time stamps for directories. +owner, mode, and time stamps for directories .It Pa \&./restoresymtable -information passed between incremental restores. +information passed between incremental restores .El .Sh SEE ALSO .Xr environ 7 , @@ -431,7 +434,7 @@ information passed between incremental restores. can get confused when doing incremental restores from dumps that were made on active file systems. .Pp -A level zero dump must be done after a full restore. +A level 0 dump must be done after a full restore. Because .Nm runs in user code, @@ -447,7 +450,7 @@ and are generated with a unique name based on the date of the dump and the process ID (see .Xr mktemp 3 ), -except for when +except when .Fl r or .Fl R diff --git a/sbin/route/route.8 b/sbin/route/route.8 index e7dedf44f5e..b7083694166 100644 --- a/sbin/route/route.8 +++ b/sbin/route/route.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: route.8,v 1.7 1998/01/15 17:22:32 niklas Exp $ +.\" $OpenBSD: route.8,v 1.8 1998/09/17 04:15:01 aaron Exp $ .\" $NetBSD: route.8,v 1.6 1995/03/18 15:00:13 cgd Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -39,7 +39,7 @@ .Os BSD 4.4 .Sh NAME .Nm route -.Nd manually manipulate the routing tables. +.Nd manually manipulate the routing tables .Sh SYNOPSIS .Nm route .Op Fl dnqv @@ -49,7 +49,7 @@ .Ar args .Oc .Sh DESCRIPTION -.Nm Route +.Nm route is a utility used to manually manipulate the network routing tables. It normally is not needed, as a system routing table management daemon such as @@ -57,9 +57,9 @@ system routing table management daemon such as should tend to this task. .Pp The -.Nm route : +.Nm route utility supports a limited number of general options, -but a rich command language, enabling the user to specify +but a rich command language enables the user to specify any arbitrary request that could be delivered via the programmatic interface discussed in .Xr route 4 . @@ -72,7 +72,7 @@ Bypasses attempts to print host and network names symbolically when reporting actions. (The process of translating between symbolic names and numerical equivalents can be quite time consuming, and may require correct operation of the network; thus it may be expedient -to forgo this, especially when attempting to repair networking operations). +to forgo this, especially when attempting to repair networking operations.) .It Fl v (verbose) Print additional details. .It Fl q @@ -80,7 +80,7 @@ Suppress all output. .El .Pp The -.Nm route : +.Nm route utility provides several commands: .Pp .Bl -tag -width Fl -compact @@ -142,12 +142,13 @@ The other commands have the following syntax: .Pp where .Ar destination -is the destination host or network, +is the destination host or network and .Ar gateway is the next-hop intermediary via which packets should be routed. Routes to a particular host may be distinguished from those to a network by interpreting the Internet address specified as the -.Ar destination argument. +.Ar destination +argument. The optional modifiers .Fl net and @@ -156,7 +157,7 @@ force the destination to be interpreted as a network or a host, respectively. Otherwise, if the .Ar destination has a ``local address part'' of -INADDR_ANY , +INADDR_ANY, or if the .Ar destination is the symbolic name of a network, then the route is @@ -280,7 +281,7 @@ If this lookup fails, .Xr getnetbyname 3 is then used to interpret the name as that of a network. .Pp -.Nm Route +.Nm route uses a routing socket and the new message types RTM_ADD, RTM_DELETE, @@ -313,10 +314,14 @@ An attempt to add a route failed because the gateway listed was not on a directly-connected network. The next-hop gateway must be given. .It Sy "not in table" -A delete operation was attempted for an entry which +A +.Cm delete +operation was attempted for an entry which wasn't present in the tables. .It Sy "routing table overflow" -An add operation was attempted, but the system was +An +.Cm add +operation was attempted, but the system was low on resources and was unable to allocate memory to create the new entry. .El @@ -325,7 +330,7 @@ to create the new entry. .Xr route 4 , .Xr esis 4 , .Xr routed 8 , -.Xr XNSrouted 8 +.Xr XNSrouted 8 , .Xr IPXrouted 8 .Sh HISTORY The diff --git a/sbin/routed/routed.8 b/sbin/routed/routed.8 index 002d91fbcc0..986d745c84c 100644 --- a/sbin/routed/routed.8 +++ b/sbin/routed/routed.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: routed.8,v 1.14 1998/08/29 21:11:09 deraadt Exp $ +.\" $OpenBSD: routed.8,v 1.15 1998/09/17 04:15:01 aaron Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -49,7 +49,7 @@ .Oc .Op Fl P Ar parms .Sh DESCRIPTION -.Nm Routed +.Nm routed is a dameon invoked at boot time to manage the network routing tables. It uses Routing Information Protocol, RIPv1 (RFC\ 1058), @@ -79,7 +79,7 @@ When started (or when a network interface is later turned on), .Nm uses an AF_ROUTE address family facility to find those directly connected interfaces configured into the -system and marked "up". +system and marked ``up''. It adds necessary routes for the interfaces to the kernel routing table. Soon after being first started, and provided there is at least one @@ -232,21 +232,21 @@ Options supported by .Nm routed : .Bl -tag -width Ds .It Fl s -this option forces +Forces .Nm to supply routing information. This is the default if multiple network interfaces are present on which RIP or Router Discovery have not been disabled, and if the kernel switch ipforwarding=1. .It Fl q -is the opposite of the +Opposite of the .Fl s option. .It Fl d Do not run in the background. This option is meant for interactive use. .It Fl g -This flag is used on internetwork routers to offer a route +Used on internetwork routers to offer a route to the "default" destination. It is equivalent to .Fl F @@ -268,13 +268,13 @@ Notice that because a metric of 1 is used, this feature is dangerous. It is more commonly accidentally used to create chaos with routing loop than to solve problems. .It Fl h -This causes host or point-to-point routes to not be advertised, +Causes host or point-to-point routes to not be advertised, provided there is a network route going the same direction. That is a limited kind of aggregation. This option is useful on gateways to ethernets that have other gateway machines connected with point-to-point links such as SLIP. .It Fl m -This causes the machine to advertise a host or point-to-point route to +Causes the machine to advertise a host or point-to-point route to its primary interface. It is useful on multi-homed machines such as NFS servers. This option should not be used except when the cost of @@ -288,33 +288,33 @@ option overrides the .Fl q option to the limited extent of advertising the host route. .It Fl A -do not ignore RIPv2 authentication if we do not care about RIPv2 +Do not ignore RIPv2 authentication if we do not care about RIPv2 authentication. This option is required for conformance with RFC 1723. However, it makes no sense and breaks using RIP as a discovery protocol to ignore all RIPv2 packets that carry authentication when this machine does not care about authentication. .It Fl T Ar tracefile -increases the debugging level to at least 1 and +Increases the debugging level to at least 1 and causes debugging information to be appended to the trace file. Note that because of security concerns, it is wisest to not run .Nm routed routinely with tracing directed to a file. .It Fl t -increases the debugging level, which causes more information to be logged +Increases the debugging level, which causes more information to be logged on the tracefile specified with .Fl T or standard out. The debugging level can be increased or decreased with the -.Em SIGUSR1 +.Dv SIGUSR1 or -.Em SIGUSR2 +.Dv SIGUSR2 signals or with the .Xr rtquery command. .It Fl F Ar net[/mask][,metric] -minimize routes in transmissions via interfaces with addresses that match +Minimize routes in transmissions via interfaces with addresses that match .Em net/mask , and synthesizes a default route to this machine with the .Em metric . @@ -333,7 +333,7 @@ number and mask. See also .Fl g . .It Fl P Ar parms -is equivalent to adding the parameter +Equivalent to adding the parameter line .Em parms to the @@ -366,9 +366,11 @@ only information from a routing socket, to discover if some of the local gateways are .Em passive , and to obtain other parameters. -Gateways specified in this manner should be marked passive +Gateways specified in this manner should be marked +.Em passive if they are not expected to exchange routing information, -while gateways marked active +while gateways marked +.Em active should be willing to exchange RIP packets. Routes through .Em passive @@ -376,7 +378,9 @@ gateways are installed in the kernel's routing tables once upon startup and are not included in transmitted RIP responses. .Pp -Distant active gateways are treated like network interfaces. +Distant +.Em active +gateways are treated like network interfaces. RIP responses are sent to the distant .Em active @@ -460,7 +464,7 @@ with is the name or address of the gateway to which RIP responses should be forwarded. .Pp -.Ar Value +.Ar value is the hop count to the destination host or network. .Ar " host hname " is equivalent to @@ -485,11 +489,11 @@ or more of the following parameter settings, separated by commas or blanks: .Bl -tag -width Ds .It Cm if Ns \&= Ns Ar ifname -indicates that the other parameters on the line apply to the interface +Indicates that the other parameters on the line apply to the interface name .Ar ifname . .It Cm subnet Ns \&= Ns Ar nname[/mask][,metric] -advertises a route to network +Advertises a route to network .Ar nname with mask .Ar mask @@ -499,19 +503,21 @@ This parameter must appear by itself on a line. .Pp Do not use this feature unless necessary. It is dangerous. .It Cm passwd Ns \&= Ns Ar XXX -specifies a RIPv2 password that will be included on all RIPv2 +Specifies a RIPv2 password that will be included on all RIPv2 responses sent and checked on all RIPv2 responses received. The password must not contain any blanks, tab characters, commas -or '#' characters. +or +.Sq # +characters. .It Cm no_ag -turns off aggregation of subnets in RIPv1 and RIPv2 responses. +Turns off aggregation of subnets in RIPv1 and RIPv2 responses. .It Cm no_super_ag -turns off aggregation of networks into supernets in RIPv2 responses. +Turns off aggregation of networks into supernets in RIPv2 responses. .It Cm passive -is equivalent +Equivalent to .Cm no_rip Cm no_rdisc . .It Cm no_rip -disables all RIP processing on the specified interface. +Disables all RIP processing on the specified interface. If no interfaces are allowed to process RIP packets, .Nm acts purely as a router discovery daemon. @@ -524,45 +530,45 @@ discovery advertisements with .Cm rdisc_adv or .Fl s -causes +Causes .Nm routed to act as a client router discovery daemon, not advertising. .It Cm no_ripv1_in -causes RIPv1 received responses to be ignored. +Causes RIPv1 received responses to be ignored. .It Cm no_ripv2_in -causes RIPv2 received responses to be ignored. +Causes RIPv2 received responses to be ignored. .It Cm ripv2_out -turns off RIPv1 output and causes RIPv2 advertisements to be +Turns off RIPv1 output and causes RIPv2 advertisements to be multicast when possible. .It Cm no_rdisc -disables the Internet Router Discovery Protocol. +Disables the Internet Router Discovery Protocol. .It Cm no_solicit -disables the tranmission of Router Discovery Solicitations. +Disables the tranmission of Router Discovery Solicitations. .It Cm send_solicit -specifies that Router Discovery solicitations should be sent, +Specifies that Router Discovery solicitations should be sent, even on point-to-point links, which by default only listen to Router Discovery messages. .It Cm no_rdisc_adv -disables the transmission of Router Discovery Advertisements. +Disables the transmission of Router Discovery Advertisements. .It Cm rdisc_adv -specifies that Router Discovery advertisements should be sent, +Specifies that Router Discovery advertisements should be sent, even on point-to-point links, which by default only listen to Router Discovery messages. .It Cm bcast_rdisc -specifies that Router Discovery packets should be broadcast instead of +Specifies that Router Discovery packets should be broadcast instead of multicast. .It Cm rdisc_pref Ns \&= Ns Ar N -sets the preference in Router Discovery Advertisements to the integer +Sets the preference in Router Discovery Advertisements to the integer .Ar N . .It Cm rdisc_interval Ns \&= Ns Ar N -sets the nominal interval with which Router Discovery Advertisements +Sets the nominal interval with which Router Discovery Advertisements are transmitted to N seconds and their lifetime to 3*N. .It Cm fake_default Ns \&= Ns Ar metric -has an identical effect to +Has an identical effect to .Fl F Ar net[/mask][,metric] with the network and mask coming from the specified interface. .It Cm pm_rdisc -is similar to +Similar to .Cm fake_default . When RIPv2 routes are multicast, so that RIPv1 listeners cannot receive them, this feature causes a RIPv1 default route to be @@ -587,7 +593,7 @@ for distant gateways .Xr gated 8 , .Xr udp 4 , .Xr icmp 4 , -.Xr rtquery 8 . +.Xr rtquery 8 .Rs .%T Internet Transport Protocols .%R XSIS 028112 diff --git a/sbin/savecore/savecore.8 b/sbin/savecore/savecore.8 index 91e883c63ea..9dae02c70db 100644 --- a/sbin/savecore/savecore.8 +++ b/sbin/savecore/savecore.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: savecore.8,v 1.4 1998/03/26 00:06:31 deraadt Exp $ +.\" $OpenBSD: savecore.8,v 1.5 1998/09/17 04:15:02 aaron Exp $ .\" $NetBSD: savecore.8,v 1.11 1995/06/27 22:40:46 briggs Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -48,7 +48,7 @@ .Op Fl N Ar system .Ar directory .Sh DESCRIPTION -.Nm Savecore +.Nm savecore copies the currently running kernel and its associated core dump into .Fa directory , and enters a reboot message and information about the core dump into @@ -74,7 +74,7 @@ Compresses the core dump and kernel (see .Xr compress 1 ). .El .Pp -.Nm Savecore +.Nm savecore checks the core dump in various ways to make sure that it is current and that it corresponds to the currently running system. If it passes these checks, it saves the core image in @@ -94,7 +94,7 @@ and it is incremented and stored back into the file each time .Nm savecore successfully runs. .Pp -.Nm Savecore +.Nm savecore also checks the available disk space before attempting to make the copies. If there is insufficient disk space in the filesystem containing .Ar directory , @@ -111,7 +111,7 @@ so that future invocations of .Nm savecore will ignore it. .Pp -.Nm Savecore +.Nm savecore is meant to be called near the end of the initialization file .Pa /etc/rc (see diff --git a/sbin/scan_ffs/scan_ffs.8 b/sbin/scan_ffs/scan_ffs.8 index 643b90bc720..cde686d71e4 100644 --- a/sbin/scan_ffs/scan_ffs.8 +++ b/sbin/scan_ffs/scan_ffs.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: scan_ffs.8,v 1.3 1998/09/07 16:44:34 aaron Exp $ +.\" $OpenBSD: scan_ffs.8,v 1.4 1998/09/17 04:15:02 aaron Exp $ .\" .\" Copyright (c) 1997 Niklas Hallqvist, Tobias Weingartner .\" All rights reserved. @@ -109,7 +109,7 @@ disklabel of the disk. .Pp .It Create a disklabel on the affected disk, which covers the whole disk, and has -at least one partition which covers the whole disk. As the 'c' partition +at least one partition which covers the whole disk. As the ``c'' partition usually covers the whole disk anyways, this sounds like a good place to start. .Pp .It diff --git a/sbin/scsi/scsi.8 b/sbin/scsi/scsi.8 index e006a6e4534..462fd84a4f1 100644 --- a/sbin/scsi/scsi.8 +++ b/sbin/scsi/scsi.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: scsi.8,v 1.4 1997/07/05 05:22:06 millert Exp $ +.\" $OpenBSD: scsi.8,v 1.5 1998/09/17 04:15:02 aaron Exp $ .\" $FreeBSD: scsi.8,v 1.5 1995/05/05 20:41:58 dufault Exp $ .\" .\" Written By Julian ELischer @@ -45,60 +45,88 @@ .Os .Sh NAME .Nm scsi -.Nd program to assist with scsi devices. +.Nd program to assist with SCSI devices .Sh SYNOPSIS -.Bd -literal -offset -Usage: -scsi -f device -d debug_level # To set debug level -scsi -f device [-v] -z seconds # To freeze bus -scsi -f device -m page [-P pc] [-e] # To read mode pages -scsi -f device -p [-b bus] [-l lun] # To probe all devices -scsi -f device -r [-b bus] [-t targ] [-l lun] # To reprobe a device -scsi -f device [-v] [-s seconds] -c cmd_fmt [arg0 ... argn] # A command... - -o count out_fmt [arg0 ... argn] # EITHER (for data out) - -i count in_fmt # OR (for data in) -.Pp -"out_fmt" can be "-" to read output data from stdin; -"in_fmt" can be "-" to write input data to stdout; -.Pp -If debugging is not compiled in the kernel, "-d" will have no effect -.Ed +.Nm scsi +.Fl f Ar device +.Fl d Ar debug_level +.Nm scsi +.Fl f Ar device +.Op Fl v +.Fl z Ar seconds +.Nm scsi +.Fl f Ar device +.Fl m Ar page +.Op Fl P Ar pc +.Op Fl e +.Nm scsi +.Fl f Ar device +.Fl p +.Op Fl b Ar bus +.Op Fl l Ar lun +.Nm scsi +.Fl f Ar device +.Fl r +.Op Fl b Ar bus +.Op Fl t Ar targ +.Op Fl l Ar lun +.Nm scsi +.Fl f Ar device +.Op Fl v +.Op Fl s Ar seconds +.Fl c Ar cmd_fmt +.Op Ar arg ... +.Fl o Ar count out_fmt +.Op Ar arg ... +.Fl i Ar count in_fmt +.Pp +.in -\\n(iSu +.Ar out_fmt +can be +.Sq - +to read output data from stdin; +.Ar in_fmt +can be +.Sq - +to write input data to stdout. +.Pp +If debugging is not compiled in the kernel, +.Fl d +will have no effect. .Sh DESCRIPTION The .Nm scsi -program is used to send commands to a scsi device. It is also -a sample usage of the user level SCSI commands. +program is used to send commands to a SCSI device. It is also +a sample usage of the user-level SCSI commands. .Pp -The -.Fr -d -option sets the SCSI kernel debug level. The kernel must have been compiled -with the -.Em SCSIDEBUG +The following options are available: +.Bl -tag -width Ds +.It Fl d Ar debug_level +Sets the SCSI kernel debug level. The kernel must have been compiled +with the SCSIDEBUG option. See -.Fr /sys/scsi/scsi_debug.h +.Pa /sys/scsi/scsi_debug.h to figure out what to set the kernel debug level to. .Pp -The -.Fr -z -option freezes all activity on all SCSI busses for a given number of +.It Fl z Ar seconds +Freezes all activity on all SCSI busses for a given number of seconds. If -.Fr -v -is also specified then a BEL character is sent to the standard +.Fl v +is also specified, a BEL character is sent to the standard output at the start and finish of the bus freeze. This requires that the kernel be built with the SCSI_FREEZE kernel option. This kernel code is not committed yet. .Pp -The -.Fr -m -option is used to read a device mode page. The file -.Fr /usr/share/misc/scsi_modes -is read to look at for how to interpret the mode data. The environment -variable SCSI_MODES can specify a different file to use. +.It Fl m Ar page +Read a device mode page. The file +.Pa /usr/share/misc/scsi_modes +is read to discover how to interpret the mode data. The environment +variable +.Ev SCSI_MODES +can specify a different file to use. .Pp -.in +.25i -The -.Fr -P -option can be used to specify a page control field. The page control +.It Fl P Ar pc +Specify a page control field. The page control fields are .Bd -literal -offset 0 Current Values @@ -107,40 +135,44 @@ fields are 3 Saved Values .Ed .Pp -The -.Fr -e -option permits you to edit the fields. It will use the editor specified -by your EDITOR environment variable. To store changes permanently, +.It Fl e +Permits you to edit the fields. It will use the editor specified +by your +.Ev EDITOR +environment variable. To store changes permanently, edit page control 3 using the -.Fr -P +.Fl P flag. -.in -.25i .Pp +.It Fl p +Can be used against the "super scsi" device +.Pa /dev/scsi/super +to probe all devices with a given SCSI +.Ar lun +on a given SCSI bus. The -.Fr -p -option can be used against the "super scsi" device -.Fr /dev/scsi/super -to probe all devices with a given SCSI lun on a given SCSI bus. -The bus can be selected with the -b option and the default is 0. -The lun can be selected with the -l option and the default is 0. +.Ar bus +can be selected with the -b option and the default is 0. +The +.Ar lun +can be selected with the -l option and the default is 0. See .Xr scsi 4 for a description of the "super scsi" device. .Pp -The -.Fr -r -option can be used in FreeBSD 1.1 to reprobe a specific SCSI device at a given +.It Fl r +Can be used in FreeBSD 1.1 to reprobe a specific SCSI device at a given Bus, Target and Lun. This is not needed in FreeBSD 2.1, since opening a fixed SCSI device has the side effect of reprobing it, and probing with the bus with the --p option should bring on line any newly found devices. +.Fl p +option should bring on line any newly found devices. See .Xr scsi 4 -for a description of fixed scsi devices. +for a description of fixed SCSI devices. .Pp -The -.Fr -c -option permits you to send user level SCSI commands specified on +.It Fl c +Permits you to send user-level SCSI commands specified on the command line to a device. The command is sent using the SCIOCCOMMAND ioctl, so the device you are accessing must permit this ioctl. See @@ -149,46 +181,50 @@ for full details of which minor devices permit the ioctl, and .Xr scsi 3 for the full details on how to build up the commands and data phases using the format arguments. -.in +.25i .Pp -.Fr -v -turns on more verbose information. +.It Fl v +Turns on more verbose information. .Pp -.Fr -s -sets the command timeout in seconds. The default is two seconds. +.It Fl s Ar seconds +Sets the command timeout to +.Ar seconds . +The default is two seconds. .Pp -.Fr "-c cmd_fmt" -specifies the command as described in +.It Fl c Ar cmd_fmt +Specifies the command as described in .Xr scsi 3 "." The additional arguments provide values for any variables specified in the command format. .Pp -.Fr "-o count out_fmt arg0 ... argn" -indicates that this is a data out command (i.e., data will be sent from +.It Fl o Ar count out_fmt arg ... +Indicates that this is a data out command (i.e., data will be sent from the system to the device) with -.Fr count +.Ar count bytes of data. The data out is built up using the facilities described in .Xr scsi 3 using the provided arguments to fill in any integer variables. -.Fr out_fmt -can be specified as a hyphen ("-") to indicate that the -.Fr count +.Ar out_fmt +can be specified as a hyphen +.Pq Sq - +to indicate that the +.Ar count bytes of data should be read from the standard input. .Pp -.Fr "-i count in_fmt" -indicates that this is a data in command (i.e., data will be read from +.It Fl i Ar count in_fmt arg ... +Indicates that this is a data in command (i.e., data will be read from the device into the system) with -.Fr count +.Ar count bytes of data read in. The information is extracted according to -.Fr in_fmt +.Ar in_fmt using the facilities described in .Xr scsi 3 and displayed on the standard output. -.Fr in_fmt -can be specified as a hyphen ("-") to indicate that the -.Fr count +.Ar in_fmt +can be specified as a hyphen +.Pq Sq - +to indicate that the +.Ar count bytes of data input should be written to the standard output. -.in -.25i .Sh EXAMPLES To verify that the device type for the disk /dev/rsd0c is 0 (direct access device): @@ -202,34 +238,42 @@ To do an inquiry to /dev/rsd2c: root# scsi -f /dev/rsd2c -c "12 0 0 0 64 0" -i 64 "s8 z8 z16 z4" FUJITSU M2654S-512 010P .Pp -To edit mode page 1 on /dev/rsd2c, and store it permanently on the +To edit mode page 1 on /dev/rsd2c and store it permanently on the drive (set AWRE and ARRE to 1 to enable bad block remapping): .Bd -literal -offset root# scsi -f /dev/rsd2c -m 1 -e -P 3 .Ed .Pp .Sh ENVIRONMENT -The SU_DEBUG_OUTPUT variable can be set to a file to send debugging +The +.Ev SU_DEBUG_OUTPUT +variable can be set to a file to send debugging output to that file. .Pp -The SU_DEBUG_LEVEL variable can be set to a non-zero integer to increase +The +.Ev SU_DEBUG_LEVEL +variable can be set to a non-zero integer to increase the level of debugging. Currently this is a on or off thing; it should perhaps use the ioctl to set the debug level in the kernel and then set it back to zero at program exit. .Pp -The SU_DEBUG_TRUNCATE variable can be set to an integer to limit the +The +.Ev SU_DEBUG_TRUNCATE +variable can be set to an integer to limit the amount of data phase output sent to the debugging file. .Pp -The EDITOR variable determines the editor to use for the mode editor. +The +.Ev EDITOR +variable determines the editor to use for the mode editor. .Sh SEE ALSO .Xr scsi 4 , .Xr scsi 3 .Sh BUGS -.Pp Some devices respond to an inquiry for all LUNS. This will cause them to come on line to 8 times during reprobe to different logical units. "scsi -f /dev/rsd0c -c "4 0 0 0 0 0" permits anyone who can write to -/dev/rsd0c to format the disk drive. +.Pa /dev/rsd0c +to format the disk drive. .Sh HISTORY The .Nm scsi diff --git a/sbin/shutdown/shutdown.8 b/sbin/shutdown/shutdown.8 index 78b1a27fbe9..68f9e9e7c00 100644 --- a/sbin/shutdown/shutdown.8 +++ b/sbin/shutdown/shutdown.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: shutdown.8,v 1.7 1997/10/02 14:37:34 downsj Exp $ +.\" $OpenBSD: shutdown.8,v 1.8 1998/09/17 04:15:02 aaron Exp $ .\" $NetBSD: shutdown.8,v 1.6 1995/03/18 15:01:07 cgd Exp $ .\" .\" Copyright (c) 1988, 1991, 1993 @@ -47,7 +47,7 @@ .Ar time .Op Ar warning-message ... .Sh DESCRIPTION -.Nm Shutdown +.Nm shutdown provides an automated shutdown procedure for super-users to nicely notify users when the system is shutting down, saving them from system administrators, hackers, and gurus, who @@ -58,11 +58,12 @@ Available friendlinesses: .It Fl d The system will perform a crash dump. .It Fl f -.Nm Shutdown +.Nm shutdown arranges, in the manner of .Xr fastboot 8 , for the file systems -.Em not to be +.Em not +to be checked on reboot. .It Fl h The system is halted at the specified @@ -72,7 +73,7 @@ when execs .Xr halt 8 . .It Fl k -Kick every body off. +Kick everybody off. The .Fl k option @@ -83,7 +84,7 @@ Prevent the normal .Xr sync 2 before stopping. .It Fl r -.Nm Shutdown +.Nm shutdown execs .Xr reboot 8 at the specified @@ -96,7 +97,7 @@ flag is passed on to causing machines which support automatic power down to do so after halting. (Currently supported on some i386 and sparc platforms.) .It Ar time -.Ar Time +.Ar time is the time at which .Nm shutdown will bring the system down and diff --git a/sbin/slattach/slattach.8 b/sbin/slattach/slattach.8 index e78307c8b56..800ec04f87b 100644 --- a/sbin/slattach/slattach.8 +++ b/sbin/slattach/slattach.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: slattach.8,v 1.3 1997/10/16 20:20:48 angelos Exp $ +.\" $OpenBSD: slattach.8,v 1.4 1998/09/17 04:15:02 aaron Exp $ .\" $NetBSD: slattach.8,v 1.12 1995/03/18 15:01:12 cgd Exp $ .\" .\" Copyright (c) 1986, 1991, 1993 @@ -46,7 +46,7 @@ .Op Fl s Ar baudrate .Ar ttyname .Sh DESCRIPTION -.Nm Slattach +.Nm slattach is used to assign a tty line to a network interface, and to define the network source and destination addresses. The following operands are supported by @@ -62,7 +62,7 @@ Specifies the speed of the connection. If not specified, the default of 9600 is used. .It Ar ttyname Specifies the name of the tty device. -.Ar Ttyname +.Ar ttyname should be a string of the form .Ql ttyXX , or @@ -95,7 +95,7 @@ To detach the interface, use after killing off the .Nm slattach process. -.Ar Interface-name +.Ar interface-name is the name that is shown by .Xr netstat 1 . .Sh EXAMPLES diff --git a/sbin/swapon/swapon.8 b/sbin/swapon/swapon.8 index 4360f99a7af..ed14c6e9dad 100644 --- a/sbin/swapon/swapon.8 +++ b/sbin/swapon/swapon.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: swapon.8,v 1.3 1997/08/25 20:45:10 millert Exp $ +.\" $OpenBSD: swapon.8,v 1.4 1998/09/17 04:15:03 aaron Exp $ .\" $NetBSD: swapon.8,v 1.8 1995/08/18 14:51:35 pk Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -46,7 +46,7 @@ .Nm swapon .Ar special_file ... .Sh DESCRIPTION -.Nm Swapon +.Nm swapon is used to specify additional devices on which paging and swapping are to take place. The system begins by swapping and paging on only a single device @@ -70,19 +70,19 @@ are made available. The second form gives individual block devices as given in the system swap configuration table. The call makes only this space available to the system for swap allocation. -.Sh SEE ALSO -.Xr swapon 2 , -.Xr fstab 5 , -.Xr init 8 , -.Xr rc 8 , -.Xr vnconfig 8 .Sh FILES .Bl -tag -width /dev/[ru][pk]?b -compact .It Pa /dev/[ru][pk]?b standard paging devices .It Pa /etc/fstab -ascii filesystem description table +ASCII filesystem description table .El +.Sh SEE ALSO +.Xr swapon 2 , +.Xr fstab 5 , +.Xr init 8 , +.Xr rc 8 , +.Xr vnconfig 8 .Sh BUGS There is no way to stop paging and swapping on a device. It is therefore not possible to make use of devices which may be diff --git a/sbin/ttyflags/ttyflags.8 b/sbin/ttyflags/ttyflags.8 index e137abe22a2..bd816d4da37 100644 --- a/sbin/ttyflags/ttyflags.8 +++ b/sbin/ttyflags/ttyflags.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ttyflags.8,v 1.4 1996/10/08 01:20:28 michaels Exp $ +.\" $OpenBSD: ttyflags.8,v 1.5 1998/09/17 04:15:03 aaron Exp $ .\" $NetBSD: ttyflags.8,v 1.2 1995/03/18 15:01:22 cgd Exp $ .\" .\" Copyright (c) 1994 Christopher G. Demetriou @@ -41,7 +41,7 @@ .Op Fl p .Op Fl a | Ar tty ... .Sh DESCRIPTION -.Nm Ttyflags +.Nm ttyflags sets the device-specific flags for terminals, based on the flags found on the terminal's line in .Pa /etc/ttys . @@ -81,6 +81,6 @@ utility appeared in .Nx 0.9a . .Sh BUGS The conditions on which to report an error are ill-defined. -.Nm Ttyflags +.Nm ttyflags tries to report all significant errors, perhaps going over-board at times. diff --git a/sbin/tunefs/tunefs.8 b/sbin/tunefs/tunefs.8 index 587454af038..f65eff4b61d 100644 --- a/sbin/tunefs/tunefs.8 +++ b/sbin/tunefs/tunefs.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tunefs.8,v 1.6 1998/07/20 22:47:11 deraadt Exp $ +.\" $OpenBSD: tunefs.8,v 1.7 1998/09/17 04:15:03 aaron Exp $ .\" $NetBSD: tunefs.8,v 1.8 1995/03/18 15:01:29 cgd Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -53,7 +53,7 @@ .Op Fl s Ar enable | disable .Op Ar special | Ar filesys .Sh DESCRIPTION -.Nm Tunefs +.Nm tunefs is designed to change the dynamic parameters of a file system which affect the layout policies. The parameters which are to be changed are indicated by the flags @@ -107,10 +107,14 @@ been deleted to get under the higher threshold. The file system can either try to minimize the time spent allocating blocks, or it can attempt to minimize the space fragmentation on the disk. -If the value of minfree (see above) is less than 5%, +If the value of +.Ar minfree +(see above) is less than 5%, then the file system should optimize for space to avoid running out of full sized blocks. -For values of minfree greater than or equal to 5%, +For values of +.Ar minfree +greater than or equal to 5%, fragmentation is unlikely to be problematical, and the file system can be optimized for time. .It Fl p diff --git a/sbin/umount/umount.8 b/sbin/umount/umount.8 index a08b449a324..30aab9368a1 100644 --- a/sbin/umount/umount.8 +++ b/sbin/umount/umount.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: umount.8,v 1.3 1997/08/20 04:57:27 millert Exp $ +.\" $OpenBSD: umount.8,v 1.4 1998/09/17 04:15:03 aaron Exp $ .\" $NetBSD: umount.8,v 1.2 1995/03/18 15:01:35 cgd Exp $ .\" .\" Copyright (c) 1980, 1989, 1991, 1993 @@ -56,14 +56,15 @@ command calls the .Xr unmount 2 system call to remove a -.Ar "special device" +.Ar special +device or the remote node (rhost:path) from the file system tree at the point .Ar node . -If either +If neither .Ar special -or +nor .Ar node -are not provided, the appropriate information is taken from the +are provided, the appropriate information is taken from the .Xr fstab 5 file. .Pp |