8980 BIOS clock is sometimes one hour fast
[unleashed.git] / usr / src / man / man1m / mkfs_pcfs.1m
blob7a82df10c77aec12412514cfc8e7b579381f6ddc
1 '\" te
2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH MKFS_PCFS 1M "Dec 1, 2003"
7 .SH NAME
8 mkfs_pcfs \- construct a FAT file system
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBmkfs\fR \fB-F\fR pcfs [\fIgeneric_options\fR] [\fB-o\fR \fIFSType_specific_options\fR] \fIraw_device_file\fR
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBpcfs\fR-specific module of \fBmkfs\fR constructs a File Allocation Table
19 (\fBFAT\fR) on removable media (diskette, JAZ disk, ZIP disk, PCMCIA card), a
20 hard disk, or a file (see NOTES). \fBFAT\fRs are the standard \fBMS-DOS\fR and
21 Windows file system format. Note that you can use \fBfdformat\fR(1) to
22 construct a FAT file system only on a diskette or PCMCIA card.
23 .sp
24 .LP
25 \fBmkfs\fR for \fBpcfs\fR determines an appropriate \fBFAT\fR size for the
26 medium, then it installs an initial boot sector and an empty \fBFAT\fR. A
27 sector size of 512 bytes is used. \fBmkfs\fR for \fBpcfs\fR can also install
28 the initial file in the file system (see the \fBpcfs\fR-specific \fB-o i\fR
29 option). This first file can optionally be marked as read-only, system, and/or
30 hidden.
31 .sp
32 .LP
33 If you want to construct a FAT with \fBmkfs\fR for \fBpcfs\fR on a medium that
34 is not formatted, you must first perform a low-level format on the medium with
35 \fBfdformat\fR(1) or \fBformat\fR(1M). Non-diskette media must also be
36 partitioned with the \fBfdisk\fR(1M) utility. Note that all existing data on
37 the diskette or disk partition, if any, is destroyed when a new \fBFAT\fR is
38 constructed.
39 .sp
40 .LP
41 \fIgeneric_options\fR are supported by the generic \fBmkfs\fR command. See
42 \fBmkfs\fR(1M) for a description of these options.
43 .sp
44 .LP
45 \fIraw_device_file\fR indicates the device on which to write unless the \fB-o
46 N\fR option has been specified, or if the \fB-V\fR or \fB-m\fR generic options
47 are passed from the generic \fBmkfs\fR module.
48 .SH OPTIONS
49 .sp
50 .LP
51 See \fBmkfs\fR(1M) for the list of supported generic options.
52 .sp
53 .LP
54 The following options are supported:
55 .sp
56 .ne 2
57 .na
58 \fB\fB-o\fR \fIFSType_specific_options\fR\fR
59 .ad
60 .RS 30n
61 Specify \fBpcfs\fR file system-specific options in a comma-separated list with
62 no intervening spaces. If invalid options are specified, a warning message is
63 printed and the invalid options are ignored.
64 .sp
65 .ne 2
66 .na
67 \fBb=\fIlabel\fR\fR
68 .ad
69 .RS 14n
70 Label the media with volume label. The volume label is restricted to 11
71 uppercase characters.
72 .RE
74 .sp
75 .ne 2
76 .na
77 \fBB=\fIfilename\fR\fR
78 .ad
79 .RS 14n
80 Install \fIfilename\fR as the boot loader in the file system's boot sector. If
81 you don't specify a boot loader, an \fBMS-DOS\fR boot loader is installed. The
82 \fBMS-DOS\fR boot loader requires specific \fBMS-DOS\fR system files to make
83 the diskette bootable. See \fBNOTES\fR for more information.
84 .RE
86 .sp
87 .ne 2
88 .na
89 \fBfat=\fIn\fR\fR
90 .ad
91 .RS 14n
92 The size of a \fBFAT\fR entry. Currently, 12, 16, and 32 are valid values. The
93 default is 12 for diskettes, 16 for larger media.
94 .RE
96 .sp
97 .ne 2
98 .na
99 \fBh\fR
101 .RS 14n
102 Mark the first file installed as a hidden file. The \fB-i\fR option must also
103 be specified.
107 .ne 2
109 \fBhidden=\fIn\fR\fR
111 .RS 14n
112 Set the number of hidden sectors to \fIn\fR. This is the number of sectors on
113 the physical disk preceding the start of the volume (which is the boot sector
114 itself). This defaults to 0 for diskettes or a computed valued (based on the
115 fdisk table) for disks. This option may be used only in conjunction with the
116 \fBnofdisk\fR option.
120 .ne 2
122 \fBi=\fIfilename\fR\fR
124 .RS 14n
125 Install \fIfilename\fR as the initial file in the new file system. The initial
126 file's contents are guaranteed to occupy consecutive clusters at the start of
127 the files area. When creating bootable media, a boot program should be
128 specified as the initial file.
132 .ne 2
134 \fBnofdisk\fR
136 .RS 14n
137 Do not attempt to find an \fBfdisk\fR table on the medium. Instead rely on the
138 \fBsize\fR option for determining the partition size. By default, the created
139 \fBFAT\fR is 16 bits and begins at the first sector of the device. This
140 origination sector can be modified with the hidden option (\fB-h\fR).
144 .ne 2
146 \fBnsect=\fIn\fR\fR
148 .RS 14n
149 The number of sectors per track on the disk. If not specified, the value is
150 determined by using a \fBdkio\fR(7I) ioctl to get the disk geometry, or (for
151 diskette) from the results of an \fBFDIOGCHAR\fR ioctl.
155 .ne 2
157 \fBntrack=\fIn\fR\fR
159 .RS 14n
160 The number of tracks per cylinder on the disk. If not specified, the value is
161 determined by using a \fBdkio\fR(7I) ioctl to get the disk geometry, or (for
162 diskette) from the results of an \fBFDIOGCHAR\fR ioctl.
166 .ne 2
168 \fBN\fR
170 .RS 14n
171 No execution mode. Print normal output, but do not actually write the file
172 system to the medium. This is most useful when used in conjunction with the
173 verbose option.
177 .ne 2
179 \fBr\fR
181 .RS 14n
182 Mark the first file installed as read-only. The \fB-i\fR option must also be
183 specified.
187 .ne 2
189 \fBreserve=\fIn\fR\fR
191 .RS 14n
192 Set the number of reserved sectors to \fIn\fR. This is the number of sectors in
193 the volume, preceding the start of the first \fBFAT\fR, including the boot
194 sector. The value should always be at least 1, and the default value is exactly
199 .ne 2
201 \fBs\fR
203 .RS 14n
204 Mark the first file installed as a system file. The \fB-i\fR option must also
205 be specified.
209 .ne 2
211 \fBsize=\fIn\fR\fR
213 .RS 14n
214 The number of sectors in the file system. If not specified, the value is
215 determined from the size of the partition given in the fdisk table or (for
216 diskette) by way of computation using the \fBFDIOGCHAR\fR ioctl.
220 .ne 2
222 \fBspc=\fIn\fR\fR
224 .RS 14n
225 The size of the allocation unit for space within the file system, expressed as
226 a number of sectors. The default value depends on the \fBFAT\fR entry size and
227 the size of the file system.
231 .ne 2
233 \fBv\fR
235 .RS 14n
236 Verbose output. Describe, in detail, operations being performed.
241 .SH FILES
243 .ne 2
245 \fB\fIraw_device_file\fR\fR
247 .RS 19n
248 The device on which to build the \fBFAT\fR. The device name for a diskette must
249 be specified as \fB/dev/rdiskette0\fR for the first diskette drive, or
250 \fB/dev/rdiskette1\fR for a second diskette drive. For non-diskette media, a
251 disk device name must be qualified with a suffix to indicate the proper
252 partition. For example, in the name \fB/dev/rdsk/c0t0d0p0:c\fR, the \fB:c\fR
253 suffix indicates that the first partition on the disk should receive the new
254 \fBFAT\fR.
256 For a file, \fIraw_device_file\fR is the block device name returned by
257 \fBlofiadm\fR(1M).
260 .SH EXAMPLES
263 The media in these examples must be formatted before running \fBmkfs\fR for
264 \fBpcfs\fR. See DESCRIPTION for more details.
266 \fBExample 1 \fRCreating a FAT File System on a Diskette
269 The following command creates a \fBFAT\fR file system on a diskette:
272 .in +2
274 mkfs -F pcfs /dev/rdiskette
276 .in -2
280 \fBExample 2 \fRCreating a FAT File System on a Disk
283 The following command creates a \fBFAT\fR file system on the second fdisk
284 partition of a disk attached to an x86 based system:
287 .in +2
289 mkfs -F pcfs /dev/rdsk/c0d0p0:d
291 .in -2
295 \fBExample 3 \fRCreating a FAT File System on a ZIP Disk
298 The following command creates a \fBFAT\fR file system on a ZIP disk located on
299 a SPARC based system:
302 .in +2
304 mkfs -F pcfs /dev/rdsk/c0t4d0s2:c
306 .in -2
310 \fBExample 4 \fRCreating a FAT File System on a JAZ Disk
313 The following command creates a \fBFAT\fR file system on a JAZ disk located on
314 a SPARC based system and overrides the sectors/track and tracks/cylinder values
315 obtained from the device's controller:
318 .in +2
320 mkfs -F pcfs -o nsect=32,ntrack=64 /dev/rdsk/c0t3d0s2:c
322 .in -2
325 .SH ATTRIBUTES
328 See \fBattributes\fR(5) for descriptions of the following attributes:
333 box;
334 c | c
335 l | l .
336 ATTRIBUTE TYPE  ATTRIBUTE VALUE
338 Interface Stability     Stable
341 .SH SEE ALSO
344 \fBfdformat\fR(1), \fBfdisk\fR(1M), \fBformat\fR(1M), \fBlofiadm\fR(1M),
345 \fBmkfs\fR(1M), \fBattributes\fR(5), \fBfd\fR(7D), \fBdkio\fR(7I),
346 \fBfdio\fR(7I)
347 .SH NOTES
350 The default \fBMS-DOS\fR boot loader, which is installed by default if \fB-o
351 B\fR is not specified, requires specific \fBMS-DOS\fR system files to make the
352 diskette bootable. These \fBMS-DOS\fR files are not installed when you format a
353 diskette with \fBmkfs\fR for \fBpcfs\fR, which makes a diskette formatted this
354 way not bootable. Trying to boot from it on an x86 based system will result in
355 the following message:
357 .in +2
359 Non-System disk or disk error
360 Replace and strike any key when ready
362 .in -2
367 You must format a diskette with the \fBDOS\fR \fBformat\fR command to install
368 the specific \fBMS-DOS\fR system files required by the default boot loader.
371 You can use \fBlofiadm\fR to create a file that appears to a \fBmkfs\fR command
372 (for example, \fBmkfs_pcfs\fR or \fBmkfs_ufs\fR) as a raw device. You can then
373 use a \fBmkfs\fR command to create a file system on that device. See
374 \fBlofiadm\fR(1M) for examples of creating a UFS and a PC (FAT) file system on
375 a device created by \fBlofiadm\fR.