8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man4 / format.dat.4
blob010ece499c2b11b1031cb15f968315764c465a4b
1 '\" te
2 .\"  Copyright (c) 1999, 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 FORMAT.DAT 4 "Apr 19, 2001"
7 .SH NAME
8 format.dat \- disk drive configuration for the format command
9 .SH DESCRIPTION
10 .sp
11 .LP
12 \fBformat.dat\fR enables you to use your specific disk drives with
13 \fBformat\fR(1M). On Solaris 2.3 and compatible systems, \fBformat\fR will
14 automatically configure and label SCSI drives, so that they need not be defined
15 in \fBformat.dat\fR. Three things can be defined in the data file:
16 .RS +4
17 .TP
18 .ie t \(bu
19 .el o
20 search paths
21 .RE
22 .RS +4
23 .TP
24 .ie t \(bu
25 .el o
26 disk types
27 .RE
28 .RS +4
29 .TP
30 .ie t \(bu
31 .el o
32 partition tables.
33 .RE
34 .SS "Syntax"
35 .sp
36 .LP
37 The following syntax rules apply to the data file:
38 .RS +4
39 .TP
40 .ie t \(bu
41 .el o
42 The pound \fB#\fR sign is the comment character. Any text on a line after a
43 pound sign is not interpreted by \fBformat\fR.
44 .RE
45 .RS +4
46 .TP
47 .ie t \(bu
48 .el o
49 Each definition in the \fBformat.dat\fR file appears on a single logical line.
50 If the definition is more than one line long, all but the last line of the
51 definition must end with a backslash (\e).
52 .RE
53 .RS +4
54 .TP
55 .ie t \(bu
56 .el o
57 A definition consists of a series of assignments that have an identifier on the
58 left side and one or more values on the right side. The assignment operator is
59 the equal sign (=). Assignments within a definition must be separated by a
60 colon (:).
61 .RE
62 .RS +4
63 .TP
64 .ie t \(bu
65 .el o
66 White space is ignored by \fBformat\fR(1M). If you want an assigned value to
67 contain white space, enclose the entire value in double quotes ("). This will
68 cause the white space within quotes to be preserved as part of the assignment
69 value.
70 .RE
71 .RS +4
72 .TP
73 .ie t \(bu
74 .el o
75 Some assignments can have multiple values on the right hand side. Separate
76 values by a comma (,).
77 .RE
78 .SS "Keywords"
79 .sp
80 .LP
81 The data file contains disk definitions that are read in by \fBformat\fR(1M)
82 when it starts up. Each definition starts with one of the following keywords:
83 \fBsearch_path\fR, \fBdisk_type\fR, and \fBpartition\fR.
84 .sp
85 .ne 2
86 .na
87 \fB\fBsearch_path\fR\fR
88 .ad
89 .RS 15n
90 4.x: Tells \fBformat\fR which disks it should search for when it starts up. The
91 list in the default data file contains all the disks in the GENERIC
92 configuration file. If your system has disks that are not in the GENERIC
93 configuration file, add them to the \fBsearch_path\fR definition in your data
94 file. The data file can contain only one \fBsearch_path\fR definition. However,
95 this single definition lets you specify all the disks you have in your system.
96 .sp
97 5.x: By default, \fBformat\fR(1M) understands all the logical devices that are
98 of the form \fB/dev/rdsk/cntndnsn\fR; hence \fBsearch_path\fR is not normally
99 defined on a 5.x system.
103 .ne 2
105 \fB\fBdisk_type\fR\fR
107 .RS 15n
108 Defines the controller and disk model. Each \fBdisk_type\fR definition contains
109 information concerning the physical geometry of the disk. The default data file
110 contains definitions for the controllers and disks that the Solaris operating
111 environment supports. You need to add a new \fBdisk_type\fR only if you have an
112 unsupported disk. You can add as many \fBdisk_type\fR definitions to the data
113 file as you want.
115 The following controller types are supported by \fBformat\fR(1M):
117 .ne 2
119 \fBXY450\fR
121 .RS 10n
122 Xylogics 450 controller (SMD)
126 .ne 2
128 \fBXD7053\fR
130 .RS 10n
131 Xylogics 7053 controller (SMD)
135 .ne 2
137 \fBSCSI\fR
139 .RS 10n
140 True SCSI (CCS or SCSI-2)
144 .ne 2
146 \fBISP-80\fR
148 .RS 10n
149 IPI panther controller
152 The keyword itself is assigned the name of the disk type. This name appears in
153 the disk's label and is used to identify the disk type whenever
154 \fBformat\fR(1M) is run. Enclose the name in double quotes to preserve any
155 white space in the name.
157 Below are lists of identifiers for supported controllers. Note that an asterisk
158 ('*') indicates the identifier is mandatory for that controller -- it is not
159 part of the keyword name.
161 The following identifiers are assigned values in all \fBdisk_type\fR
162 definitions:
164 .ne 2
166 \fB\fBacyl*\fR\fR
168 .RS 12n
169 alternate cylinders
173 .ne 2
175 \fB\fBasect\fR\fR
177 .RS 12n
178 alternate sectors per track
182 .ne 2
184 \fB\fBatrks\fR\fR
186 .RS 12n
187 alternate tracks
191 .ne 2
193 \fB\fBfmt_time\fR\fR
195 .RS 12n
196 formatting time per cylinder
200 .ne 2
202 \fB\fBncyl*\fR\fR
204 .RS 12n
205 number of logical cylinders
209 .ne 2
211 \fB\fBnhead*\fR\fR
213 .RS 12n
214 number of logical heads
218 .ne 2
220 \fB\fBnsect*\fR\fR
222 .RS 12n
223 number of logical sectors per track
227 .ne 2
229 \fB\fBpcyl*\fR\fR
231 .RS 12n
232 number of physical cylinders
236 .ne 2
238 \fB\fBphead\fR\fR
240 .RS 12n
241 number of physical heads
245 .ne 2
247 \fB\fBpsect\fR\fR
249 .RS 12n
250 number of physical sectors per track
254 .ne 2
256 \fB\fBrpm*\fR\fR
258 .RS 12n
259 drive RPM
262 These identifiers are for SCSI and MD-21 Controllers
264 .ne 2
266 \fB\fBread_retries\fR\fR
268 .RS 17n
269 page 1 byte 3 (read retries)
273 .ne 2
275 \fB\fBwrite_retries\fR\fR
277 .RS 17n
278 page 1 byte 8 (write retries)
282 .ne 2
284 \fB\fBcyl_skew\fR\fR
286 .RS 17n
287 page 3 bytes 18-19 (cylinder skew)
291 .ne 2
293 \fB\fBtrk_skew\fR\fR
295 .RS 17n
296 page 3 bytes 16-17 (track skew)
300 .ne 2
302 \fB\fBtrks_zone\fR\fR
304 .RS 17n
305 page 3 bytes 2-3 (tracks per zone)
309 .ne 2
311 \fB\fBcache\fR\fR
313 .RS 17n
314 page 38 byte 2 (cache parameter)
318 .ne 2
320 \fB\fBprefetch\fR\fR
322 .RS 17n
323 page 38 byte 3 (prefetch parameter)
327 .ne 2
329 \fB\fBmax_prefetch\fR\fR
331 .RS 17n
332 page 38 byte 4 (minimum prefetch)
336 .ne 2
338 \fB\fBmin_prefetch\fR\fR
340 .RS 17n
341 page 38 byte 6 (maximum prefetch)
344 Note: The Page 38 values are device-specific. Refer the user to the particular
345 disk's manual for these values.
347 For SCSI disks, the following geometry specifiers may cause a mode select on
348 the byte(s) indicated:
350 .ne 2
352 \fB\fBasect\fR\fR
354 .RS 9n
355 page 3 bytes 4-5 (alternate sectors per zone)
359 .ne 2
361 \fB\fBatrks\fR\fR
363 .RS 9n
364 page 3 bytes 8-9 (alt. tracks per logical unit)
368 .ne 2
370 \fB\fBphead\fR\fR
372 .RS 9n
373 page 4 byte 5 (number of heads)
377 .ne 2
379 \fB\fBpsect\fR\fR
381 .RS 9n
382 page 3 bytes 10-11 (sectors per track)
385 And these identifiers are for SMD Controllers Only
387 .ne 2
389 \fB\fBbps*\fR\fR
391 .RS 8n
392 bytes per sector (SMD)
396 .ne 2
398 \fB\fBbpt*\fR\fR
400 .RS 8n
401 bytes per track (SMD)
404 Note: under SunOS 5.x, bpt is only required for SMD disks. Under SunOS 4.x, bpt
405 was required for all disk types, even though it was only used for SMD disks.
407 And this identifier is for XY450 SMD Controllers Only
409 .ne 2
411 \fB\fBdrive_type*\fR\fR
413 .RS 15n
414 drive type (SMD) (just call this "xy450 drive type")
420 .ne 2
422 \fB\fBpartition\fR\fR
424 .RS 15n
425 Defines a partition table for a specific disk type. The partition table
426 contains the partitioning information, plus a name that lets you refer to it in
427 \fBformat\fR(1M). The default data file contains default partition definitions
428 for several kinds of disk drives. Add a partition definition if you
429 repartitioned any of the disks on your system. Add as many partition
430 definitions to the data file as you need.
432 Partition naming conventions differ in SunOS 4.x and in SunOS 5.x.
434 4.x: the partitions are named as \fBa\fR, \fBb\fR, \fBc\fR, \fBd\fR, \fBe\fR,
435 \fBf\fR, \fBg\fR, \fBh\fR.
437 5.x: the partitions are referred to by numbers \fB0\fR, \fB1\fR, \fB2\fR,
438 \fB3\fR, \fB4\fR, \fB5\fR, \fB6\fR, \fB7\fR.
441 .SH EXAMPLES
443 \fBExample 1 \fRA sample \fBdisk_type\fR and \fBpartition\fR.
446 Following is a sample \fBdisk_type\fR and \fBpartition\fR definition in
447 \fBformat.dat\fR file for SUN0535 disk device.
450 .in +2
452 disk_type = "SUN0535" \e
453         : ctlr = SCSI : fmt_time = 4 \e
454         : ncyl = 1866 : acyl = 2 : pcyl = 2500 : nhead = 7 : nsect = 80 \e
455         : rpm = 5400
456 partition = "SUN0535" \e
457         : disk = "SUN0535" : ctlr = SCSI \e
458       : 0 = 0, 64400 : 1 = 115, 103600 : 2 = 0, 1044960 : 6 = 300, 876960
460 .in -2
463 .SH FILES
465 .ne 2
467 \fB\fB/etc/format.dat\fR\fR
469 .RS 19n
470 default data file if \fBformat\fR \fB-x\fR is not specified, nor is there a
471 \fBformat.dat\fR file in the current directory.
474 .SH SEE ALSO
477 \fBformat\fR(1M)
480 \fISystem Administration Guide: Basic Administration\fR