sbin/geom/class/part/gpart.8

   1 .\" Copyright (c) 2007, 2008 Marcel Moolenaar
   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 the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd March 19, 2012
  28 .Dt GPART 8
  29 .Os
  30 .Sh NAME
  31 .Nm gpart
  32 .Nd "control utility for the disk partitioning GEOM class"
  33 .Sh SYNOPSIS
  34 To add support for the disk partitioning GEOM class,
  35 place one or more of the following
  36 lines in the kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "options GEOM_PART_APM"
  39 .Cd "options GEOM_PART_BSD"
  40 .Cd "options GEOM_PART_GPT"
  41 .Cd "options GEOM_PART_LDM"
  42 .Cd "options GEOM_PART_MBR"
  43 .Cd "options GEOM_PART_EBR"
  44 .Cd "options GEOM_PART_EBR_COMPAT"
  45 .Cd "options GEOM_PART_PC98"
  46 .Cd "options GEOM_PART_VTOC8"
  47 .Ed
  48 .Pp
  49 These options provide support for the various types of partitioning
  50 schemes supported by the
  51 .Ns Nm
  52 utility.
  53 See
  54 .Sx "PARTITIONING SCHEMES"
  55 below for more details.
  56 .Pp
  57 Usage of the
  58 .Ns Nm
  59 utility:
  60 .Pp
  61 .\" ==== ADD ====
  62 .Nm
  63 .Cm add
  64 .Fl t Ar type
  65 .Op Fl a Ar alignment
  66 .Op Fl b Ar start
  67 .Op Fl s Ar size
  68 .Op Fl i Ar index
  69 .Op Fl l Ar label
  70 .Op Fl f Ar flags
  71 .Ar geom
  72 .\" ==== BACKUP ====
  73 .Nm
  74 .Cm backup
  75 .Ar geom
  76 .\" ==== BOOTCODE ====
  77 .Nm
  78 .Cm bootcode
  79 .Op Fl b Ar bootcode
  80 .Op Fl p Ar partcode Fl i Ar index
  81 .Op Fl f Ar flags
  82 .Ar geom
  83 .\" ==== COMMIT ====
  84 .Nm
  85 .Cm commit
  86 .Ar geom
  87 .\" ==== CREATE ====
  88 .Nm
  89 .Cm create
  90 .Fl s Ar scheme
  91 .Op Fl n Ar entries
  92 .Op Fl f Ar flags
  93 .Ar provider
  94 .\" ==== DELETE ====
  95 .Nm
  96 .Cm delete
  97 .Fl i Ar index
  98 .Op Fl f Ar flags
  99 .Ar geom
 100 .\" ==== DESTROY ====
 101 .Nm
 102 .Cm destroy
 103 .Op Fl F
 104 .Op Fl f Ar flags
 105 .Ar geom
 106 .\" ==== MODIFY ====
 107 .Nm
 108 .Cm modify
 109 .Fl i Ar index
 110 .Op Fl l Ar label
 111 .Op Fl t Ar type
 112 .Op Fl f Ar flags
 113 .Ar geom
 114 .\" ==== RECOVER ====
 115 .Nm
 116 .Cm recover
 117 .Op Fl f Ar flags
 118 .Ar geom
 119 .\" ==== RESIZE ====
 120 .Nm
 121 .Cm resize
 122 .Fl i Ar index
 123 .Op Fl a Ar alignment
 124 .Op Fl s Ar size
 125 .Op Fl f Ar flags
 126 .Ar geom
 127 .\" ==== RESTORE ====
 128 .Nm
 129 .Cm restore
 130 .Op Fl lF
 131 .Op Fl f Ar flags
 132 .Ar provider
 133 .Op Ar ...
 134 .\" ==== SET ====
 135 .Nm
 136 .Cm set
 137 .Fl a Ar attrib
 138 .Fl i Ar index
 139 .Op Fl f Ar flags
 140 .Ar geom
 141 .\" ==== SHOW ====
 142 .Nm
 143 .Cm show
 144 .Op Fl l | r
 145 .Op Fl p
 146 .Op Ar geom ...
 147 .\" ==== UNDO ====
 148 .Nm
 149 .Cm undo
 150 .Ar geom
 151 .\" ==== UNSET ====
 152 .Nm
 153 .Cm unset
 154 .Fl a Ar attrib
 155 .Fl i Ar index
 156 .Op Fl f Ar flags
 157 .Ar geom
 158 .\"
 159 .Sh DESCRIPTION
 160 The
 161 .Nm
 162 utility is used to partition GEOM providers, normally disks.
 163 The first argument is the action to be taken:
 164 .Bl -tag -width ".Cm bootcode"
 165 .\" ==== ADD ====
 166 .It Cm add
 167 Add a new partition to the partitioning scheme given by
 168 .Ar geom .
 169 The partition begins on the logical block address given by the
 170 .Fl b Ar start
 171 option.
 172 Its size is given by the
 173 .Fl s Ar size
 174 option.
 175 SI unit suffixes are allowed.
 176 One or both
 177 .Fl b
 178 and
 179 .Fl s
 180 options can be omitted.
 181 If so they are automatically calculated.
 182 The type of the partition is given by the
 183 .Fl t Ar type
 184 option.
 185 Partition types are discussed below in the section entitled
 186 .Sx "PARTITION TYPES" .
 187 .Pp
 188 Additional options include:
 189 .Bl -tag -width 12n
 190 .It Fl a Ar alignment
 191 If specified, then
 192 .Nm
 193 utility tries to align
 194 .Ar start
 195 offset and partition
 196 .Ar size
 197 to be multiple of
 198 .Ar alignment
 199 value.
 200 .It Fl i Ar index
 201 The index in the partition table at which the new partition is to be
 202 placed.
 203 The index determines the name of the device special file used
 204 to represent the partition.
 205 .It Fl l Ar label
 206 The label attached to the partition.
 207 This option is only valid when used on partitioning schemes that support
 208 partition labels.
 209 .It Fl f Ar flags
 210 Additional operational flags.
 211 See the section entitled
 212 .Sx "OPERATIONAL FLAGS"
 213 below for a discussion
 214 about its use.
 215 .El
 216 .\" ==== BACKUP ====
 217 .It Cm backup
 218 Dump a partition table to standard output in a special format used by the
 219 .Cm restore
 220 action.
 221 .\" ==== BOOTCODE ====
 222 .It Cm bootcode
 223 Embed bootstrap code into the partitioning scheme's metadata on the
 224 .Ar geom
 225 (using
 226 .Fl b Ar bootcode )
 227 or write bootstrap code into a partition (using
 228 .Fl p Ar partcode
 229 and
 230 .Fl i Ar index ) .
 231 Not all partitioning schemes have embedded bootstrap code, so the
 232 .Fl b Ar bootcode
 233 option is scheme-specific in nature (see the section entitled
 234 .Sx BOOTSTRAPPING
 235 below).
 236 The
 237 .Fl b Ar bootcode
 238 option specifies a file that contains the bootstrap code.
 239 The contents and size of the file are determined by the partitioning
 240 scheme.
 241 The
 242 .Fl p Ar partcode
 243 option specifies a file that contains the bootstrap code intended to be
 244 written to a partition.
 245 The partition is specified by the
 246 .Fl i Ar index
 247 option.
 248 The size of the file must be smaller than the size of the partition.
 249 .Pp
 250 Additional options include:
 251 .Bl -tag -width 10n
 252 .It Fl f Ar flags
 253 Additional operational flags.
 254 See the section entitled
 255 .Sx "OPERATIONAL FLAGS"
 256 below for a discussion
 257 about its use.
 258 .El
 259 .\" ==== COMMIT ====
 260 .It Cm commit
 261 Commit any pending changes for geom
 262 .Ar geom .
 263 All actions are committed by default and will not result in
 264 pending changes.
 265 Actions can be modified with the
 266 .Fl f Ar flags
 267 option so that they are not committed, but become pending.
 268 Pending changes are reflected by the geom and the
 269 .Nm
 270 utility, but they are not actually written to disk.
 271 The
 272 .Cm commit
 273 action will write all pending changes to disk.
 274 .\" ==== CREATE ====
 275 .It Cm create
 276 Create a new partitioning scheme on a provider given by
 277 .Ar provider .
 278 The
 279 .Fl s Ar scheme
 280 option determines the scheme to use.
 281 The kernel must have support for a particular scheme before
 282 that scheme can be used to partition a disk.
 283 .Pp
 284 Additional options include:
 285 .Bl -tag -width 10n
 286 .It Fl n Ar entries
 287 The number of entries in the partition table.
 288 Every partitioning scheme has a minimum and maximum number of entries.
 289 This option allows tables to be created with a number of entries
 290 that is within the limits.
 291 Some schemes have a maximum equal to the minimum and some schemes have
 292 a maximum large enough to be considered unlimited.
 293 By default, partition tables are created with the minimum number of
 294 entries.
 295 .It Fl f Ar flags
 296 Additional operational flags.
 297 See the section entitled
 298 .Sx "OPERATIONAL FLAGS"
 299 below for a discussion
 300 about its use.
 301 .El
 302 .\" ==== DELETE ====
 303 .It Cm delete
 304 Delete a partition from geom
 305 .Ar geom
 306 and further identified by the
 307 .Fl i Ar index
 308 option.
 309 The partition cannot be actively used by the kernel.
 310 .Pp
 311 Additional options include:
 312 .Bl -tag -width 10n
 313 .It Fl f Ar flags
 314 Additional operational flags.
 315 See the section entitled
 316 .Sx "OPERATIONAL FLAGS"
 317 below for a discussion
 318 about its use.
 319 .El
 320 .\" ==== DESTROY ====
 321 .It Cm destroy
 322 Destroy the partitioning scheme as implemented by geom
 323 .Ar geom .
 324 .Pp
 325 Additional options include:
 326 .Bl -tag -width 10n
 327 .It Fl F
 328 Forced destroying of the partition table even if it is not empty.
 329 .It Fl f Ar flags
 330 Additional operational flags.
 331 See the section entitled
 332 .Sx "OPERATIONAL FLAGS"
 333 below for a discussion
 334 about its use.
 335 .El
 336 .\" ==== MODIFY ====
 337 .It Cm modify
 338 Modify a partition from geom
 339 .Ar geom
 340 and further identified by the
 341 .Fl i Ar index
 342 option.
 343 Only the type and/or label of the partition can be modified.
 344 To change the type of a partition, specify the new type with the
 345 .Fl t Ar type
 346 option.
 347 To change the label of a partition, specify the new label with the
 348 .Fl l Ar label
 349 option.
 350 Not all partitioning schemes support labels and it is invalid to
 351 try to change a partition label in such cases.
 352 .Pp
 353 Additional options include:
 354 .Bl -tag -width 10n
 355 .It Fl f Ar flags
 356 Additional operational flags.
 357 See the section entitled
 358 .Sx "OPERATIONAL FLAGS"
 359 below for a discussion
 360 about its use.
 361 .El
 362 .\" ==== RECOVER ====
 363 .It Cm recover
 364 Recover a corrupt partition's scheme metadata on the geom
 365 .Ar geom .
 366 See the section entitled
 367 .Sx RECOVERING
 368 below for the additional information.
 369 .Pp
 370 Additional options include:
 371 .Bl -tag -width 10n
 372 .It Fl f Ar flags
 373 Additional operational flags.
 374 See the section entitled
 375 .Sx "OPERATIONAL FLAGS"
 376 below for a discussion
 377 about its use.
 378 .El
 379 .\" ==== RESIZE ====
 380 .It Cm resize
 381 Resize a partition from geom
 382 .Ar geom
 383 and further identified by the
 384 .Fl i Ar index
 385 option.
 386 New partition size is expressed in logical block
 387 numbers and can be given by the
 388 .Fl s Ar size
 389 option.
 390 If
 391 .Fl s
 392 option is omitted then new size is automatically calculated
 393 to maximum available from given geom
 394 .Ar geom .
 395 .Pp
 396 Additional options include:
 397 .Bl -tag -width 12n
 398 .It Fl a Ar alignment
 399 If specified, then
 400 .Nm
 401 utility tries to align partition
 402 .Ar size
 403 to be multiple of
 404 .Ar alignment
 405 value.
 406 .It Fl f Ar flags
 407 Additional operational flags.
 408 See the section entitled
 409 .Sx "OPERATIONAL FLAGS"
 410 below for a discussion
 411 about its use.
 412 .El
 413 .\" ==== RESTORE ====
 414 .It Cm restore
 415 Restore the partition table from a backup previously created by the
 416 .Cm backup
 417 action and read from standard input.
 418 Only the partition table is restored.
 419 This action does not affect the content of partitions.
 420 After restoring the partition table and writing bootcode if needed,
 421 user data must be restored from backup.
 422 .Pp
 423 Additional options include:
 424 .Bl -tag -width 10n
 425 .It Fl F
 426 Destroy partition table on the given
 427 .Ar provider
 428 before doing restore.
 429 .It Fl l
 430 Restore partition labels for partitioning schemes that support them.
 431 .It Fl f Ar flags
 432 Additional operational flags.
 433 See the section entitled
 434 .Sx "OPERATIONAL FLAGS"
 435 below for a discussion
 436 about its use.
 437 .El
 438 .\" ==== SET ====
 439 .It Cm set
 440 Set the named attribute on the partition entry.
 441 See the section entitled
 442 .Sx ATTRIBUTES
 443 below for a list of available attributes.
 444 .Pp
 445 Additional options include:
 446 .Bl -tag -width 10n
 447 .It Fl f Ar flags
 448 Additional operational flags.
 449 See the section entitled
 450 .Sx "OPERATIONAL FLAGS"
 451 below for a discussion
 452 about its use.
 453 .El
 454 .\" ==== SHOW ====
 455 .It Cm show
 456 Show the current partition information of the specified geoms
 457 or all geoms if none are specified.
 458 Additional options include:
 459 .Bl -tag -width 10n
 460 .It Fl l
 461 For partitioning schemes that support partition labels, print them
 462 instead of partition type.
 463 .It Fl p
 464 Show provider names instead of partition indexes.
 465 .It Fl r
 466 Show raw partition type instead of symbolic name.
 467 .El
 468 .\" ==== UNDO ====
 469 .It Cm undo
 470 Revert any pending changes for geom
 471 .Ar geom .
 472 This action is the opposite of the
 473 .Cm commit
 474 action and can be used to undo any changes that have not been committed.
 475 .\" ==== UNSET ====
 476 .It Cm unset
 477 Clear the named attribute on the partition entry.
 478 See the section entitled
 479 .Sx ATTRIBUTES
 480 below for a list of available attributes.
 481 .Pp
 482 Additional options include:
 483 .Bl -tag -width 10n
 484 .It Fl f Ar flags
 485 Additional operational flags.
 486 See the section entitled
 487 .Sx "OPERATIONAL FLAGS"
 488 below for a discussion
 489 about its use.
 490 .El
 491 .El
 492 .Sh PARTITIONING SCHEMES
 493 Several partitioning schemes are supported by the
 494 .Nm
 495 utility:
 496 .Bl -tag -width ".Cm VTOC8"
 497 .It Cm APM
 498 Apple Partition Map, used by PowerPC(R) Macintosh(R) computers.
 499 Requires the
 500 .Cd GEOM_PART_APM
 501 kernel option.
 502 .It Cm BSD
 503 Traditional BSD disklabel, usually used to subdivide MBR partitions.
 504 .Po
 505 This scheme can also be used as the sole partitioning method, without
 506 an MBR.
 507 Partition editing tools from other operating systems often do not
 508 understand the bare disklabel partition layout, so this is sometimes
 509 called
 510 .Dq dangerously dedicated .
 511 .Pc
 512 Requires the
 513 .Cm GEOM_PART_BSD
 514 kernel option.
 515 .It Cm LDM
 516 The Logical Disk Manager is an implementation of volume manager for
 517 Microsoft Windows NT.
 518 Requires the
 519 .Cd GEOM_PART_LDM
 520 kernel option.
 521 .It Cm GPT
 522 GUID Partition Table is used on Intel-based Macintosh computers and
 523 gradually replacing MBR on most PCs and other systems.
 524 Requires the
 525 .Cm GEOM_PART_GPT
 526 kernel option.
 527 .It Cm MBR
 528 Master Boot Record is used on PCs and removable media.
 529 Requires the
 530 .Cm GEOM_PART_MBR
 531 kernel option.
 532 The
 533 .Cm GEOM_PART_EBR
 534 option adds support for the Extended Boot Record (EBR),
 535 which is used to define a logical partition.
 536 The
 537 .Cm GEOM_PART_EBR_COMPAT
 538 option enables backward compatibility for partition names
 539 in the EBR scheme.
 540 It also prevents any type of actions on such partitions.
 541 .It Cm PC98
 542 An MBR variant for NEC PC-98 and compatible computers.
 543 Requires the
 544 .Cm GEOM_PART_PC98
 545 kernel option.
 546 .It Cm VTOC8
 547 Sun's SMI Volume Table Of Contents, used by
 548 .Tn SPARC64
 549 and
 550 .Tn UltraSPARC
 551 computers.
 552 Requires the
 553 .Cm GEOM_PART_VTOC8
 554 kernel option.
 555 .El
 556 .Sh PARTITION TYPES
 557 Partition types are identified on disk by particular strings or magic
 558 values.
 559 The
 560 .Nm
 561 utility uses symbolic names for common partition types so the user
 562 does not need to know these values or other details of the partitioning
 563 scheme in question.
 564 The
 565 .Nm
 566 utility also allows the user to specify scheme-specific partition types
 567 for partition types that do not have symbolic names.
 568 Symbolic names currently understood are:
 569 .Bl -tag -width ".Cm ms-ldm-metadata"
 570 .It Cm bios-boot
 571 The system partition dedicated to second stage of the boot loader program.
 572 Usually it is used by the GRUB 2 loader for GPT partitioning schemes.
 573 The scheme-specific type is
 574 .Qq Li "!21686148-6449-6E6F-744E-656564454649" .
 575 .It Cm efi
 576 The system partition for computers that use the Extensible Firmware
 577 Interface (EFI).
 578 In such cases, the GPT partitioning scheme is used and the
 579 actual partition type for the system partition can also be specified as
 580 .Qq Li "!c12a7328-f81f-11d2-ba4b-00a0c93ec93ab" .
 581 .It Cm freebsd
 582 A
 583 .Fx
 584 partition subdivided into filesystems with a
 585 .Bx
 586 disklabel.
 587 This is a legacy partition type and should not be used for the APM
 588 or GPT schemes.
 589 The scheme-specific types are
 590 .Qq Li "!165"
 591 for MBR,
 592 .Qq Li "!FreeBSD"
 593 for APM, and
 594 .Qq Li "!516e7cb4-6ecf-11d6-8ff8-00022d09712b"
 595 for GPT.
 596 .It Cm freebsd-boot
 597 A
 598 .Fx
 599 partition dedicated to bootstrap code.
 600 The scheme-specific type is
 601 .Qq Li "!83bd6b9d-7f41-11dc-be0b-001560b84f0f"
 602 for GPT.
 603 .It Cm freebsd-swap
 604 A
 605 .Fx
 606 partition dedicated to swap space.
 607 The scheme-specific types are
 608 .Qq Li "!FreeBSD-swap"
 609 for APM,
 610 .Qq Li "!516e7cb5-6ecf-11d6-8ff8-00022d09712b"
 611 for GPT, and tag 0x0901 for VTOC8.
 612 .It Cm freebsd-ufs
 613 A
 614 .Fx
 615 partition that contains a UFS or UFS2 filesystem.
 616 The scheme-specific types are
 617 .Qq Li "!FreeBSD-UFS"
 618 for APM,
 619 .Qq Li "!516e7cb6-6ecf-11d6-8ff8-00022d09712b"
 620 for GPT, and tag 0x0902 for VTOC8.
 621 .It Cm freebsd-vinum
 622 A
 623 .Fx
 624 partition that contains a Vinum volume.
 625 The scheme-specific types are
 626 .Qq Li "!FreeBSD-Vinum"
 627 for APM,
 628 .Qq Li "!516e7cb8-6ecf-11d6-8ff8-00022d09712b"
 629 for GPT, and tag 0x0903 for VTOC8.
 630 .It Cm freebsd-zfs
 631 A
 632 .Fx
 633 partition that contains a ZFS volume.
 634 The scheme-specific types are
 635 .Qq Li "!FreeBSD-ZFS"
 636 for APM,
 637 .Qq Li "!516e7cba-6ecf-11d6-8ff8-00022d09712b"
 638 for GPT, and 0x0904 for VTOC8.
 639 .It Cm mbr
 640 A partition that is sub-partitioned by a Master Boot Record (MBR).
 641 This type is known as
 642 .Qq Li "!024dee41-33e7-11d3-9d69-0008c781f39f"
 643 by GPT.
 644 .It Cm ms-ldm-data
 645 A partition that contains Logical Disk Manager (LDM) volumes.
 646 The scheme-specific types are
 647 .Qq Li "!66"
 648 for MBR,
 649 .Qq Li "!af9b60a0-1431-4f62-bc68-3311714a69ad"
 650 for GPT.
 651 .It Cm ms-ldm-metadata
 652 A partition that contains Logical Disk Manager (LDM) database.
 653 The scheme-specific type is
 654 .Qq Li "!5808c8aa-7e8f-42e0-85d2-e1e90434cfb3"
 655 for GPT.
 656 .El
 657 .Sh ATTRIBUTES
 658 The scheme-specific attributes for EBR:
 659 .Bl -tag -width ".Cm active"
 660 .It Cm active
 661 .El
 662 .Pp
 663 The scheme-specific attributes for GPT:
 664 .Bl -tag -width ".Cm bootfailed"
 665 .It Cm bootme
 666 When set, the
 667 .Nm gptboot
 668 stage 1 boot loader will try to boot the system from this partition.
 669 Multiple partitions might be marked with the
 670 .Cm bootme
 671 attribute.
 672 In such scenario the
 673 .Nm gptboot
 674 will try all
 675 .Cm bootme
 676 partitions one by one, until the next boot stage is successfully entered.
 677 .It Cm bootonce
 678 Setting this attribute automatically sets the
 679 .Cm bootme
 680 attribute.
 681 When set, the
 682 .Nm gptboot
 683 stage 1 boot loader will try to boot the system from this partition only once.
 684 Partitions with both
 685 .Cm bootonce
 686 and
 687 .Cm bootme
 688 attributes are tried before partitions with only the
 689 .Cm bootme
 690 attribute.
 691 Before
 692 .Cm bootonce
 693 partition is tried, the
 694 .Nm gptboot
 695 removes the
 696 .Cm bootme
 697 attribute and tries to execute the next boot stage.
 698 If it fails, the
 699 .Cm bootonce
 700 attribute that is now alone is replaced with the
 701 .Cm bootfailed
 702 attribute.
 703 If the execution of the next boot stage succeeds, but the system is not fully
 704 booted, the
 705 .Nm gptboot
 706 will look for
 707 .Cm bootonce
 708 attributes alone (without the
 709 .Cm bootme
 710 attribute) on the next system boot and will replace those with the
 711 .Cm bootfailed
 712 attribute.
 713 If the system is fully booted, the
 714 .Pa /etc/rc.d/gptboot
 715 start-up script will look for partition with the
 716 .Cm bootonce
 717 attribute alone, will remove the attribute and log that the system was
 718 successfully booted from this partition.
 719 There should be at most one
 720 .Cm bootonce
 721 partition when system is successfully booted.
 722 Multiple partitions might be marked with the
 723 .Cm bootonce
 724 and
 725 .Cm bootme
 726 attribute pairs.
 727 .It Cm bootfailed
 728 This attribute should not be manually managed.
 729 It is managed by the
 730 .Nm gptboot
 731 stage 1 boot loader and the
 732 .Pa /etc/rc.d/gptboot
 733 start-up script.
 734 This attribute is used to mark partitions that had the
 735 .Cm bootonce
 736 attribute set, but we failed to boot from them.
 737 Once we successfully boot, the
 738 .Pa /etc/rc.d/gptboot
 739 script will log all the partitions we failed to boot from and will remove the
 740 .Cm bootfailed
 741 attributes.
 742 .El
 743 .Pp
 744 The scheme-specific attributes for MBR:
 745 .Bl -tag -width ".Cm active"
 746 .It Cm active
 747 .El
 748 .Pp
 749 The scheme-specific attributes for PC98:
 750 .Bl -tag -width ".Cm bootable"
 751 .It Cm active
 752 .It Cm bootable
 753 .El
 754 .Sh BOOTSTRAPPING
 755 .Fx
 756 supports several partitioning schemes and each scheme uses different
 757 bootstrap code.
 758 The bootstrap code is located in a specific disk area for each partitioning
 759 scheme, and may vary in size for different schemes.
 760 .Pp
 761 Bootstrap code can be separated into two types.
 762 The first type is embedded in the partitioning scheme's metadata, while the
 763 second type is located on a specific partition.
 764 Embedding bootstrap code should only be done with the
 765 .Cm gpart bootcode
 766 command with the
 767 .Fl b Ar bootcode
 768 option.
 769 The GEOM PART class knows how to safely embed bootstrap code into
 770 specific partitioning scheme metadata without causing any damage.
 771 .Pp
 772 The Master Boot Record (MBR) uses a 512-byte bootstrap code image, embedded
 773 into the partition table's metadata area.
 774 There are two variants of this bootstrap code:
 775 .Pa /boot/mbr
 776 and
 777 .Pa /boot/boot0 .
 778 .Pa /boot/mbr
 779 searches for a partition with the
 780 .Cm active
 781 attribute (see the
 782 .Sx ATTRIBUTES
 783 section) in the partition table.
 784 Then it runs next bootstrap stage.
 785 The
 786 .Pa /boot/boot0
 787 image contains a boot manager with some additional interactive functions
 788 for multi-booting from a user-selected partition.
 789 .Pp
 790 A BSD disklabel is usually created inside an MBR partition (slice)
 791 with type
 792 .Cm freebsd
 793 (see the
 794 .Sx "PARTITION TYPES"
 795 section).
 796 It uses 8 KB size bootstrap code image
 797 .Pa /boot/boot ,
 798 embedded into the partition table's metadata area.
 799 .Pp
 800 Both types of bootstrap code are used to boot from the GUID Partition Table.
 801 First, a protective MBR is embedded into the first disk sector from the
 802 .Pa /boot/pmbr
 803 image.
 804 It searches the GPT
 805 .Cm freebsd-boot
 806 partition (see the
 807 .Sx "PARTITION TYPES"
 808 section) in the GPT and runs the next bootstrap stage from it.
 809 The
 810 .Cm freebsd-boot
 811 partition should be smaller than 545 KB.
 812 There are two variants of bootstrap code to write to this partition:
 813 .Pa /boot/gptboot
 814 and
 815 .Pa /boot/gptzfsboot .
 816 .Pa /boot/gptboot
 817 is used to boot from UFS.
 818 It searches
 819 .Cm freebsd-ufs
 820 GPT partitions and starts
 821 .Pa /boot/loader
 822 .Pq the third bootstrap stage
 823 if found.
 824 The
 825 .Pa /boot/gptzfsboot
 826 is used to boot from ZFS.
 827 It searches
 828 .Cm freebsd-zfs
 829 GPT partitions and starts
 830 .Pa /boot/zfsloader
 831 if found.
 832 .Pp
 833 The VTOC8 scheme does not support embedding bootstrap code.
 834 Instead, the 8 KBytes bootstrap code image
 835 .Pa /boot/boot1
 836 should be written with the
 837 .Cm gpart bootcode
 838 command with the
 839 .Fl p Ar bootcode
 840 option to all sufficiently large VTOC8 partitions.
 841 To do this the
 842 .Fl i Ar index
 843 option could be omitted.
 844 .Pp
 845 The APM scheme also does not support embedding bootstrap code.
 846 Instead, the 800 KBytes bootstrap code image
 847 .Pa /boot/boot1.hfs
 848 should be written with the
 849 .Cm gpart bootcode
 850 command to a partition of type
 851 .Cm freebsd-boot ,
 852 which should also be 800 KB in size.
 853 .Sh OPERATIONAL FLAGS
 854 Actions other than the
 855 .Cm commit
 856 and
 857 .Cm undo
 858 actions take an optional
 859 .Fl f Ar flags
 860 option.
 861 This option is used to specify action-specific operational flags.
 862 By default, the
 863 .Nm
 864 utility defines the
 865 .Ql C
 866 flag so that the action is immediately
 867 committed.
 868 The user can specify
 869 .Dq Fl f Cm x
 870 to have the action result in a pending change that can later, with
 871 other pending changes, be committed as a single compound change with
 872 the
 873 .Cm commit
 874 action or reverted with the
 875 .Cm undo
 876 action.
 877 .Sh RECOVERING
 878 The GEOM PART class supports recovering of partition tables only for GPT.
 879 The GPT primary metadata is stored at the beginning of the device.
 880 For redundancy, a secondary
 881 .Pq backup
 882 copy of the metadata is stored at the end of the device.
 883 As a result of having two copies, some corruption of metadata is not
 884 fatal to the working of GPT.
 885 When the kernel detects corrupt metadata, it marks this table as corrupt
 886 and reports the problem.
 887 .Cm destroy
 888 and
 889 .Cm recover
 890 are the only operations allowed on corrupt tables.
 891 .Pp
 892 If the first sector of a provider is corrupt, the kernel can not detect GPT
 893 even if the partition table itself is not corrupt.
 894 The protective MBR can be rewritten using the
 895 .Xr dd 1
 896 command, to restore the ability to detect the GPT.
 897 The copy of the protective MBR is usually located in the
 898 .Pa /boot/pmbr
 899 file.
 900 .Pp
 901 If one GPT header appears to be corrupt but the other copy remains intact,
 902 the kernel will log the following:
 903 .Bd -literal -offset indent
 904 GEOM: provider: the primary GPT table is corrupt or invalid.
 905 GEOM: provider: using the secondary instead -- recovery strongly advised.
 906 .Ed
 907 .Pp
 908 or
 909 .Bd -literal -offset indent
 910 GEOM: provider: the secondary GPT table is corrupt or invalid.
 911 GEOM: provider: using the primary only -- recovery suggested.
 912 .Ed
 913 .Pp
 914 Also
 915 .Nm
 916 commands such as
 917 .Cm show , status
 918 and
 919 .Cm list
 920 will report about corrupt tables.
 921 .Pp
 922 If the size of the device has changed (e.g.\& volume expansion) the
 923 secondary GPT header will no longer be located in the last sector.
 924 This is not a metadata corruption, but it is dangerous because any
 925 corruption of the primary GPT will lead to loss of the partition table.
 926 This problem is reported by the kernel with the message:
 927 .Bd -literal -offset indent
 928 GEOM: provider: the secondary GPT header is not in the last LBA.
 929 .Ed
 930 .Pp
 931 This situation can be recovered with the
 932 .Cm recover
 933 command.
 934 This command reconstructs the corrupt metadata using known valid
 935 metadata and relocates the secondary GPT to the end of the device.
 936 .Pp
 937 .Em NOTE :
 938 The GEOM PART class can detect the same partition table visible through
 939 different GEOM providers, and some of them will be marked as corrupt.
 940 Be careful when choosing a provider for recovery.
 941 If you choose incorrectly you can destroy the metadata of another GEOM class,
 942 e.g.\& GEOM MIRROR or GEOM LABEL.
 943 .Sh SYSCTL VARIABLES
 944 The following
 945 .Xr sysctl 8
 946 variables can be used to control the behavior of the
 947 .Nm PART
 948 GEOM class.
 949 The default value is shown next to each variable.
 950 .Bl -tag -width indent
 951 .It Va kern.geom.part.check_integrity : No 1
 952 This variable controls the behaviour of metadata integrity checks.
 953 When integrity checks are enabled, the
 954 .Nm PART
 955 GEOM class verifies all generic partition parameters obtained from the
 956 disk metadata.
 957 If some inconsistency is detected, the partition table will be
 958 rejected with a diagnostic message:
 959 .Sy "GEOM_PART: Integrity check failed (provider, scheme)" .
 960 .It Va kern.geom.part.ldm.debug : No 0
 961 Debug level of the Logical Disk Manager (LDM) module.
 962 This can be set to a number between 0 and 2 inclusive.
 963 If set to 0 minimal debug information is printed,
 964 and if set to 2 the maximum amount of debug information is printed.
 965 .It Va kern.geom.part.ldm.show_mirrors : No 0
 966 This variable controls how the Logical Disk Manager (LDM) module handles
 967 mirrored volumes.
 968 By default mirrored volumes are shown as partitions with type
 969 .Cm ms-ldm-data
 970 (see the
 971 .Sx "PARTITION TYPES"
 972 section).
 973 If this variable set to 1 each component of the mirrored volume will be
 974 present as independent partition.
 975 .Em NOTE :
 976 This may break a mirrored volume and lead to data damage.
 977 .El
 978 .Sh EXIT STATUS
 979 Exit status is 0 on success, and 1 if the command fails.
 980 .Sh EXAMPLES
 981 Create a GPT scheme on
 982 .Pa ad0 :
 983 .Bd -literal -offset indent
 984 /sbin/gpart create -s GPT ad0
 985 .Ed
 986 .Pp
 987 Embed GPT bootstrap code into a protective MBR:
 988 .Bd -literal -offset indent
 989 /sbin/gpart bootcode -b /boot/pmbr ad0
 990 .Ed
 991 .Pp
 992 Create a dedicated
 993 .Cm freebsd-boot
 994 partition that can boot
 995 .Fx
 996 from a
 997 .Cm freebsd-ufs
 998 partition, and install bootstrap code into it.
 999 This partition must be larger than the bootstrap code
