diff options
71 files changed, 493 insertions, 415 deletions
diff --git a/sbin/adjkerntz/adjkerntz.8 b/sbin/adjkerntz/adjkerntz.8 index 48b89fe813d9..512b4cc7210d 100644 --- a/sbin/adjkerntz/adjkerntz.8 +++ b/sbin/adjkerntz/adjkerntz.8 @@ -31,9 +31,9 @@ .Nm adjkerntz .Nd "adjust local time CMOS clock to reflect time zone changes and keep current timezone offset for the kernel" .Sh SYNOPSIS -.Nm adjkerntz +.Nm .Fl i -.Nm adjkerntz +.Nm .Fl a Op Fl s .Sh DESCRIPTION .Nm Adjkerntz @@ -47,7 +47,7 @@ file system. The main purpose of this thing is not general fixing of initially broken MS-DOS file timestamp idea but keeping the same timestamps between -.Bx Free +.Fx MS-DOS file system and MS-DOS operating system installed on the same machine. diff --git a/sbin/badsect/badsect.8 b/sbin/badsect/badsect.8 index a67767b447e2..a1e4924ce806 100644 --- a/sbin/badsect/badsect.8 +++ b/sbin/badsect/badsect.8 @@ -39,7 +39,7 @@ .Nm badsect .Nd create files to contain bad sectors .Sh SYNOPSIS -.Nm badsect +.Nm .Ar bbdir sector ... .Sh DESCRIPTION .Nm Badsect @@ -120,7 +120,7 @@ A warning is issued if the block is already in use. .Sh BUGS If more than one sector which comprise a file system fragment are bad, you should specify only one of them to -.Nm Ns , +.Nm , as the blocks in the bad sector files actually cover all the sectors in a file system fragment. .Sh HISTORY diff --git a/sbin/camcontrol/camcontrol.8 b/sbin/camcontrol/camcontrol.8 index 6d2c59fbe2e3..be18c63ec48f 100644 --- a/sbin/camcontrol/camcontrol.8 +++ b/sbin/camcontrol/camcontrol.8 @@ -34,56 +34,56 @@ .Nm camcontrol .Nd CAM control program .Sh SYNOPSIS -.Nm camcontrol +.Nm .Aq Ar command .Op device id .Op generic args .Op command args -.Nm camcontrol +.Nm .Ic devlist .Op Fl v -.Nm camcontrol +.Nm .Ic periphlist .Op device id .Op Fl n Ar dev_name .Op Fl u Ar unit_number -.Nm camcontrol +.Nm .Ic tur .Op device id .Op generic args -.Nm camcontrol +.Nm .Ic inquiry .Op device id .Op generic args .Op Fl D .Op Fl S .Op Fl R -.Nm camcontrol +.Nm .Ic start .Op device id .Op generic args -.Nm camcontrol +.Nm .Ic stop .Op device id .Op generic args -.Nm camcontrol +.Nm .Ic eject .Op device id .Op generic args -.Nm camcontrol +.Nm .Ic rescan .Aq bus Ns Op :target:lun -.Nm camcontrol +.Nm .Ic reset .Aq bus Ns Op :target:lun -.Nm camcontrol +.Nm .Ic defects .Op device id .Op generic args .Aq Fl f Ar format .Op Fl P .Op Fl G -.Nm camcontrol +.Nm .Ic modepage .Op device id .Op generic args @@ -91,7 +91,7 @@ .Op Fl P Ar pgctl .Op Fl e .Op Fl d -.Nm camcontrol +.Nm .Ic cmd .Op device id .Op generic args @@ -100,21 +100,21 @@ .Bk -words .Op Fl o Ar len Ar fmt Op args .Ek -.Nm camcontrol +.Nm .Ic debug .Op Fl I .Op Fl T .Op Fl S .Op Fl c .Aq all|off|bus Ns Op :target Ns Op :lun -.Nm camcontrol +.Nm .Ic tags .Op device id .Op generic args .Op Fl N Ar tags .Op Fl q .Op Fl v -.Nm camcontrol +.Nm .Ic negotiate .Op device id .Op generic args @@ -127,27 +127,27 @@ .Op Fl U .Op Fl W Ar bus_width .Op Fl v -.Nm camcontrol +.Nm .Ic format .Op device id .Op generic args .Op Fl q .Op Fl w .Op Fl y -.Nm camcontrol +.Nm .Ic help .Sh DESCRIPTION -.Nm camcontrol +.Nm is a utility designed to provide a way for users to access and control the .Fx CAM subsystem. .Pp -.Nm camcontrol +.Nm can cause a loss of data and/or system crashes if used improperly. Even expert users are encouraged to exercise caution when using this command. Novice users should stay away from this utility. .Pp -.Nm camcontrol +.Nm has a number of primary functions, many of which support an optional device identifier. A device identifier can take one of three forms: .Bl -tag -width 01234567890123 @@ -182,7 +182,7 @@ arguments will override a specified bus:target or bus:target:lun, however. .Pp Most of the -.Nm camcontrol +.Nm primary functions support these generic arguments: .Bl -tag -width 01234567890123 .It Fl C Ar count @@ -226,11 +226,11 @@ List all peripheral drivers attached to a given physical device (logical unit). .It Ic tur Send the SCSI test unit ready (0x00) command to the given device. -.Nm camcontrol +.Nm will report whether the device is ready or not. .It Ic inquiry Send a SCSI inquiry command (0x12) to a device. By default, -.Nm camcontrol +.Nm will print out the standard inquiry data, device serial number, and transfer rate information. The user can specify that only certain types of inquiry data be printed: @@ -239,7 +239,7 @@ inquiry data be printed: Get the standard inquiry data. .It Fl S Print out the serial number. If this flag is the only one specified, -.Nm camcontrol +.Nm will not print out "Serial Number" before the value returned by the drive. This is to aid in script writing. .It Fl R @@ -283,11 +283,11 @@ required. Most drives support the physical sector format. Some drives support the logical block format. Many drives, if they don't support the requested format, return the data in an alternate format, along with sense information indicating that the requested data format isn't supported. -.Nm camcontrol +.Nm attempts to detect this, and print out whatever format the drive returns. If the drive uses a non-standard sense code to report that it doesn't support the requested format, -.Nm camcontrol +.Nm will probably see the error as a failure to complete the request. .It Fl G Print out the grown defect list. This is a list of bad blocks that have @@ -301,7 +301,7 @@ If neither nor .Fl G is specified, -.Nm camcontrol +.Nm will print out the number of defects given in the READ DEFECT DATA header returned from the drive. .It Ic modepage @@ -414,7 +414,7 @@ determined by using the switch. The meaning of the .Fl v switch for this -.Nm camcontrol +.Nm subcommand is described below. .It Fl q Be quiet, and don't report the number of tags. This is generally used when @@ -423,7 +423,7 @@ setting the number of tags. The verbose flag has special functionality for the .Em tags argument. It causes -.Nm camcontrol +.Nm to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB: .Bl -tag -width 0123456789012 .It dev_openings @@ -466,7 +466,7 @@ Show or negotiate various communication parameters. Some controllers may not support setting or changing some of these values. For instance, the Adaptec 174x controllers do not support changing a device's sync rate or offset. -.Nm camcontrol +.Nm will not attempt to set the parameter if the controller indicates that it does not support setting the parameter. To find out what the controller supports, use the @@ -508,7 +508,7 @@ current negotiation settings. The verbose switch has special meaning for the .Ic negotiate subcommand. It causes -.Nm camcontrol +.Nm to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the controller driver. .It Fl W Ar bus_width @@ -564,24 +564,24 @@ the questions, however. To disable questions, use the argument, below. .It Fl w Issue a non-immediate format command. By default, -.Nm camcontrol +.Nm issues the FORMAT UNIT command with the immediate bit set. This tells the device to immediately return the format command, before the format has actually completed. Then, -.Nm camcontrol +.Nm gathers .Tn SCSI sense information from the device every second to determine how far along in the format process it is. If the .Fl w argument is specified, -.Nm camcontrol +.Nm will issue a non-immediate format command, and will be unable to print any information to let the user know what percentage of the disk has been formatted. .It Fl y Don't ask any questions. By default, -.Nm camcontrol +.Nm will ask the user if he/she really wants to format the disk in question, and also if the default format command timeout is acceptable. The user will not be asked about the timeout if a timeout is specified on the @@ -598,7 +598,7 @@ variable allows the user to specify an alternate mode page format file. The .Ev EDITOR variable determines which text editor -.Nm camcontrol +.Nm starts when editing mode pages. .Sh FILES .Bl -tag -width /usr/share/misc/scsi_modes -compact @@ -618,7 +618,7 @@ fails. .Dl camcontrol tur da0 .Pp Send the SCSI test unit ready command to da0. -.Nm camcontrol +.Nm will report whether the disk is ready, but will not display sense information if the command fails since the .Fl v @@ -634,7 +634,7 @@ printing (with the .Fl v flag) if the command fails. Since error recovery is turned on, the disk will be spun up if it is not currently spinning. -.Nm camcontrol +.Nm will report whether the disk is ready. .Bd -literal -offset indent camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e @@ -696,7 +696,7 @@ Test Unit Ready command to make the settings take effect. .Xr xpt 4 .Sh HISTORY The -.Nm camcontrol +.Nm command first appeared in .Fx 3.0 . .Pp @@ -725,7 +725,7 @@ The sense information from the test unit ready command would not get printed out, since the first .Xr getopt 3 call in -.Nm camcontrol +.Nm bails out when it sees the second argument to .Fl c .Po @@ -735,5 +735,5 @@ above. Fixing this behavior would take some gross code, or changes to the .Xr getopt 3 interface. The best way to circumvent this problem is to always make sure to specify generic -.Nm camcontrol +.Nm arguments before any command-specific arguments. diff --git a/sbin/ccdconfig/ccdconfig.8 b/sbin/ccdconfig/ccdconfig.8 index f3aaa4eee9ce..9fd35515cf99 100644 --- a/sbin/ccdconfig/ccdconfig.8 +++ b/sbin/ccdconfig/ccdconfig.8 @@ -39,27 +39,27 @@ .Nm ccdconfig .Nd configuration utility for the concatenated disk driver .Sh SYNOPSIS -.Nm ccdconfig +.Nm .Op Fl cv .Ar ccd .Ar ileave .Op Ar flags .Ar dev .Op Ar -.Nm ccdconfig +.Nm .Fl C .Op Fl v .Op Fl f Ar config_file -.Nm ccdconfig +.Nm .Fl u .Op Fl v .Ar ccd .Op Ar -.Nm ccdconfig +.Nm .Fl U .Op Fl v .Op Fl f Ar config_file -.Nm ccdconfig +.Nm .Fl g .Op Fl M Ar core .Op Fl N Ar system @@ -77,7 +77,7 @@ The options are as follows: .Bl -tag -width indent .It Fl c Configure a ccd. This is the default behavior of -.Nm Ns . +.Nm . .It Fl C Configure all ccd devices listed in the ccd configuration file. .It Fl f Ar config_file @@ -144,7 +144,7 @@ The component devices need to name partitions of type .Dq 4.2BSD as shown by .Xr disklabel 8 ). -.Sh EXAMPLE +.Sh EXAMPLES .Pp A number of ccdconfig examples are shown below. The arguments passed to ccdconfig are exactly the same as you might place in the diff --git a/sbin/clri/clri.8 b/sbin/clri/clri.8 index 7f66eccc54f2..3ea8e8eec30e 100644 --- a/sbin/clri/clri.8 +++ b/sbin/clri/clri.8 @@ -39,7 +39,7 @@ .Nm clri .Nd clear an inode .Sh SYNOPSIS -.Nm clri +.Nm .Ar special_device inode_number ... .Sh DESCRIPTION .Bf -symbolic diff --git a/sbin/comcontrol/comcontrol.8 b/sbin/comcontrol/comcontrol.8 index 655ff1a8f399..29765001620b 100644 --- a/sbin/comcontrol/comcontrol.8 +++ b/sbin/comcontrol/comcontrol.8 @@ -6,7 +6,7 @@ .Nm comcontrol .Nd control an sio device. .Sh SYNOPSIS -.Nm comcontrol +.Nm .Ar sio_special_device .Op options .Sh DESCRIPTION diff --git a/sbin/disklabel/disklabel.8 b/sbin/disklabel/disklabel.8 index 3ba888d24f76..03cf88458272 100644 --- a/sbin/disklabel/disklabel.8 +++ b/sbin/disklabel/disklabel.8 @@ -42,27 +42,27 @@ .Nm disklabel .Nd read and write disk pack label .Sh SYNOPSIS -.Nm disklabel +.Nm .Op Fl r .Ar disk -.Nm disklabel +.Nm .Fl w .Op Fl r .Ar disk Ar disktype/auto .Oo Ar packid Oc -.Nm disklabel +.Nm .Fl e .Op Fl r .Ar disk -.Nm disklabel +.Nm .Fl R .Op Fl r .Ar disk Ar protofile -.Nm disklabel +.Nm .Op Fl NW .Ar disk -.sp -.Nm disklabel +.Pp +.Nm .Fl B .Oo .Fl b Ar boot1 @@ -70,7 +70,7 @@ .Oc .Ar disk .Oo Ar disktype/auto Oc -.Nm disklabel +.Nm .Fl w .Fl B .Oo @@ -79,7 +79,7 @@ .Oc .Ar disk Ar disktype/auto .Oo Ar packid Oc -.Nm disklabel +.Nm .Fl R .Fl B .Oo @@ -114,7 +114,7 @@ is described under each command. .Ss Disk device name .Pp All -.Nm disklabel +.Nm forms require a disk device name, which should always be the raw device name representing the disk or slice. For example .Pa da0 @@ -124,8 +124,9 @@ and represents a slice. Some devices, most notably .Ar ccd , require that the -.if t ``whole-disk'' (or ``c'') -.if n "whole-disk" (or "c") +.Dq whole-disk +(or +.Dq c ) partition be specified. For example .Pa ccd0c . You do not have to include the @@ -139,7 +140,7 @@ To examine or save the label on a disk drive, use .Nm without options: .Pp -.Nm disklabel +.Nm .Op Fl r .Ar disk .Pp @@ -166,13 +167,13 @@ is corrupt. .Pp To write a standard label, use the form .Pp -.Nm disklabel +.Nm .Fl w .Op Fl r .Ar disk Ar disktype/auto .Oo Ar packid Oc .Pp -.Nm disklabel +.Nm .Fl w .Op Fl r .Ar disk @@ -220,13 +221,17 @@ itself must be provided as the canonical name, i.e. not as a full path name. .Pp PC-based systems have special requirements in order for the BIOS to properly -recognize a FreeBSD disklabel. Older systems may require what is known as -a ``dangerously dedicated'' +recognize a +.Fx +disklabel. Older systems may require what is known as a +.Dq dangerously dedicated disklabel, which creates a fake DOS partition to work around problems older BIOSes have with modern disk geometries. On newer systems you generally want to create a normal DOS slice using .Ar fdisk -and then create a FreeBSD disklabel within that slice. This is described +and then create a +.Fx +disklabel within that slice. This is described later on in this page. .Pp Installing a new disklabel does not in of itself allow your system to boot @@ -236,7 +241,7 @@ described later on in this manual page. .Pp To edit an existing disk label, use the form .Pp -.Nm disklabel +.Nm .Fl e .Op Fl r .Ar disk @@ -257,13 +262,13 @@ was specified. .Pp To restore a disk label from a file, use the form .Pp -.Nm disklabel +.Nm .Fl R .Op Fl r .Ar disk Ar protofile .Pp .Nm -is capable of restoring a disk label that was previously saved in a file ASCII. +is capable of restoring a disk label that was previously saved in a file in ASCII format. 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 .Ar \&# @@ -278,14 +283,14 @@ By default, it is not possible to write to the disk label area at the beginning of a disk. The disk driver silently ignores any attempt to do so. If you need to write to this area (for example, to obliterate the label), use the form .Pp -.Nm disklabel +.Nm .Op Fl W .Ar disk .Pp To disallow writing to the label area after previously allowing it, use the command .Pp -.Nm disklabel +.Nm .Op Fl N .Ar disk .Ss Installing bootstraps @@ -293,7 +298,8 @@ command The final three forms of .Nm are used to install bootstrap code. If you are creating a -``dangerously-dedicated'' partition for compatibility with older PC systems, +.Dq dangerously-dedicated +partition for compatibility with older PC systems, you generally want to specify the raw disk name such as .Pa da0. If you are creating a label within an existing DOS slice, you should specify @@ -301,9 +307,11 @@ the slice name such as .Pa da0s1 . Making a partition bootable can be tricky. If you are using a normal DOS slice you typically install (or leave) a standard MBR on the base disk and -then install the FreeBSD bootblocks in the slice. +then install the +.Fx +bootblocks in the slice. .Pp -.Nm disklabel +.Nm .Fl B .Oo .Fl b Ar boot1 @@ -313,13 +321,14 @@ then install the FreeBSD bootblocks in the slice. .Oo Ar disktype Oc .Pp This form installs the bootstrap only. It does not change the disk label. -You should never use this command on a base disk unless you intend to create -a ``dangerously-dedicated'' disk, such as +You should never use this command on a base disk unless you intend to create a +.Dq dangerously-dedicated +disk, such as .Ar da0 . This command is typically run on a slice such as .Ar da0s1 . .Pp -.Nm disklabel +.Nm .Fl w .Fl B .Oo @@ -329,13 +338,15 @@ This command is typically run on a slice such as .Ar disk Ar disktype .Oo Ar packid Oc .Pp -.if t This form corresponds to the ``write label'' command described above. -.if n This form corresponds to the "write label" command described above. +This form corresponds to the +.Dq write label +command described above. In addition to writing a new volume label, it also installs the bootstrap. -If run on a base disk this command will create a ``dangerously-dedicated'' +If run on a base disk this command will create a +.Dq dangerously-dedicated label. This command is normally run on a slice rather than a base disk. .Pp -.Nm disklabel +.Nm .Fl R .Fl B .Oo @@ -345,10 +356,12 @@ label. This command is normally run on a slice rather than a base disk. .Ar disk Ar protofile .Oo Ar disktype Oc .Pp -.if t This form corresponds to the ``restore label'' command described above. -.if n This form corresponds to the "restore label" command described above. +This form corresponds to the +.Dq restore label +command described above. In addition to restoring the volume label, it also installs the bootstrap. -If run on a base disk this command will create a ``dangerously-dedicated'' +If run on a base disk this command will create a +.Dq dangerously-dedicated label. This command is normally run on a slice rather than a base disk. .Pp The bootstrap commands always access the disk directly, so it is not necessary @@ -378,8 +391,9 @@ and flags are not specified, but .Ar disktype was specified, the names of the programs are taken from the -.if t ``b0'' and ``b1'' -.if n "b0" and "b1" +.Dq b0 +and +.Dq b1 parameters of the .Xr disktab 5 entry for the disk if the disktab entry exists and includes those parameters. @@ -395,34 +409,54 @@ on architectures like the Alpha, where only a single-stage boot is used). .Pp To initialize a disk from scratch the following sequence is recommended. Please note that this will wipe everything that was previously on the disk, -including any non-FreeBSD slices. +including any +.No non- Ns Fx +slices. .Bl -enum .It Use .Ar fdisk to initialize the DOS partition table, creating a real whole-disk slice to -hold the FreeBSD disklabel, and installing a master boot record. +hold the +.Fx +disklabel, and installing a master boot record. .It Use .Ar disklabel -to initialize a virgin FreeBSD disklabel and install FreeBSD boot blocks . +to initialize a virgin +.Fx +disklabel and install +.Fx +boot blocks. .It Use .Ar disklabel to edit your newly created label, adding appropriate partitions. .It Finally newfs the filesystem partitions you created in the label. A typical -disklabel partitioning scheme would be to have an ``a'' partition -of approximately 128MB to hold the root filesystem, a ``b'' partition for -swap, a ``d'' partition for /var (usually 128MB), an ``e'' partition -for /var/tmp (usually 128MB), an ``f'' partition for /usr (usually around 2G), -and finally a ``g'' partition for /home (usually all remaining space). +disklabel partitioning scheme would be to have an +.Dq a +partition +of approximately 128MB to hold the root filesystem, a +.Dq b +partition for +swap, a +.Dq d +partition for /var (usually 128MB), an +.Dq e +partition +for /var/tmp (usually 128MB), an +.Dq f +partition for /usr (usually around 2G), +and finally a +.Dq g +partition for /home (usually all remaining space). Your mileage may vary. .El .Pp -.Nm fdisk -BI da0 +.Nm fdisk Fl BI Ar da0 .Pp -.Nm disklabel +.Nm .Fl w .Fl r .Fl B @@ -430,7 +464,7 @@ Your mileage may vary. auto .Pp .Pp -.Nm disklabel +.Nm .Fl e .Ar da0s1 .Pp @@ -487,7 +521,9 @@ Flags may be or .Ar badsect . .Ar removable -is set for removable media drives, but no current FreeBSD driver evaluates this +is set for removable media drives, but no current +.Fx +driver evaluates this flag. .Ar ecc is no longer supported; @@ -540,9 +576,12 @@ Display the in-core label for .Pa da0s1 as obtained via .Pa /dev/da0s1 . -When reading a label, FreeBSD will allow you to specify the base disk name +When reading a label, +.Fx +will allow you to specify the base disk name even if the label resides on a slice. However, to be proper you should -specify the base disk name only if you are using a ``dangerously-dedicated'' +specify the base disk name only if you are using a +.Dq dangerously-dedicated label. Normally you specify the slice. .Pp .Dl disklabel da0s1 > savedlabel @@ -560,8 +599,8 @@ flag to restore the label at a later date. Create a label for .Pa da0s1 based on information for -.if t ``da2212'' found in -.if n "da2212" found in +.Dq da2212 +found in .Pa /etc/disktab . Any existing bootstrap code will be clobbered. .Pp @@ -600,9 +639,9 @@ On-disk and in-core labels are unchanged. .Dl disklabel -w -B /dev/da0s1 -b newboot1 -s newboot da2212 .Pp Install a new label and bootstrap. -.if t The label is derived from disktab information for ``da2212'' and -.if n The label is derived from disktab information for "da2212" and -installed both in-core and on-disk. +The label is derived from disktab information for +.Dq da2212 +and installed both in-core and on-disk. The bootstrap code comes from the files .Pa /boot/newboot1 and @@ -615,7 +654,9 @@ and .Dl disklabel -e da0s1 .Pp Completely wipe any prior information on the disk, creating a new bootable -disk with a DOS partition table containing one ``whole-disk'' slice. Then +disk with a DOS partition table containing one +.Dq whole-disk +slice. Then initialize the slice, then edit it to your needs. The .Pa dd commands are optional, but may be necessary for some BIOSes to properly @@ -630,21 +671,20 @@ The kernel device drivers will not allow the size of a disk partition to be decreased or the offset of a partition to be changed while it is open. Some device drivers create a label containing only a single large partition if a disk is unlabeled; thus, the label must be written to the -.if t ``a'' -.if n "a" +.Dq a partition of the disk while it is open. This sometimes requires the desired label to be set in two steps, the first one creating at least one other partition, and the second setting the label on the new partition while shrinking the -.if t ``a'' -.if n "a" +.Dq a partition. .Pp On some machines the bootstrap code may not fit entirely in the area allocated for it by some filesystems. As a result, it may not be possible to have filesystems on some partitions -.if t of a ``bootable'' disk. -.if n of a "bootable" disk. +of a +.Dq bootable +disk. When installing bootstrap code, .Nm checks for these cases. @@ -658,8 +698,9 @@ Conversely, if a partition has a type other than FS_UNUSED or FS_BOOT, will not install bootstrap code that overlaps it. .Sh BUGS When a disk name is given without a full pathname, -.if t the constructed device name uses the ``c'' partition. -.if n the constructed device name uses the "c" partition. +the constructed device name uses the +.Dq c +partition. .Pp For the i386 architecture, the primary bootstrap sector contains an embedded diff --git a/sbin/dmesg/dmesg.8 b/sbin/dmesg/dmesg.8 index fd9e175c23a4..d67f191bb4da 100644 --- a/sbin/dmesg/dmesg.8 +++ b/sbin/dmesg/dmesg.8 @@ -39,7 +39,7 @@ .Nm dmesg .Nd "display the system message buffer" .Sh SYNOPSIS -.Nm dmesg +.Nm .Op Fl M Ar core .Op Fl N Ar system .Sh DESCRIPTION diff --git a/sbin/dump/dump.8 b/sbin/dump/dump.8 index fb7b3b4e1e9c..855288c7300f 100644 --- a/sbin/dump/dump.8 +++ b/sbin/dump/dump.8 @@ -41,7 +41,7 @@ .Nm rdump .Nd filesystem backup .Sh SYNOPSIS -.Nm dump +.Nm .Op Fl 0123456789acknu .Op Fl B Ar records .Op Fl b Ar blocksize @@ -51,10 +51,10 @@ .Op Fl s Ar feet .Op Fl T Ar date .Ar filesystem -.Nm dump +.Nm .Op Fl W Li \&| Fl w .Pp -.in -\\n(iSu +.in -\n(iSu (The .Bx 4.3 option syntax is implemented for backward compatibility, but @@ -87,7 +87,7 @@ By default, the same output file name is used for each volume after prompting the operator to change media. .Pp The following options are supported by -.Nm Ns : +.Nm : .Bl -tag -width Ds .It Fl 0\-9 Dump levels. @@ -187,7 +187,6 @@ If this amount is exceeded, prompts for a new tape. It is recommended to be a bit conservative on this option. The default tape length is 2300 feet. -.ne 1i .It Fl T Ar date Use the specified date as the starting time for the dump instead of the time determined from looking in diff --git a/sbin/dumpfs/dumpfs.8 b/sbin/dumpfs/dumpfs.8 index 8c668c13e9a6..51a634bc7d0d 100644 --- a/sbin/dumpfs/dumpfs.8 +++ b/sbin/dumpfs/dumpfs.8 @@ -39,7 +39,7 @@ .Nm dumpfs .Nd dump file system information .Sh SYNOPSIS -.Nm dumpfs +.Nm .Op Ar filesys No \&| Ar device .Sh DESCRIPTION .Nm Dumpfs diff --git a/sbin/dumpon/dumpon.8 b/sbin/dumpon/dumpon.8 index 3e9e1bdb2efb..fc4680d30ceb 100644 --- a/sbin/dumpon/dumpon.8 +++ b/sbin/dumpon/dumpon.8 @@ -39,10 +39,10 @@ .Nm dumpon .Nd "specify a device for crash dumps" .Sh SYNOPSIS -.Nm dumpon +.Nm .Op Fl v .Ar special_file -.Nm dumpon +.Nm .Op Fl v .Ar off .Sh DESCRIPTION diff --git a/sbin/fsck/fsck.8 b/sbin/fsck/fsck.8 index 59d7fa8d1a47..1cb1699aea99 100644 --- a/sbin/fsck/fsck.8 +++ b/sbin/fsck/fsck.8 @@ -40,13 +40,13 @@ .Nm fsck .Nd filesystem consistency check and interactive repair .Sh SYNOPSIS -.Nm fsck +.Nm .Fl p .Op Fl f .Op Fl m Ar mode .Op Ar filesystem .Ar ... -.Nm fsck +.Nm .Op Fl ny .Op Fl b Ar block# .Op Fl c Ar level @@ -162,7 +162,7 @@ and combined. .Pp The following flags are interpreted by -.Nm Ns . +.Nm . .Bl -tag -width indent .It Fl b Use the block specified immediately after the flag as @@ -203,7 +203,7 @@ first line of output from .Xr dumpfs 8 . .It Fl f Force -.Nm fsck +.Nm to check .Sq clean filesystems when preening. @@ -232,7 +232,7 @@ do not open the filesystem for writing. Preen filesystems (see above). .It Fl y Assume a yes response to all questions asked by -.Nm Ns ; +.Nm ; this should be used with great caution as this is a free license to continue after essentially unlimited trouble has been encountered. .El diff --git a/sbin/fsdb/fsdb.8 b/sbin/fsdb/fsdb.8 index 2ea7d621927d..46489d8c1e67 100644 --- a/sbin/fsdb/fsdb.8 +++ b/sbin/fsdb/fsdb.8 @@ -35,7 +35,7 @@ .Nm fsdb .Nd FFS debugging/editing tool .Sh SYNOPSIS -.Nm fsdb +.Nm .Op Fl d .Op Fl f .Op Fl r @@ -103,7 +103,6 @@ may be a multi-component name or may begin with slash to indicate that the root inode should be used to start the lookup. If some component along the pathname is not found, the last valid directory encountered is left as the active inode. -.br This command is valid only if the starting inode is a directory. .Pp .It Cm active @@ -216,9 +215,9 @@ Exit the program. .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. @@ -232,7 +231,7 @@ first appeared in .Nx , written by .An John T. Kohl . -.br +.Pp .An Peter Wemm ported it to .Fx . diff --git a/sbin/fsirand/fsirand.8 b/sbin/fsirand/fsirand.8 index 966baaa1b457..6d9764f6da36 100644 --- a/sbin/fsirand/fsirand.8 +++ b/sbin/fsirand/fsirand.8 @@ -36,7 +36,7 @@ .Nm fsirand .Nd randomize inode generation numbers .Sh SYNOPSIS -.Nm fsirand +.Nm .Op Fl b .Op Fl f .Op Fl p @@ -98,11 +98,12 @@ of memory for large disks with few cylinder groups. The .Nm command appeared in SunOS 3.x. -.br +.Pp This version of .Nm first appeared in .Ox 2.1 . +.Pp A .Fx version first appeared in diff --git a/sbin/i386/cxconfig/cxconfig.8 b/sbin/i386/cxconfig/cxconfig.8 index 066c4e95e9a0..913e758897a8 100644 --- a/sbin/i386/cxconfig/cxconfig.8 +++ b/sbin/i386/cxconfig/cxconfig.8 @@ -6,7 +6,7 @@ .Nm cxconfig .Nd channel options management utility for Cronyx-Sigma adapter .Sh SYNOPSIS -.Nm cxconfig +.Nm .Op Fl a .Op Ar <channel> Op Ar <option>... .Sh DESCRIPTION @@ -277,7 +277,7 @@ Frame address registers for address recognition. .El .Sh EXAMPLES Set up the channel 7 of the adapter Sigma-400 under -.Bx Free . +.Fx . Physical 4-wire leased line with Zelax+ M115 short-range modems. Synchronous mode, 128000 bits/sec, interface RS-232, protocol PpP/HDLC without keepalive support, NRZI encoding, @@ -288,7 +288,7 @@ ifconfig cx7 158.250.244.2 158.250.244.1 up .Ed .Pp Set up the channel 0 of the adapter Sigma-100 under -.Bx Free . +.Fx . Attachment to the near computer by short cable, internal clock source. Synchronous mode, 256000 bits/sec, interface RS-232, protocol Cisco/HDLC with keepalive support: @@ -306,7 +306,7 @@ ifconfig cx1 193.124.254.50 193.124.254.49 multicast up .Ed .Pp Set up the channel 0 of the adapter Sigma-840 under -.Bx Free . +.Fx . Attachment to the Cisco-4000 router by null-modem cable, internal clock source. Synchronous mode, 64000 bits/sec, interface RS-232, protocol PpP/HDLC with keepalive support and flow control, diff --git a/sbin/i386/fdisk/fdisk.8 b/sbin/i386/fdisk/fdisk.8 index aa3000829f38..f78d406e382e 100644 --- a/sbin/i386/fdisk/fdisk.8 +++ b/sbin/i386/fdisk/fdisk.8 @@ -7,13 +7,13 @@ .Nm fdisk .Nd PC partition table maintenance program .Sh SYNOPSIS -.Nm fdisk +.Nm .Op Fl BIaistu .Op Fl b Ar bootcode .Op Fl 1234 .Op Ar disk .Bl -tag -width time -.Nm fdisk +.Nm .Fl f Ar configfile .Op Fl itv .Op Ar disk @@ -40,7 +40,7 @@ program can be used to divide space on the disk into partitions and set one .Em active . .Sh DESCRIPTION The -.Bx Free +.Fx program .Nm serves a similar purpose to the DOS program. The first form is used to @@ -171,7 +171,7 @@ The second partition overlaps the end of the first. .Bl -tag -width "cyl, sector and head" .It Em "sysid" is used to label the partition. -.Bx Free +.Fx reserves the magic number 165 decimal (A5 in hex). .It Em "start and size" @@ -244,7 +244,7 @@ While the .Fl i flag is used to "initialize" sector 0; it will setup the last BIOS partition to use the whole disk for -.Bx Free ; +.Fx ; and make it active. .Sh NOTES The automatic calculation of starting cylinder etc. uses @@ -257,7 +257,7 @@ that use geometry translation under the BIOS. .Pp If you hand craft your disk layout, please make sure that the -.Bx Free +.Fx partition starts on a cylinder boundary. A number of decisions made later may assume this. (This might not be necessary later.) @@ -316,28 +316,26 @@ This line must occur before any lines that specify partition information. .Pp It is an error if the following is not true: -.Pp -.nf - 1 <= number of cylinders - 1 <= number of heads <= 256 - 1 <= number of sectors/track < 64 -.fi +.Bd -literal -offset indent +1 <= number of cylinders +1 <= number of heads <= 256 +1 <= number of sectors/track < 64 +.Ed .Pp The number of cylinders should be less than or equal to 1024, but this is not enforced, although a warning will be output. Note that bootable -.Bx Free +.Fx partitions (the "/" filesystem) must lie completely within the first 1024 cylinders; if this is not true, booting may fail. Non-bootable partitions do not have this restriction. .Pp Example (all of these are equivalent), for a disk with 1019 cylinders, 39 heads, and 63 sectors: -.Pp -.nf - g c1019 h39 s63 - g h39 c1019 s63 - g s63 h39 c1019 -.fi +.Bd -literal -offset indent +g c1019 h39 s63 +g h39 c1019 s63 +g s63 h39 c1019 +.Ed .It Xo .Ic p .No Ar partition @@ -370,7 +368,7 @@ if one is present. The .Ar type is 165 for -.Bx Free +.Fx partitions. Specifying a partition type of zero is the same as clearing the partition and marking it as unused; however, dummy values (such as "0") must still be specified for @@ -383,20 +381,20 @@ necessary, and the end offset will be rounded downwards to a cylinder boundary if necessary. .Pp Example: to clear partition 4 and mark it as unused: -.Pp -.nf - p 4 0 0 0 -.fi +.Bd -literal -offset indent +p 4 0 0 0 +.Ed .Pp Example: to set partition 1 to a -.Bx Free +.Fx partition, starting at sector 1 for 2503871 sectors (note: these numbers will be rounded upwards and downwards to correspond to head and cylinder boundaries): .Pp -.nf - p 1 165 1 2503871 -.fi +.Bd -literal -offset indent +p 1 165 1 2503871 +.Ed +.Pp .It Xo .Ic a .No Ar partition @@ -407,13 +405,10 @@ the active partition. Can occur anywhere in the config file, but only one must be present. .Pp Example: to make partition 1 the active partition: -.Pp -.nf - a 1 -.fi - +.Bd -literal -offset indent +a 1 +.Ed .El -.Pp .Sh FILES .Bl -tag -width /boot/mbr -compact .It Pa /boot/mbr @@ -434,7 +429,7 @@ is used where it should actually be in order to conform with the terms used elsewhere. .Pp You cannot use this command to completely dedicate a disk to -.Bx Free . +.Fx . The .Xr disklabel 8 command must be used for this. diff --git a/sbin/i386/nextboot/nextboot.8 b/sbin/i386/nextboot/nextboot.8 index bd7348158d60..3afe41b98d66 100644 --- a/sbin/i386/nextboot/nextboot.8 +++ b/sbin/i386/nextboot/nextboot.8 @@ -6,16 +6,16 @@ .Nm nextboot .Nd install a default bootstring block on the boot disk .Sh SYNOPSIS -.Nm nextboot +.Nm .Op Fl b .Ar filename bootstring .Ar -.Nm nextboot +.Nm .Op Fl ed .Ar filename .Sh DESCRIPTION The -.Bx Free +.Fx program .Nm controls the actions of the boot blocks at the time of the next boot. diff --git a/sbin/ifconfig/ifconfig.8 b/sbin/ifconfig/ifconfig.8 index 6f67af985927..f3ca86fe2ba4 100644 --- a/sbin/ifconfig/ifconfig.8 +++ b/sbin/ifconfig/ifconfig.8 @@ -39,7 +39,7 @@ .Nm ifconfig .Nd configure network interface parameters .Sh SYNOPSIS -.Nm ifconfig +.Nm .Op Fl L .Ar interface .Op Ar address_family @@ -48,18 +48,18 @@ .Op Ar dest_address .Oc .Op Ar parameters -.Nm ifconfig +.Nm .Fl a .Op Fl L .Op Fl d .Op Fl u .Op Ar address_family -.Nm ifconfig +.Nm .Fl l .Op Fl d .Op Fl u .Op Ar address_family -.Nm ifconfig +.Nm .Op Fl L .Op Fl d .Op Fl u @@ -136,7 +136,7 @@ for example, .El .Pp The following parameters may be set with -.Nm ifconfig : +.Nm : .Bl -tag -width indent .It Cm add Another name for the ``alias'' parameter. Introduced for compatibility @@ -441,7 +441,7 @@ tried to alter an interface's configuration. IPv6 link-local addresses are required for several basic communication between IPv6 node. If they are deleted by -.Nm ifconfig +.Nm manually, the kernel might show very strange behavior. So, such manual deletions are strongly discouraged. .Sh SEE ALSO diff --git a/sbin/init/init.8 b/sbin/init/init.8 index a5909dbb4d1d..7aa927194a3a 100644 --- a/sbin/init/init.8 +++ b/sbin/init/init.8 @@ -42,8 +42,8 @@ .Nm init .Nd process control initialization .Sh SYNOPSIS -.Nm init -.Nm init +.Nm +.Nm .Oo .Cm 0 | 1 | 6 | .Cm c | q diff --git a/sbin/ip6fw/ip6fw.8 b/sbin/ip6fw/ip6fw.8 index 14176635615c..7aaf2ca58eec 100644 --- a/sbin/ip6fw/ip6fw.8 +++ b/sbin/ip6fw/ip6fw.8 @@ -10,25 +10,25 @@ .Sh SYNOPSIS .Nm .Ar file -.Nm ip6fw +.Nm .Op Fl f | Fl q flush -.Nm ip6fw +.Nm .Op Fl q zero .Op Ar number ... -.Nm ip6fw +.Nm delete .Ar number ... -.Nm ip6fw +.Nm .Op Fl aftN list .Op Ar number ... -.Nm ip6fw +.Nm .Op Fl ftN show .Op Ar number ... -.Nm ip6fw +.Nm .Op Fl q add .Op Ar number @@ -482,6 +482,8 @@ not accepted. .An Poul-Henning Kamp , .An Alex Nash , .An Archie Cobbs . +.Pp +.An -nosplit API based upon code written by .An Daniel Boulet for BSDI. diff --git a/sbin/ipfw/ipfw.8 b/sbin/ipfw/ipfw.8 index c06309929134..9e02222b7278 100644 --- a/sbin/ipfw/ipfw.8 +++ b/sbin/ipfw/ipfw.8 @@ -8,7 +8,7 @@ .Nm ipfw .Nd controlling utility for IP firewall and traffic shaper .Sh SYNOPSIS -.Nm ipfw +.Nm .Op Fl q .Oo .Fl p Ar preproc @@ -21,41 +21,41 @@ .Op Fl U Ar macro .Oc .Ar pathname -.Nm ipfw +.Nm .Op Fl f | q .Cm flush -.Nm ipfw +.Nm .Op Fl q .Es \&{ \&} .En Cm zero | resetlog | delete .Op Ar number ... -.Nm ipfw +.Nm .Op Fl s Op Ar field .Op Fl aftN .Es \&{ \&} .En Cm list | show .Op Ar number ... -.Nm ipfw +.Nm .Op Fl q .Cm add .Op Ar number .Ar rule-body -.Nm ipfw +.Nm .Cm pipe .Ar number .Cm config .Ar pipe-config-options -.Nm ipfw +.Nm .Cm pipe .Es \&{ \&} .En Cm delete | list | show .Op Ar number ... -.Nm ipfw +.Nm .Cm queue .Ar number .Cm config .Ar queue-config-options -.Nm ipfw +.Nm .Cm queue .Es \&{ \&} .En Cm delete | list | show @@ -122,7 +122,7 @@ See the and .Sx EXAMPLES sections below for more information on the stateful behaviour of -.Nm ipfw . +.Nm . .Pp All rules (including dynamic ones) have a few associated counters: a packet count, a byte count, a log count and a timestamp @@ -1046,7 +1046,7 @@ meaning: .Bl -tag -width indent .It Em net.inet.ip.fw.debug : No 1 Controls debugging messages produced by -.Nm ipfw . +.Nm . .It Em net.inet.ip.fw.one_pass : No 1 When set, the packet exiting from the .Xr dummynet 4 @@ -1269,7 +1269,7 @@ on a net with per-host limits, rather than per-network limits: .Xr kldload 8 , .Xr reboot 8 , .Xr sysctl 8 , -.Xr syslogd 8 . +.Xr syslogd 8 .Sh BUGS .Pp The syntax has grown over the years and it is not very clean. @@ -1303,8 +1303,9 @@ This may be fixed in a later version. .An Archie Cobbs , .An Luigi Rizzo . .Pp +.An -nosplit API based upon code written by -Daniel Boulet +.An Daniel Boulet for BSDI. .Pp Work on diff --git a/sbin/kget/kget.8 b/sbin/kget/kget.8 index 7fea15fd9cc7..4b847304bb8a 100644 --- a/sbin/kget/kget.8 +++ b/sbin/kget/kget.8 @@ -31,7 +31,7 @@ .Nm kget .Nd print kernel change information. .Sh SYNOPSIS -.Nm kget +.Nm .Ar filename .Sh DESCRIPTION The diff --git a/sbin/kldload/kldload.8 b/sbin/kldload/kldload.8 index 39b42f0691c1..328744ddccb8 100644 --- a/sbin/kldload/kldload.8 +++ b/sbin/kldload/kldload.8 @@ -32,7 +32,7 @@ .Nm kldload .Nd load a file into the kernel .Sh SYNOPSIS -.Nm kldload +.Nm .Op Fl v .Ar filename .Sh DESCRIPTION diff --git a/sbin/kldstat/kldstat.8 b/sbin/kldstat/kldstat.8 index f12d5039d8cb..bb47b785d311 100644 --- a/sbin/kldstat/kldstat.8 +++ b/sbin/kldstat/kldstat.8 @@ -32,7 +32,7 @@ .Nm kldstat .Nd display status of dynamic kernel linker .Sh SYNOPSIS -.Nm kldstat +.Nm .Op Fl v .Op Fl i Ar id .Op Fl n Ar name diff --git a/sbin/kldunload/kldunload.8 b/sbin/kldunload/kldunload.8 index 6cbb60bb9861..39832e6b9753 100644 --- a/sbin/kldunload/kldunload.8 +++ b/sbin/kldunload/kldunload.8 @@ -32,10 +32,10 @@ .Nm kldunload .Nd unload a file from the kernel .Sh SYNOPSIS -.Nm kldunload +.Nm .Op Fl v .Fl i Ar id -.Nm kldunload +.Nm .Op Fl v .Op Fl n .Ar name diff --git a/sbin/ldconfig/ldconfig.8 b/sbin/ldconfig/ldconfig.8 index 8f4f801b32ee..9bda2510adf2 100644 --- a/sbin/ldconfig/ldconfig.8 +++ b/sbin/ldconfig/ldconfig.8 @@ -36,7 +36,7 @@ .Nm ldconfig .Nd configure the shared library cache .Sh SYNOPSIS -.Nm ldconfig +.Nm .Op Fl aout | Fl elf .Op Fl Rmrsv .Op Fl f Ar hints_file @@ -87,7 +87,7 @@ switch of is typically run as part of the boot sequence. .Pp The following options recognized by -.Nm ldconfig: +.Nm : .Bl -tag -width indent .It Fl aout Generate the hints for a.out format shared libraries. @@ -185,4 +185,5 @@ or A .Nm utility first appeared in SunOS 4.0, it appeared in its current form -in FreeBSD 1.1. +in +.Fx 1.1 . diff --git a/sbin/md5/md5.1 b/sbin/md5/md5.1 index c485184cc440..559663de31cf 100644 --- a/sbin/md5/md5.1 +++ b/sbin/md5/md5.1 @@ -6,7 +6,7 @@ .Nm md5 .Nd calculate a message-digest fingerprint (checksum) for a file .Sh SYNOPSIS -.Nm md5 +.Nm .Op Fl pqrtx .Op Fl s Ar string .Op Ar file ... diff --git a/sbin/mknod/mknod.8 b/sbin/mknod/mknod.8 index 22e60a99ad01..8e76667a4439 100644 --- a/sbin/mknod/mknod.8 +++ b/sbin/mknod/mknod.8 @@ -39,14 +39,14 @@ .Nm mknod .Nd build special file .Sh SYNOPSIS -.Nm mknod +.Nm .Ar name .Op Cm c | Cm b .Ar major minor .Op owner:group .Sh DESCRIPTION The -.Nm mknod +.Nm command creates device special files. Normally the shell script .Pa /dev/MAKEDEV diff --git a/sbin/mount/getmntopts.3 b/sbin/mount/getmntopts.3 index 84ad24f598a7..f9380acf7acf 100644 --- a/sbin/mount/getmntopts.3 +++ b/sbin/mount/getmntopts.3 @@ -44,7 +44,7 @@ .Fn getmntopts "char *options" "struct mntopt *mopts" "int *flagp" "int *altflagp" .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. @@ -64,7 +64,7 @@ or field of the option's table entry) are updated. The flag words are not initialized by -.Nm getmntopt . +.Fn getmntopts . The table, .Dv mopts , has the following format: @@ -85,7 +85,7 @@ for example .Dq suid . .It Fa m_inverse tells -.Nm getmntopts +.Fn getmntopts that the name has the inverse meaning of the bit. For example, @@ -164,7 +164,7 @@ struct mntopt mopts[] = { If the external integer variable .Dv getmnt_silent is non-zero then the -.Nm getmntopts +.Fn getmntopts function displays an error message and exits if an unrecognized option is encountered. By default diff --git a/sbin/mount/mount.8 b/sbin/mount/mount.8 index 570e8e87be7a..02311ce3567f 100644 --- a/sbin/mount/mount.8 +++ b/sbin/mount/mount.8 @@ -39,13 +39,13 @@ .Nm mount .Nd mount file systems .Sh SYNOPSIS -.Nm mount +.Nm .Op Fl adfpruvw .Op Fl t Ar ufs | lfs | external_type -.Nm mount +.Nm .Op Fl dfpruvw .Ar special | node -.Nm mount +.Nm .Op Fl dfpruvw .Op Fl o Ar options .Op Fl t Ar ufs | lfs | external_type @@ -70,7 +70,7 @@ file. .Pp The system maintains a list of currently mounted file systems. If no arguments are given to -.Nm mount , +.Nm , this list is printed. .Pp The options are as follows: diff --git a/sbin/mount_cd9660/mount_cd9660.8 b/sbin/mount_cd9660/mount_cd9660.8 index 7e409fa3c74a..4e2a6f827f85 100644 --- a/sbin/mount_cd9660/mount_cd9660.8 +++ b/sbin/mount_cd9660/mount_cd9660.8 @@ -43,7 +43,7 @@ .Nm mount_cd9660 .Nd mount an ISO-9660 filesystem .Sh SYNOPSIS -.Nm mount_cd9660 +.Nm .Op Fl egjrv .Op Fl o Ar options .Op Fl s Ar startsector diff --git a/sbin/mount_ext2fs/mount_ext2fs.8 b/sbin/mount_ext2fs/mount_ext2fs.8 index 3360b90d91f5..1ff6ea0cb2f8 100644 --- a/sbin/mount_ext2fs/mount_ext2fs.8 +++ b/sbin/mount_ext2fs/mount_ext2fs.8 @@ -38,7 +38,7 @@ .Nm mount_ext2fs .Nd mount a ext2fs file system .Sh SYNOPSIS -.Nm mount_ext2fs +.Nm .Op Fl o Ar options .Ar special .Ar node diff --git a/sbin/mount_hpfs/mount_hpfs.8 b/sbin/mount_hpfs/mount_hpfs.8 index f45272e0e60d..34a9bed38d0e 100644 --- a/sbin/mount_hpfs/mount_hpfs.8 +++ b/sbin/mount_hpfs/mount_hpfs.8 @@ -37,7 +37,7 @@ .Nm mount_hpfs .Nd mount an HPFS file system .Sh SYNOPSIS -.Nm mount_hpfs +.Nm .Op Fl o Ar options .Op Fl u Ar uid .Op Fl g Ar gid @@ -92,8 +92,9 @@ It is strongly recomended to mount readonly! .Sh HISTORY The .Nm -first appered in FreeBSD 3.0 -.Sh AUTHOR +first appered in +.Fx 3.0 . +.Sh AUTHORS HPFS kernel implementation, .Nm and manual were written by Semen Ustimenko <semenu@FreeBSD.org>. diff --git a/sbin/mount_msdos/mount_msdos.8 b/sbin/mount_msdos/mount_msdos.8 index 8083d2f5f8f3..99cfa6867b36 100644 --- a/sbin/mount_msdos/mount_msdos.8 +++ b/sbin/mount_msdos/mount_msdos.8 @@ -37,7 +37,7 @@ .Nm mount_msdos .Nd mount an MS-DOS file system .Sh SYNOPSIS -.Nm mount_msdos +.Nm .Op Fl o Ar options .Op Fl u Ar uid .Op Fl g Ar gid @@ -212,4 +212,4 @@ utility appeared in .Fx 1.0 , and was abandoned in favor of the more aptly-named -.Nm Ns . +.Nm . diff --git a/sbin/mount_nfs/mount_nfs.8 b/sbin/mount_nfs/mount_nfs.8 index d5245feff96f..21a639ff3516 100644 --- a/sbin/mount_nfs/mount_nfs.8 +++ b/sbin/mount_nfs/mount_nfs.8 @@ -40,7 +40,7 @@ .Nm mount_nfs .Nd mount nfs file systems .Sh SYNOPSIS -.Nm mount_nfs +.Nm .Op Fl 23KNPTUbcdilqs .Op Fl D Ar deadthresh .Op Fl I Ar readdirsize @@ -211,7 +211,7 @@ the longer the cache is considered valid, subject to the limits above. .Pp Use of these options is deprecated, they are only mentioned here for compatibility with historic versions of -.Nm Ns . +.Nm . .It bg Same as .Fl b . diff --git a/sbin/mount_ntfs/mount_ntfs.8 b/sbin/mount_ntfs/mount_ntfs.8 index 1a757ec1e646..5208446c2c7d 100644 --- a/sbin/mount_ntfs/mount_ntfs.8 +++ b/sbin/mount_ntfs/mount_ntfs.8 @@ -37,7 +37,7 @@ .Nm mount_ntfs .Nd mount an NTFS file system .Sh SYNOPSIS -.Nm mount_ntfs +.Nm .Op Fl a .Op Fl i .Op Fl u Ar uid diff --git a/sbin/mount_null/mount_null.8 b/sbin/mount_null/mount_null.8 index 1e56e4f41520..c2e7167f7a7c 100644 --- a/sbin/mount_null/mount_null.8 +++ b/sbin/mount_null/mount_null.8 @@ -45,7 +45,7 @@ .Nd mount a loopback filesystem sub-tree; demonstrate the use of a null file system layer .Sh SYNOPSIS -.Nm mount_null +.Nm .Op Fl o Ar options .Ar target .Ar mount-point @@ -228,7 +228,7 @@ is that vnode arguments must be manually mapped. .\" .Sh SEE ALSO .Xr mount 8 -.sp +.Pp UCLA Technical Report CSD-910056, .Em "Stackable Layers: an Architecture for File System Development" . .Sh BUGS diff --git a/sbin/mount_nwfs/mount_nwfs.8 b/sbin/mount_nwfs/mount_nwfs.8 index b56d26c8e301..2e92a6829cdf 100644 --- a/sbin/mount_nwfs/mount_nwfs.8 +++ b/sbin/mount_nwfs/mount_nwfs.8 @@ -6,7 +6,7 @@ .Nm mount_nwfs .Nd mount NetWare volume from a NetWare file server .Sh SYNOPSIS -.Nm mount_nwfs +.Nm .Op Fl Chv .Fl S Ar server .Fl U Ar user @@ -22,7 +22,7 @@ .Op Fl u Ar uid .Op Fl w Ar scheme .Ar node -.Nm mount_nwfs +.Nm .Op Fl options .Ar /server:user/volume[/path] .Ar node diff --git a/sbin/mount_portal/mount_portal.8 b/sbin/mount_portal/mount_portal.8 index 306a220c8aff..f84fa480c142 100644 --- a/sbin/mount_portal/mount_portal.8 +++ b/sbin/mount_portal/mount_portal.8 @@ -44,7 +44,7 @@ .Nm mount_portal .Nd mount the portal daemon .Sh SYNOPSIS -.Nm mount_portal +.Nm .Op Fl o Ar options .Ar /etc/portal.conf .Ar mount_point diff --git a/sbin/mount_std/mount_std.8 b/sbin/mount_std/mount_std.8 index 3dc527b2566c..01d992ba3ee4 100644 --- a/sbin/mount_std/mount_std.8 +++ b/sbin/mount_std/mount_std.8 @@ -83,7 +83,7 @@ and has a kernel filesystem module name the same as its user-visible name. .It requires no other special processing on the part of the -.Nm mount_std +.Nm command. .El .Pp @@ -155,7 +155,7 @@ loadable module for it was found. None of the ``standard'' filesystems may be NFS-exported. .Sh HISTORY The -.Nm mount_std +.Nm utility first appeared in .Fx 2.2 . Loadable filesystem modules first appeared in diff --git a/sbin/mount_umap/mount_umap.8 b/sbin/mount_umap/mount_umap.8 index 4c6abfa3e438..f0801d839a2b 100644 --- a/sbin/mount_umap/mount_umap.8 +++ b/sbin/mount_umap/mount_umap.8 @@ -43,7 +43,7 @@ .Nm mount_umap .Nd sample file system layer .Sh SYNOPSIS -.Nm mount_umap +.Nm .Op Fl o Ar options .Fl u Ar uid-mapfile .Fl g Ar gid-mapfile diff --git a/sbin/mount_union/mount_union.8 b/sbin/mount_union/mount_union.8 index 08a48044cdce..163839ed3b6a 100644 --- a/sbin/mount_union/mount_union.8 +++ b/sbin/mount_union/mount_union.8 @@ -42,7 +42,7 @@ .Nm mount_union .Nd mount union filesystems .Sh SYNOPSIS -.Nm mount_union +.Nm .Op Fl br .Op Fl o Ar options .Ar directory @@ -127,7 +127,7 @@ Similarly, an attempt to truncate a lower layer file to zero length causes an empty file to be created in the upper layer. Any other operation which would ultimately require modification to the lower layer fails with -.Dv EROFS . +.Er EROFS . .Pp The union filesystem manipulates the namespace, rather than individual filesystems. @@ -183,19 +183,20 @@ accessible via .Xr mount 8 , .Xr mount_null 8 .Sh BUGS - THIS FILESYSTEM TYPE IS NOT YET FULLY SUPPORTED (READ: IT DOESN'T WORK) AND USING IT MAY, IN FACT, DESTROY DATA ON YOUR SYSTEM. USE AT YOUR OWN RISK. BEWARE OF DOG. SLIPPERY WHEN WET. - +.Pp This code also needs an owner in order to be less dangerous - serious -hackers can apply by sending mail to hackers@freebsd.org and announcing +hackers can apply by sending mail to +.Aq hackers@FreeBSD.org +and announcing their intent to take it over. - +.Pp 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 +.Er EROFS is returned for this kind of operations along with any others which would make modifications to the lower layer, such as .Xr chmod 1 . @@ -209,4 +210,5 @@ The .Nm command first appeared in .Bx 4.4 . -It first worked in FreeBSD-(fill this in). +It first worked in +.Fx Ns -(fill this in) . diff --git a/sbin/mountd/exports.5 b/sbin/mountd/exports.5 index 0dc4651fb9dd..246b40a466db 100644 --- a/sbin/mountd/exports.5 +++ b/sbin/mountd/exports.5 @@ -41,7 +41,7 @@ .Tn NFS mount requests .Sh SYNOPSIS -.Nm exports +.Nm .Sh DESCRIPTION The .Nm diff --git a/sbin/mountd/mountd.8 b/sbin/mountd/mountd.8 index fdb62a17907b..509fbb7b4f74 100644 --- a/sbin/mountd/mountd.8 +++ b/sbin/mountd/mountd.8 @@ -41,7 +41,7 @@ .Tn NFS mount requests .Sh SYNOPSIS -.Nm mountd +.Nm .Op Fl 2dlnr .Op Ar exportsfile .Sh DESCRIPTION diff --git a/sbin/mountd/netgroup.5 b/sbin/mountd/netgroup.5 index fb1a8bcd2a57..919f1fe3b22d 100644 --- a/sbin/mountd/netgroup.5 +++ b/sbin/mountd/netgroup.5 @@ -39,7 +39,7 @@ .Nm netgroup .Nd defines network groups .Sh SYNOPSIS -.Nm netgroup +.Nm .Sh DESCRIPTION The .Nm diff --git a/sbin/natd/natd.8 b/sbin/natd/natd.8 index 0220e399414b..7a1f6de5f62f 100644 --- a/sbin/natd/natd.8 +++ b/sbin/natd/natd.8 @@ -6,7 +6,8 @@ .Nm natd .Nd Network Address Translation Daemon .Sh SYNOPSIS -.Nm natd +.Nm +.Bk -words .Op Fl unregistered_only | u .Op Fl log | l .Op Fl proxy_only @@ -30,6 +31,7 @@ .Op Fl log_denied .Op Fl log_facility Ar facility_name .Op Fl punch_fw Ar firewall_range +.Ek .Sh DESCRIPTION This program provides a Network Address Translation facility for use with @@ -60,7 +62,7 @@ checked against this internal table. If an entry is found, it is used to determine the correct target IP number and port to place in the packet. .Pp -The following command line options are available. +The following command line options are available: .Bl -tag -width Fl .It Fl log | l Log various aliasing statistics and information to the file @@ -69,8 +71,13 @@ This file is truncated each time .Nm is started. .It Fl deny_incoming | d -Do not pass packets destined for the current IP number that have no +Do not pass incoming packets that have no entry in the internal translation table. +.Pp +If this option is not used, then such a packet will be altered +using the rules in +.Fl target_address +below, and the entry will be made in the internal translation table. .It Fl log_denied Log denied incoming packets via .Xr syslog 3 @@ -101,7 +108,7 @@ changed as per normal. Do not call .Xr daemon 3 on startup. -Instead, stay attached to the controling terminal and display all packet +Instead, stay attached to the controlling terminal and display all packet alterations to the standard output. This option should only be used for debugging purposes. .It Fl unregistered_only | u @@ -267,17 +274,28 @@ If the interface's IP number is changed, will dynamically alter its concept of the alias address. .It Fl in_port | i Ar port Read from and write to +.Xr divert 4 +port .Ar port , -treating all packets as packets coming into the machine. +treating all packets as +.Dq incoming . .It Fl out_port | o Ar port Read from and write to +.Xr divert 4 +port .Ar port , -treating all packets as packets going out of the machine. +treating all packets as +.Dq outgoing . .It Fl port | p Ar port Read from and write to +.Xr divert 4 +port .Ar port , -distinguishing packets as incoming our outgoing using the rules -specified in +distinguishing packets as +.Dq incoming +or +.Dq outgoing +using the rules specified in .Xr divert 4 . If .Ar port @@ -285,7 +303,7 @@ is not numeric, it is searched for in the .Xr services 5 database. If this option is not specified, the divert port named -.Em natd +.Ar natd will be used as a default. .It Fl alias_address | a Ar address Use @@ -295,7 +313,8 @@ If this option is not specified, the .Fl interface option must be used. The specified address is usually the address assigned to the -public network interface. +.Dq public +network interface. .Pp All data passing .Em out @@ -314,8 +333,8 @@ and assignments are checked and actioned. If no other action can be made and if .Fl deny_incoming -is not specified, the packet is delivered unaltered to the local -machine and port as specified in the packet, but see the +is not specified, the packet is delivered to the local machine +using the rules specified in .Fl target_address option below. .It Fl t | target_address Ar address @@ -352,7 +371,11 @@ option must be used. .Pp The specified .Ar interface -is usually the public network interface. +is usually the +.Dq public +(or +.Dq external ) +network interface. .It Fl config | f Ar file Read configuration from .Ar file . @@ -365,7 +388,7 @@ For example, the line .Dl alias_address 158.152.17.1 .Pp would specify an alias address of 158.152.17.1. -Options that do not take an argument are specified with an option of +Options that do not take an argument are specified with an argument of .Ar yes or .Ar no @@ -384,9 +407,15 @@ sign will mark the rest of the line as a comment. .It Fl reverse This option makes .Nm -reverse the way it handles incoming and outgoing packets, -allowing it to operate on the internal interface rather than -the external one. +reverse the way it handles +.Dq incoming +and +.Dq outgoing +packets, allowing it to operate on the +.Dq internal +network interface rather than the +.Dq external +one. .Pp This can be useful in some transparent proxying situations when outgoing traffic is redirected to the local machine @@ -437,7 +466,7 @@ The range will be cleared for all rules on startup. .El .Sh RUNNING NATD The following steps are necessary before attempting to run -.Nm natd : +.Nm : .Bl -enum .It Build a custom kernel with the following options: @@ -464,14 +493,16 @@ file or using the command If you use the .Fl interface option, make sure that your interface is already configured. -If, for example, you wish to specify tun0 as your +If, for example, you wish to specify +.Ql tun0 +as your .Ar interface , and you are using .Xr ppp 8 on that interface, you must make sure that you start .Nm ppp prior to starting -.Nm natd . +.Nm . .El .Pp Running @@ -488,7 +519,7 @@ on how to configure it to be started automatically during boot. Once .Nm is running, you must ensure that traffic is diverted to -.Nm natd : +.Nm : .Bl -enum .It You will need to adjust the @@ -502,7 +533,9 @@ following lines will do: /sbin/ipfw add pass all from any to any .Ed .Pp -The second line depends on your interface (change ed0 as appropriate). +The second line depends on your interface (change +.Ql ed0 +as appropriate). .Pp You should be aware of the fact that, with these firewall settings, everyone on your local network can fake his source-address using your @@ -517,7 +550,7 @@ the start of the script so that sees all packets before they are dropped by the firewall. .Pp After translation by -.Nm natd , +.Nm , packets re-enter the firewall at the rule number following the rule number that caused the diversion (not the next rule if there are several at the same number). @@ -547,7 +580,7 @@ disaster. .Xr services 5 , .Xr syslog.conf 5 , .Xr ipfw 8 , -.Xr ppp 8 . +.Xr ppp 8 .Sh AUTHORS This program is the result of the efforts of many people at different times: @@ -564,3 +597,5 @@ times: (early PPTP support) .An Brian Somers Aq brian@awfulhak.org (glue) +.An Ruslan Ermilov Aq ru@FreeBSD.org +(natd, packet aliasing, glue) diff --git a/sbin/newfs/newfs.8 b/sbin/newfs/newfs.8 index 1e1d3cd7852b..c1f6b494a963 100644 --- a/sbin/newfs/newfs.8 +++ b/sbin/newfs/newfs.8 @@ -40,7 +40,7 @@ .Nm mount_mfs .Nd construct a new file system .Sh SYNOPSIS -.Nm newfs +.Nm .Op Fl NO .Op Fl S Ar sector-size .Op Fl T Ar disktype @@ -118,7 +118,7 @@ corresponding file system. The parameters to .Nm mount_mfs are the same as those to -.Nm Ns . +.Nm . If the .Fl T flag is specified (see below), the special file is unused. @@ -179,7 +179,6 @@ with read/write-behind achieve higher performance with this feature disabled, so this value should be left at the default value of 0 milliseconds. See .Xr tunefs 8 for more details on how to set this option. -.ne 1i .It Fl e Ar maxbpg Indicate the maximum number of blocks any single file can allocate out of a cylinder group before it is forced to begin @@ -246,7 +245,7 @@ Specify that the disk does not contain any partitions, and that .Nm should build a file system on the whole disk. This option is useful for synthetic disks such as -.Nm vinum. +.Nm vinum . .El .Pp The following options override the standard sizes for the disk geometry. @@ -291,7 +290,6 @@ bad sector allocation. .It Fl r Ar revolutions/minute The speed of the disk in revolutions per minute. This value is no longer of interest, since all the parameters which depend on it are usually disabled. -.ne 1i .It Fl t Ar #tracks/cylinder The number of tracks/cylinder available for data allocation by the file system. diff --git a/sbin/newfs_msdos/newfs_msdos.8 b/sbin/newfs_msdos/newfs_msdos.8 index 36182269d163..701542cd40dc 100644 --- a/sbin/newfs_msdos/newfs_msdos.8 +++ b/sbin/newfs_msdos/newfs_msdos.8 @@ -32,7 +32,7 @@ .Nm newfs_msdos .Nd construct a new MS-DOS (FAT) file system .Sh SYNOPSIS -.Nm newfs_msdos +.Nm .Op Fl N .Op Fl B Ar boot .Op Fl F Ar FAT-type diff --git a/sbin/nfsd/nfsd.8 b/sbin/nfsd/nfsd.8 index f5d0efbff063..fb44149bb4d8 100644 --- a/sbin/nfsd/nfsd.8 +++ b/sbin/nfsd/nfsd.8 @@ -41,7 +41,7 @@ .Tn NFS server .Sh SYNOPSIS -.Nm nfsd +.Nm .Op Fl arut .Op Fl n Ar num_servers .Op Fl h Ar bindip @@ -51,7 +51,7 @@ runs on a server machine to service .Tn NFS requests from client machines. At least one -.Nm nfsd +.Nm must be running for a machine to operate as a server. .Pp Unless otherwise specified, four servers for @@ -118,7 +118,7 @@ RFC1094 and .%T "NFS: Network File System Version 3 Protocol Specification" . .Pp If -.Nm nfsd +.Nm detects that .Tn NFS is not loaded in the running kernel, it will attempt @@ -131,11 +131,11 @@ by way of If this fails, or no .Tn NFS KLD is available, -.Nm nfsd +.Nm will exit with an error. .Pp If -.Nm nfsd +.Nm is to be run on a host with multiple interfaces or interface aliases, use of the .Fl h @@ -148,7 +148,7 @@ would then be used to block nfs-related packets that come in on the outside interface. .Pp The -.Nm nfsd +.Nm utility exits 0 on success, and >0 if an error occurs. .Sh SEE ALSO .Xr nfsstat 1 , @@ -160,6 +160,6 @@ utility exits 0 on success, and >0 if an error occurs. .Xr ipfw 8 .Sh HISTORY The -.Nm nfsd +.Nm utility first appeared in .Bx 4.4 . diff --git a/sbin/nfsiod/nfsiod.8 b/sbin/nfsiod/nfsiod.8 index 6ff15bfe2afb..50e5a11ae3aa 100644 --- a/sbin/nfsiod/nfsiod.8 +++ b/sbin/nfsiod/nfsiod.8 @@ -41,7 +41,7 @@ .Tn NFS asynchronous I/O server .Sh SYNOPSIS -.Nm nfsiod +.Nm .Op Fl n Ar num_servers .Sh DESCRIPTION .Nm Nfsiod diff --git a/sbin/nologin/nologin.8 b/sbin/nologin/nologin.8 index d5f4cb7a5f0b..fedd4a038409 100644 --- a/sbin/nologin/nologin.8 +++ b/sbin/nologin/nologin.8 @@ -39,7 +39,7 @@ .Nm nologin .Nd politely refuse a login .Sh SYNOPSIS -.Nm nologin +.Nm .Sh DESCRIPTION .Nm Nologin displays a message that an account is not available and diff --git a/sbin/nos-tun/nos-tun.8 b/sbin/nos-tun/nos-tun.8 index f6f74eefc128..e8eb6533b2a3 100644 --- a/sbin/nos-tun/nos-tun.8 +++ b/sbin/nos-tun/nos-tun.8 @@ -15,7 +15,7 @@ .Nm nos-tun .Nd implement ``nos'' or ``ka9q'' style IP over IP tunnel .Sh SYNOPSIS -.Nm nos-tun +.Nm .Fl t .Ar tunnel .Fl s @@ -80,6 +80,7 @@ tunnel source 192.168.56.45 .Sh BUGS We don't allow for setting our source address for multihomed machines. .Sh AUTHORS +.An -nosplit .An Nickolay N. Dudorov Aq nnd@itfs.nsk.su wrote the program, .An Poul-Henning Kamp Aq phk@FreeBSD.org diff --git a/sbin/pc98/fdisk/fdisk.8 b/sbin/pc98/fdisk/fdisk.8 index 7b9d4140a154..d39ce8c19f5d 100644 --- a/sbin/pc98/fdisk/fdisk.8 +++ b/sbin/pc98/fdisk/fdisk.8 @@ -7,14 +7,14 @@ .Nm fdisk .Nd PC partition table maintenance program .Sh SYNOPSIS -.Nm fdisk +.Nm .\" !PC98 .Op Fl BIaistu .Op Fl Bastu .Op Fl b Ar bootcode .Op Fl 1234 .Op Ar disk .Bl -tag -width time -.Nm fdisk +.Nm .Fl f Ar configfile .Op Fl itv .Op Ar disk @@ -41,7 +41,7 @@ program can be used to divide space on the disk into partitions and set one .Em active . .Sh DESCRIPTION The -.Bx Free +.Fx program .Nm serves a similar purpose to the DOS program. The first form is used to @@ -197,7 +197,7 @@ The second partition overlaps the end of the first. .Bl -tag -width "cyl, sector and head" .It Em "sysmid" is used to label the partition. -.Bx Free +.Fx reserves the magic number 148 decimal (94 in hex). .It Em "start and size" @@ -272,7 +272,7 @@ While the .Fl i flag is used to "initialize" sector 0; it will setup the last BIOS partition to use the whole disk for -.Bx Free ; +.Fx ; and make it active. .Sh NOTES The automatic calculation of starting cylinder etc. uses @@ -285,7 +285,7 @@ that use geometry translation under the BIOS. .Pp If you hand craft your disk layout, please make sure that the -.Bx Free +.Fx partition starts on a cylinder boundary. A number of decisions made later may assume this. (This might not be necessary later.) @@ -344,28 +344,26 @@ This line must occur before any lines that specify partition information. .Pp It is an error if the following is not true: -.Pp -.nf - 1 <= number of cylinders - 1 <= number of heads <= 256 - 1 <= number of sectors/track < 64 -.fi +.Bd -literal -offset indent +1 <= number of cylinders +1 <= number of heads <= 256 +1 <= number of sectors/track < 64 +.Ed .Pp The number of cylinders should be less than or equal to 1024, but this is not enforced, although a warning will be output. Note that bootable -.Bx Free +.Fx partitions (the "/" filesystem) must lie completely within the first 1024 cylinders; if this is not true, booting may fail. Non-bootable partitions do not have this restriction. .Pp Example (all of these are equivalent), for a disk with 1019 cylinders, 39 heads, and 63 sectors: -.Pp -.nf - g c1019 h39 s63 - g h39 c1019 s63 - g s63 h39 c1019 -.fi +.Bd -literal -offset indent +g c1019 h39 s63 +g h39 c1019 s63 +g s63 h39 c1019 +.Ed .It Xo .Ic p .No Ar partition @@ -398,7 +396,7 @@ if one is present. The .Ar type is 165 for -.Bx Free +.Fx partitions. Specifying a partition type of zero is the same as clearing the partition and marking it as unused; however, dummy values (such as "0") must still be specified for @@ -411,20 +409,18 @@ necessary, and the end offset will be rounded downwards to a cylinder boundary if necessary. .Pp Example: to clear partition 4 and mark it as unused: -.Pp -.nf - p 4 0 0 0 -.fi +.Bd -literal -offset indent +p 4 0 0 0 +.Ed .Pp Example: to set partition 1 to a -.Bx Free +.Fx partition, starting at sector 1 for 2503871 sectors (note: these numbers will be rounded upwards and downwards to correspond to head and cylinder boundaries): -.Pp -.nf - p 1 165 1 2503871 -.fi +.Bd -literal -offset indent +p 1 165 1 2503871 +.Ed .It Xo .Ic a .No Ar partition @@ -435,13 +431,10 @@ the active partition. Can occur anywhere in the config file, but only one must be present. .Pp Example: to make partition 1 the active partition: -.Pp -.nf - a 1 -.fi - +.Bd -literal -offset indent +a 1 +.Ed .El -.Pp .Sh FILES .Bl -tag -width /boot/mbr -compact .It Pa /boot/mbr @@ -462,7 +455,7 @@ is used where it should actually be in order to conform with the terms used elsewhere. .Pp You cannot use this command to completely dedicate a disk to -.Bx Free . +.Fx . The .Xr disklabel 8 command must be used for this. diff --git a/sbin/ping/ping.8 b/sbin/ping/ping.8 index d0bffd3fd930..02f492d385f9 100644 --- a/sbin/ping/ping.8 +++ b/sbin/ping/ping.8 @@ -41,7 +41,7 @@ .Tn ICMP ECHO_REQUEST packets to network hosts .Sh SYNOPSIS -.Nm ping +.Nm .Op Fl QRadfnqrv .Op Fl c Ar count .Op Fl i Ar wait @@ -329,7 +329,7 @@ You can then examine this file for repeated patterns that you can test using the .Fl p option of -.Nm Ns . +.Nm . .Sh TTL DETAILS The .Tn TTL diff --git a/sbin/ping6/ping6.8 b/sbin/ping6/ping6.8 index f2e81f151e94..f9c25fc5a3eb 100644 --- a/sbin/ping6/ping6.8 +++ b/sbin/ping6/ping6.8 @@ -38,7 +38,7 @@ .Tn ICMPv6 ECHO_REQUEST packets to network hosts .Sh SYNOPSIS -.Nm ping6 +.Nm .\" without ipsec, or new ipsec .Op Fl dfHnNqRvw .\" old ipsec @@ -381,7 +381,7 @@ You can then examine this file for repeated patterns that you can test using the .Fl p option of -.Nm Ns . +.Nm . .Sh RETURN VALUES .Nm returns 0 on success (the host is alive), diff --git a/sbin/quotacheck/quotacheck.8 b/sbin/quotacheck/quotacheck.8 index 5a42e5ab67f8..cc903d22cf73 100644 --- a/sbin/quotacheck/quotacheck.8 +++ b/sbin/quotacheck/quotacheck.8 @@ -42,13 +42,13 @@ .Nm quotacheck .Nd filesystem quota consistency checker .Sh SYNOPSIS -.Nm quotacheck +.Nm .Op Fl g .Op Fl u .Op Fl v .Ar filesystem .Ar -.Nm quotacheck +.Nm .Op Fl g .Op Fl u .Op Fl v diff --git a/sbin/reboot/reboot.8 b/sbin/reboot/reboot.8 index 9d6476386881..c593a521e532 100644 --- a/sbin/reboot/reboot.8 +++ b/sbin/reboot/reboot.8 @@ -44,7 +44,7 @@ .Sh SYNOPSIS .Nm halt .Op Fl nqp -.Nm reboot +.Nm .Op Fl dnqp .Nm fasthalt .Op Fl nqp diff --git a/sbin/restore/restore.8 b/sbin/restore/restore.8 index af81e8661499..54410369a00a 100644 --- a/sbin/restore/restore.8 +++ b/sbin/restore/restore.8 @@ -40,32 +40,32 @@ .Nm rrestore .Nd "restore files or file systems from backups made with dump" .Sh SYNOPSIS -.Nm restore +.Nm .Fl i .Op Fl chkmNuvy .Op Fl b Ar blocksize .Op Fl f Ar file .Op Fl s Ar fileno -.Nm restore +.Nm .Fl R .Op Fl ckNuvy .Op Fl b Ar blocksize .Op Fl f Ar file .Op Fl s Ar fileno -.Nm restore +.Nm .Fl r .Op Fl ckNuvy .Op Fl b Ar blocksize .Op Fl f Ar file .Op Fl s Ar fileno -.Nm restore +.Nm .Fl t .Op Fl chkNuvy .Op Fl b Ar blocksize .Op Fl f Ar file .Op Fl s Ar fileno .Op file ... -.Nm restore +.Nm .Fl x .Op Fl chkmNuvy .Op Fl b Ar blocksize @@ -73,14 +73,14 @@ .Op Fl s Ar fileno .Op file ... .Pp -.in -\\n(iSu +.in -\n(iSu (The .Bx 4.3 option syntax is implemented for backward compatibility, but is not documented here.) .Sh DESCRIPTION The -.Nm restore +.Nm command performs the inverse function of .Xr dump 8 . A full backup of a file system may be restored and @@ -106,7 +106,7 @@ Exactly one of the following flags is required: .It Fl i This mode allows interactive restoration of files from a dump. After reading in the directory information from the dump, -.Nm restore +.Nm provides a shell like interface that allows the user to move around the directory tree selecting files to be extracted. The available commands are given below; @@ -170,7 +170,7 @@ When set, the verbose flag causes the .Ic ls command to list the inode numbers of all entries. It also causes -.Nm restore +.Nm to print out information about each file as it is extracted. .El .It Fl R @@ -208,7 +208,7 @@ restore rf /dev/rsa0 .Ed .Pp Note that -.Nm restore +.Nm leaves a file .Pa restoresymtable in the root directory to pass information between incremental @@ -238,7 +238,6 @@ Note that the flag replaces the function of the old .Xr dumpdir 8 program. -.ne 1i .It Fl x The named files are read from the given media. If a named file matches a directory whose contents @@ -265,11 +264,11 @@ The number of kilobytes per dump record. If the .Fl b option is not specified, -.Nm restore +.Nm tries to determine the media block size dynamically. .It Fl c Normally, -.Nm restore +.Nm will try to determine dynamically whether the dump was made from an old (pre-4.4) or new format file system. The .Fl c @@ -293,14 +292,14 @@ If the name of the file is of the form .Dq host:file , or .Dq user@host:file , -.Nm restore +.Nm reads from the named file on the remote host using .Xr rmt 8 . .Pp .It Fl k Use Kerberos authentication when contacting the remote tape server. (Only available if this options was enabled when -.Nm restore +.Nm was compiled.) .Pp .It Fl h @@ -332,7 +331,7 @@ To prevent this, the to create new ones. .It Fl v Normally -.Nm restore +.Nm does its work silently. The .Fl v @@ -349,24 +348,24 @@ If .Fl y has been specified, or the user responds .Ql y , -.Nm restore +.Nm will attempt to continue the restore. .Pp If a backup was made using more than one tape volume, -.Nm restore +.Nm will notify the user when it is time to mount the next volume. If the .Fl x or .Fl i flag has been specified, -.Nm restore +.Nm will also 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. .Pp There are numerous consistency checks that can be listed by -.Nm restore . +.Nm . Most checks are self-explanatory or can ``never happen''. Common errors are given below. .Pp @@ -408,7 +407,7 @@ though files may not be found on the tape. .Pp .It resync restore, skipped <num> blocks After a dump read error, -.Nm restore +.Nm may have to resynchronize itself. This message lists the number of blocks that were skipped over. .El @@ -468,6 +467,6 @@ have two different dumps started at the same time, and separate operations shouldn't conflict with each other. .Sh HISTORY The -.Nm restore +.Nm command appeared in .Bx 4.2 . diff --git a/sbin/route/route.8 b/sbin/route/route.8 index 465b675e83da..65c07e9e1b47 100644 --- a/sbin/route/route.8 +++ b/sbin/route/route.8 @@ -39,7 +39,7 @@ .Nm route .Nd manually manipulate the routing tables .Sh SYNOPSIS -.Nm route +.Nm .Op Fl dnqtv .Ar command .Oo @@ -99,14 +99,16 @@ routing lookup misses, or suspected network partitionings. The monitor command has the syntax: .Pp .Bd -filled -offset indent -compact -.Nm route Op Fl n +.Nm +.Op Fl n .Cm monitor .Ed .Pp The flush command has the syntax: .Pp .Bd -filled -offset indent -compact -.Nm route Op Fl n +.Nm +.Op Fl n .Cm flush .Op Ar family .Ed @@ -129,7 +131,8 @@ delineated family will be deleted. The other commands have the following syntax: .Pp .Bd -filled -offset indent -compact -.Nm route Op Fl n +.Nm +.Op Fl n .Ar command .Op Fl net No \&| Fl host .Ar destination gateway diff --git a/sbin/routed/routed.8 b/sbin/routed/routed.8 index e00a9cad6ca3..ed21687d3638 100644 --- a/sbin/routed/routed.8 +++ b/sbin/routed/routed.8 @@ -43,7 +43,7 @@ .Nm rdisc .Nd network RIP and router discovery routing daemon .Sh SYNOPSIS -.Nm routed +.Nm .Op Fl sqdghmpAtv .Op Fl T Ar tracefile .Oo @@ -167,7 +167,7 @@ of ICMP Redirect messages are deleted after a while to minimize .Em black-holes . When a TCP connection suffers a timeout, the kernel tells -.Nm Ns , +.Nm , which deletes all redirected routes through the gateway involved, advances the age of all RIP routes through the gateway to allow an alternate to be chosen, and advances of the @@ -422,7 +422,7 @@ that another routing process will install such a route if necessary, and that other routes to that destination should not be installed by -.Nm Ns . +.Nm . Such entries are only required when both routers may learn of routes to the same destination. .Pp @@ -469,7 +469,7 @@ or or .Xr named 8 , must have been started before -.Nm Ns .) +.Nm . ) .Pp .Ar Mask is an optional number between 1 and 32 indicating the netmask associated diff --git a/sbin/routed/rtquery/rtquery.8 b/sbin/routed/rtquery/rtquery.8 index c7dcab7e157d..c0e1f06b067f 100644 --- a/sbin/routed/rtquery/rtquery.8 +++ b/sbin/routed/rtquery/rtquery.8 @@ -14,7 +14,6 @@ .Op Fl r Ar addr .Op Fl a Ar secret .Ar host ... -.br .Nm .Op Fl t Ar op .Ar host ... diff --git a/sbin/savecore/savecore.8 b/sbin/savecore/savecore.8 index 37e1f7184e07..78429a239bc0 100644 --- a/sbin/savecore/savecore.8 +++ b/sbin/savecore/savecore.8 @@ -39,9 +39,9 @@ .Nm savecore .Nd "save a core dump of the operating system" .Sh SYNOPSIS -.Nm savecore +.Nm .Fl c -.Nm savecore +.Nm .Op Fl fvz .Op Fl N Ar system .Ar directory diff --git a/sbin/shutdown/shutdown.8 b/sbin/shutdown/shutdown.8 index bf2276b830f4..d8c987d9ff1f 100644 --- a/sbin/shutdown/shutdown.8 +++ b/sbin/shutdown/shutdown.8 @@ -39,7 +39,7 @@ .Nm shutdown .Nd "close down the system at a given time" .Sh SYNOPSIS -.Nm shutdown +.Nm .Op Fl .Oo .Fl h | Fl p | diff --git a/sbin/slattach/slattach.8 b/sbin/slattach/slattach.8 index 6bdb275cd2be..cb458607b97c 100644 --- a/sbin/slattach/slattach.8 +++ b/sbin/slattach/slattach.8 @@ -40,7 +40,7 @@ .Nm slattach .Nd attach serial lines as network interfaces .Sh SYNOPSIS -.Nm slattach +.Nm .Op Fl a .Op Fl c .Op Fl e Ar exit-command @@ -124,12 +124,12 @@ using more than one slip line. When .Nm is connected for the first time, -.Ql Nm "sh -c" Ar unit-command Nm \-1 Ar new +.Ql Nm "sh -c" Ar unit-command \-1 new is run. When .Nm is disconnected, -.Ql Nm "sh -c" Ar unit-command old Nm \-1 +.Ql Nm "sh -c" Ar unit-command old \-1 is run. .Nm Slattach will abort if the unit number @@ -233,7 +233,7 @@ slattach \-r 'kermit -y dial.script >kermit.log 2>&1' .Sh DIAGNOSTICS Look for error messages in .Pa /var/log/messages -.Pf ( Nm slattach +.No ( Nm is a daemon). Messages indicating the specified interface does not exit, the requested address is unknown, the user is not privileged and tried to diff --git a/sbin/spppcontrol/spppcontrol.8 b/sbin/spppcontrol/spppcontrol.8 index d9d8dde88118..d531de9185b2 100644 --- a/sbin/spppcontrol/spppcontrol.8 +++ b/sbin/spppcontrol/spppcontrol.8 @@ -31,7 +31,7 @@ .Nm spppcontrol .Nd display or set parameters for an sppp interface .Sh SYNOPSIS -.Nm spppcontrol +.Nm .Op Fl v .Ar ifname .Op Ar parameter Ns Op \&= Ns Ar value @@ -224,6 +224,5 @@ utility appeared in .Fx 3.0 . .Sh AUTHORS The program was written by -.ie t J\(:org Wunsch, -.el Joerg Wunsch, +.An J\(:org Wunsch , Dresden. diff --git a/sbin/startslip/startslip.1 b/sbin/startslip/startslip.1 index 285816b5edee..7f2632ab5fbf 100644 --- a/sbin/startslip/startslip.1 +++ b/sbin/startslip/startslip.1 @@ -39,7 +39,7 @@ .Nm startslip .Nd dial up and login to a slip server .Sh SYNOPSIS -.Nm startslip +.Nm .Op Fl d .Op Fl b Ar speed [ @@ -79,14 +79,14 @@ and goes to wait mode. If carrier drops (modem control enabled) or a .Dv SIGHUP is sent to -.Nm Ns , +.Nm , it closes the device, calls .Ar downscript and attempts to repeat the dialup and login sequence. If a .Dv SIGTERM is send to -.Nm Ns , +.Nm , it closes the device, calls .Ar downscript and exits. diff --git a/sbin/swapon/swapon.8 b/sbin/swapon/swapon.8 index 8779299ab388..6e22dced4cbc 100644 --- a/sbin/swapon/swapon.8 +++ b/sbin/swapon/swapon.8 @@ -39,9 +39,9 @@ .Nm swapon .Nd "specify additional device for paging and swapping" .Sh SYNOPSIS -.Nm swapon +.Nm .Fl a -.Nm swapon +.Nm .Ar special_file ... .Sh DESCRIPTION .Nm Swapon diff --git a/sbin/sysctl/sysctl.8 b/sbin/sysctl/sysctl.8 index af76a9bc8367..95431d3c5d26 100644 --- a/sbin/sysctl/sysctl.8 +++ b/sbin/sysctl/sysctl.8 @@ -39,14 +39,14 @@ .Nm sysctl .Nd get or set kernel state .Sh SYNOPSIS -.Nm sysctl +.Nm .Op Fl bn .Ar name ... -.Nm sysctl +.Nm .Op Fl bn .Fl w .Ar name=value ... -.Nm sysctl +.Nm .Op Fl bn .Fl aAX .Sh DESCRIPTION diff --git a/sbin/tunefs/tunefs.8 b/sbin/tunefs/tunefs.8 index ae86c7b923f0..c2a05012fecb 100644 --- a/sbin/tunefs/tunefs.8 +++ b/sbin/tunefs/tunefs.8 @@ -39,7 +39,7 @@ .Nm tunefs .Nd tune up an existing file system .Sh SYNOPSIS -.Nm tunefs +.Nm .Op Fl A .Op Fl a Ar maxcontig .Op Fl d Ar rotdelay diff --git a/sbin/umount/umount.8 b/sbin/umount/umount.8 index d8222da1a304..2b11394c582e 100644 --- a/sbin/umount/umount.8 +++ b/sbin/umount/umount.8 @@ -39,10 +39,10 @@ .Nm umount .Nd unmount filesystems .Sh SYNOPSIS -.Nm umount +.Nm .Op Fl fv .Ar special \&| node -.Nm umount +.Nm .Fl a | A .Op Fl fv .Op Fl h Ar host diff --git a/sbin/vinum/vinum.8 b/sbin/vinum/vinum.8 index 344d8229c992..5f629e6abe19 100644 --- a/sbin/vinum/vinum.8 +++ b/sbin/vinum/vinum.8 @@ -273,7 +273,7 @@ Set the state of the object to \fIstate\fP\| .Cd setdaemon .Op value .in +1i -Set dæmon configuration. +Set daemon configuration. .in .Cd setstate .Ar state @@ -315,7 +315,7 @@ is a utility program to communicate with the \fBVinum\fP\| logical volume manager. See .Xr vinum 4 for more information about the volume manager. -.Xr vinum 8 +.Nm is designed either for interactive use, when started without command line arguments, or to execute a single command if the command is supplied on the command line. In interactive mode, @@ -905,7 +905,7 @@ This command is deprecated. .Ar list is used to show information about the specified object. If the argument is omitted, information is shown about all objects known to -.Nm vinum . +.Nm . The .Ar l command is a synonym for @@ -1219,7 +1219,7 @@ care: it can result in total loss of data on a volume. .Nm setdaemon sets a variable bitmask for the .Nm -dæmon. This command is temporary and will be replaced. Currently, the bit mask +daemon. This command is temporary and will be replaced. Currently, the bit mask may contain the bits 1 (log every action to syslog) and 4 (don't update configuration). Option bit 4 can be useful for error recovery. .It Nm setstate @@ -1355,7 +1355,7 @@ If no parameters are specified, removes the .Nm kld and stops -.Xr vinum 8 . +.Nm . This can only be done if no objects are active. In particular, the .Fl f option does not override this requirement. Normally, the @@ -1633,7 +1633,7 @@ must be the name of a disk partition, for example or .Pa /dev/wd3s2h , and it must be of type -.Nm vinum . +.Nm . Do not use the .Nm c partition, which is reserved for the complete disk. @@ -1907,7 +1907,7 @@ the maximum size of a subdisk is 265 sectors smaller than the drive. maintains a log file, by default .Pa /var/log/vinum_history , in which it keeps track of the commands issued to -.Nm vinum . +.Nm . You can override the name of this file by setting the environment variable .Ev VINUM_HISTORY to the name of the file. @@ -1926,7 +1926,7 @@ system. .Ss Where to put the data The first choice you need to make is where to put the data. You need dedicated disk partitions for -.Nm vinum . +.Nm . They should be partitions, not devices, and they should not be partition .Nm c . For example, good names are @@ -2299,16 +2299,20 @@ command. A number of misconceptions exist about how to set up a RAID array for best performance. In particular, most systems use far too small a stripe size. The following discussion applies to all RAID systems, not just to -.Nm vinum . +.Nm . .Pp -The FreeBSD block I/O system issues requests of between .5kB and 60 kB; a +The +.Fx +block I/O system issues requests of between .5kB and 60 kB; a typical mix is somewhere round 8 kB. You can't stop any striping system from breaking a request into two physical requests, and if you do it wrong it can be broken into several. This will result in a significant drop in performance: the decrease in transfer time per disk is offset by the order of magnitude greater increase in latency. .Pp -With modern disk sizes and the FreeBSD I/O system, you can expect to have a +With modern disk sizes and the +.Fx +I/O system, you can expect to have a reasonably small number of fragmented requests with a stripe size between 256 kB and 512 kB; with correct RAID implementations there is no obvious reason not to increase the size to 2 or 4 MB on a large disk. @@ -2506,7 +2510,8 @@ you can easily overwrite a file system. will not permit this. .Pp For similar reasons, the -.Nm vinum Ar start +.Nm +.Ar start command will not accept a drive on partition .Ar c . Partition @@ -2545,7 +2550,8 @@ provides two ways to ensure that newly created plexes are .Bl -bullet .It Create the plexes and then synchronize them with -.Nm vinum start . +.Nm +.Ar start . .It Create the volume (not the plex) with the keyword .Ar setupstate , @@ -2584,7 +2590,7 @@ please report the situation. If you build the kernel module with the .Ar -DVINUMDEBUG option, you must also build -.Nm vinum(8) +.Nm with the .Ar -DVINUMDEBUG option, since the size of some data objects used by both components depends on @@ -2599,12 +2605,15 @@ vinumioctl: invalid ioctl from process 247 (vinum): c0e44642 This error may also occur if you use old versions of kld or userland program. .It The -.Nm vinum Ar read +.Nm +.Ar read command has a particularly emetic syntax. Once it was the only way to start -.Nm vinum , +.Nm , but now the preferred method is with -.Nm vinum Ar start . -.Nm vinum Ar read +.Nm +.Ar start . +.Nm +.Ar read should be used for maintenance purposes only. Note that its syntax has changed, and the arguments must be disk slices, such as .Pa /dev/da0 , @@ -2620,7 +2629,7 @@ objects. .br .Ar /dev/vinum/control - control device for -.Nm vinum +.Nm .br .Ar /dev/vinum/plex - directory containing device nodes for @@ -2648,7 +2657,7 @@ The name of the editor to use for editing configuration files, by default .Xr newfs 8 , .Pa http://www.lemis.com/vinum.html , .Pa http://www.lemis.com/vinum-debugging.html . -.Sh AUTHOR +.Sh AUTHORS .An Greg Lehey Aq grog@lemis.com . .Sh HISTORY The |