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 January 26, 2022
  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 Do not 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 skips preservation to help with some versions of
 224 .Xr boot0cfg 8
 225 that do not 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.
 767 The same GUID is being used also for
 768 .Sy illumos/Solaris /usr partition .
 769 See
 770 .Sx CAVEATS
 771 section below.
 772 .It Cm dragonfly-label32
 773 A DragonFlyBSD partition subdivided into filesystems with a
 774 .Bx
 775 disklabel.
 776 The scheme-specific type is
 777 .Qq Li "!9d087404-1ca5-11dc-8817-01301bb8a9f5"
 778 for GPT.
 779 .It Cm dragonfly-label64
 780 A DragonFlyBSD partition subdivided into filesystems with a
 781 disklabel64.
 782 The scheme-specific type is
 783 .Qq Li "!3d48ce54-1d16-11dc-8696-01301bb8a9f5"
 784 for GPT.
 785 .It Cm dragonfly-legacy
 786 A legacy partition type used in DragonFlyBSD.
 787 The scheme-specific type is
 788 .Qq Li "!bd215ab2-1d16-11dc-8696-01301bb8a9f5"
 789 for GPT.
 790 .It Cm dragonfly-ccd
 791 A DragonFlyBSD partition used with Concatenated Disk driver.
 792 The scheme-specific type is
 793 .Qq Li "!dbd5211b-1ca5-11dc-8817-01301bb8a9f5"
 794 for GPT.
 795 .It Cm dragonfly-hammer
 796 A DragonFlyBSD partition that contains a Hammer filesystem.
 797 The scheme-specific type is
 798 .Qq Li "!61dc63ac-6e38-11dc-8513-01301bb8a9f5"
 799 for GPT.
 800 .It Cm dragonfly-hammer2
 801 A DragonFlyBSD partition that contains a Hammer2 filesystem.
 802 The scheme-specific type is
 803 .Qq Li "!5cbb9ad1-862d-11dc-a94d-01301bb8a9f5"
 804 for GPT.
 805 .It Cm dragonfly-swap
 806 A DragonFlyBSD partition dedicated to swap space.
 807 The scheme-specific type is
 808 .Qq Li "!9d58fdbd-1ca5-11dc-8817-01301bb8a9f5"
 809 for GPT.
 810 .It Cm dragonfly-ufs
 811 A DragonFlyBSD partition that contains an UFS1 filesystem.
 812 The scheme-specific type is
 813 .Qq Li "!9d94ce7c-1ca5-11dc-8817-01301bb8a9f5"
 814 for GPT.
 815 .It Cm dragonfly-vinum
 816 A DragonFlyBSD partition used with Logical Volume Manager.
 817 The scheme-specific type is
 818 .Qq Li "!9dd4478f-1ca5-11dc-8817-01301bb8a9f5"
 819 for GPT.
 820 .It Cm ebr
 821 A partition subdivided into filesystems with a EBR.
 822 The scheme-specific type is
 823 .Qq Li "!5"
 824 for MBR.
 825 .It Cm fat16
 826 A partition that contains a FAT16 filesystem.
 827 The scheme-specific type is
 828 .Qq Li "!6"
 829 for MBR.
 830 .It Cm fat32
 831 A partition that contains a FAT32 filesystem.
 832 The scheme-specific type is
 833 .Qq Li "!11"
 834 for MBR.
 835 .It Cm fat32lba
 836 A partition that contains a FAT32 (LBA) filesystem.
 837 The scheme-specific type is
 838 .Qq Li "!12"
 839 for MBR.
 840 .It Cm hifive-fsbl
 841 A raw partition containing a HiFive first stage bootloader.
 842 The scheme-specific type is
 843 .Qq Li "!5b193300-fc78-40cd-8002-e86c45580b47"
 844 for GPT.
 845 .It Cm hifive-bbl
 846 A raw partition containing a HiFive second stage bootloader.
 847 The scheme-specific type is
 848 .Qq Li "!2e54b353-1271-4842-806f-e436d6af6985"
 849 for GPT.
 850 .It Cm linux-data
 851 A Linux partition that contains some filesystem with data.
 852 The scheme-specific types are
 853 .Qq Li "!131"
 854 for MBR and
 855 .Qq Li "!0fc63daf-8483-4772-8e79-3d69d8477de4"
 856 for GPT.
 857 .It Cm linux-lvm
 858 A Linux partition dedicated to Logical Volume Manager.
 859 The scheme-specific types are
 860 .Qq Li "!142"
 861 for MBR and
 862 .Qq Li "!e6d6d379-f507-44c2-a23c-238f2a3df928"
 863 for GPT.
 864 .It Cm linux-raid
 865 A Linux partition used in a software RAID configuration.
 866 The scheme-specific types are
 867 .Qq Li "!253"
 868 for MBR and
 869 .Qq Li "!a19d880f-05fc-4d3b-a006-743f0f84911e"
 870 for GPT.
 871 .It Cm linux-swap
 872 A Linux partition dedicated to swap space.
 873 The scheme-specific types are
 874 .Qq Li "!130"
 875 for MBR and
 876 .Qq Li "!0657fd6d-a4ab-43c4-84e5-0933c84b4f4f"
 877 for GPT.
 878 .It Cm mbr
 879 A partition that is sub-partitioned by a Master Boot Record (MBR).
 880 This type is known as
 881 .Qq Li "!024dee41-33e7-11d3-9d69-0008c781f39f"
 882 by GPT.
 883 .It Cm ms-basic-data
 884 A basic data partition (BDP) for Microsoft operating systems.
 885 In the GPT this type is the equivalent to partition types
 886 .Cm fat16 , fat32
 887 and
 888 .Cm ntfs
 889 in MBR.
 890 This type is used for GPT exFAT partitions.
 891 The scheme-specific type is
 892 .Qq Li "!ebd0a0a2-b9e5-4433-87c0-68b6b72699c7"
 893 for GPT.
 894 .It Cm ms-ldm-data
 895 A partition that contains Logical Disk Manager (LDM) volumes.
 896 The scheme-specific types are
 897 .Qq Li "!66"
 898 for MBR,
 899 .Qq Li "!af9b60a0-1431-4f62-bc68-3311714a69ad"
 900 for GPT.
 901 .It Cm ms-ldm-metadata
 902 A partition that contains Logical Disk Manager (LDM) database.
 903 The scheme-specific type is
 904 .Qq Li "!5808c8aa-7e8f-42e0-85d2-e1e90434cfb3"
 905 for GPT.
 906 .It Cm netbsd-ccd
 907 A NetBSD partition used with Concatenated Disk driver.
 908 The scheme-specific type is
 909 .Qq Li "!2db519c4-b10f-11dc-b99b-0019d1879648"
 910 for GPT.
 911 .It Cm netbsd-cgd
 912 An encrypted NetBSD partition.
 913 The scheme-specific type is
 914 .Qq Li "!2db519ec-b10f-11dc-b99b-0019d1879648"
 915 for GPT.
 916 .It Cm netbsd-ffs
 917 A NetBSD partition that contains an UFS filesystem.
 918 The scheme-specific type is
 919 .Qq Li "!49f48d5a-b10e-11dc-b99b-0019d1879648"
 920 for GPT.
 921 .It Cm netbsd-lfs
 922 A NetBSD partition that contains an LFS filesystem.
 923 The scheme-specific type is
 924 .Qq Li "!49f48d82-b10e-11dc-b99b-0019d1879648"
 925 for GPT.
 926 .It Cm netbsd-raid
 927 A NetBSD partition used in a software RAID configuration.
 928 The scheme-specific type is
 929 .Qq Li "!49f48daa-b10e-11dc-b99b-0019d1879648"
 930 for GPT.
 931 .It Cm netbsd-swap
 932 A NetBSD partition dedicated to swap space.
 933 The scheme-specific type is
 934 .Qq Li "!49f48d32-b10e-11dc-b99b-0019d1879648"
 935 for GPT.
 936 .It Cm ntfs
 937 A partition that contains a NTFS or exFAT filesystem.
 938 The scheme-specific type is
 939 .Qq Li "!7"
 940 for MBR.
 941 .It Cm prep-boot
 942 The system partition dedicated to storing boot loaders on some PowerPC systems,
 943 notably those made by IBM.
 944 The scheme-specific types are
 945 .Qq Li "!65"
 946 for MBR and
 947 .Qq Li "!9e1a2d38-c612-4316-aa26-8b49521e5a8b"
 948 for GPT.
 949 .It Cm solaris-boot
 950 A illumos/Solaris partition dedicated to boot loader.
 951 The scheme-specific type is
 952 .Qq Li "!6a82cb45-1dd2-11b2-99a6-080020736631"
 953 for GPT.
 954 .It Cm solaris-root
 955 A illumos/Solaris partition dedicated to root filesystem.
 956 The scheme-specific type is
 957 .Qq Li "!6a85cf4d-1dd2-11b2-99a6-080020736631"
 958 for GPT.
 959 .It Cm solaris-swap
 960 A illumos/Solaris partition dedicated to swap.
 961 The scheme-specific type is
 962 .Qq Li "!6a87c46f-1dd2-11b2-99a6-080020736631"
 963 for GPT.
 964 .It Cm solaris-backup
 965 A illumos/Solaris partition dedicated to backup.
 966 The scheme-specific type is
 967 .Qq Li "!6a8b642b-1dd2-11b2-99a6-080020736631"
 968 for GPT.
 969 .It Cm solaris-var
 970 A illumos/Solaris partition dedicated to /var filesystem.
 971 The scheme-specific type is
 972 .Qq Li "!6a8ef2e9-1dd2-11b2-99a6-080020736631"
 973 for GPT.
 974 .It Cm solaris-home
 975 A illumos/Solaris partition dedicated to /home filesystem.
 976 The scheme-specific type is
 977 .Qq Li "!6a90ba39-1dd2-11b2-99a6-080020736631"
 978 for GPT.
 979 .It Cm solaris-altsec
 980 A illumos/Solaris partition dedicated to alternate sector.
 981 The scheme-specific type is
 982 .Qq Li "!6a9283a5-1dd2-11b2-99a6-080020736631"
 983 for GPT.
 984 .It Cm solaris-reserved
 985 A illumos/Solaris partition dedicated to reserved space.
 986 The scheme-specific type is
 987 .Qq Li "!6a945a3b-1dd2-11b2-99a6-080020736631"
 988 for GPT.
 989 .It Cm vmware-vmfs
 990 A partition that contains a VMware File System (VMFS).
 991 The scheme-specific types are
 992 .Qq Li "!251"
 993 for MBR and
 994 .Qq Li "!aa31e02a-400f-11db-9590-000c2911d1b8"
 995 for GPT.
 996 .It Cm vmware-vmkdiag
 997 A partition that contains a VMware diagostic filesystem.
 998 The scheme-specific types are
 999 .Qq Li "!252"
