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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)newfs.8     8.6 (Berkeley) 5/3/95
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd January 29, 2019
  32 .Dt NEWFS 8
  33 .Os
  34 .Sh NAME
  35 .Nm newfs
  36 .Nd construct a new UFS1/UFS2 file system
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl EJNUjlnt
  40 .Op Fl L Ar volname
  41 .Op Fl O Ar filesystem-type
  42 .Op Fl S Ar sector-size
  43 .Op Fl T Ar disktype
  44 .Op Fl a Ar maxcontig
  45 .Op Fl b Ar block-size
  46 .Op Fl c Ar blocks-per-cylinder-group
  47 .Op Fl d Ar max-extent-size
  48 .Op Fl e Ar maxbpg
  49 .Op Fl f Ar frag-size
  50 .Op Fl g Ar avgfilesize
  51 .Op Fl h Ar avgfpdir
  52 .Op Fl i Ar bytes
  53 .Op Fl k Ar held-for-metadata-blocks
  54 .Op Fl m Ar free-space
  55 .Op Fl o Ar optimization
  56 .Op Fl p Ar partition
  57 .Op Fl r Ar reserved
  58 .Op Fl s Ar size
  59 .Ar special
  60 .Sh DESCRIPTION
  61 The
  62 .Nm
  63 utility is used to initialize and clear file systems before first use.
  64 The
  65 .Nm
  66 utility builds a file system on the specified special file.
  67 (We often refer to the
  68 .Dq special file
  69 as the
  70 .Dq disk ,
  71 although the special file need not be a physical disk.
  72 In fact, it need not even be special.)
  73 Typically the defaults are reasonable, however
  74 .Nm
  75 has numerous options to allow the defaults to be selectively overridden.
  76 .Pp
  77 The following options define the general layout policies:
  78 .Bl -tag -width indent
  79 .It Fl E
  80 Erase the content of the disk before making the filesystem.
  81 The reserved area in front of the superblock (for bootcode) will not be erased.
  82 Erasing is only relevant to flash-memory or thinly provisioned devices.
  83 Erasing may take a long time.
  84 If the device does not support BIO_DELETE, the command will fail.
  85 .It Fl J
  86 Enable journaling on the new file system via gjournal.
  87 See
  88 .Xr gjournal 8
  89 for details.
  90 .It Fl L Ar volname
  91 Add a volume label to the new file system.
  92 Legal characters are alphanumerics, dashes, and underscores.
  93 .It Fl N
  94 Cause the file system parameters to be printed out
  95 without really creating the file system.
  96 .It Fl O Ar filesystem-type
  97 Use 1 to specify that a UFS1 format file system be built;
  98 use 2 to specify that a UFS2 format file system be built.
  99 The default format is UFS2.
 100 .It Fl T Ar disktype
 101 For backward compatibility.
 102 .It Fl U
 103 Enable soft updates on the new file system.
 104 .It Fl a Ar maxcontig
 105 Specify the maximum number of contiguous blocks that will be
 106 laid out before forcing a rotational delay.
 107 The default value is 16.
 108 See
 109 .Xr tunefs 8
 110 for more details on how to set this option.
 111 .It Fl b Ar block-size
 112 The block size of the file system, in bytes.
 113 It must be a power of 2.
 114 The
 115 default size is 32768 bytes, and the smallest allowable size is 4096 bytes.
 116 The optimal block:fragment ratio is 8:1.
 117 Other ratios are possible, but are not recommended,
 118 and may produce poor results.
 119 .It Fl c Ar blocks-per-cylinder-group
 120 The number of blocks per cylinder group in a file system.
 121 The default is to compute the maximum allowed by the other parameters.
 122 This value is
 123 dependent on a number of other parameters, in particular the block size
 124 and the number of bytes per inode.
 125 .It Fl d Ar max-extent-size
 126 The file system may choose to store large files using extents.
 127 This parameter specifies the largest extent size that may be used.
 128 The default value is the file system blocksize.
 129 It is presently limited to a maximum value of 16 times the
 130 file system blocksize and a minimum value of the file system blocksize.
 131 .It Fl e Ar maxbpg
 132 Indicate the maximum number of blocks any single file can
 133 allocate out of a cylinder group before it is forced to begin
 134 allocating blocks from another cylinder group.
 135 The default is about one quarter of the total blocks in a cylinder group.
 136 See
 137 .Xr tunefs 8
 138 for more details on how to set this option.
 139 .It Fl f Ar frag-size
 140 The fragment size of the file system in bytes.
 141 It must be a power of two
 142 ranging in value between
 143 .Ar blocksize Ns /8
 144 and
 145 .Ar blocksize .
 146 The default is 4096 bytes.
 147 .It Fl g Ar avgfilesize
 148 The expected average file size for the file system.
 149 .It Fl h Ar avgfpdir
 150 The expected average number of files per directory on the file system.
 151 .It Fl i Ar bytes
 152 Specify the density of inodes in the file system.
 153 The default is to create an inode for every
 154 .Pq 2 * Ar frag-size
 155 bytes of data space.
 156 If fewer inodes are desired, a larger number should be used;
 157 to create more inodes a smaller number should be given.
 158 One inode is required for each distinct file, so this value effectively
 159 specifies the average file size on the file system.
 160 .It Fl j
 161 Enable soft updates journaling on the new file system.
 162 This flag is implemented by running the
 163 .Xr tunefs 8
 164 utility found in the user's
 165 .Dv $PATH .
 166 .It Fl k Ar held-for-metadata-blocks
 167 Set the amount of space to be held for metadata blocks in each cylinder group.
 168 When set, the file system preference routines will try to save
 169 the specified amount of space immediately following the inode blocks
 170 in each cylinder group for use by metadata blocks.
 171 Clustering the metadata blocks speeds up random file access
 172 and decreases the running time of
 173 .Xr fsck 8 .
 174 By default
 175 .Nm
 176 sets it to half of the space reserved to minfree.
 177 .It Fl l
 178 Enable multilabel MAC on the new file system.
 179 .It Fl m Ar free-space
 180 The percentage of space reserved from normal users; the minimum free
 181 space threshold.
 182 The default value used is
 183 defined by
 184 .Dv MINFREE
 185 from
 186 .In ufs/ffs/fs.h ,
 187 currently 8%.
 188 See
 189 .Xr tunefs 8
 190 for more details on how to set this option.
 191 .It Fl n
 192 Do not create a
 193 .Pa .snap
 194 directory on the new file system.
 195 The resulting file system will not support snapshot generation, so
 196 .Xr dump 8
 197 in live mode and background
 198 .Xr fsck 8
 199 will not function properly.
 200 The traditional
 201 .Xr fsck 8
 202 and offline
 203 .Xr dump 8
 204 will work on the file system.
 205 This option is intended primarily for memory or vnode-backed file systems that
 206 do not require
 207 .Xr dump 8
 208 or
 209 .Xr fsck 8
 210 support.
 211 .It Fl o Ar optimization
 212 .Cm ( space
 213 or
 214 .Cm time ) .
 215 The file system can either be instructed to try to minimize the time spent
 216 allocating blocks, or to try to minimize the space fragmentation on the disk.
 217 If the value of minfree (see above) is less than 8%,
 218 the default is to optimize for
 219 .Cm space ;
 220 if the value of minfree is greater than or equal to 8%,
 221 the default is to optimize for
 222 .Cm time .
 223 See
 224 .Xr tunefs 8
 225 for more details on how to set this option.
 226 .It Fl p Ar partition
 227 The partition name (a..h) you want to use in case the underlying image
 228 is a file, so you do not have access to individual partitions through the
 229 filesystem.
 230 Can also be used with a device, e.g.,
 231 .Nm
 232 .Fl p Ar f
 233 .Ar /dev/da1s3
 234 is equivalent to
 235 .Nm
 236 .Ar /dev/da1s3f .
 237 .It Fl r Ar reserved
 238 The size, in sectors, of reserved space
 239 at the end of the partition specified in
 240 .Ar special .
 241 This space will not be occupied by the file system;
 242 it can be used by other consumers such as
 243 .Xr geom 4 .
 244 Defaults to 0.
 245 .It Fl s Ar size
 246 The size of the file system in sectors.
 247 This value defaults to the size of the
 248 raw partition specified in
 249 .Ar special
 250 less the
 251 .Ar reserved
 252 space at its end (see
 253 .Fl r ) .
 254 A
 255 .Ar size
 256 of 0 can also be used to choose the default value.
 257 A valid
 258 .Ar size
 259 value cannot be larger than the default one,
 260 which means that the file system cannot extend into the reserved space.
 261 .It Fl t
 262 Turn on the TRIM enable flag.
 263 If enabled, and if the underlying device supports the BIO_DELETE
 264 command, the file system will send a delete request to the underlying
 265 device for each freed block.
 266 The trim enable flag is typically set for flash-memory devices to
 267 reduce write amplification which reduces wear on write-limited
 268 flash-memory and often improves long-term performance.
 269 Thinly provisioned storage also benefits by returning unused blocks to
 270 the global pool.
 271 .El
 272 .Pp
 273 The following options override the standard sizes for the disk geometry.
 274 Their default values are taken from the disk label.
 275 Changing these defaults is useful only when using
 276 .Nm
 277 to build a file system whose raw image will eventually be used on a
 278 different type of disk than the one on which it is initially created
 279 (for example on a write-once disk).
 280 Note that changing any of these values from their defaults will make
 281 it impossible for
 282 .Xr fsck 8
 283 to find the alternate superblocks if the standard superblock is lost.
 284 .Bl -tag -width indent
 285 .It Fl S Ar sector-size
 286 The size of a sector in bytes (almost never anything but 512).
 287 .El
 288 .Sh EXAMPLES
 289 .Dl newfs /dev/ada3s1a
 290 .Pp
 291 Creates a new ufs file system on
 292 .Pa ada3s1a .
 293 The
 294 .Nm
 295 utility will use a block size of 32768 bytes, a fragment size of 4096 bytes
 296 and the largest possible number of blocks per cylinders group.
 297 These values tend to produce better performance for most applications
 298 than the historical defaults
 299 (8192 byte block size and 1024 byte fragment size).
 300 This large fragment size may lead to much wasted space
 301 on file systems that contain many small files.
 302 .Sh SEE ALSO
 303 .Xr fdformat 1 ,
 304 .Xr geom 4 ,
 305 .Xr disktab 5 ,
 306 .Xr fs 5 ,
 307 .Xr camcontrol 8 ,
 308 .Xr dump 8 ,
 309 .Xr dumpfs 8 ,
 310 .Xr fsck 8 ,
 311 .Xr gpart 8 ,
 312 .Xr gjournal 8 ,
 313 .Xr growfs 8 ,
 314 .Xr gvinum 8 ,
 315 .Xr makefs 8 ,
 316 .Xr mount 8 ,
 317 .Xr tunefs 8
 318 .Rs
 319 .%A M. McKusick
 320 .%A W. Joy
 321 .%A S. Leffler
 322 .%A R. Fabry
 323 .%T A Fast File System for UNIX
 324 .%J ACM Transactions on Computer Systems 2
 325 .%V 3
 326 .%P pp 181-197
 327 .%D August 1984
 328 .%O (reprinted in the BSD System Manager's Manual)
 329 .Re
 330 .Sh HISTORY
 331 The
 332 .Nm
 333 utility appeared in
 334 .Bx 4.2 .