sbin/newfs/newfs.8

   1 .\" Copyright (c) 1983, 1987, 1991, 1993, 1994
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)newfs.8     8.6 (Berkeley) 5/3/95
  33 .\" $FreeBSD: src/sbin/newfs/newfs.8,v 1.26.2.15 2003/05/13 12:16:08 joerg Exp $
  34 .\" $DragonFly: src/sbin/newfs/newfs.8,v 1.2 2003/06/17 04:27:34 dillon Exp $
  35 .\"
  36 .Dd May 13, 2003
  37 .Dt NEWFS 8
  38 .Os
  39 .Sh NAME
  40 .Nm newfs ,
  41 .Nm mount_mfs
  42 .Nd construct a new file system
  43 .Sh SYNOPSIS
  44 .Nm
  45 .Op Fl NOU
  46 .Op Fl S Ar sector-size
  47 .Op Fl T Ar disktype
  48 .Op Fl a Ar maxcontig
  49 .Op Fl b Ar block-size
  50 .Op Fl c Ar cylinders
  51 .Op Fl d Ar rotdelay
  52 .Op Fl e Ar maxbpg
  53 .Op Fl f Ar frag-size
  54 .Op Fl g Ar avgfilesize
  55 .Op Fl h Ar avfpdir
  56 .Op Fl i Ar bytes
  57 .Op Fl k Ar skew
  58 .Op Fl l Ar interleave
  59 .Op Fl m Ar free space
  60 .Op Fl n Ar rotational positions
  61 .Op Fl o Ar optimization
  62 .Op Fl p Ar sectors
  63 .Op Fl r Ar revolutions
  64 .Op Fl s Ar size
  65 .Op Fl t Ar tracks
  66 .Op Fl u Ar sectors
  67 .Op Fl v
  68 .Op Fl x Ar sectors
  69 .Ar special
  70 .Nm mount_mfs
  71 .Op Fl NU
  72 .Op Fl F Ar file
  73 .Op Fl T Ar disktype
  74 .Op Fl a Ar maxcontig
  75 .Op Fl b Ar block-size
  76 .Op Fl c Ar cylinders
  77 .Op Fl d Ar rotdelay
  78 .Op Fl e Ar maxbpg
  79 .Op Fl f Ar frag-size
  80 .Op Fl i Ar bytes
  81 .Op Fl m Ar free space
  82 .Op Fl n Ar rotational positions
  83 .Op Fl o Ar options
  84 .Op Fl s Ar size
  85 .Op Fl v
  86 .Ar special node
  87 .Sh DESCRIPTION
  88 .Nm Newfs
  89 is used to initialize and clear filesystems before first use.
  90 Before running
  91 .Nm
  92 or
  93 .Nm mount_mfs ,
  94 the disk must be labeled using
  95 .Xr disklabel 8 .
  96 .Nm Newfs
  97 builds a file system on the specified special file.
  98 (We often refer to the
  99 .Dq special file
 100 as the
 101 .Dq disk ,
 102 although the special file need not be a physical disk.
 103 In fact, it need not even be special.)
 104 Typically the defaults are reasonable, however
 105 .Nm
 106 has numerous options to allow the defaults to be selectively overridden.
 107 .Pp
 108 .Nm Mount_mfs
 109 is used to build a file system in virtual memory and then mount it
 110 on a specified node.
 111 .Nm Mount_mfs
 112 exits and the contents of the file system are lost
 113 when the file system is unmounted.
 114 If
 115 .Nm mount_mfs
 116 is sent a signal while running,
 117 for example during system shutdown,
 118 it will attempt to unmount its
 119 corresponding file system.
 120 The parameters to
 121 .Nm mount_mfs
 122 are the same as those to
 123 .Nm .
 124 If the
 125 .Fl T
 126 flag is specified (see below), the special file is unused.
 127 Otherwise, it is only used to read the disk label which provides
 128 a set of configuration parameters for the memory based file system.
 129 The special file is typically that of the primary swap area,
 130 since that is where the file system will be backed up when
 131 free memory gets low and the memory supporting
 132 the file system has to be paged.
 133 .Pp
 134 The following options define the general layout policies:
 135 .Bl -tag -width indent
 136 .It Fl T Ar disktype
 137 For backward compatibility and for
 138 .Nm mount_mfs .
 139 .It Fl F Ar file
 140 .Nm Mount_mfs
 141 will use this file for the image of the filesystem.  When
 142 .Nm mount_mfs
 143 exits, this file will be left behind.
 144 .It Fl N
 145 Cause the file system parameters to be printed out
 146 without really creating the file system.
 147 .It Fl O
 148 Create a
 149 .Bx 4.3
 150 format filesystem.
 151 This options is primarily used to build root filesystems
 152 that can be understood by older boot ROMs.
 153 .It Fl T
 154 Use information for the specified disk from
 155 .Pa /etc/disktab
 156 instead of trying to get the information from a disklabel.
 157 .It Fl U
 158 Enables soft updates on the new filesystem.
 159 .It Fl a Ar maxcontig
 160 Specify the maximum number of contiguous blocks that will be
 161 laid out before forcing a rotational delay (see the
 162 .Fl d
 163 option).
 164 The default value is 1.
 165 See
 166 .Xr tunefs 8
 167 for more details on how to set this option.
 168 .It Fl b Ar block-size
 169 The block size of the file system, in bytes.  It must be a power of 2.  The
 170 default size is 16384 bytes, and the smallest allowable size is 4096 bytes.
 171 The optimal block:fragment ratio is 8:1.
 172 Other ratios are possible, but are not recommended,
 173 and may produce unpredictable results.
 174 .It Fl c Ar #cylinders/group
 175 The number of cylinders per cylinder group in a file system.  The default
 176 is to compute the maximum allowed by the other parameters.  This value is
 177 dependent on a number of other parameters, in particular the block size
 178 and the number of bytes per inode.
 179 .It Fl d Ar rotdelay
 180 This parameter once specified the minimum time in milliseconds required to
 181 initiate another disk transfer on the same cylinder.  It was used in determining
 182 the rotationally optimal layout for disk blocks within a file.  Modern disks
 183 with read/write-behind achieve higher performance with this feature disabled, so
 184 this value should be left at the default value of 0 milliseconds.  See
 185 .Xr tunefs 8
 186 for more details on how to set this option.
 187 .It Fl e Ar maxbpg
 188 Indicate the maximum number of blocks any single file can
 189 allocate out of a cylinder group before it is forced to begin
 190 allocating blocks from another cylinder group.
 191 The default is about one quarter of the total blocks in a cylinder group.
 192 See
 193 .Xr tunefs 8
 194 for more details on how to set this option.
 195 .It Fl f Ar frag-size
 196 The fragment size of the file system in bytes.  It must be a power of two
 197 ranging in value between
 198 .Ar blocksize Ns /8
 199 and
 200 .Ar blocksize .
 201 The default is 2048 bytes.
 202 .It Fl g Ar avgfilesize
 203 The expected average file size for the file system.
 204 .It Fl h Ar avgfpdir
 205 The expected average number of files per directory on the file system.
 206 .It Fl i Ar number of bytes per inode
 207 Specify the density of inodes in the file system.
 208 The default is to create an inode for every
 209 .Pq 4 * Ar frag-size
 210 bytes of data space.
 211 If fewer inodes are desired, a larger number should be used;
 212 to create more inodes a smaller number should be given.
 213 One inode is required for each distinct file, so this value effectively
 214 specifies the average file size on the file system.
 215 .It Fl m Ar free space \&%
 216 The percentage of space reserved from normal users; the minimum free
 217 space threshold.
 218 The default value used is
 219 defined by
 220 .Dv MINFREE
 221 from
 222 .Aq Pa ufs/ffs/fs.h ,
 223 currently 8%.
 224 See
 225 .Xr tunefs 8
 226 for more details on how to set this option.
 227 .It Fl n Ar number of distinguished rotational positions
 228 UFS has the ability to keep track of the availability of blocks at different
 229 rotational positions, so that it could lay out the data to be picked up with
 230 minimum rotational latency.  This parameter specifies the default number of
 231 rotational positions to distinguish.
 232 .Pp
 233 Nowadays this value should be set to 1 (which essentially disables the
 234 rotational position table) because modern drives with read-ahead and
 235 write-behind do better without the rotational position table.
 236 .It Fl o Ar optimization\ preference
 237 .Pq Ar space No or Ar time .
 238 The file system can either be instructed to try to minimize the time spent
 239 allocating blocks, or to try to minimize the space fragmentation on the disk.
 240 If the value of minfree (see above) is less than 8%,
 241 the default is to optimize for
 242 .Ar space ;
 243 if the value of minfree is greater than or equal to 8%,
 244 the default is to optimize for
 245 .Ar time .
 246 See
 247 .Xr tunefs 8
 248 for more details on how to set this option.
 249 .It Fl s Ar size
 250 The size of the file system in sectors.  This value defaults to the size of the
 251 raw partition specified in
 252 .Ar special
 253 (in other words,
 254 .Nm
 255 will use the entire partition for the file system).
 256 .It Fl v
 257 Specify that the disk does not contain any partitions, and that
 258 .Nm
 259 should build a file system on the whole disk.
 260 This option is useful for synthetic disks such as
 261 .Nm vinum .
 262 .El
 263 .Pp
 264 The following options override the standard sizes for the disk geometry.
 265 Their default values are taken from the disk label.
 266 Changing these defaults is useful only when using
 267 .Nm
 268 to build a file system whose raw image will eventually be used on a
 269 different type of disk than the one on which it is initially created
 270 (for example on a write-once disk).
 271 Note that changing any of these values from their defaults will make
 272 it impossible for
 273 .Xr fsck 8
 274 to find the alternate superblocks if the standard superblock is lost.
 275 .Bl -tag -width indent
 276 .It Fl S Ar sector-size
 277 The size of a sector in bytes (almost never anything but 512).
 278 .It Fl k Ar sector \&0 skew , per track
 279 Used to describe perturbations in the media format to compensate for
 280 a slow controller.
 281 Track skew is the offset of sector 0 on track N relative to sector 0
 282 on track N-1 on the same cylinder.
 283 This option is of historical importance only; modern controllers are always fast
 284 enough to handle operations back-to-back.
 285 .It Fl l Ar hardware sector interleave
 286 Used to describe perturbations in the media format to compensate for
 287 a slow controller.
 288 Interleave is physical sector interleave on each track,
 289 specified as the denominator of the ratio:
 290 .Dl sectors read/sectors passed over
 291 Thus an interleave of 1/1 implies contiguous layout, while 1/2 implies
 292 logical sector 0 is separated by one sector from logical sector 1.
 293 This option is of historical importance only; the physical sector layout of
 294 modern disks is not visible from outside.
 295 .It Fl p Ar spare sectors per track
 296 Spare sectors (bad sector replacements) are physical sectors that occupy
 297 space at the end of each track.
 298 They are not counted as part of the sectors/track
 299 .Pq Fl u
 300 since they are not available to the file system for data allocation.
 301 This option is of historical importance only.  Modern disks perform their own
 302 bad sector allocation.
 303 .It Fl r Ar revolutions/minute
 304 The speed of the disk in revolutions per minute.  This value is no longer of
 305 interest, since all the parameters which depend on it are usually disabled.
 306 .It Fl t Ar #tracks/cylinder
 307 The number of tracks/cylinder available for data allocation by the file
 308 system.
 309 The default is 1.
 310 If zero is specified, the value from the disklabel will be used.
 311 .It Fl u Ar sectors/track
 312 The number of sectors per track available for data allocation by the file
 313 system.
 314 The default is 4096.
 315 If zero is specified, the value from the disklabel will be used.
 316 This does not include sectors reserved at the end of each track for bad
 317 block replacement (see the
 318 .Fl p
 319 option).
 320 .It Fl x Ar spare sectors per cylinder
 321 Spare sectors (bad sector replacements) are physical sectors that occupy
 322 space at the end of the last track in the cylinder.
 323 They are deducted from the sectors/track
 324 .Pq Fl u
 325 of the last track of each cylinder since they are not available to the file
 326 system for data allocation.
 327 This option is of historical importance only.  Modern disks perform their own
 328 bad sector allocation.
 329 .El
 330 .Pp
 331 The options to the
 332 .Nm mount_mfs
 333 command are as described for the
 334 .Nm
 335 command, except for the
 336 .Fl o
 337 option.
 338 .Pp
 339 That option is as follows:
 340 .Bl -tag -width indent
 341 .It Fl o
 342 Options are specified with a
 343 .Fl o
 344 flag followed by a comma separated string of options.
 345 See the
 346 .Xr mount 8
 347 man page for possible options and their meanings.
 348 .El
 349 .Sh EXAMPLES
 350 .Dl newfs /dev/ad3s1a
 351 .Pp
 352 Creates a new ufs file system on
 353 .Pa ad3s1a .
 354 .Nm
 355 will use a block size of 16384 bytes, a fragment size of 2048 bytes
 356 and the largest possible number of cylinders per group.
 357 These values tend to produce better performance for most applications
 358 than the historical defaults
 359 (8192 byte block size and 1024 byte fragment size).
 360 This large fragment size
 361 may lead to large amounts of wasted space
 362 on filesystems that contain a large number of small files.
 363 .Pp
 364 .Dl mount_mfs -s 131072 -o nosuid,nodev,nosymfollow /dev/da0s1b /tmp
 365 .Pp
 366 Mount a 64 MB large memory file system on
 367 .Pa /tmp ,
 368 with
 369 .Xr mount 8
 370 options
 371 .Ar nosuid ,
 372 .Ar nodev ,
 373 and
 374 .Ar nosymfollow .
 375 .Sh SEE ALSO
 376 .Xr fdformat 1 ,
 377 .Xr disktab 5 ,
 378 .Xr fs 5 ,
 379 .Xr camcontrol 8 ,
 380 .Xr disklabel 8 ,
 381 .Xr diskpart 8 ,
 382 .Xr dumpfs 8 ,
 383 .Xr fsck 8 ,
 384 .Xr mount 8 ,
 385 .Xr tunefs 8 ,
 386 .Xr vinum 8
 387 .Rs
 388 .%A M. McKusick
 389 .%A W. Joy
 390 .%A S. Leffler
 391 .%A R. Fabry
 392 .%T A Fast File System for UNIX
 393 .%J ACM Transactions on Computer Systems 2
 394 .%V 3
 395 .%P pp 181-197
 396 .%D August 1984
 397 .%O (reprinted in the BSD System Manager's Manual)
 398 .Re
 399 .Sh HISTORY
 400 The
 401 .Nm
 402 command appeared in
 403 .Bx 4.2 .