lib/geom/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 August 17, 2020
  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 .\" ==== ADD ====
  35 .Nm
  36 .Cm add
  37 .Fl t Ar type
  38 .Op Fl a Ar alignment
  39 .Op Fl b Ar start
  40 .Op Fl s Ar size
  41 .Op Fl i Ar index
  42 .Op Fl l Ar label
  43 .Op Fl f Ar flags
  44 .Ar geom
  45 .\" ==== BACKUP ====
  46 .Nm
  47 .Cm backup
  48 .Ar geom
  49 .\" ==== BOOTCODE ====
  50 .Nm
  51 .Cm bootcode
  52 .Op Fl N
  53 .Op Fl b Ar bootcode
  54 .Op Fl p Ar partcode Fl i Ar index
  55 .Op Fl f Ar flags
  56 .Ar geom
  57 .\" ==== COMMIT ====
  58 .Nm
  59 .Cm commit
  60 .Ar geom
  61 .\" ==== CREATE ====
  62 .Nm
  63 .Cm create
  64 .Fl s Ar scheme
  65 .Op Fl n Ar entries
  66 .Op Fl f Ar flags
  67 .Ar provider
  68 .\" ==== DELETE ====
  69 .Nm
  70 .Cm delete
  71 .Fl i Ar index
  72 .Op Fl f Ar flags
  73 .Ar geom
  74 .\" ==== DESTROY ====
  75 .Nm
  76 .Cm destroy
  77 .Op Fl F
  78 .Op Fl f Ar flags
  79 .Ar geom
  80 .\" ==== MODIFY ====
  81 .Nm
  82 .Cm modify
  83 .Fl i Ar index
  84 .Op Fl l Ar label
  85 .Op Fl t Ar type
  86 .Op Fl f Ar flags
  87 .Ar geom
  88 .\" ==== RECOVER ====
  89 .Nm
  90 .Cm recover
  91 .Op Fl f Ar flags
  92 .Ar geom
  93 .\" ==== RESIZE ====
  94 .Nm
  95 .Cm resize
  96 .Fl i Ar index
  97 .Op Fl a Ar alignment
  98 .Op Fl s Ar size
  99 .Op Fl f Ar flags
 100 .Ar geom
 101 .\" ==== RESTORE ====
 102 .Nm
 103 .Cm restore
 104 .Op Fl lF
 105 .Op Fl f Ar flags
 106 .Ar provider
 107 .Op Ar ...
 108 .\" ==== SET ====
 109 .Nm
 110 .Cm set
 111 .Fl a Ar attrib
 112 .Fl i Ar index
 113 .Op Fl f Ar flags
 114 .Ar geom
 115 .\" ==== SHOW ====
 116 .Nm
 117 .Cm show
 118 .Op Fl l | r
 119 .Op Fl p
 120 .Op Ar geom ...
 121 .\" ==== UNDO ====
 122 .Nm
 123 .Cm undo
 124 .Ar geom
 125 .\" ==== UNSET ====
 126 .Nm
 127 .Cm unset
 128 .Fl a Ar attrib
 129 .Fl i Ar index
 130 .Op Fl f Ar flags
 131 .Ar geom
 132 .\"
 133 .Nm
 134 .Cm list
 135 .Nm
 136 .Cm status
 137 .Nm
 138 .Cm load
 139 .Nm
 140 .Cm unload
 141 .Sh DESCRIPTION
 142 The
 143 .Nm
 144 utility is used to partition GEOM providers, normally disks.
 145 The first argument is the action to be taken:
 146 .Bl -tag -width ".Cm bootcode"
 147 .\" ==== ADD ====
 148 .It Cm add
 149 Add a new partition to the partitioning scheme given by
 150 .Ar geom .
 151 The partition type must be specified with
 152 .Fl t Ar type .
 153 The partition's location, size, and other attributes will be calculated
 154 automatically if the corresponding options are not specified.
 155 .Pp
 156 The
 157 .Cm add
 158 command accepts these options:
 159 .Bl -tag -width 12n
 160 .It Fl a Ar alignment
 161 If specified, then the
 162 .Nm
 163 utility tries to align
 164 .Ar start
 165 offset and partition
 166 .Ar size
 167 to be multiple of
 168 .Ar alignment
 169 value.
 170 .It Fl b Ar start
 171 The logical block address where the partition will begin.
 172 An SI unit suffix is allowed.
 173 .It Fl f Ar flags
 174 Additional operational flags.
 175 See the section entitled
 176 .Sx "OPERATIONAL FLAGS"
 177 below for a discussion
 178 about its use.
 179 .It Fl i Ar index
 180 The index in the partition table at which the new partition is to be
 181 placed.
 182 The index determines the name of the device special file used
 183 to represent the partition.
 184 .It Fl l Ar label
 185 The label attached to the partition.
 186 This option is only valid when used on partitioning schemes that support
 187 partition labels.
 188 .It Fl s Ar size
 189 Create a partition of size
 190 .Ar size .
 191 An SI unit suffix is allowed.
 192 .It Fl t Ar type
 193 Create a partition of type
 194 .Ar type .
 195 Partition types are discussed below in the section entitled
 196 .Sx "PARTITION TYPES" .
 197 .El
 198 .\" ==== BACKUP ====
 199 .It Cm backup
 200 Dump a partition table to standard output in a special format used by the
 201 .Cm restore
 202 action.
 203 .\" ==== BOOTCODE ====
 204 .It Cm bootcode
 205 Embed bootstrap code into the partitioning scheme's metadata on the
 206 .Ar geom
 207 (using
 208 .Fl b Ar bootcode )
 209 or write bootstrap code into a partition (using
 210 .Fl p Ar partcode
 211 and
 212 .Fl i Ar index ) .
 213 .Pp
 214 The
 215 .Cm bootcode
 216 command accepts these options:
 217 .Bl -tag -width 10n
 218 .It Fl N
 219 Don't preserve the Volume Serial Number for MBR.
 220 MBR bootcode contains Volume Serial Number by default, and
 221 .Nm
 222 tries to preserve it when installing new bootstrap code.
 223 This option allows to skip the preservation to help with some versions of
 224 .Xr boot0 8
 225 that don't support Volume Serial Number.
 226 .It Fl b Ar bootcode
 227 Embed bootstrap code from the file
 228 .Ar bootcode
 229 into the partitioning scheme's metadata for
 230 .Ar geom .
 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 .Ar bootcode
 238 file must match the partitioning scheme's requirements for file content
 239 and size.
 240 .It Fl f Ar flags
 241 Additional operational flags.
 242 See the section entitled
 243 .Sx "OPERATIONAL FLAGS"
 244 below for a discussion
 245 about its use.
 246 .It Fl i Ar index
 247 Specify the target partition for
 248 .Fl p Ar partcode .
 249 .It Fl p Ar partcode
 250 Write the bootstrap code from the file
 251 .Ar partcode
 252 into the
 253 .Ar geom
 254 partition specified by
 255 .Fl i Ar index .
 256 The size of the file must be smaller than the size of the partition.
 257 .El
 258 .\" ==== COMMIT ====
 259 .It Cm commit
 260 Commit any pending changes for geom
 261 .Ar geom .
 262 All actions are committed by default and will not result in
 263 pending changes.
 264 Actions can be modified with the
 265 .Fl f Ar flags
 266 option so that they are not committed, but become pending.
 267 Pending changes are reflected by the geom and the
 268 .Nm
 269 utility, but they are not actually written to disk.
 270 The
 271 .Cm commit
 272 action will write all pending changes to disk.
 273 .\" ==== CREATE ====
 274 .It Cm create
 275 Create a new partitioning scheme on a provider given by
 276 .Ar provider .
 277 The scheme to use must be specified with the
 278 .Fl s Ar scheme
 279 option.
 280 .Pp
 281 The
 282 .Cm create
 283 command accepts these options:
 284 .Bl -tag -width 10n
 285 .It Fl f Ar flags
 286 Additional operational flags.
 287 See the section entitled
 288 .Sx "OPERATIONAL FLAGS"
 289 below for a discussion
 290 about its use.
 291 .It Fl n Ar entries
 292 The number of entries in the partition table.
 293 Every partitioning scheme has a minimum and maximum number of entries.
 294 This option allows tables to be created with a number of entries
 295 that is within the limits.
 296 Some schemes have a maximum equal to the minimum and some schemes have
 297 a maximum large enough to be considered unlimited.
 298 By default, partition tables are created with the minimum number of
 299 entries.
 300 .It Fl s Ar scheme
 301 Specify the partitioning scheme to use.
 302 The kernel must have support for a particular scheme before
 303 that scheme can be used to partition a disk.
 304 .El
 305 .\" ==== DELETE ====
 306 .It Cm delete
 307 Delete a partition from geom
 308 .Ar geom
 309 and further identified by the
 310 .Fl i Ar index
 311 option.
 312 The partition cannot be actively used by the kernel.
 313 .Pp
 314 The
 315 .Cm delete
 316 command accepts these options:
 317 .Bl -tag -width 10n
 318 .It Fl f Ar flags
 319 Additional operational flags.
 320 See the section entitled
 321 .Sx "OPERATIONAL FLAGS"
 322 below for a discussion
 323 about its use.
 324 .It Fl i Ar index
 325 Specifies the index of the partition to be deleted.
 326 .El
 327 .\" ==== DESTROY ====
 328 .It Cm destroy
 329 Destroy the partitioning scheme as implemented by geom
 330 .Ar geom .
 331 .Pp
 332 The
 333 .Cm destroy
 334 command accepts these options:
 335 .Bl -tag -width 10n
 336 .It Fl F
 337 Forced destroying of the partition table even if it is not empty.
 338 .It Fl f Ar flags
 339 Additional operational flags.
 340 See the section entitled
 341 .Sx "OPERATIONAL FLAGS"
 342 below for a discussion
 343 about its use.
 344 .El
 345 .\" ==== MODIFY ====
 346 .It Cm modify
 347 Modify a partition from geom
 348 .Ar geom
 349 and further identified by the
 350 .Fl i Ar index
 351 option.
 352 Only the type and/or label of the partition can be modified.
 353 Not all partitioning schemes support labels and it is invalid to
 354 try to change a partition label in such cases.
 355 .Pp
 356 The
 357 .Cm modify
 358 command accepts these options:
 359 .Bl -tag -width 10n
 360 .It Fl f Ar flags
 361 Additional operational flags.
 362 See the section entitled
 363 .Sx "OPERATIONAL FLAGS"
 364 below for a discussion
 365 about its use.
 366 .It Fl i Ar index
 367 Specifies the index of the partition to be modified.
 368 .It Fl l Ar label
 369 Change the partition label to
 370 .Ar label .
 371 .It Fl t Ar type
 372 Change the partition type to
 373 .Ar type .
 374 .El
 375 .\" ==== RECOVER ====
 376 .It Cm recover
 377 Recover a corrupt partition's scheme metadata on the geom
 378 .Ar geom .
 379 See the section entitled
 380 .Sx RECOVERING
 381 below for the additional information.
 382 .Pp
 383 The
 384 .Cm recover
 385 command accepts these options:
 386 .Bl -tag -width 10n
 387 .It Fl f Ar flags
 388 Additional operational flags.
 389 See the section entitled
 390 .Sx "OPERATIONAL FLAGS"
 391 below for a discussion
 392 about its use.
 393 .El
 394 .\" ==== RESIZE ====
 395 .It Cm resize
 396 Resize a partition from geom
 397 .Ar geom
 398 and further identified by the
 399 .Fl i Ar index
 400 option.
 401 If the new size is not specified it is automatically calculated
 402 to be the maximum available from
 403 .Ar geom .
 404 .Pp
 405 The
 406 .Cm resize
 407 command accepts these options:
 408 .Bl -tag -width 12n
 409 .It Fl a Ar alignment
 410 If specified, then the
 411 .Nm
 412 utility tries to align partition
 413 .Ar size
 414 to be a multiple of the
 415 .Ar alignment
 416 value.
 417 .It Fl f Ar flags
 418 Additional operational flags.
 419 See the section entitled
 420 .Sx "OPERATIONAL FLAGS"
 421 below for a discussion
 422 about its use.
 423 .It Fl i Ar index
 424 Specifies the index of the partition to be resized.
 425 .It Fl s Ar size
 426 Specifies the new size of the partition, in logical blocks.
 427 An SI unit suffix is allowed.
 428 .El
 429 .\" ==== RESTORE ====
 430 .It Cm restore
 431 Restore the partition table from a backup previously created by the
 432 .Cm backup
 433 action and read from standard input.
 434 Only the partition table is restored.
 435 This action does not affect the content of partitions.
 436 After restoring the partition table and writing bootcode if needed,
 437 user data must be restored from backup.
 438 .Pp
 439 The
 440 .Cm restore
 441 command accepts these options:
 442 .Bl -tag -width 10n
 443 .It Fl F
 444 Destroy partition table on the given
 445 .Ar provider
 446 before doing restore.
 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 .It Fl l
 454 Restore partition labels for partitioning schemes that support them.
 455 .El
 456 .\" ==== SET ====
 457 .It Cm set
 458 Set the named attribute on the partition entry.
 459 See the section entitled
 460 .Sx ATTRIBUTES
 461 below for a list of available attributes.
 462 .Pp
 463 The
 464 .Cm set
 465 command accepts these options:
 466 .Bl -tag -width 10n
 467 .It Fl a Ar attrib
 468 Specifies the attribute to set.
 469 .It Fl f Ar flags
 470 Additional operational flags.
 471 See the section entitled
 472 .Sx "OPERATIONAL FLAGS"
 473 below for a discussion
 474 about its use.
 475 .It Fl i Ar index
 476 Specifies the index of the partition on which the attribute will be set.
 477 .El
 478 .\" ==== SHOW ====
 479 .It Cm show
 480 Show current partition information for the specified geoms, or all
 481 geoms if none are specified.
 482 The default output includes the logical starting block of each
 483 partition, the partition size in blocks, the partition index number,
 484 the partition type, and a human readable partition size.
 485 Block sizes and locations are based on the device's Sectorsize
 486 as shown by
 487 .Cm gpart list .
 488 .Pp
 489 The
 490 .Cm show
 491 command accepts these options:
 492 .Bl -tag -width 10n
 493 .It Fl l
 494 For partitioning schemes that support partition labels, print them
 495 instead of partition type.
 496 .It Fl p
 497 Show provider names instead of partition indexes.
 498 .It Fl r
 499 Show raw partition type instead of symbolic name.
 500 .El
 501 .\" ==== UNDO ====
 502 .It Cm undo
 503 Revert any pending changes for geom
 504 .Ar geom .
 505 This action is the opposite of the
 506 .Cm commit
 507 action and can be used to undo any changes that have not been committed.
 508 .\" ==== UNSET ====
 509 .It Cm unset
 510 Clear the named attribute on the partition entry.
 511 See the section entitled
 512 .Sx ATTRIBUTES
 513 below for a list of available attributes.
 514 .Pp
 515 The
 516 .Cm unset
 517 command accepts these options:
 518 .Bl -tag -width 10n
 519 .It Fl a Ar attrib
 520 Specifies the attribute to clear.
 521 .It Fl f Ar flags
 522 Additional operational flags.
 523 See the section entitled
 524 .Sx "OPERATIONAL FLAGS"
 525 below for a discussion
 526 about its use.
 527 .It Fl i Ar index
 528 Specifies the index of the partition on which the attribute will be cleared.
 529 .El
 530 .It Cm list
 531 See
 532 .Xr geom 8 .
 533 .It Cm status
 534 See
 535 .Xr geom 8 .
 536 .It Cm load
 537 See
 538 .Xr geom 8 .
 539 .It Cm unload
 540 See
 541 .Xr geom 8 .
 542 .El
 543 .Sh PARTITIONING SCHEMES
 544 Several partitioning schemes are supported by the
 545 .Nm
 546 utility:
 547 .Bl -tag -width ".Cm VTOC8"
 548 .It Cm APM
 549 Apple Partition Map, used by PowerPC(R) Macintosh(R) computers.
 550 Requires the
 551 .Cd GEOM_PART_APM
 552 kernel option.
 553 .It Cm BSD
 554 Traditional BSD disklabel, usually used to subdivide MBR partitions.
 555 .Po
 556 This scheme can also be used as the sole partitioning method, without
 557 an MBR.
 558 Partition editing tools from other operating systems often do not
 559 understand the bare disklabel partition layout, so this is sometimes
 560 called
 561 .Dq dangerously dedicated .
 562 .Pc
 563 Requires the
 564 .Cm GEOM_PART_BSD
 565 kernel option.
 566 .It Cm BSD64
 567 64-bit implementation of BSD disklabel used in DragonFlyBSD to subdivide MBR
 568 or GPT partitions.
 569 Requires the
 570 .Cm GEOM_PART_BSD64
 571 kernel option.
 572 .It Cm LDM
 573 The Logical Disk Manager is an implementation of volume manager for
 574 Microsoft Windows NT.
 575 Requires the
 576 .Cd GEOM_PART_LDM
 577 kernel option.
 578 .It Cm GPT
 579 GUID Partition Table is used on Intel-based Macintosh computers and
 580 gradually replacing MBR on most PCs and other systems.
 581 Requires the
 582 .Cm GEOM_PART_GPT
 583 kernel option.
 584 .It Cm MBR
 585 Master Boot Record is used on PCs and removable media.
 586 Requires the
 587 .Cm GEOM_PART_MBR
 588 kernel option.
 589 The
 590 .Cm GEOM_PART_EBR
 591 option adds support for the Extended Boot Record (EBR),
 592 which is used to define a logical partition.
 593 The
 594 .Cm GEOM_PART_EBR_COMPAT
 595 option enables backward compatibility for partition names
 596 in the EBR scheme.
 597 It also prevents any type of actions on such partitions.
 598 .It Cm VTOC8
 599 Sun's SMI Volume Table Of Contents, used by
 600 .Tn SPARC64
 601 and
 602 .Tn UltraSPARC
 603 computers.
 604 Requires the
 605 .Cm GEOM_PART_VTOC8
 606 kernel option.
 607 .El
 608 .Pp
 609 See
 610 .Xr glabel 8
 611 for additional information on labelization of devices and partitions.
 612 .Sh PARTITION TYPES
 613 Partition types are identified on disk by particular strings or magic
 614 values.
 615 The
 616 .Nm
 617 utility uses symbolic names for common partition types so the user
 618 does not need to know these values or other details of the partitioning
 619 scheme in question.
 620 The
 621 .Nm
 622 utility also allows the user to specify scheme-specific partition types
 623 for partition types that do not have symbolic names.
 624 Symbolic names currently understood and used by
 625 .Fx
 626 are:
 627 .Bl -tag -width ".Cm dragonfly-disklabel64"
 628 .It Cm apple-boot
 629 The system partition dedicated to storing boot loaders on some Apple
 630 systems.
 631 The scheme-specific types are
 632 .Qq Li "!171"
 633 for MBR,
 634 .Qq Li "!Apple_Bootstrap"
 635 for APM, and
 636 .Qq Li "!426f6f74-0000-11aa-aa11-00306543ecac"
 637 for GPT.
 638 .It Cm bios-boot
 639 The system partition dedicated to second stage of the boot loader program.
 640 Usually it is used by the GRUB 2 loader for GPT partitioning schemes.
 641 The scheme-specific type is
 642 .Qq Li "!21686148-6449-6E6F-744E-656564454649" .
 643 .It Cm efi
 644 The system partition for computers that use the Extensible Firmware
 645 Interface (EFI).
 646 The scheme-specific types are
 647 .Qq Li "!239"
 648 for MBR, and
 649 .Qq Li "!c12a7328-f81f-11d2-ba4b-00a0c93ec93b"
 650 for GPT.
 651 .It Cm freebsd
 652 A
 653 .Fx
 654 partition subdivided into filesystems with a
 655 .Bx
 656 disklabel.
 657 This is a legacy partition type and should not be used for the APM
 658 or GPT schemes.
 659 The scheme-specific types are
 660 .Qq Li "!165"
 661 for MBR,
 662 .Qq Li "!FreeBSD"
 663 for APM, and
 664 .Qq Li "!516e7cb4-6ecf-11d6-8ff8-00022d09712b"
 665 for GPT.
 666 .It Cm freebsd-boot
 667 A
 668 .Fx
 669 partition dedicated to bootstrap code.
 670 The scheme-specific type is
 671 .Qq Li "!83bd6b9d-7f41-11dc-be0b-001560b84f0f"
 672 for GPT.
 673 .It Cm freebsd-swap
 674 A
 675 .Fx
 676 partition dedicated to swap space.
 677 The scheme-specific types are
 678 .Qq Li "!FreeBSD-swap"
 679 for APM,
 680 .Qq Li "!516e7cb5-6ecf-11d6-8ff8-00022d09712b"
 681 for GPT, and tag 0x0901 for VTOC8.
 682 .It Cm freebsd-ufs
 683 A
 684 .Fx
 685 partition that contains a UFS or UFS2 filesystem.
 686 The scheme-specific types are
 687 .Qq Li "!FreeBSD-UFS"
 688 for APM,
 689 .Qq Li "!516e7cb6-6ecf-11d6-8ff8-00022d09712b"
 690 for GPT, and tag 0x0902 for VTOC8.
 691 .It Cm freebsd-vinum
 692 A
 693 .Fx
 694 partition that contains a Vinum volume.
 695 The scheme-specific types are
 696 .Qq Li "!FreeBSD-Vinum"
 697 for APM,
 698 .Qq Li "!516e7cb8-6ecf-11d6-8ff8-00022d09712b"
 699 for GPT, and tag 0x0903 for VTOC8.
 700 .It Cm freebsd-zfs
 701 A
 702 .Fx
 703 partition that contains a ZFS volume.
 704 The scheme-specific types are
 705 .Qq Li "!FreeBSD-ZFS"
 706 for APM,
 707 .Qq Li "!516e7cba-6ecf-11d6-8ff8-00022d09712b"
 708 for GPT, and 0x0904 for VTOC8.
 709 .El
 710 .Pp
 711 Other symbolic names that can be used with the
 712 .Nm
 713 utility are:
 714 .Bl -tag -width ".Cm dragonfly-disklabel64"
 715 .It Cm apple-apfs
 716 An Apple macOS partition used for the Apple file system, APFS.
 717 .It Cm apple-core-storage
 718 An Apple Mac OS X partition used by logical volume manager known as
 719 Core Storage.
 720 The scheme-specific type is
 721 .Qq Li "!53746f72-6167-11aa-aa11-00306543ecac"
 722 for GPT.
 723 .It Cm apple-hfs
 724 An Apple Mac OS X partition that contains a HFS or HFS+ filesystem.
 725 The scheme-specific types are
 726 .Qq Li "!175"
 727 for MBR,
 728 .Qq Li "!Apple_HFS"
 729 for APM and
 730 .Qq Li "!48465300-0000-11aa-aa11-00306543ecac"
 731 for GPT.
 732 .It Cm apple-label
 733 An Apple Mac OS X partition dedicated to partition metadata that descibes
 734 disk device.
 735 The scheme-specific type is
 736 .Qq Li "!4c616265-6c00-11aa-aa11-00306543ecac"
 737 for GPT.
 738 .It Cm apple-raid
 739 An Apple Mac OS X partition used in a software RAID configuration.
 740 The scheme-specific type is
 741 .Qq Li "!52414944-0000-11aa-aa11-00306543ecac"
 742 for GPT.
 743 .It Cm apple-raid-offline
 744 An Apple Mac OS X partition used in a software RAID configuration.
 745 The scheme-specific type is
 746 .Qq Li "!52414944-5f4f-11aa-aa11-00306543ecac"
 747 for GPT.
 748 .It Cm apple-tv-recovery
 749 An Apple Mac OS X partition used by Apple TV.
 750 The scheme-specific type is
 751 .Qq Li "!5265636f-7665-11aa-aa11-00306543ecac"
 752 for GPT.
 753 .It Cm apple-ufs
 754 An Apple Mac OS X partition that contains a UFS filesystem.
 755 The scheme-specific types are
 756 .Qq Li "!168"
 757 for MBR,
 758 .Qq Li "!Apple_UNIX_SVR2"
 759 for APM and
 760 .Qq Li "!55465300-0000-11aa-aa11-00306543ecac"
 761 for GPT.
 762 .It Cm apple-zfs
 763 An Apple Mac OS X partition that contains a ZFS volume.
 764 The scheme-specific type is
 765 .Qq Li "!6a898cc3-1dd2-11b2-99a6-080020736631"
 766 for GPT. The same GUID is being used also for
 767 .Sy illumos/Solaris /usr partition .
 768 See
 769 .Sx CAVEATS
 770 section below.
 771 .It Cm dragonfly-label32
 772 A DragonFlyBSD partition subdivided into filesystems with a
 773 .Bx
 774 disklabel.
 775 The scheme-specific type is
 776 .Qq Li "!9d087404-1ca5-11dc-8817-01301bb8a9f5"
 777 for GPT.
 778 .It Cm dragonfly-label64
 779 A DragonFlyBSD partition subdivided into filesystems with a
 780 disklabel64.
 781 The scheme-specific type is
 782 .Qq Li "!3d48ce54-1d16-11dc-8696-01301bb8a9f5"
 783 for GPT.
 784 .It Cm dragonfly-legacy
 785 A legacy partition type used in DragonFlyBSD.
 786 The scheme-specific type is
 787 .Qq Li "!bd215ab2-1d16-11dc-8696-01301bb8a9f5"
 788 for GPT.
 789 .It Cm dragonfly-ccd
 790 A DragonFlyBSD partition used with Concatenated Disk driver.
 791 The scheme-specific type is
 792 .Qq Li "!dbd5211b-1ca5-11dc-8817-01301bb8a9f5"
 793 for GPT.
 794 .It Cm dragonfly-hammer
 795 A DragonFlyBSD partition that contains a Hammer filesystem.
 796 The scheme-specific type is
 797 .Qq Li "!61dc63ac-6e38-11dc-8513-01301bb8a9f5"
 798 for GPT.
 799 .It Cm dragonfly-hammer2
 800 A DragonFlyBSD partition that contains a Hammer2 filesystem.
 801 The scheme-specific type is
 802 .Qq Li "!5cbb9ad1-862d-11dc-a94d-01301bb8a9f5"
 803 for GPT.
 804 .It Cm dragonfly-swap
 805 A DragonFlyBSD partition dedicated to swap space.
 806 The scheme-specific type is
 807 .Qq Li "!9d58fdbd-1ca5-11dc-8817-01301bb8a9f5"
 808 for GPT.
 809 .It Cm dragonfly-ufs
 810 A DragonFlyBSD partition that contains an UFS1 filesystem.
 811 The scheme-specific type is
 812 .Qq Li "!9d94ce7c-1ca5-11dc-8817-01301bb8a9f5"
 813 for GPT.
 814 .It Cm dragonfly-vinum
 815 A DragonFlyBSD partition used with Logical Volume Manager.
 816 The scheme-specific type is
 817 .Qq Li "!9dd4478f-1ca5-11dc-8817-01301bb8a9f5"
 818 for GPT.
 819 .It Cm ebr
 820 A partition subdivided into filesystems with a EBR.
 821 The scheme-specific type is
 822 .Qq Li "!5"
 823 for MBR.
 824 .It Cm fat16
 825 A partition that contains a FAT16 filesystem.
 826 The scheme-specific type is
 827 .Qq Li "!6"
 828 for MBR.
 829 .It Cm fat32
 830 A partition that contains a FAT32 filesystem.
 831 The scheme-specific type is
 832 .Qq Li "!11"
 833 for MBR.
 834 .It Cm fat32lba
 835 A partition that contains a FAT32 (LBA) filesystem.
 836 The scheme-specific type is
 837 .Qq Li "!12"
 838 for MBR.
 839 .It Cm linux-data
 840 A Linux partition that contains some filesystem with data.
 841 The scheme-specific types are
 842 .Qq Li "!131"
 843 for MBR and
 844 .Qq Li "!0fc63daf-8483-4772-8e79-3d69d8477de4"
 845 for GPT.
 846 .It Cm linux-lvm
 847 A Linux partition dedicated to Logical Volume Manager.
 848 The scheme-specific types are
 849 .Qq Li "!142"
 850 for MBR and
 851 .Qq Li "!e6d6d379-f507-44c2-a23c-238f2a3df928"
 852 for GPT.
 853 .It Cm linux-raid
 854 A Linux partition used in a software RAID configuration.
 855 The scheme-specific types are
 856 .Qq Li "!253"
 857 for MBR and
 858 .Qq Li "!a19d880f-05fc-4d3b-a006-743f0f84911e"
 859 for GPT.
 860 .It Cm linux-swap
 861 A Linux partition dedicated to swap space.
 862 The scheme-specific types are
 863 .Qq Li "!130"
 864 for MBR and
 865 .Qq Li "!0657fd6d-a4ab-43c4-84e5-0933c84b4f4f"
 866 for GPT.
 867 .It Cm mbr
 868 A partition that is sub-partitioned by a Master Boot Record (MBR).
 869 This type is known as
 870 .Qq Li "!024dee41-33e7-11d3-9d69-0008c781f39f"
 871 by GPT.
 872 .It Cm ms-basic-data
 873 A basic data partition (BDP) for Microsoft operating systems.
 874 In the GPT this type is the equivalent to partition types
 875 .Cm fat16 , fat32
 876 and
 877 .Cm ntfs
 878 in MBR.
 879 This type is used for GPT exFAT partitions.
 880 The scheme-specific type is
 881 .Qq Li "!ebd0a0a2-b9e5-4433-87c0-68b6b72699c7"
 882 for GPT.
 883 .It Cm ms-ldm-data
 884 A partition that contains Logical Disk Manager (LDM) volumes.
 885 The scheme-specific types are
 886 .Qq Li "!66"
 887 for MBR,
 888 .Qq Li "!af9b60a0-1431-4f62-bc68-3311714a69ad"
 889 for GPT.
 890 .It Cm ms-ldm-metadata
 891 A partition that contains Logical Disk Manager (LDM) database.
 892 The scheme-specific type is
 893 .Qq Li "!5808c8aa-7e8f-42e0-85d2-e1e90434cfb3"
 894 for GPT.
 895 .It Cm netbsd-ccd
 896 A NetBSD partition used with Concatenated Disk driver.
 897 The scheme-specific type is
 898 .Qq Li "!2db519c4-b10f-11dc-b99b-0019d1879648"
 899 for GPT.
 900 .It Cm netbsd-cgd
 901 An encrypted NetBSD partition.
 902 The scheme-specific type is
 903 .Qq Li "!2db519ec-b10f-11dc-b99b-0019d1879648"
 904 for GPT.
 905 .It Cm netbsd-ffs
 906 A NetBSD partition that contains an UFS filesystem.
 907 The scheme-specific type is
 908 .Qq Li "!49f48d5a-b10e-11dc-b99b-0019d1879648"
 909 for GPT.
 910 .It Cm netbsd-lfs
 911 A NetBSD partition that contains an LFS filesystem.
 912 The scheme-specific type is
 913 .Qq Li "!49f48d82-b10e-11dc-b99b-0019d1879648"
 914 for GPT.
 915 .It Cm netbsd-raid
 916 A NetBSD partition used in a software RAID configuration.
 917 The scheme-specific type is
 918 .Qq Li "!49f48daa-b10e-11dc-b99b-0019d1879648"
 919 for GPT.
 920 .It Cm netbsd-swap
 921 A NetBSD partition dedicated to swap space.
 922 The scheme-specific type is
 923 .Qq Li "!49f48d32-b10e-11dc-b99b-0019d1879648"
 924 for GPT.
 925 .It Cm ntfs
 926 A partition that contains a NTFS or exFAT filesystem.
 927 The scheme-specific type is
 928 .Qq Li "!7"
 929 for MBR.
 930 .It Cm prep-boot
 931 The system partition dedicated to storing boot loaders on some PowerPC systems,
 932 notably those made by IBM.
 933 The scheme-specific types are
 934 .Qq Li "!65"
 935 for MBR and
 936 .Qq Li "!9e1a2d38-c612-4316-aa26-8b49521e5a8b"
 937 for GPT.
 938 .It Cm solaris-boot
 939 A illumos/Solaris partition dedicated to boot loader.
 940 The scheme-specific type is
 941 .Qq Li "!6a82cb45-1dd2-11b2-99a6-080020736631"
 942 for GPT.
 943 .It Cm solaris-root
 944 A illumos/Solaris partition dedicated to root filesystem.
 945 The scheme-specific type is
 946 .Qq Li "!6a85cf4d-1dd2-11b2-99a6-080020736631"
 947 for GPT.
 948 .It Cm solaris-swap
 949 A illumos/Solaris partition dedicated to swap.
 950 The scheme-specific type is
 951 .Qq Li "!6a87c46f-1dd2-11b2-99a6-080020736631"
 952 for GPT.
 953 .It Cm solaris-backup
 954 A illumos/Solaris partition dedicated to backup.
 955 The scheme-specific type is
 956 .Qq Li "!6a8b642b-1dd2-11b2-99a6-080020736631"
 957 for GPT.
 958 .It Cm solaris-var
 959 A illumos/Solaris partition dedicated to /var filesystem.
 960 The scheme-specific type is
 961 .Qq Li "!6a8ef2e9-1dd2-11b2-99a6-080020736631"
 962 for GPT.
 963 .It Cm solaris-home
 964 A illumos/Solaris partition dedicated to /home filesystem.
 965 The scheme-specific type is
 966 .Qq Li "!6a90ba39-1dd2-11b2-99a6-080020736631"
 967 for GPT.
 968 .It Cm solaris-altsec
 969 A illumos/Solaris partition dedicated to alternate sector.
 970 The scheme-specific type is
 971 .Qq Li "!6a9283a5-1dd2-11b2-99a6-080020736631"
 972 for GPT.
 973 .It Cm solaris-reserved
 974 A illumos/Solaris partition dedicated to reserved space.
 975 The scheme-specific type is
 976 .Qq Li "!6a945a3b-1dd2-11b2-99a6-080020736631"
 977 for GPT.
 978 .It Cm vmware-vmfs
 979 A partition that contains a VMware File System (VMFS).
 980 The scheme-specific types are
 981 .Qq Li "!251"
 982 for MBR and
 983 .Qq Li "!aa31e02a-400f-11db-9590-000c2911d1b8"
 984 for GPT.
 985 .It Cm vmware-vmkdiag
 986 A partition that contains a VMware diagostic filesystem.
 987 The scheme-specific types are
 988 .Qq Li "!252"
 989 for MBR and
 990 .Qq Li "!9d275380-40ad-11db-bf97-000c2911d1b8"
 991 for GPT.
 992 .It Cm vmware-reserved
 993 A VMware reserved partition.
 994 The scheme-specific type is
 995 .Qq Li "!9198effc-31c0-11db-8f-78-000c2911d1b8"
 996 for GPT.
 997 .It Cm vmware-vsanhdr
 998 A partition claimed by VMware VSAN.
 999 The scheme-specific type is
