sbin/fdisk/fdisk.8

   1 .\" $FreeBSD$
   2 .\"
   3 .Dd December 12, 2006
   4 .Dt FDISK 8
   5 .Os
   6 .Sh NAME
   7 .Nm fdisk
   8 .Nd PC slice table maintenance utility
   9 .Sh SYNOPSIS
  10 .Nm
  11 .Op Fl BIaistu
  12 .Op Fl b Ar bootcode
  13 .Op Fl 1234
  14 .Op Ar disk
  15 .Nm
  16 .Fl f Ar configfile
  17 .Op Fl itv
  18 .Op Ar disk
  19 .Sh PROLOGUE
  20 In order for the BIOS to boot the kernel,
  21 certain conventions must be adhered to.
  22 Sector 0 of the disk must contain boot code,
  23 a slice table,
  24 and a magic number.
  25 BIOS slices can be used to break the disk up into several pieces.
  26 The BIOS brings in sector 0 and verifies the magic number.
  27 The sector
  28 0 boot code then searches the slice table to determine which
  29 slice is marked
  30 .Dq active .
  31 This boot code then brings in the bootstrap from the
  32 active slice and, if marked bootable, runs it.
  33 Under
  34 .Tn DOS ,
  35 you can have one or more slices with one active.
  36 The
  37 .Tn DOS
  38 .Nm
  39 utility can be used to divide space on the disk into slices and set one
  40 active.
  41 .Sh DESCRIPTION
  42 The
  43 .Fx
  44 utility,
  45 .Nm ,
  46 serves a similar purpose to the
  47 .Tn DOS
  48 utility.
  49 The first form is used to
  50 display slice information or to interactively edit the slice
  51 table.
  52 The second is used to write a slice table using a
  53 .Ar configfile ,
  54 and is designed to be used by other scripts/programs.
  55 .Pp
  56 Options are:
  57 .Bl -tag -width indent
  58 .It Fl a
  59 Change the active slice only.
  60 Ignored if
  61 .Fl f
  62 is given.
  63 .It Fl b Ar bootcode
  64 Get the boot code from the file
  65 .Ar bootcode .
  66 Default is
  67 .Pa /boot/mbr .
  68 .It Fl B
  69 Reinitialize the boot code contained in sector 0 of the disk.
  70 Ignored if
  71 .Fl f
  72 is given.
  73 .It Fl f Ar configfile
  74 Set slice values using the file
  75 .Ar configfile .
  76 The
  77 .Ar configfile
  78 only modifies explicitly specified slices, unless
  79 .Fl i
  80 is also given, in which case all existing slices are deleted (marked
  81 as
  82 .Dq unused )
  83 before the
  84 .Ar configfile
  85 is read.
  86 The
  87 .Ar configfile
  88 can be
  89 .Sq Fl ,
  90 in which case standard input is read.
  91 See
  92 .Sx CONFIGURATION FILE ,
  93 below, for file syntax.
  94 .Pp
  95 .Em WARNING :
  96 when
  97 .Fl f
  98 is used, you are not asked if you really want to write the slices
  99 table (as you are in the interactive mode).
 100 Use with caution!
 101 .It Fl i
 102 Initialize sector 0 of the disk.
 103 Existing slice entries will be cleared
 104 (marked as unused) before editing.
 105 (Compare with
 106 .Fl u . )
 107 .It Fl I
 108 Initialize sector 0 slice table
 109 for one
 110 .Fx
 111 slice covering the entire disk.
 112 .It Fl s
 113 Print summary information and exit.
 114 .It Fl t
 115 Test mode; do not write slice values.
 116 Generally used with the
 117 .Fl f
 118 option to see what would be written to the slice table.
 119 Implies
 120 .Fl v .
 121 .It Fl u
 122 Update (edit) the disk's sector 0 slice table.
 123 Ignored if
 124 .Fl f
 125 is given.
 126 .It Fl v
 127 Be verbose.
 128 When
 129 .Fl f
 130 is used,
 131 .Nm
 132 prints out the slice table that is written to the disk.
 133 .It Fl 1234
 134 Operate on a single slice table entry only.
 135 Ignored if
 136 .Fl f
 137 is given.
 138 .El
 139 .Pp
 140 The final disk name can be provided as a
 141 .Dq bare
 142 disk name only, e.g.\&
 143 .Pa da0 ,
 144 or as a full pathname.
 145 If omitted,
 146 .Nm
 147 tries to figure out the default disk device name from the
 148 mounted root device.
 149 .Pp
 150 When called with no arguments, it prints the sector 0 slice table.
 151 An example follows:
 152 .Bd -literal
 153         ******* Working on device /dev/ad0 *******
 154         parameters extracted from in-core disklabel are:
 155         cylinders=769 heads=15 sectors/track=33 (495 blks/cyl)
 156
 157         parameters to be used for BIOS calculations are:
 158         cylinders=769 heads=15 sectors/track=33 (495 blks/cyl)
 159
 160         Warning: BIOS sector numbering starts with sector 1
 161         Information from DOS bootblock is:
 162         The data for partition 1 is:
 163         sysid 165,(FreeBSD/NetBSD/386BSD)
 164             start 495, size 380160 (185 Meg), flag 0
 165                 beg: cyl 1/ sector 1/ head 0;
 166                 end: cyl 768/ sector 33/ head 14
 167         The data for partition 2 is:
 168         sysid 164,(unknown)
 169             start 378180, size 2475 (1 Meg), flag 0
 170                 beg: cyl 764/ sector 1/ head 0;
 171                 end: cyl 768/ sector 33/ head 14
 172         The data for partition 3 is:
 173         <UNUSED>
 174         The data for partition 4 is:
 175         sysid 99,(ISC UNIX, other System V/386, GNU HURD or Mach)
 176             start 380656, size 224234 (109 Meg), flag 80
 177                 beg: cyl 769/ sector 2/ head 0;
 178                 end: cyl 197/ sector 33/ head 14
 179 .Ed
 180 .Pp
 181 The disk is divided into three slices that happen to fill the disk.
 182 The second slice overlaps the end of the first.
 183 (Used for debugging purposes.)
 184 .Bl -tag -width ".Em cyl , sector No and Em head"
 185 .It Em sysid
 186 is used to label the slice.
 187 .Fx
 188 reserves the
 189 magic number 165 decimal (A5 in hex).
 190 .It Xo
 191 .Em start
 192 and
 193 .Em size
 194 .Xc
 195 fields provide the start address
 196 and size of a slice in sectors.
 197 .It Em "flag 80"
 198 specifies that this is the active slice.
 199 .It Xo
 200 .Em cyl , sector
 201 and
 202 .Em head
 203 .Xc
 204 fields are used to specify the beginning and end addresses of the slice.
 205 .El
 206 .Pp
 207 .Em Note :
 208 these numbers are calculated using BIOS's understanding of the disk geometry
 209 and saved in the bootblock.
 210 .Pp
 211 The
 212 .Fl i
 213 and
 214 .Fl u
 215 flags are used to indicate that the slice data is to be updated.
 216 Unless the
 217 .Fl f
 218 option is also given,
 219 .Nm
 220 will enter a conversational mode.
 221 In this mode, no changes will be written to disk unless you explicitly tell
 222 .Nm
 223 to.
 224 .Pp
 225 The
 226 .Nm
 227 utility will display each slice and ask whether you want to edit it.
 228 If you say yes,
 229 .Nm
 230 will step through each field, show you the old value,
 231 and ask you for a new one.
 232 When you are done with the slice,
 233 .Nm
 234 will display it and ask you whether it is correct.
 235 It will then proceed to the next entry.
 236 .Pp
 237 Getting the
 238 .Em cyl , sector ,
 239 and
 240 .Em head
 241 fields correct is tricky, so by default,
 242 they will be calculated for you;
 243 you can specify them if you choose to though.
 244 .Pp
 245 After all the slices are processed,
 246 you are given the option to change the
 247 .Dq active
 248 slice.
 249 Finally, when all the new data for sector 0 has been accumulated,
 250 you are asked to confirm whether you really want to rewrite it.
 251 .Pp
 252 The difference between the
 253 .Fl u
 254 and
 255 .Fl i
 256 flags is that
 257 the
 258 .Fl u
 259 flag edits (updates) the existing slice parameters
 260 while the
 261 .Fl i
 262 flag is used to
 263 .Dq initialize
 264 them (old values will be ignored);
 265 if you edit the first slice,
 266 .Fl i
 267 will also set it up to use the whole disk for
 268 .Fx
 269 and make it active.
 270 .Sh NOTES
 271 The automatic calculation of starting cylinder etc.\& uses
 272 a set of figures that represent what the BIOS thinks the
 273 geometry of the drive is.
 274 These figures are taken from the in-core disklabel by default,
 275 but
 276 .Nm
 277 initially gives you an opportunity to change them.
 278 This allows you to create a bootblock that can work with drives
 279 that use geometry translation under the BIOS.
 280 .Pp
 281 If you hand craft your disk layout,
 282 please make sure that the
 283 .Fx
 284 slice starts on a cylinder boundary.
 285 .Pp
 286 Editing an existing slice will most likely result in the loss of
 287 all data in that slice.
 288 .Pp
 289 You should run
 290 .Nm
 291 interactively once or twice to see how it works.
 292 This is completely safe as long as you answer the last question
 293 in the negative.
 294 There are subtleties that
 295 .Nm
 296 detects that are not fully explained in this manual page.
 297 .Sh CONFIGURATION FILE
 298 When the
 299 .Fl f
 300 option is given, a disk's slice table can be written using values
 301 from a
 302 .Ar configfile .
 303 The syntax of this file is very simple;
 304 each line is either a comment or a specification, as follows:
 305 .Bl -tag -width indent
 306 .It Ic # Ar comment ...
 307 Lines beginning with a
 308 .Ic #
 309 are comments and are ignored.
 310 .It Ic g Ar spec1 spec2 spec3
 311 Set the BIOS geometry used in slice calculations.
 312 There must be
 313 three values specified, with a letter preceding each number:
 314 .Bl -tag -width indent
 315 .It Cm c Ns Ar num
 316 Set the number of cylinders to
 317 .Ar num .
 318 .It Cm h Ns Ar num
 319 Set the number of heads to
 320 .Ar num .
 321 .It Cm s Ns Ar num
 322 Set the number of sectors/track to
 323 .Ar num .
 324 .El
 325 .Pp
 326 These specs can occur in any order, as the leading letter determines
 327 which value is which; however, all three must be specified.
 328 .Pp
 329 This line must occur before any lines that specify slice
 330 information.
 331 .Pp
 332 It is an error if the following is not true:
 333 .Bd -literal -offset indent
 334 1 <= number of cylinders
 335 1 <= number of heads <= 256
 336 1 <= number of sectors/track < 64
 337 .Ed
 338 .Pp
 339 The number of cylinders should be less than or equal to 1024, but this
 340 is not enforced, although a warning will be printed.
 341 Note that bootable
 342 .Fx
 343 slices (the
 344 .Dq Pa /
 345 file system) must lie completely within the
 346 first 1024 cylinders; if this is not true, booting may fail.
 347 Non-bootable slices do not have this restriction.
 348 .Pp
 349 Example (all of these are equivalent), for a disk with 1019 cylinders,
 350 39 heads, and 63 sectors:
 351 .Bd -literal -offset indent
 352 g       c1019   h39     s63
 353 g       h39     c1019   s63
 354 g       s63     h39     c1019
 355 .Ed
 356 .It Ic p Ar slice type start length
 357 Set the slice given by
 358 .Ar slice
 359 (1-4) to type
 360 .Ar type ,
 361 starting at sector
 362 .Ar start
 363 for
 364 .Ar length
 365 sectors.
 366 .Pp
 367 Only those slices explicitly mentioned by these lines are modified;
 368 any slice not referenced by a
 369 .Ic p
 370 line will not be modified.
 371 However, if an invalid slice table is present, or the
 372 .Fl i
 373 option is specified, all existing slice entries will be cleared
 374 (marked as unused), and these
 375 .Ic p
 376 lines will have to be used to
 377 explicitly set slice information.
 378 If multiple slices need to be
 379 set, multiple
 380 .Ic p
 381 lines must be specified; one for each slice.
 382 .Pp
 383 These slice lines must occur after any geometry specification lines,
 384 if one is present.
 385 .Pp
 386 The
 387 .Ar type
 388 is 165 for
 389 .Fx
 390 slices.
 391 Specifying a slice type of zero is
 392 the same as clearing the slice and marking it as unused; however,
 393 dummy values (such as
 394 .Dq 0 )
 395 must still be specified for
 396 .Ar start
 397 and
 398 .Ar length .
 399 .Pp
 400 Note: the start offset will be rounded upwards to a head boundary if
 401 necessary, and the end offset will be rounded downwards to a cylinder
 402 boundary if necessary.
 403 .Pp
 404 Example: to clear slice 4 and mark it as unused:
 405 .Pp
 406 .Dl "p       4       0       0       0"
 407 .Pp
 408 Example: to set slice 1 to a
 409 .Fx
 410 slice, starting at sector 1
 411 for 2503871 sectors (note: these numbers will be rounded upwards and
 412 downwards to correspond to head and cylinder boundaries):
 413 .Pp
 414 .Dl "p       1       165     1       2503871"
 415 .It Ic a Ar slice
 416 Make
 417 .Ar slice
 418 the active slice.
 419 Can occur anywhere in the config file, but only
 420 one must be present.
 421 .Pp
 422 Example: to make slice 1 the active slice:
 423 .Pp
 424 .Dl "a       1"
 425 .El
 426 .Sh FILES
 427 .Bl -tag -width ".Pa /boot/mbr" -compact
 428 .It Pa /boot/mbr
 429 The default boot code.
 430 .El
 431 .Sh SEE ALSO
 432 .Xr boot0cfg 8 ,
 433 .Xr bsdlabel 8 ,
 434 .Xr newfs 8
 435 .Sh BUGS
 436 The default boot code will not necessarily handle all slice types
 437 correctly, in particular those introduced since
 438 .Tn MS-DOS
 439 6.x.
 440 .Pp
 441 The entire utility should be made more user-friendly.
 442 .Pp
 443 Most users new to
 444 .Fx
 445 do not understand the difference between
 446 .Dq slice
 447 and
 448 .Dq partition ,
 449 causing difficulty to adjust.
 450 .Pp
 451 You cannot use this command to completely dedicate a disk to
 452 .Fx .
 453 The
 454 .Xr bsdlabel 8
 455 command must be used for this.