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