summaryrefslogtreecommitdiff
path: root/sbin/newfs/newfs.8
diff options
context:
space:
mode:
authorJason McIntyre <jmc@cvs.openbsd.org>2005-06-27 09:48:06 +0000
committerJason McIntyre <jmc@cvs.openbsd.org>2005-06-27 09:48:06 +0000
commitf57586a08cf7046bd7b8c21215825a5c5a82372b (patch)
tree8270a3f39226149717d951c15639e738929c8825 /sbin/newfs/newfs.8
parent009e4169664c2072a3dd795cd43ed6443c96f5be (diff)
- sort synopsis and options list
- sync the args in the options list to those in synopsis, and avoid using structures such as `-l very long description of single arg'
Diffstat (limited to 'sbin/newfs/newfs.8')
-rw-r--r--sbin/newfs/newfs.891
1 files changed, 45 insertions, 46 deletions
diff --git a/sbin/newfs/newfs.8 b/sbin/newfs/newfs.8
index fc6618b995c..fa2c7e46743 100644
--- a/sbin/newfs/newfs.8
+++ b/sbin/newfs/newfs.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: newfs.8,v 1.43 2004/11/28 06:25:48 tedu Exp $
+.\" $OpenBSD: newfs.8,v 1.44 2005/06/27 09:48:05 jmc Exp $
.\" $NetBSD: newfs.8,v 1.12 1995/03/18 14:58:41 cgd Exp $
.\"
.\" Copyright (c) 1983, 1987, 1991, 1993, 1994
@@ -39,8 +39,7 @@
.Sh SYNOPSIS
.Nm newfs
.Bk -words
-.Op Fl NO
-.Op Fl S Ar sector-size
+.Op Fl NOq
.Op Fl a Ar maxcontig
.Op Fl b Ar block-size
.Op Fl c Ar cylinders
@@ -52,12 +51,12 @@
.Op Fl i Ar bytes
.Op Fl k Ar skew
.Op Fl l Ar interleave
-.Op Fl m Ar free space
+.Op Fl m Ar free-space
.Op Fl n Ar nrpos
.Op Fl o Ar optimization
.Op Fl p Ar sectors
-.Op Fl q
.Op Fl r Ar revolutions
+.Op Fl S Ar sector-size
.Op Fl s Ar size
.Op Fl t Ar fstype
.Op Fl u Ar sectors
@@ -68,7 +67,6 @@
.Pp
.Nm mount_mfs
.Bk -words
-.Op Fl P Ar file
.Op Fl a Ar maxcontig
.Op Fl b Ar block-size
.Op Fl c Ar cylinders
@@ -78,6 +76,7 @@
.Op Fl i Ar bytes
.Op Fl m Ar free space
.Op Fl o Ar options
+.Op Fl P Ar file
.Op Fl s Ar size
.Ar special node
.Ek
@@ -140,20 +139,6 @@ file system (or list the inode generation numbers).
.Pp
The following options define the general layout policies:
.Bl -tag -width Fl
-.It Fl N
-Causes the file system parameters to be printed out
-without really creating the file system.
-.It Fl O
-Creates a
-.Bx 4.3
-format file system.
-This option is primarily used to build root file systems
-that can be understood by older boot ROMs.
-.It Fl q
-Operate in quiet mode.
-With this option,
-.Nm
-will not print extraneous information like superblock backups.
.It Fl a Ar maxcontig
This specifies the maximum number of contiguous blocks that will be
laid out before forcing a rotational delay (see the
@@ -167,7 +152,7 @@ for more details on how to set this option.
.It Fl b Ar block-size
The block size of the file system, in bytes.
The default is 16KB.
-.It Fl c Ar #cylinders/group
+.It Fl c Ar cylinders
The number of cylinders per cylinder group in a file system.
The default is to use as many as fit with the other parameters given.
.It Fl d Ar rotdelay
@@ -192,22 +177,31 @@ The default is 2048.
The expected average file size for the file system in bytes.
.It Fl h Ar avgfpdir
The expected average number of files per directory on the file system.
-.It Fl i Ar number of bytes per inode
+.It Fl i Ar bytes
This specifies the density of inodes in the file system.
The default is to create an inode for each 8192 bytes of data space.
If fewer inodes are desired, a larger number should be used;
to create more inodes a smaller number should be given.
-.It Fl m Ar free space \&%
+.It Fl m Ar free-space
The percentage of space reserved from normal users; the minimum free
space threshold.
The default value used is 5%.
See
.Xr tunefs 8
for more details on how to set this option.
-.It Fl n Ar number of rotational positions
+.It Fl N
+Causes the file system parameters to be printed out
+without really creating the file system.
+.It Fl n Ar nrpos
The number of distinct rotational positions.
The default is 1.
-.It Fl o Ar optimization\ preference
+.It Fl O
+Creates a
+.Bx 4.3
+format file system.
+This option is primarily used to build root file systems
+that can be understood by older boot ROMs.
+.It Fl o Ar optimization
.Ar space
or
.Ar time .
@@ -220,6 +214,11 @@ the default is to optimize for time.
See
.Xr tunefs 8
for more details on how to set this option.
+.It Fl q
+Operate in quiet mode.
+With this option,
+.Nm
+will not print extraneous information like superblock backups.
.It Fl s Ar size
The size of the file system in sectors.
The maximum size of a file system is 2,147,483,647 (2^31 \- 1) sectors,
@@ -238,14 +237,12 @@ it impossible for
.Xr fsck 8
to find the alternate superblocks if the standard superblock is lost.
.Bl -tag -width Fl
-.It Fl S Ar sector-size
-The size of a sector in bytes (almost never anything but 512).
-.It Fl k Ar sector \&0 skew , per track
+.It Fl k Ar skew
Used to describe perturbations in the media format to compensate for
a slow controller.
Track skew is the offset of sector 0 on track N relative to sector 0
on track N\-1 on the same cylinder.
-.It Fl l Ar hardware sector interleave
+.It Fl l Ar interleave
Used to describe perturbations in the media format to compensate for
a slow controller.
Interleave is physical sector interleave on each track,
@@ -253,35 +250,37 @@ specified as the denominator of the ratio:
.Dl sectors read/sectors passed over
Thus an interleave of 1/1 implies contiguous layout, while 1/2 implies
logical sector 0 is separated by one sector from logical sector 1.
-.It Fl p Ar spare sectors per track
+.It Fl p Ar sectors
Spare sectors (bad sector replacements) are physical sectors that occupy
space at the end of each track.
They are not counted as part of the sectors/track
.Pq Fl u
since they are not available to the file system for data allocation.
-.It Fl r Ar revolutions/minute
+.It Fl r Ar revolutions
The speed of the disk in revolutions per minute.
-.It Fl z Ar #tracks/cylinder
-The number of tracks/cylinder available for data allocation by the file
-system.
+.It Fl S Ar sector-size
+The size of a sector in bytes (almost never anything but 512).
.It Fl t Ar fstype
Set the file system type of which file system you wish to create.
.Nm
will be smart enough to run the alternate newfs_XXX program instead.
-.It Fl u Ar sectors/track
+.It Fl u Ar sectors
The number of sectors per track available for data allocation by the file
system.
This does not include sectors reserved at the end of each track for bad
block replacement (see the
.Fl p
option).
-.It Fl x Ar spare sectors per cylinder
+.It Fl x Ar sectors
Spare sectors (bad sector replacements) are physical sectors that occupy
space at the end of the last track in the cylinder.
They are deducted from the sectors/track
.Pq Fl u
of the last track of each cylinder since they are not available to the file
system for data allocation.
+.It Fl z Ar tracks
+The number of tracks/cylinder available for data allocation by the file
+system.
.El
.Pp
The options to the
@@ -289,13 +288,20 @@ The options to the
command are as described for the
.Nm
command, except for the
-.Fl P
-option and the
.Fl o
-option.
+and
+.Fl P
+options.
.Pp
These options are as follows:
.Bl -tag -width indent
+.It Fl o Ar options
+Options are specified with a
+.Fl o
+flag followed by a comma separated string of options.
+See the
+.Xr mount 8
+man page for possible options and their meanings.
.It Fl P Ar file
If
.Ar file
@@ -305,13 +311,6 @@ If
.Ar file
is a block device, populate the created mfs file system with
the contents of the FFS file system contained on the device.
-.It Fl o
-Options are specified with a
-.Fl o
-flag followed by a comma separated string of options.
-See the
-.Xr mount 8
-man page for possible options and their meanings.
.El
.Pp
If the