sbin/newfs_msdos/newfs_msdos.8

   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 May 16, 2017
  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
  36 .Op Fl N
  37 .Op Fl @ Ar offset
  38 .Op Fl B Ar boot
  39 .Op Fl C Ar create-size
  40 .Op Fl F Ar FAT-type
  41 .Op Fl I Ar VolumeID
  42 .Op Fl L Ar label
  43 .Op Fl O Ar OEM
  44 .Op Fl S Ar sector-size
  45 .Op Fl T Ar timestamp
  46 .Op Fl a Ar FAT-size
  47 .Op Fl b Ar block-size
  48 .Op Fl c Ar cluster-size
  49 .Op Fl e Ar DirEnts
  50 .Op Fl f Ar format
  51 .Op Fl h Ar heads
  52 .Op Fl i Ar info
  53 .Op Fl k Ar backup
  54 .Op Fl m Ar media
  55 .Op Fl n Ar FATs
  56 .Op Fl o Ar hidden
  57 .Op Fl r Ar reserved
  58 .Op Fl s Ar total
  59 .Op Fl u Ar track-size
  60 .Ar special
  61 .Op Ar disktype
  62 .Sh DESCRIPTION
  63 The
  64 .Nm
  65 utility creates a FAT12, FAT16, or FAT32 file system on device or file named
  66 .Ar special ,
  67 using
  68 .Xr disktab 5
  69 entry
  70 .Ar disktype
  71 to determine geometry, if required.
  72 .Pp
  73 If
  74 .Ar special
  75 does not contain a
  76 .Ar /
  77 and
  78 .Fl C
  79 is not used, it is assumed to be a device name and
  80 .Ar /dev/
  81 is prepended to the name to construct the actual device name.
  82 To work a file in the current directory use
  83 .Ar ./filename
  84 .Pp
  85 The options are as follow:
  86 .Bl -tag -width indent
  87 .It Fl N
  88 Do not create a file system: just print out parameters.
  89 .It Fl @ Ar offset
  90 Build the filesystem at the specified offset in bytes in the device or file.
  91 A suffix s, k, m, g (lower or upper case)
  92 appended to the offset specifies that the
  93 number is in sectors, kilobytes, megabytes or gigabytes, respectively.
  94 .It Fl B Ar boot
  95 Get bootstrap from file.
  96 .It Fl C Ar create-size
  97 Create the image file with the specified size.
  98 A suffix character appended to the size is interpreted as for the
  99 .Fl @
 100 option.
 101 The file is created by truncating any existing file with the same name and
 102 resizing it to the requested size.
 103 If the file system supports sparse files, the space occupied on disk may be
 104 smaller than the size specified as parameter.
 105 .It Fl F Ar FAT-type
 106 FAT type (one of 12, 16, or 32).
 107 .It Fl I Ar VolumeID
 108 Volume ID, a 32 bit number in decimal or hexadecimal (0x...) format.
 109 .It Fl L Ar label
 110 Volume label (up to 11 characters).
 111 The label should consist of
 112 only those characters permitted in regular DOS (8+3) filenames.
 113 .It Fl O Ar OEM
 114 OEM string (up to 8 characters).
 115 The default is
 116 .Qq Li "BSD4.4  " .
 117 .It Fl S Ar sector-size
 118 Number of bytes per sector.
 119 Acceptable values are powers of 2
 120 in the range 512 through 32768, inclusive.
 121 .It Fl T Ar timestamp
 122 Create the filesystem as though the current time is
 123 .Ar timestamp .
 124 The default filesystem volume ID is derived from the time.
 125 .Ar timestamp
 126 can be a pathname (where the timestamp is derived from
 127 that file) or an integer value interpreted
 128 as the number of seconds since the Epoch.
 129 .It Fl a Ar FAT-size
 130 Number of sectors per FAT.
 131 .It Fl b Ar block-size
 132 File system block size (bytes per cluster).
 133 This should resolve to an
 134 acceptable number of sectors per cluster (see below).
 135 .It Fl c Ar cluster-size
 136 Sectors per cluster.
 137 Acceptable values are powers of 2 in the range
 138 1 through 128.
 139 If the block or cluster size are not specified, the code
 140 uses a cluster between 512 bytes and 32K depending on
 141 the filesystem size.
 142 .It Fl e Ar DirEnts
 143 Number of root directory entries (FAT12 and FAT16 only).
 144 .It Fl f Ar format
 145 Specify a standard (floppy disk) format.
 146 The standard formats
 147 are (capacities in kilobytes): 160, 180, 320, 360, 640, 720, 1200,
 148 1232, 1440, 2880.
 149 .It Fl h Ar heads
 150 Number of drive heads.
 151 .It Fl i Ar info
 152 Location of the file system info sector (FAT32 only).
 153 A value of 0xffff signifies no info sector.
 154 .It Fl k Ar backup
 155 Location of the backup boot sector (FAT32 only).
 156 A value
 157 of 0xffff signifies no backup sector.
 158 .It Fl m Ar media
 159 Media descriptor (acceptable range 0xf0 to 0xff).
 160 .It Fl n Ar FATs
 161 Number of FATs.
 162 Acceptable values are 1 to 16 inclusive.
 163 The default
 164 is 2.
 165 .It Fl o Ar hidden
 166 Number of hidden sectors.
 167 .It Fl r Ar reserved
 168 Number of reserved sectors.
 169 .It Fl s Ar total
 170 File system size.
 171 .It Fl u Ar track-size
 172 Number of sectors per track.
 173 .El
 174 .Sh NOTES
 175 If some parameters (e.g., size, number of sectors, etc.) are not specified
 176 through options or disktype, the program tries to generate them automatically.
 177 In particular, the size is determined as the device or file size minus the
 178 offset specified with the
 179 .Fl @
 180 option.
 181 When the geometry is not available, it is assumed to be 63 sectors, 255 heads.
 182 The size is then rounded to become a multiple of the track size and avoid
 183 complaints by some filesystem code.
 184 .Pp
 185 FAT file system parameters occupy a "Boot Sector BPB (BIOS Parameter
 186 Block)" in the first of the "reserved" sectors which precede the actual
 187 file system.
 188 For reference purposes, this structure is presented
 189 below.
 190 .Bd -literal
 191 struct bsbpb {
 192     uint16_t    bpbBytesPerSec;         /* [-S] bytes per sector */
 193     uint8_t     bpbSecPerClust;         /* [-c] sectors per cluster */
 194     uint16_t    bpbResSectors;          /* [-r] reserved sectors */
 195     uint8_t     bpbFATs;                /* [-n] number of FATs */
 196     uint16_t    bpbRootDirEnts;         /* [-e] root directory entries */
 197     uint16_t    bpbSectors;             /* [-s] total sectors */
 198     uint8_t     bpbMedia;               /* [-m] media descriptor */
 199     uint16_t    bpbFATsecs;             /* [-a] sectors per FAT */
 200     uint16_t    bpbSecPerTrack;         /* [-u] sectors per track */
 201     uint16_t    bpbHeads;               /* [-h] drive heads */
 202     uint32_t    bpbHiddenSecs;          /* [-o] hidden sectors */
 203     uint32_t    bpbHugeSectors;         /* [-s] big total sectors */
 204 };
 205 /* FAT32 extensions */
 206 struct bsxbpb {
 207     uint32_t    bpbBigFATsecs;          /* [-a] big sectors per FAT */
 208     uint16_t    bpbExtFlags;            /* control flags */
 209     uint16_t    bpbFSVers;              /* file system version */
 210     uint32_t    bpbRootClust;           /* root directory start cluster */
 211     uint16_t    bpbFSInfo;              /* [-i] file system info sector */
 212     uint16_t    bpbBackup;              /* [-k] backup boot sector */
 213 };
 214 .Ed
 215 .Sh LIMITATION
 216 The maximum file size is 4GB, even if the file system itself is bigger.
 217 .Sh EXIT STATUS
 218 Exit status is 0 on success and 1 on error.
 219 .Sh EXAMPLES
 220 Create a file system, using default parameters, on
 221 .Pa /dev/ada0s1 :
 222 .Bd -literal -offset indent
 223 newfs_msdos /dev/ada0s1
 224 .Ed
 225 .Pp
 226 Create a standard 1.44M file system, with volume label
 227 .Ar foo ,
 228 on
 229 .Pa /dev/fd0 :
 230 .Bd -literal -offset indent
 231 newfs_msdos -f 1440 -L foo fd0
 232 .Ed
 233 .Pp
 234 Create a 30MB image file, with the FAT partition starting
 235 63 sectors within the image file:
 236 .Bd -literal -offset indent
 237 newfs_msdos -C 30M -@63s ./somefile
 238 .Ed
 239 .Sh SEE ALSO
 240 .Xr gpart 8 ,
 241 .Xr newfs 8
 242 .Sh HISTORY
 243 The
 244 .Nm
 245 utility first appeared in
 246 .Fx 3.0 .
 247 .Sh AUTHORS
 248 .An Robert Nordier Aq Mt rnordier@FreeBSD.org