1000 for MBR and
1001 .Qq Li "!9d275380-40ad-11db-bf97-000c2911d1b8"
1002 for GPT.
1003 .It Cm vmware-reserved
1004 A VMware reserved partition.
1005 The scheme-specific type is
1006 .Qq Li "!9198effc-31c0-11db-8f-78-000c2911d1b8"
1007 for GPT.
1008 .It Cm vmware-vsanhdr
1009 A partition claimed by VMware VSAN.
1010 The scheme-specific type is
1011 .Qq Li "!381cfccc-7288-11e0-92ee-000c2911d0b2"
1012 for GPT.
1013 .El
1014 .Sh ATTRIBUTES
1015 The scheme-specific attributes for EBR:
1016 .Bl -tag -width ".Cm active"
1017 .It Cm active
1018 .El
1019 .Pp
1020 The scheme-specific attributes for GPT:
1021 .Bl -tag -width ".Cm bootfailed"
1022 .It Cm bootme
1023 When set, the
1024 .Nm gptboot
1025 stage 1 boot loader will try to boot the system from this partition.
1026 Multiple partitions can be marked with the
1027 .Cm bootme
1028 attribute.
1029 See
1030 .Xr gptboot 8
1031 for more details.
1032 .It Cm bootonce
1033 Setting this attribute automatically sets the
1034 .Cm bootme
1035 attribute.
1036 When set, the
1037 .Nm gptboot
1038 stage 1 boot loader will try to boot the system from this partition only once.
1039 Multiple partitions can be marked with the
1040 .Cm bootonce
1041 and
1042 .Cm bootme
1043 attribute pairs.
1044 See
1045 .Xr gptboot 8
1046 for more details.
1047 .It Cm bootfailed
1048 This attribute should not be manually managed.
1049 It is managed by the
1050 .Nm gptboot
1051 stage 1 boot loader and the
1052 .Pa /etc/rc.d/gptboot
1053 start-up script.
1054 See
1055 .Xr gptboot 8
1056 for more details.
1057 .It Cm lenovofix
1058 Setting this attribute overwrites the Protective MBR with a new one where
1059 the 0xee partition is the second, rather than the first record.
1060 This resolves a BIOS compatibility issue with some Lenovo models including the
1061 X220, T420, and T520, allowing them to boot from GPT partitioned disks
1062 without using EFI.
1063 .El
1064 .Pp
1065 The scheme-specific attributes for MBR:
1066 .Bl -tag -width ".Cm active"
1067 .It Cm active
1068 .El
1069 .Sh BOOTSTRAPPING
1070 .Fx
1071 supports several partitioning schemes and each scheme uses different
1072 bootstrap code.
1073 The bootstrap code is located in a specific disk area for each partitioning
1074 scheme, and may vary in size for different schemes.
1075 .Pp
1076 Bootstrap code can be separated into two types.
1077 The first type is embedded in the partitioning scheme's metadata, while the
1078 second type is located on a specific partition.
1079 Embedding bootstrap code should only be done with the
1080 .Cm gpart bootcode
1081 command with the
1082 .Fl b Ar bootcode
1083 option.
1084 The GEOM PART class knows how to safely embed bootstrap code into
1085 specific partitioning scheme metadata without causing any damage.
1086 .Pp
1087 The Master Boot Record (MBR) uses a 512-byte bootstrap code image, embedded
1088 into the partition table's metadata area.
1089 There are two variants of this bootstrap code:
1090 .Pa /boot/mbr
1091 and
1092 .Pa /boot/boot0 .
1093 .Pa /boot/mbr
1094 searches for a partition with the
1095 .Cm active
1096 attribute (see the
1097 .Sx ATTRIBUTES
1098 section) in the partition table.
1099 Then it runs next bootstrap stage.
1100 The
1101 .Pa /boot/boot0
1102 image contains a boot manager with some additional interactive functions
1103 for multi-booting from a user-selected partition.
1104 .Pp
1105 A BSD disklabel is usually created inside an MBR partition (slice)
1106 with type
1107 .Cm freebsd
1108 (see the
1109 .Sx "PARTITION TYPES"
1110 section).
1111 It uses 8 KB size bootstrap code image
1112 .Pa /boot/boot ,
1113 embedded into the partition table's metadata area.
1114 .Pp
1115 Both types of bootstrap code are used to boot from the GUID Partition Table.
1116 First, a protective MBR is embedded into the first disk sector from the
1117 .Pa /boot/pmbr
1118 image.
1119 It searches through the GPT for a
1120 .Cm freebsd-boot
1121 partition (see the
1122 .Sx "PARTITION TYPES"
1123 section) and runs the next bootstrap stage from it.
1124 The
1125 .Cm freebsd-boot
1126 partition should be smaller than 545 KB.
1127 It can be located either before or after other
1128 .Fx
1129 partitions on the disk.
1130 There are two variants of bootstrap code to write to this partition:
1131 .Pa /boot/gptboot
1132 and
1133 .Pa /boot/gptzfsboot .
1134 .Pp
1135 .Pa /boot/gptboot
1136 is used to boot from UFS partitions.
1137 .Cm gptboot
1138 searches through
1139 .Cm freebsd-ufs
1140 partitions in the GPT and selects one to boot based on the
1141 .Cm bootonce
1142 and
1143 .Cm bootme
1144 attributes.
1145 If neither attribute is found,
1146 .Pa /boot/gptboot
1147 boots from the first
1148 .Cm freebsd-ufs
1149 partition.
1150 .Pa /boot/loader
1151 .Pq the third bootstrap stage
1152 is loaded from the first partition that matches these conditions.
1153 See
1154 .Xr gptboot 8
1155 for more information.
1156 .Pp
1157 .Pa /boot/gptzfsboot
1158 is used to boot from ZFS.
1159 It searches through the GPT for
1160 .Cm freebsd-zfs
1161 partitions, trying to detect ZFS pools.
1162 After all pools are detected,
1163 .Pa /boot/loader
1164 is started from the first one found set as bootable.
1165 .Pp
1166 The VTOC8 scheme does not support embedding bootstrap code.
1167 Instead, the 8 KBytes bootstrap code image
1168 .Pa /boot/boot1
1169 should be written with the
1170 .Cm gpart bootcode
1171 command with the
1172 .Fl p Ar bootcode
1173 option to all sufficiently large VTOC8 partitions.
1174 To do this the
1175 .Fl i Ar index
1176 option could be omitted.
1177 .Pp
1178 The APM scheme also does not support embedding bootstrap code.
1179 Instead, the 800 KBytes bootstrap code image
1180 .Pa /boot/boot1.hfs
1181 should be written with the
1182 .Cm gpart bootcode
1183 command to a partition of type
1184 .Cm apple-boot ,
1185 which should also be 800 KB in size.
1186 .Sh OPERATIONAL FLAGS
1187 Actions other than the
1188 .Cm commit
1189 and
1190 .Cm undo
1191 actions take an optional
1192 .Fl f Ar flags
1193 option.
1194 This option is used to specify action-specific operational flags.
1195 By default, the
1196 .Nm
1197 utility defines the
1198 .Ql C
1199 flag so that the action is immediately
1200 committed.
1201 The user can specify
1202 .Dq Fl f Cm x
1203 to have the action result in a pending change that can later, with
1204 other pending changes, be committed as a single compound change with
1205 the
1206 .Cm commit
1207 action or reverted with the
1208 .Cm undo
1209 action.
1210 .Sh RECOVERING
1211 The GEOM PART class supports recovering of partition tables only for GPT.
1212 The GPT primary metadata is stored at the beginning of the device.
1213 For redundancy, a secondary
1214 .Pq backup
1215 copy of the metadata is stored at the end of the device.
1216 As a result of having two copies, some corruption of metadata is not
1217 fatal to the working of GPT.
1218 When the kernel detects corrupt metadata, it marks this table as corrupt
1219 and reports the problem.
1220 .Cm destroy
1221 and
1222 .Cm recover
1223 are the only operations allowed on corrupt tables.
1224 .Pp
1225 If one GPT header appears to be corrupt but the other copy remains intact,
1226 the kernel will log the following:
1227 .Bd -literal -offset indent
1228 GEOM: provider: the primary GPT table is corrupt or invalid.
1229 GEOM: provider: using the secondary instead -- recovery strongly advised.
1230 .Ed
1231 .Pp
1232 or
1233 .Bd -literal -offset indent
1234 GEOM: provider: the secondary GPT table is corrupt or invalid.
1235 GEOM: provider: using the primary only -- recovery suggested.
1236 .Ed
1237 .Pp
1238 Also
1239 .Nm
1240 commands such as
1241 .Cm show , status
1242 and
1243 .Cm list
1244 will report about corrupt tables.
1245 .Pp
1246 If the size of the device has changed (e.g.,\& volume expansion) the
1247 secondary GPT header will no longer be located in the last sector.
1248 This is not a metadata corruption, but it is dangerous because any
1249 corruption of the primary GPT will lead to loss of the partition table.
1250 This problem is reported by the kernel with the message:
1251 .Bd -literal -offset indent
1252 GEOM: provider: the secondary GPT header is not in the last LBA.
1253 .Ed
1254 .Pp
1255 This situation can be recovered with the
1256 .Cm recover
1257 command.
1258 This command reconstructs the corrupt metadata using known valid
1259 metadata and relocates the secondary GPT to the end of the device.
1260 .Pp
1261 .Em NOTE :
1262 The GEOM PART class can detect the same partition table visible through
1263 different GEOM providers, and some of them will be marked as corrupt.
1264 Be careful when choosing a provider for recovery.
1265 If you choose incorrectly you can destroy the metadata of another GEOM class,
1266 e.g.,\& GEOM MIRROR or GEOM LABEL.
1267 .Sh SYSCTL VARIABLES
1268 The following
1269 .Xr sysctl 8
1270 variables can be used to control the behavior of the
1271 .Nm PART
1272 GEOM class.
1273 The default value is shown next to each variable.
1274 .Bl -tag -width indent
1275 .It Va kern.geom.part.allow_nesting : No 0
1276 By default, some schemes (currently BSD, BSD64 and VTOC8) do not permit
1277 further nested partitioning.
1278 This variable overrides this restriction and allows arbitrary nesting (except
1279 within partitions created at offset 0).
1280 Some schemes have their own separate checks, for which see below.
1281 .It Va kern.geom.part.auto_resize : No 1
1282 This variable controls automatic resize behavior of the
1283 .Nm PART
1284 GEOM class.
1285 When this variable is enable and new size of provider is detected, the schema
1286 metadata is resized but all changes are not saved to disk, until
1287 .Cm gpart commit
1288 is run to confirm changes.
1289 This behavior is also reported with diagnostic message:
1290 .Sy "GEOM_PART: (provider) was automatically resized."
1291 .Sy "Use `gpart commit (provider)` to save changes or `gpart undo (provider)`"
1292 .Sy "to revert them."
1293 .It Va kern.geom.part.check_integrity : No 1
1294 This variable controls the behaviour of metadata integrity checks.
1295 When integrity checks are enabled, the
1296 .Nm PART
1297 GEOM class verifies all generic partition parameters obtained from the
1298 disk metadata.
1299 If some inconsistency is detected, the partition table will be
1300 rejected with a diagnostic message:
1301 .Sy "GEOM_PART: Integrity check failed (provider, scheme)" .
1302 .It Va kern.geom.part.gpt.allow_nesting : No 0
1303 By default the GPT scheme is allowed only at the outermost nesting level.
1304 This variable allows this restriction to be removed.
1305 .It Va kern.geom.part.ldm.debug : No 0
1306 Debug level of the Logical Disk Manager (LDM) module.
1307 This can be set to a number between 0 and 2 inclusive.
1308 If set to 0 minimal debug information is printed,
1309 and if set to 2 the maximum amount of debug information is printed.
1310 .It Va kern.geom.part.ldm.show_mirrors : No 0
1311 This variable controls how the Logical Disk Manager (LDM) module handles
1312 mirrored volumes.
1313 By default mirrored volumes are shown as partitions with type
1314 .Cm ms-ldm-data
1315 (see the
1316 .Sx "PARTITION TYPES"
1317 section).
1318 If this variable set to 1 each component of the mirrored volume will be
1319 present as independent partition.
1320 .Em NOTE :
1321 This may break a mirrored volume and lead to data damage.
1322 .It Va kern.geom.part.mbr.enforce_chs : No 0
1323 Specify how the Master Boot Record (MBR) module does alignment.
1324 If this variable is set to a non-zero value, the module will automatically
1325 recalculate the user-specified offset and size for alignment with the CHS
1326 geometry.
1327 Otherwise the values will be left unchanged.
1328 .It Va kern.geom.part.separator : No ""
1329 Specify an optional separator that will be inserted between the GEOM name
1330 and partition name.
1331 This variable is a
1332 .Xr loader 8
1333 tunable.
1334 Note that setting this variable may break software which assumes a particular
1335 naming scheme.
1336 .El
1337 .Sh EXIT STATUS
1338 Exit status is 0 on success, and 1 if the command fails.
1339 .Sh EXAMPLES
1340 The examples below assume that the disk's logical block size is 512
1341 bytes, regardless of its physical block size.
1342 .Ss GPT
1343 In this example, we will format
1344 .Pa ada0
1345 with the GPT scheme and create boot, swap and root partitions.
1346 First, we need to create the partition table:
1347 .Bd -literal -offset indent
1348 /sbin/gpart create -s GPT ada0
1349 .Ed
1350 .Pp
1351 Next, we install a protective MBR with the first-stage bootstrap code.
1352 The protective MBR lists a single, bootable partition spanning the
1353 entire disk, thus allowing non-GPT-aware BIOSes to boot from the disk
1354 and preventing tools which do not understand the GPT scheme from
1355 considering the disk to be unformatted.
1356 .Bd -literal -offset indent
1357 /sbin/gpart bootcode -b /boot/pmbr ada0
1358 .Ed
1359 .Pp
1360 We then create a dedicated
1361 .Cm freebsd-boot
1362 partition to hold the second-stage boot loader, which will load the
1363 .Fx
1364 kernel and modules from a UFS or ZFS filesystem.
1365 This partition must be larger than the bootstrap code
1366 .Po
1367 either
1368 .Pa /boot/gptboot
1369 for UFS or
1370 .Pa /boot/gptzfsboot
1371 for ZFS
1372 .Pc ,
1373 but smaller than 545 kB since the first-stage loader will load the
1374 entire partition into memory during boot, regardless of how much data
1375 it actually contains.
1376 We create a 472-block (236 kB) boot partition at offset 40, which is
1377 the size of the partition table (34 blocks or 17 kB) rounded up to the
1378 nearest 4 kB boundary.
1379 .Bd -literal -offset indent
1380 /sbin/gpart add -b 40 -s 472 -t freebsd-boot ada0
1381 /sbin/gpart bootcode -p /boot/gptboot -i 1 ada0
1382 .Ed
1383 .Pp
1384 We now create a 4 GB swap partition at the first available offset,
1385 which is 40 + 472 = 512 blocks (256 kB).
1386 .Bd -literal -offset indent
1387 /sbin/gpart add -s 4G -t freebsd-swap ada0
1388 .Ed
1389 .Pp
1390 Aligning the swap partition and all subsequent partitions on a 256 kB
1391 boundary ensures optimal performance on a wide range of media, from
1392 plain old disks with 512-byte blocks, through modern
1393 .Dq advanced format
1394 disks with 4096-byte physical blocks, to RAID volumes with stripe
1395 sizes of up to 256 kB.
1396 .Pp
1397 Finally, we create and format an 8 GB
1398 .Cm freebsd-ufs
1399 partition for the root filesystem, leaving the rest of the slice free
1400 for additional filesystems:
1401 .Bd -literal -offset indent
1402 /sbin/gpart add -s 8G -t freebsd-ufs ada0
1403 /sbin/newfs -Uj /dev/ada0p3
1404 .Ed
1405 .Ss MBR
1406 In this example, we will format
1407 .Pa ada0
1408 with the MBR scheme and create a single partition which we subdivide
1409 using a traditional
1410 .Bx
1411 disklabel.
1412 .Pp
1413 First, we create the partition table and a single 64 GB partition,
1414 then we mark that partition active (bootable) and install the
1415 first-stage boot loader:
1416 .Bd -literal -offset indent
1417 /sbin/gpart create -s MBR ada0
1418 /sbin/gpart add -t freebsd -s 64G ada0
1419 /sbin/gpart set -a active -i 1 ada0
1420 /sbin/gpart bootcode -b /boot/boot0 ada0
1421 .Ed
1422 .Pp
1423 Next, we create a disklabel in that partition
1424 .Po
1425 .Dq slice
1426 in disklabel terminology
1427 .Pc
1428 with room for up to 20 partitions:
1429 .Bd -literal -offset indent
1430 /sbin/gpart create -s BSD -n 20 ada0s1
1431 .Ed
1432 .Pp
1433 We then create an 8 GB root partition and a 4 GB swap partition:
1434 .Bd -literal -offset indent
1435 /sbin/gpart add -t freebsd-ufs -s 8G ada0s1
1436 /sbin/gpart add -t freebsd-swap -s 4G ada0s1
1437 .Ed
1438 .Pp
1439 Finally, we install the appropriate boot loader for the
1440 .Bx
1441 label:
1442 .Bd -literal -offset indent
1443 /sbin/gpart bootcode -b /boot/boot ada0s1
1444 .Ed
1445 .Ss VTOC8
1446 .Pp
1447 Create a VTOC8 scheme on
1448 .Pa da0 :
1449 .Bd -literal -offset indent
1450 /sbin/gpart create -s VTOC8 da0
1451 .Ed
1452 .Pp
1453 Create a 512MB-sized
1454 .Cm freebsd-ufs
1455 partition to contain a UFS filesystem from which the system can boot.
1456 .Bd -literal -offset indent
1457 /sbin/gpart add -s 512M -t freebsd-ufs da0
1458 .Ed
1459 .Pp
1460 Create a 15GB-sized
1461 .Cm freebsd-ufs
1462 partition to contain a UFS filesystem and aligned on 4KB boundaries:
1463 .Bd -literal -offset indent
1464 /sbin/gpart add -s 15G -t freebsd-ufs -a 4k da0
1465 .Ed
1466 .Pp
1467 After creating all required partitions, embed bootstrap code into them:
1468 .Bd -literal -offset indent
1469 /sbin/gpart bootcode -p /boot/boot1 da0
1470 .Ed
1471 .Ss Deleting Partitions and Destroying the Partitioning Scheme
1472 If a
1473 .Em "Device busy"
1474 error is shown when trying to destroy a partition table, remember that
1475 all of the partitions must be deleted first with the
1476 .Cm delete
1477 action.
1478 In this example,
1479 .Pa da0
1480 has three partitions:
1481 .Bd -literal -offset indent
1482 /sbin/gpart delete -i 3 da0
1483 /sbin/gpart delete -i 2 da0
1484 /sbin/gpart delete -i 1 da0
1485 /sbin/gpart destroy da0
1486 .Ed
1487 .Pp
1488 Rather than deleting each partition and then destroying the partitioning
1489 scheme, the
1490 .Fl F
1491 option can be given with
1492 .Cm destroy
1493 to delete all of the partitions before destroying the partitioning scheme.
1494 This is equivalent to the previous example:
1495 .Bd -literal -offset indent
1496 /sbin/gpart destroy -F da0
1497 .Ed
1498 .Ss Backup and Restore
1499 .Pp
1500 Create a backup of the partition table from
1501 .Pa da0 :
1502 .Bd -literal -offset indent
1503 /sbin/gpart backup da0 > da0.backup
1504 .Ed
1505 .Pp
1506 Restore the partition table from the backup to
1507 .Pa da0 :
1508 .Bd -literal -offset indent
1509 /sbin/gpart restore -l da0 < /mnt/da0.backup
1510 .Ed
1511 .Pp
1512 Clone the partition table from
1513 .Pa ada0
1514 to
1515 .Pa ada1
1516 and
1517 .Pa ada2 :
1518 .Bd -literal -offset indent
1519 /sbin/gpart backup ada0 | /sbin/gpart restore -F ada1 ada2
1520 .Ed
1521 .Sh SEE ALSO
1522 .Xr geom 4 ,
1523 .Xr boot0cfg 8 ,
1524 .Xr geom 8 ,
1525 .Xr glabel 8 ,
1526 .Xr gptboot 8
1527 .Sh HISTORY
1528 The
1529 .Nm
1530 utility appeared in
1531 .Fx 7.0 .
1532 .Sh AUTHORS
1533 .An Marcel Moolenaar Aq Mt marcel@FreeBSD.org
1534 .Sh CAVEATS
1535 Partition type
1536 .Em apple-zfs
1537 (6a898cc3-1dd2-11b2-99a6-080020736631) is also being used
1538 on illumos/Solaris platforms for ZFS volumes.