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: src/sbin/newfs_msdos/newfs_msdos.8,v 1.7.2.7 2003/02/24 00:56:42 trhodes Exp $
  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
  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
  60 The
  61 .Nm
  62 utility creates a FAT12, FAT16, or FAT32 file system on device
  63 .Ar special ,
  64 using
  65 .Xr disktab 5
  66 entry
  67 .Ar disktype
  68 to determine geometry, if required.
  69 .Pp
  70 The options are as follow:
  71 .Bl -tag -width indent
  72 .It Fl N
  73 Don't create a file system: just print out parameters.
  74 .It Fl B Ar boot
  75 Get bootstrap from file.
  76 .It Fl F Ar FAT-type
  77 FAT type (one of 12, 16, or 32).
  78 .It Fl I Ar volid
  79 Volume ID.
  80 .It Fl L Ar label
  81 Volume label (up to 11 characters).  The label should consist of
  82 only those characters permitted in regular DOS (8+3) filenames.
  83 .It Fl O Ar OEM
  84 OEM string (up to 8 characters).  The default is
  85 .Qq Li "BSD  4.4" .
  86 .It Fl S Ar sector-size
  87 Number of bytes per sector.  Acceptable values are powers of 2
  88 in the range 128 through 32768.
  89 .It Fl a Ar FAT-size
  90 Number of sectors per FAT.
  91 .It Fl b Ar block-size
  92 File system block size (bytes per cluster).  This should resolve to an
  93 acceptable number of sectors per cluster (see below).
  94 .It Fl c Ar cluster-size
  95 Sectors per cluster.  Acceptable values are powers of 2 in the range
  96 1 through 128.
  97 .It Fl e Ar dirents
  98 Number of root directory entries (FAT12 and FAT16 only).
  99 .It Fl f Ar format
 100 Specify a standard (floppy disk) format.  The standard formats
 101 are (capacities in kilobytes): 160, 180, 320, 360, 640, 720, 1200,
 102 1232, 1440, 2880.
 103 .It Fl h Ar heads
 104 Number of drive heads.
 105 .It Fl i Ar info
 106 Location of the file system info sector (FAT32 only).
 107 A value of 0xffff signifies no info sector.
 108 .It Fl k Ar backup
 109 Location of the backup boot sector (FAT32 only).  A value
 110 of 0xffff signifies no backup sector.
 111 .It Fl m Ar media
 112 Media descriptor (acceptable range 0xf0 to 0xff).
 113 .It Fl n Ar FATs
 114 Number of FATs.  Acceptable values are 1 to 16 inclusive.
 115 The default
 116 is 2.
 117 .It Fl o Ar hidden
 118 Number of hidden sectors.
 119 .It Fl r Ar reserved
 120 Number of reserved sectors.
 121 .It Fl s Ar total
 122 File system size.
 123 .It Fl u Ar track-size
 124 Number of sectors per track.
 125 .El
 126 .Sh NOTES
 127 FAT file system parameters occupy a "Boot Sector BPB (BIOS Parameter
 128 Block)" in the first of the "reserved" sectors which precede the actual
 129 file system.  For reference purposes, this structure is presented
 130 below.
 131 .Bd -literal
 132 struct bsbpb {
 133     u_int16_t   bps;            /* [-S] bytes per sector */
 134     u_int8_t    spc;            /* [-c] sectors per cluster */
 135     u_int16_t   res;            /* [-r] reserved sectors */
 136     u_int8_t    nft;            /* [-n] number of FATs */
 137     u_int16_t   rde;            /* [-e] root directory entries */
 138     u_int16_t   sec;            /* [-s] total sectors */
 139     u_int8_t    mid;            /* [-m] media descriptor */
 140     u_int16_t   spf;            /* [-a] sectors per FAT */
 141     u_int16_t   spt;            /* [-u] sectors per track */
 142     u_int16_t   hds;            /* [-h] drive heads */
 143     u_int32_t   hid;            /* [-o] hidden sectors */
 144     u_int32_t   bsec;           /* [-s] big total sectors */
 145 };
 146 /* FAT32 extensions */
 147 struct bsxbpb {
 148     u_int32_t   bspf;           /* [-a] big sectors per FAT */
 149     u_int16_t   xflg;           /* control flags */
 150     u_int16_t   vers;           /* file system version */
 151     u_int32_t   rdcl;           /* root directory start cluster */
 152     u_int16_t   infs;           /* [-i] file system info sector */
 153     u_int16_t   bkbs;           /* [-k] backup boot sector */
 154 };
 155 .Ed
 156 .Sh EXAMPLES
 157 .Bd -literal -offset indent
 158 newfs_msdos /dev/ad0s1
 159 .Ed
 160 .Pp
 161 Create a file system, using default parameters, on
 162 .Pa /dev/ad0s1 .
 163 .Bd -literal -offset indent
 164 newfs_msdos -f 1440 -L foo fd0
 165 .Ed
 166 .Pp
 167 Create a standard 1.44M file system, with volume label
 168 .Ar foo ,
 169 on
 170 .Pa /dev/fd0 .
 171 .Sh SEE ALSO
 172 .Xr disktab 5 ,
 173 .Xr disklabel 8 ,
 174 .Xr fdisk 8 ,
 175 .Xr newfs 8
 176 .Sh DIAGNOSTICS
 177 Exit status is 0 on success and 1 on error.
 178 .Sh HISTORY
 179 The
 180 .Nm
 181 utility first appeared in
 182 .Fx 3.0 .
 183 .Sh AUTHORS
 184 .An Robert Nordier Aq rnordier@FreeBSD.org .