1000 .Po
1001 usually either
1002 .Pa /boot/gptboot
1003 or
1004 .Pa /boot/gptzfsboot
1005 .Pc ,
1006 but smaller than 545 kB since the first-stage loader will load the
1007 entire partition into memory during boot, regardless of how much data
1008 it actually contains.
1009 This example uses 88 blocks (44 kB) so the next partition will be
1010 aligned on a 64 kB boundary without the need to specify an explicit
1011 offset or alignment.
1012 The boot partition itself is aligned on a 4 kB boundary.
1013 .Bd -literal -offset indent
1014 /sbin/gpart add -b 40 -s 88 -t freebsd-boot ad0
1015 /sbin/gpart bootcode -p /boot/gptboot -i 1 ad0
1016 .Ed
1017 .Pp
1018 Create a 512MB-sized
1019 .Cm freebsd-ufs
1020 partition to contain a UFS filesystem from which the system can boot.
1021 .Bd -literal -offset indent
1022 /sbin/gpart add -s 512M -t freebsd-ufs ad0
1023 .Ed
1024 .Pp
1025 Create an MBR scheme on
1026 .Pa ada0 ,
1027 then create a 30GB-sized
1028 .Fx
1029 slice, mark it active and
1030 install the
1031 .Nm boot0
1032 boot manager:
1033 .Bd -literal -offset indent
1034 /sbin/gpart create -s MBR ada0
1035 /sbin/gpart add -t freebsd -s 30G ada0
1036 /sbin/gpart set -a active -i 1 ada0
1037 /sbin/gpart bootcode -b /boot/boot0 ada0
1038 .Ed
1039 .Pp
1040 Now create a
1041 .Bx
1042 scheme
1043 .Pf ( Bx
1044 label) with space for up to 20 partitions:
1045 .Bd -literal -offset indent
1046 /sbin/gpart create -s BSD -n 20 ada0s1
1047 .Ed
1048 .Pp
1049 Create a 1GB-sized UFS partition and a 4GB-sized swap partition:
1050 .Bd -literal -offset indent
1051 /sbin/gpart add -t freebsd-ufs -s 1G ada0s1
1052 /sbin/gpart add -t freebsd-swap -s 4G ada0s1
1053 .Ed
1054 .Pp
1055 Install bootstrap code for the
1056 .Bx
1057 label:
1058 .Bd -literal -offset indent
1059 /sbin/gpart bootcode -b /boot/boot ada0s1
1060 .Ed
1061 .Pp
1062 Create a VTOC8 scheme on
1063 .Pa da0 :
1064 .Bd -literal -offset indent
1065 /sbin/gpart create -s VTOC8 da0
1066 .Ed
1067 .Pp
1068 Create a 512MB-sized
1069 .Cm freebsd-ufs
1070 partition to contain a UFS filesystem from which the system can boot.
1071 .Bd -literal -offset indent
1072 /sbin/gpart add -s 512M -t freebsd-ufs da0
1073 .Ed
1074 .Pp
1075 Create a 15GB-sized
1076 .Cm freebsd-ufs
1077 partition to contain a UFS filesystem and aligned on 4KB boundaries:
1078 .Bd -literal -offset indent
1079 /sbin/gpart add -s 15G -t freebsd-ufs -a 4k da0
1080 .Ed
1081 .Pp
1082 After creating all required partitions, embed bootstrap code into them:
1083 .Bd -literal -offset indent
1084 /sbin/gpart bootcode -p /boot/boot1 da0
1085 .Ed
1086 .Pp
1087 Create a backup of the partition table from
1088 .Pa da0 :
1089 .Bd -literal -offset indent
1090 /sbin/gpart backup da0 > da0.backup
1091 .Ed
1092 .Pp
1093 Restore the partition table from the backup to
1094 .Pa da0 :
1095 .Bd -literal -offset indent
1096 /sbin/gpart restore -l da0 < /mnt/da0.backup
1097 .Ed
1098 .Pp
1099 Clone the partition table from
1100 .Pa ada0
1101 to
1102 .Pa ada1
1103 and
1104 .Pa ada2 :
1105 .Bd -literal -offset indent
1106 /sbin/gpart backup ada0 | /sbin/gpart restore -F ada1 ada2
1107 .Ed
1108 .Sh SEE ALSO
1109 .Xr dd 1 ,
1110 .Xr geom 4 ,
1111 .Xr boot0cfg 8 ,
1112 .Xr geom 8
1113 .Sh HISTORY
1114 The
1115 .Nm
1116 utility appeared in
1117 .Fx 7.0 .
1118 .Sh AUTHORS
1119 .An Marcel Moolenaar Aq marcel@FreeBSD.org