xref: /freebsd/sbin/newfs_msdos/newfs_msdos.8 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
1.\" Copyright (c) 1998 Robert Nordier
2.\" 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
11.\"    the documentation and/or other materials provided with the
12.\"    distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
15.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY
18.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
20.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
22.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
24.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd July 6, 1998
29.Dt NEWFS_MSDOS 8
30.Os
31.Sh NAME
32.Nm newfs_msdos
33.Nd construct a new MS-DOS (FAT) file system
34.Sh SYNOPSIS
35.Nm newfs_msdos
36.Op Fl N
37.Op Fl B Ar boot
38.Op Fl F Ar FAT-type
39.Op Fl I Ar volid
40.Op Fl L Ar label
41.Op Fl O Ar OEM
42.Op Fl S Ar sector-size
43.Op Fl a Ar FAT-size
44.Op Fl b Ar block-size
45.Op Fl c Ar cluster-size
46.Op Fl e Ar dirents
47.Op Fl f Ar format
48.Op Fl h Ar heads
49.Op Fl i Ar info
50.Op Fl k Ar backup
51.Op Fl m Ar media
52.Op Fl n Ar FATs
53.Op Fl o Ar hidden
54.Op Fl r Ar reserved
55.Op Fl s Ar total
56.Op Fl u Ar track-size
57.Ar special
58.Op Ar disktype
59.Sh DESCRIPTION
60The
61.Nm
62utility creates a FAT12, FAT16, or FAT32 file system on device
63.Ar special ,
64using
65.Xr disktab 5
66entry
67.Ar disktype
68to determine geometry, if required.
69.Pp
70The options are as follow:
71.Bl -tag -width indent
72.It Fl N
73Don't create a file system: just print out parameters.
74.It Fl B Ar boot
75Get bootstrap from file.
76.It Fl F Ar FAT-type
77FAT type (one of 12, 16, or 32).
78.It Fl I Ar volid
79Volume ID.
80.It Fl L Ar label
81Volume label (up to 11 characters).  The label should consist of
82only those characters permitted in regular DOS (8+3) filenames.
83.It Fl O Ar OEM
84OEM string (up to 8 characters).  The default is
85"BSD  4.4".
86.It Fl S Ar sector-size
87Number of bytes per sector.  Acceptable values are powers of 2
88in the range 128 through 32768.
89.It Fl a Ar FAT-size
90Number of sectors per FAT.
91.It Fl b Ar block-size
92File system block size (bytes per cluster).  This should resolve to an
93acceptable number of sectors per cluster (see below).
94.It Fl c Ar cluster-size
95Sectors per cluster.  Acceptable values are powers of 2 in the range
961 through 128.
97.It Fl e Ar dirents
98Number of root directory entries (FAT12 and FAT16 only).
99.It Fl f Ar format
100Specify a standard (floppy disk) format.  The eight standard formats
101are (capacities in kilobytes): 160, 180, 320, 360, 720, 1200, 1440,
1022880.
103.It Fl h Ar heads
104Number of drive heads.
105.It Fl i Ar info
106Location of the file system info sector (FAT32 only).
107A value of 0xffff signifies no info sector.
108.It Fl k Ar backup
109Location of the backup boot sector (FAT32 only).  A value
110of 0xffff signifies no backup sector.
111.It Fl m Ar media
112Media descriptor (acceptable range 0xf0 to 0xff).
113.It Fl n Ar FATs
114Number of FATs.  Acceptable values are 1 to 16 inclusive. The default
115is 2.
116.It Fl o Ar hidden
117Number of hidden sectors.
118.It Fl r Ar reserved
119Number of reserved sectors.
120.It Fl s Ar total
121File system size.
122.It Fl u Ar track-size
123Number of sectors per track.
124.El
125.Sh NOTES
126FAT file system parameters occupy a "Boot Sector BPB (BIOS Parameter
127Block)" in the first of the "reserved" sectors which precede the actual
128file system.  For reference purposes, this structure is presented
129below.
130.Bd -literal
131struct bsbpb {
132    u_int16_t	bps;		/* [-S] bytes per sector */
133    u_int8_t	spc;		/* [-c] sectors per cluster */
134    u_int16_t	res;		/* [-r] reserved sectors */
135    u_int8_t	nft;		/* [-n] number of FATs */
136    u_int16_t	rde;		/* [-e] root directory entries */
137    u_int16_t	sec;		/* [-s] total sectors */
138    u_int8_t	mid;		/* [-m] media descriptor */
139    u_int16_t	spf;		/* [-a] sectors per FAT */
140    u_int16_t	spt;		/* [-u] sectors per track */
141    u_int16_t	hds;		/* [-h] drive heads */
142    u_int32_t	hid;		/* [-o] hidden sectors */
143    u_int32_t	bsec;		/* [-s] big total sectors */
144};
145/* FAT32 extensions */
146struct bsxbpb {
147    u_int32_t	bspf;		/* [-a] big sectors per FAT */
148    u_int16_t	xflg;		/* control flags */
149    u_int16_t	vers;		/* file system version */
150    u_int32_t	rdcl;		/* root directory start cluster */
151    u_int16_t	infs;		/* [-i] file system info sector */
152    u_int16_t	bkbs;		/* [-k] backup boot sector */
153};
154.Ed
155.Sh EXAMPLES
156
157	newfs_msdos /dev/rwd0s1
158
159Create a file system, using default parameters, on /dev/rwd0s1.
160
161	newfs_msdos -f 1440 -L foo fd0
162
163Create a standard 1.44M file system, with volume label "foo", on
164/dev/rfd0.
165.Sh SEE ALSO
166.Xr disktab 5 ,
167.Xr disklabel 8 ,
168.Xr fdisk 8 ,
169.Xr newfs 8
170.Sh DIAGNOSTICS
171Exit status is 0 on success and 1 on error.
172.Sh HISTORY
173The
174.Nm
175command first appeared in
176.Fx 3.0 .
177.Sh AUTHORS
178.An Robert Nordier Aq rnordier@FreeBSD.org .
179