1 .\" Copyright (c) 1983, 1987, 1991, 1993, 1994
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
28 .\" @(#)newfs.8 8.6 (Berkeley) 5/3/95
36 .Nd construct a new UFS1/UFS2 file system
41 .Op Fl O Ar filesystem-type
42 .Op Fl S Ar sector-size
45 .Op Fl b Ar block-size
46 .Op Fl c Ar blocks-per-cylinder-group
47 .Op Fl d Ar max-extent-size
50 .Op Fl g Ar avgfilesize
53 .Op Fl k Ar held-for-metadata-blocks
54 .Op Fl m Ar free-space
55 .Op Fl o Ar optimization
63 utility is used to initialize and clear file systems before first use.
66 utility builds a file system on the specified special file.
67 (We often refer to the
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
75 has numerous options to allow the defaults to be selectively overridden.
77 The following options define the general layout policies:
78 .Bl -tag -width indent
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.
86 Enable journaling on the new file system via gjournal.
91 Add a volume label to the new file system.
92 Legal characters are alphanumerics, dashes, and underscores.
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.
101 For backward compatibility.
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.
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 .\" If changing the default block size and it causes the default
115 .\" fragment size to change, be sure to update the location of
116 .\" the first backup superblock on the fsck_ffs.8 manual page.
118 default size is 32768 bytes, and the smallest allowable size is 4096 bytes.
119 The optimal block:fragment ratio is 8:1.
120 Other ratios are possible, but are not recommended,
121 and may produce poor results.
122 .It Fl c Ar blocks-per-cylinder-group
123 The number of blocks per cylinder group in a file system.
124 The default is to compute the maximum allowed by the other parameters.
126 dependent on a number of other parameters, in particular the block size
127 and the number of bytes per inode.
128 .It Fl d Ar max-extent-size
129 The file system may choose to store large files using extents.
130 This parameter specifies the largest extent size that may be used.
131 The default value is the file system blocksize.
132 It is presently limited to a maximum value of 16 times the
133 file system blocksize and a minimum value of the file system blocksize.
135 Indicate the maximum number of blocks any single file can
136 allocate out of a cylinder group before it is forced to begin
137 allocating blocks from another cylinder group.
138 The default is about one quarter of the total blocks in a cylinder group.
141 for more details on how to set this option.
142 .It Fl f Ar frag-size
143 The fragment size of the file system in bytes.
144 It must be a power of two
145 ranging in value between
149 .\" If changing the default fragment size or it changes because of a
150 .\" change to the default block size, be sure to update the location
151 .\" of the first backup superblock on the fsck_ffs.8 manual page.
152 The default is 4096 bytes.
153 .It Fl g Ar avgfilesize
154 The expected average file size for the file system.
156 The expected average number of files per directory on the file system.
158 Specify the density of inodes in the file system.
159 The default is to create an inode for every
162 If fewer inodes are desired, a larger number should be used;
163 to create more inodes a smaller number should be given.
164 One inode is required for each distinct file, so this value effectively
165 specifies the average file size on the file system.
167 Enable soft updates journaling on the new file system.
168 This flag is implemented by running the
170 utility found in the user's
173 Enabling journaling reduces the time spent by
175 cleaning up a filesystem after a crash to a few seconds from minutes to hours.
176 Without journaling, the time to recover after a crash is a function
177 of the number of files in the filesystem and the size of the filesystem.
178 With journaling, the time to recover after a crash is a function of the
179 amount of activity in the filesystem in the minute before the crash.
180 Journaled recovery time is usually only a few seconds and never
183 The drawback to using journaling is that the writes to its log adds
184 an extra write load to the media containing the filesystem.
185 Thus a write-intensive workload will have reduced throughput on a
186 filesystem running with journaling.
188 Like all journaling filesystems, the journal recovery will only fix
189 issues known to the journal.
190 Specifically if a media error occurs,
191 the journal will not know about it and hence will not fix it.
192 Thus when using journaling, it is still necessary to run a full fsck
193 every few months or after a filesystem panic to check for and fix
194 any errors brought on by media failure.
195 A full fsck can be done by running a background fsck on a live
196 filesystem or by running with the
198 flag on an unmounted filesystem.
201 in background on a live filesystem the filesystem performance
202 will be about half of normal during the time that the background
205 Running a full fsck on a UFS filesystem is the equivalent of
206 running a scrub on a ZFS filesystem.
208 Presently it is not possible
209 to run background fsck on filesystems enabled for journaling.
210 .It Fl k Ar held-for-metadata-blocks
211 Set the amount of space to be held for metadata blocks in each cylinder group.
212 When set, the file system preference routines will try to save
213 the specified amount of space immediately following the inode blocks
214 in each cylinder group for use by metadata blocks.
215 Clustering the metadata blocks speeds up random file access
216 and decreases the running time of
220 sets it to half of the space reserved to minfree.
222 Enable multilabel MAC on the new file system.
223 .It Fl m Ar free-space
224 The percentage of space reserved from normal users; the minimum free
226 The default value used is
234 for more details on how to set this option.
238 directory on the new file system.
239 The resulting file system will not support snapshot generation, so
241 in live mode and background
243 will not function properly.
248 will work on the file system.
249 This option is intended primarily for memory or vnode-backed file systems that
255 .It Fl o Ar optimization
259 The file system can either be instructed to try to minimize the time spent
260 allocating blocks, or to try to minimize the space fragmentation on the disk.
261 If the value of minfree (see above) is less than 8%,
262 the default is to optimize for
264 if the value of minfree is greater than or equal to 8%,
265 the default is to optimize for
269 for more details on how to set this option.
270 .It Fl p Ar partition
271 The partition name (a..h) you want to use in case the underlying image
272 is a file, so you do not have access to individual partitions through the
274 Can also be used with a device, e.g.,
282 The size, in sectors, of reserved space
283 at the end of the partition specified in
285 This space will not be occupied by the file system;
286 it can be used by other consumers such as
290 The size of the file system in sectors.
291 This value defaults to the size of the
292 raw partition specified in
296 space at its end (see
300 of 0 can also be used to choose the default value.
303 value cannot be larger than the default one,
304 which means that the file system cannot extend into the reserved space.
306 Turn on the TRIM enable flag.
307 If enabled, and if the underlying device supports the BIO_DELETE
308 command, the file system will send a delete request to the underlying
309 device for each freed block.
310 The trim enable flag is typically set for flash-memory devices to
311 reduce write amplification which reduces wear on write-limited
312 flash-memory and often improves long-term performance.
313 Thinly provisioned storage also benefits by returning unused blocks to
317 The following options override the standard sizes for the disk geometry.
318 Their default values are taken from the disk label.
319 Changing these defaults is useful only when using
321 to build a file system whose raw image will eventually be used on a
322 different type of disk than the one on which it is initially created
323 (for example on a write-once disk).
324 Note that changing any of these values from their defaults will make
327 to find the alternate superblocks if the standard superblock is lost.
328 .Bl -tag -width indent
329 .It Fl S Ar sector-size
330 The size of a sector in bytes (almost never anything but 512).
332 .Sh NOTES ON THE NAMING
334 is a common name prefix for utilities creating filesystems, with the suffix
335 indicating the type of the filesystem, for instance
339 utility is a special case which predates that convention.
341 .Dl newfs /dev/ada3s1a
343 Creates a new ufs file system on
347 utility will use a block size of 32768 bytes, a fragment size of 4096 bytes
348 and the largest possible number of blocks per cylinders group.
349 These values tend to produce better performance for most applications
350 than the historical defaults
351 (8192 byte block size and 1024 byte fragment size).
352 This large fragment size may lead to much wasted space
353 on file systems that contain many small files.
376 .%T A Fast File System for UNIX
377 .%J ACM Transactions on Computer Systems 2
381 .%O (reprinted in the BSD System Manager's Manual)
projects / FreeBSD / FreeBSD.git / blob