1000 .Qq Li "!381cfccc-7288-11e0-92ee-000c2911d0b2"
1001 for GPT.
1002 .El
1003 .Sh ATTRIBUTES
1004 The scheme-specific attributes for EBR:
1005 .Bl -tag -width ".Cm active"
1006 .It Cm active
1007 .El
1008 .Pp
1009 The scheme-specific attributes for GPT:
1010 .Bl -tag -width ".Cm bootfailed"
1011 .It Cm bootme
1012 When set, the
1013 .Nm gptboot
1014 stage 1 boot loader will try to boot the system from this partition.
1015 Multiple partitions can be marked with the
1016 .Cm bootme
1017 attribute.
1018 See
1019 .Xr gptboot 8
1020 for more details.
1021 .It Cm bootonce
1022 Setting this attribute automatically sets the
1023 .Cm bootme
1024 attribute.
1025 When set, the
1026 .Nm gptboot
1027 stage 1 boot loader will try to boot the system from this partition only once.
1028 Multiple partitions can be marked with the
1029 .Cm bootonce
1030 and
1031 .Cm bootme
1032 attribute pairs.
1033 See
1034 .Xr gptboot 8
1035 for more details.
1036 .It Cm bootfailed
1037 This attribute should not be manually managed.
1038 It is managed by the
1039 .Nm gptboot
1040 stage 1 boot loader and the
1041 .Pa /etc/rc.d/gptboot
1042 start-up script.
1043 See
1044 .Xr gptboot 8
1045 for more details.
1046 .It Cm lenovofix
1047 Setting this attribute overwrites the Protective MBR with a new one where
1048 the 0xee partition is the second, rather than the first record.
1049 This resolves a BIOS compatibility issue with some Lenovo models including the
1050 X220, T420, and T520, allowing them to boot from GPT partitioned disks
1051 without using EFI.
1052 .El
1053 .Pp
1054 The scheme-specific attributes for MBR:
1055 .Bl -tag -width ".Cm active"
1056 .It Cm active
1057 .El
1058 .Sh BOOTSTRAPPING
1059 .Fx
1060 supports several partitioning schemes and each scheme uses different
1061 bootstrap code.
1062 The bootstrap code is located in a specific disk area for each partitioning
1063 scheme, and may vary in size for different schemes.
1064 .Pp
1065 Bootstrap code can be separated into two types.
1066 The first type is embedded in the partitioning scheme's metadata, while the
1067 second type is located on a specific partition.
1068 Embedding bootstrap code should only be done with the
1069 .Cm gpart bootcode
1070 command with the
1071 .Fl b Ar bootcode
1072 option.
1073 The GEOM PART class knows how to safely embed bootstrap code into
1074 specific partitioning scheme metadata without causing any damage.
1075 .Pp
1076 The Master Boot Record (MBR) uses a 512-byte bootstrap code image, embedded
1077 into the partition table's metadata area.
1078 There are two variants of this bootstrap code:
1079 .Pa /boot/mbr
1080 and
1081 .Pa /boot/boot0 .
1082 .Pa /boot/mbr
1083 searches for a partition with the
1084 .Cm active
1085 attribute (see the
1086 .Sx ATTRIBUTES
1087 section) in the partition table.
1088 Then it runs next bootstrap stage.
1089 The
1090 .Pa /boot/boot0
1091 image contains a boot manager with some additional interactive functions
1092 for multi-booting from a user-selected partition.
1093 .Pp
1094 A BSD disklabel is usually created inside an MBR partition (slice)
1095 with type
1096 .Cm freebsd
1097 (see the
1098 .Sx "PARTITION TYPES"
1099 section).
1100 It uses 8 KB size bootstrap code image
1101 .Pa /boot/boot ,
1102 embedded into the partition table's metadata area.
1103 .Pp
1104 Both types of bootstrap code are used to boot from the GUID Partition Table.
1105 First, a protective MBR is embedded into the first disk sector from the
1106 .Pa /boot/pmbr
1107 image.
1108 It searches through the GPT for a
1109 .Cm freebsd-boot
1110 partition (see the
1111 .Sx "PARTITION TYPES"
1112 section) and runs the next bootstrap stage from it.
1113 The
1114 .Cm freebsd-boot
1115 partition should be smaller than 545 KB.
1116 It can be located either before or after other
1117 .Fx
1118 partitions on the disk.
1119 There are two variants of bootstrap code to write to this partition:
1120 .Pa /boot/gptboot
1121 and
1122 .Pa /boot/gptzfsboot .
1123 .Pp
1124 .Pa /boot/gptboot
1125 is used to boot from UFS partitions.
1126 .Cm gptboot
1127 searches through
1128 .Cm freebsd-ufs
1129 partitions in the GPT and selects one to boot based on the
1130 .Cm bootonce
1131 and
1132 .Cm bootme
1133 attributes.
1134 If neither attribute is found,
1135 .Pa /boot/gptboot
1136 boots from the first
1137 .Cm freebsd-ufs
1138 partition.
1139 .Pa /boot/loader
1140 .Pq the third bootstrap stage
1141 is loaded from the first partition that matches these conditions.
1142 See
1143 .Xr gptboot 8
1144 for more information.
1145 .Pp
1146 .Pa /boot/gptzfsboot
1147 is used to boot from ZFS.
1148 It searches through the GPT for
1149 .Cm freebsd-zfs
1150 partitions, trying to detect ZFS pools.
1151 After all pools are detected,
1152 .Pa /boot/loader
1153 is started from the first one found set as bootable.
1154 .Pp
1155 The VTOC8 scheme does not support embedding bootstrap code.
1156 Instead, the 8 KBytes bootstrap code image
1157 .Pa /boot/boot1
1158 should be written with the
1159 .Cm gpart bootcode
1160 command with the
1161 .Fl p Ar bootcode
1162 option to all sufficiently large VTOC8 partitions.
1163 To do this the
1164 .Fl i Ar index
1165 option could be omitted.
1166 .Pp
1167 The APM scheme also does not support embedding bootstrap code.
1168 Instead, the 800 KBytes bootstrap code image
1169 .Pa /boot/boot1.hfs
1170 should be written with the
1171 .Cm gpart bootcode
1172 command to a partition of type
1173 .Cm apple-boot ,
1174 which should also be 800 KB in size.
1175 .Sh OPERATIONAL FLAGS
1176 Actions other than the
1177 .Cm commit
1178 and
1179 .Cm undo
1180 actions take an optional
1181 .Fl f Ar flags
1182 option.
1183 This option is used to specify action-specific operational flags.
1184 By default, the
1185 .Nm
1186 utility defines the
1187 .Ql C
1188 flag so that the action is immediately
1189 committed.
1190 The user can specify
1191 .Dq Fl f Cm x
1192 to have the action result in a pending change that can later, with
1193 other pending changes, be committed as a single compound change with
1194 the
1195 .Cm commit
1196 action or reverted with the
1197 .Cm undo
1198 action.
1199 .Sh RECOVERING
1200 The GEOM PART class supports recovering of partition tables only for GPT.
1201 The GPT primary metadata is stored at the beginning of the device.
1202 For redundancy, a secondary
1203 .Pq backup
1204 copy of the metadata is stored at the end of the device.
1205 As a result of having two copies, some corruption of metadata is not
1206 fatal to the working of GPT.
1207 When the kernel detects corrupt metadata, it marks this table as corrupt
1208 and reports the problem.
1209 .Cm destroy
1210 and
1211 .Cm recover
1212 are the only operations allowed on corrupt tables.
1213 .Pp
1214 If one GPT header appears to be corrupt but the other copy remains intact,
1215 the kernel will log the following:
1216 .Bd -literal -offset indent
1217 GEOM: provider: the primary GPT table is corrupt or invalid.
1218 GEOM: provider: using the secondary instead -- recovery strongly advised.
1219 .Ed
1220 .Pp
1221 or
1222 .Bd -literal -offset indent
1223 GEOM: provider: the secondary GPT table is corrupt or invalid.
1224 GEOM: provider: using the primary only -- recovery suggested.
1225 .Ed
1226 .Pp
1227 Also
1228 .Nm
1229 commands such as
1230 .Cm show , status
1231 and
1232 .Cm list
1233 will report about corrupt tables.
1234 .Pp
1235 If the size of the device has changed (e.g.,\& volume expansion) the
1236 secondary GPT header will no longer be located in the last sector.
1237 This is not a metadata corruption, but it is dangerous because any
1238 corruption of the primary GPT will lead to loss of the partition table.
1239 This problem is reported by the kernel with the message:
1240 .Bd -literal -offset indent
1241 GEOM: provider: the secondary GPT header is not in the last LBA.
1242 .Ed
1243 .Pp
1244 This situation can be recovered with the
1245 .Cm recover
1246 command.
1247 This command reconstructs the corrupt metadata using known valid
1248 metadata and relocates the secondary GPT to the end of the device.
1249 .Pp
1250 .Em NOTE :
1251 The GEOM PART class can detect the same partition table visible through
1252 different GEOM providers, and some of them will be marked as corrupt.
1253 Be careful when choosing a provider for recovery.
1254 If you choose incorrectly you can destroy the metadata of another GEOM class,
1255 e.g.,\& GEOM MIRROR or GEOM LABEL.
1256 .Sh SYSCTL VARIABLES
1257 The following
1258 .Xr sysctl 8
1259 variables can be used to control the behavior of the
1260 .Nm PART
1261 GEOM class.
1262 The default value is shown next to each variable.
1263 .Bl -tag -width indent
1264 .It Va kern.geom.part.allow_nesting : No 0
1265 By default, some schemes (currently BSD, BSD64 and VTOC8) do not permit
1266 further nested partitioning.
1267 This variable overrides this restriction and allows arbitrary nesting (except
1268 within partitions created at offset 0).
1269 Some schemes have their own separate checks, for which see below.
1270 .It Va kern.geom.part.auto_resize : No 1
1271 This variable controls automatic resize behavior of the
1272 .Nm PART
1273 GEOM class.
1274 When this variable is enable and new size of provider is detected, the schema
1275 metadata is resized but all changes are not saved to disk, until
1276 .Cm gpart commit
1277 is run to confirm changes.
1278 This behavior is also reported with diagnostic message:
1279 .Sy "GEOM_PART: (provider) was automatically resized."
1280 .Sy "Use `gpart commit (provider)` to save changes or `gpart undo (provider)`"
1281 .Sy "to revert them."
1282 .It Va kern.geom.part.check_integrity : No 1
1283 This variable controls the behaviour of metadata integrity checks.
1284 When integrity checks are enabled, the
1285 .Nm PART
1286 GEOM class verifies all generic partition parameters obtained from the
1287 disk metadata.
1288 If some inconsistency is detected, the partition table will be
1289 rejected with a diagnostic message:
1290 .Sy "GEOM_PART: Integrity check failed (provider, scheme)" .
1291 .It Va kern.geom.part.gpt.allow_nesting : No 0
1292 By default the GPT scheme is allowed only at the outermost nesting level.
1293 This variable allows this restriction to be removed.
1294 .It Va kern.geom.part.ldm.debug : No 0
1295 Debug level of the Logical Disk Manager (LDM) module.
1296 This can be set to a number between 0 and 2 inclusive.
1297 If set to 0 minimal debug information is printed,
1298 and if set to 2 the maximum amount of debug information is printed.
1299 .It Va kern.geom.part.ldm.show_mirrors : No 0
1300 This variable controls how the Logical Disk Manager (LDM) module handles
1301 mirrored volumes.
1302 By default mirrored volumes are shown as partitions with type
1303 .Cm ms-ldm-data
1304 (see the
1305 .Sx "PARTITION TYPES"
1306 section).
1307 If this variable set to 1 each component of the mirrored volume will be
1308 present as independent partition.
1309 .Em NOTE :
1310 This may break a mirrored volume and lead to data damage.
1311 .It Va kern.geom.part.mbr.enforce_chs : No 0
1312 Specify how the Master Boot Record (MBR) module does alignment.
1313 If this variable is set to a non-zero value, the module will automatically
1314 recalculate the user-specified offset and size for alignment with the CHS
1315 geometry.
1316 Otherwise the values will be left unchanged.
1317 .It Va kern.geom.part.separator : No ""
1318 Specify an optional separator that will be inserted between the GEOM name
1319 and partition name.
1320 This variable is a
1321 .Xr loader 8
1322 tunable.
1323 Note that setting this variable may break software which assumes a particular
1324 naming scheme.
1325 .El
1326 .Sh EXIT STATUS
1327 Exit status is 0 on success, and 1 if the command fails.
1328 .Sh EXAMPLES
1329 The examples below assume that the disk's logical block size is 512
1330 bytes, regardless of its physical block size.
1331 .Ss GPT
1332 In this example, we will format
1333 .Pa ada0
1334 with the GPT scheme and create boot, swap and root partitions.
1335 First, we need to create the partition table:
1336 .Bd -literal -offset indent
1337 /sbin/gpart create -s GPT ada0
1338 .Ed
1339 .Pp
1340 Next, we install a protective MBR with the first-stage bootstrap code.
1341 The protective MBR lists a single, bootable partition spanning the
1342 entire disk, thus allowing non-GPT-aware BIOSes to boot from the disk
1343 and preventing tools which do not understand the GPT scheme from
1344 considering the disk to be unformatted.
1345 .Bd -literal -offset indent
1346 /sbin/gpart bootcode -b /boot/pmbr ada0
1347 .Ed
1348 .Pp
1349 We then create a dedicated
1350 .Cm freebsd-boot
1351 partition to hold the second-stage boot loader, which will load the
1352 .Fx
1353 kernel and modules from a UFS or ZFS filesystem.
1354 This partition must be larger than the bootstrap code
1355 .Po
1356 either
1357 .Pa /boot/gptboot
1358 for UFS or
1359 .Pa /boot/gptzfsboot
1360 for ZFS
1361 .Pc ,
1362 but smaller than 545 kB since the first-stage loader will load the
1363 entire partition into memory during boot, regardless of how much data
1364 it actually contains.
1365 We create a 472-block (236 kB) boot partition at offset 40, which is
1366 the size of the partition table (34 blocks or 17 kB) rounded up to the
1367 nearest 4 kB boundary.
1368 .Bd -literal -offset indent
1369 /sbin/gpart add -b 40 -s 472 -t freebsd-boot ada0
1370 /sbin/gpart bootcode -p /boot/gptboot -i 1 ada0
1371 .Ed
1372 .Pp
1373 We now create a 4 GB swap partition at the first available offset,
1374 which is 40 + 472 = 512 blocks (256 kB).
1375 .Bd -literal -offset indent
1376 /sbin/gpart add -s 4G -t freebsd-swap ada0
1377 .Ed
1378 .Pp
1379 Aligning the swap partition and all subsequent partitions on a 256 kB
1380 boundary ensures optimal performance on a wide range of media, from
1381 plain old disks with 512-byte blocks, through modern
1382 .Dq advanced format
1383 disks with 4096-byte physical blocks, to RAID volumes with stripe
1384 sizes of up to 256 kB.
1385 .Pp
1386 Finally, we create and format an 8 GB
1387 .Cm freebsd-ufs
1388 partition for the root filesystem, leaving the rest of the slice free
1389 for additional filesystems:
1390 .Bd -literal -offset indent
1391 /sbin/gpart add -s 8G -t freebsd-ufs ada0
1392 /sbin/newfs -Uj /dev/ada0p3
1393 .Ed
1394 .Ss MBR
1395 In this example, we will format
1396 .Pa ada0
1397 with the MBR scheme and create a single partition which we subdivide
1398 using a traditional
1399 .Bx
1400 disklabel.
1401 .Pp
1402 First, we create the partition table and a single 64 GB partition,
1403 then we mark that partition active (bootable) and install the
1404 first-stage boot loader:
1405 .Bd -literal -offset indent
1406 /sbin/gpart create -s MBR ada0
1407 /sbin/gpart add -t freebsd -s 64G ada0
1408 /sbin/gpart set -a active -i 1 ada0
1409 /sbin/gpart bootcode -b /boot/boot0 ada0
1410 .Ed
1411 .Pp
1412 Next, we create a disklabel in that partition
1413 .Po
1414 .Dq slice
1415 in disklabel terminology
1416 .Pc
1417 with room for up to 20 partitions:
1418 .Bd -literal -offset indent
1419 /sbin/gpart create -s BSD -n 20 ada0s1
1420 .Ed
1421 .Pp
1422 We then create an 8 GB root partition and a 4 GB swap partition:
1423 .Bd -literal -offset indent
1424 /sbin/gpart add -t freebsd-ufs -s 8G ada0s1
1425 /sbin/gpart add -t freebsd-swap -s 4G ada0s1
1426 .Ed
1427 .Pp
1428 Finally, we install the appropriate boot loader for the
1429 .Bx
1430 label:
1431 .Bd -literal -offset indent
1432 /sbin/gpart bootcode -b /boot/boot ada0s1
1433 .Ed
1434 .Ss VTOC8
1435 .Pp
1436 Create a VTOC8 scheme on
1437 .Pa da0 :
1438 .Bd -literal -offset indent
1439 /sbin/gpart create -s VTOC8 da0
1440 .Ed
1441 .Pp
1442 Create a 512MB-sized
1443 .Cm freebsd-ufs
1444 partition to contain a UFS filesystem from which the system can boot.
1445 .Bd -literal -offset indent
1446 /sbin/gpart add -s 512M -t freebsd-ufs da0
1447 .Ed
1448 .Pp
1449 Create a 15GB-sized
1450 .Cm freebsd-ufs
1451 partition to contain a UFS filesystem and aligned on 4KB boundaries:
1452 .Bd -literal -offset indent
1453 /sbin/gpart add -s 15G -t freebsd-ufs -a 4k da0
1454 .Ed
1455 .Pp
1456 After creating all required partitions, embed bootstrap code into them:
1457 .Bd -literal -offset indent
1458 /sbin/gpart bootcode -p /boot/boot1 da0
1459 .Ed
1460 .Ss Deleting Partitions and Destroying the Partitioning Scheme
1461 If a
1462 .Em "Device busy"
1463 error is shown when trying to destroy a partition table, remember that
1464 all of the partitions must be deleted first with the
1465 .Cm delete
1466 action.
1467 In this example,
1468 .Pa da0
1469 has three partitions:
1470 .Bd -literal -offset indent
1471 /sbin/gpart delete -i 3 da0
1472 /sbin/gpart delete -i 2 da0
1473 /sbin/gpart delete -i 1 da0
1474 /sbin/gpart destroy da0
1475 .Ed
1476 .Pp
1477 Rather than deleting each partition and then destroying the partitioning
1478 scheme, the
1479 .Fl F
1480 option can be given with
1481 .Cm destroy
1482 to delete all of the partitions before destroying the partitioning scheme.
1483 This is equivalent to the previous example:
1484 .Bd -literal -offset indent
1485 /sbin/gpart destroy -F da0
1486 .Ed
1487 .Ss Backup and Restore
1488 .Pp
1489 Create a backup of the partition table from
1490 .Pa da0 :
1491 .Bd -literal -offset indent
1492 /sbin/gpart backup da0 > da0.backup
1493 .Ed
1494 .Pp
1495 Restore the partition table from the backup to
1496 .Pa da0 :
1497 .Bd -literal -offset indent
1498 /sbin/gpart restore -l da0 < /mnt/da0.backup
1499 .Ed
1500 .Pp
1501 Clone the partition table from
1502 .Pa ada0
1503 to
1504 .Pa ada1
1505 and
1506 .Pa ada2 :
1507 .Bd -literal -offset indent
1508 /sbin/gpart backup ada0 | /sbin/gpart restore -F ada1 ada2
1509 .Ed
1510 .Sh SEE ALSO
1511 .Xr geom 4 ,
1512 .Xr boot0cfg 8 ,
1513 .Xr geom 8 ,
1514 .Xr glabel 8 ,
1515 .Xr gptboot 8
1516 .Sh HISTORY
1517 The
1518 .Nm
1519 utility appeared in
1520 .Fx 7.0 .
1521 .Sh AUTHORS
1522 .An Marcel Moolenaar Aq Mt marcel@FreeBSD.org
1523 .Sh CAVEATS
1524 Partition type
1525 .Em apple-zfs
1526 (6a898cc3-1dd2-11b2-99a6-080020736631) is also being used
1527 on illumos/Solaris platforms for ZFS volumes.