$NetBSD: disklabel.8,v 1.9 1995/03/18 14:54:38 cgd Exp $
Copyright (c) 1987, 1988, 1991, 1993
The Regents of the University of California. All rights reserved.
This code is derived from software contributed to Berkeley by
Symmetric Computer Systems.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
@(#)disklabel.8 8.2 (Berkeley) 4/19/94
.Dd $Mdocdate: July 5 2023 $ .Dt DISKLABEL 8 .Os .Sh NAME .Nm disklabel .Nd read and write disk pack label .Sh SYNOPSIS .Nm disklabel .Op Fl Acdtv .Op Fl h | p Ar unit .Op Fl T Ar file .Ar disk .Nm disklabel .Fl w .Op Fl Acdnv .Op Fl T Ar file .Ar disk disktype .Op Ar packid .Nm disklabel .Fl e .Op Fl Acdnv .Op Fl T Ar file .Ar disk .Nm disklabel .Fl E .Op Fl Acdnv .Op Fl F Ns | Ns Fl f Ar file .Op Fl T Ar file .Ar disk .Nm disklabel .Fl R .Op Fl nv .Op Fl F Ns | Ns Fl f Ar file .Ar disk protofile .Sh DESCRIPTION The .Nm utility can be used to install, examine, or modify the label on a disk drive or pack. The disk label contains information about disk characteristics
q size, type, etc. and the partition layout, stored on the disk itself. It is used by the operating system to optimize disk I/O and locate the filesystems resident on the disk.
p .Nm supports 15 configurable partitions, .Sq a through .Sq p , excluding .Sq c . The .Sq c partition describes the entire physical disk, is automatically created by the kernel, and cannot be modified or deleted by .Nm . By convention, the .Sq a partition of the boot disk is the root partition, and the .Sq b partition of the boot disk is the swap partition, but all other letters can be used in any order for any other partitions as desired.
p The options are as follows: l -tag -width Ds t Fl A Automatically allocate all the disk space in the .Ox portion of the disk in the recommended manner. See .Sx AUTOMATIC DISK ALLOCATION , below. t Fl c Clear the system's in-core copy of the label and update it based on the on-disk label. t Fl d Use the .Em default label. This ignores any existing .Ox disk label on the disk. t Fl E Use the built-in command-driven label editor described below. t Fl e Edit an existing disk label using the editor specified in the .Ev EDITOR environment variable, or .Xr vi 1 if none is specified. t Fl F Ar file Write entries to .Ar file in .Xr fstab 5 format for any partitions for which mount point information is known. The entries will be written using disklabel UIDs. The .Fl F flag is only valid when used in conjunction with the .Fl E or .Fl R flags. If .Ar file already exists, it will be overwritten. t Fl f Ar file The same as .Fl F except that entries will be written using disk device names. t Fl h Print partition sizes in human readable format. t Fl n Make no permanent changes to the disklabel
q useful for debugging purposes . t Fl p Ar unit Print partition sizes in .Ar unit instead of sectors. Valid units are b(ytes), c(ylinders), k(ilobytes), m(egabytes), g(igabytes) and t(erabytes). t Fl R Restore a disk label that was formatted in a prior operation and saved in an ASCII file. t Fl T Ar file Read the template for automatic allocation from .Ar file instead of using the builtin one. See .Sx AUTOMATIC DISK ALLOCATION below for the format. If .Ar file is a single dash
q Sq - , the template is read from the standard input. t Fl t Format the label as a .Xr disktab 5 entry. t Fl v Print additional information during operation
q verbose mode . t Fl w Write a standard label on the designated drive. t Ar disk Specify the .Ar disk to operate on. It can be specified by its full pathname, by an abbreviated disk form, or by its disklabel UID. In its abbreviated form, the path to the device, the .Sq r denoting .Qq raw device , and the partition letter, can all be omitted. For example, the first IDE disk can be specified as either
a /dev/wd0c , or .Ar wd0 . t Ar disktype Specify a .Ar disktype entry from the .Xr disktab 5 database. t Ar packid Specify a pack identification string for the device
q see below . t Ar protofile Used with the restore option
q Fl R to specify a file to read an ASCII label from. .El
p The first form of the command
q read is used to examine the label on the named disk drive. It will display all of the parameters associated with the drive and its partition layout. The kernel's in-core copy of the label is displayed; if the disk has no label, or the partition types on the disk are incorrect, the kernel may have constructed or modified the label.
p The second form of the command
q write is used to write a standard label on the designated drive. The drive parameters and partitions are taken from that file. If different disks of the same physical type are to have different partitions, it will be necessary to have separate disktab entries describing each, or to edit the label after installation as described below. The optional argument is a pack identification string, up to 16 characters long. The pack ID must be quoted if it contains blanks. The existing label will be updated via the in-core copy.
p In the third form of the command
q edit , the label is read from the in-core kernel copy and then supplied to an editor for changes. If no editor is specified in an .Ev EDITOR environment variable, .Xr vi 1 is used. When the editor terminates, the formatted label is reread and used to rewrite the disk label.
p The built-in label editor
q fourth form provides a simple interactive label editor. The editor prompt contains information about the state of the edit process.
p .Dl Ar disk Ns *>
p Where .Ar disk is the name of the disk being edited, .Sq * means that the in-memory copy of the partition table has been modified but not yet written to disk.
p Some commands or prompts take an optional unit. Available units are .Sq b for bytes, .Sq c for cylinders, .Sq k for kilobytes, .Sq m for megabytes, .Sq g for gigabytes, and .Sq t for terabytes. If no unit is given, the default is to use sectors (usually 512 bytes).
p Quantities are rounded to the nearest cylinder when units are specified for sizes
q or offsets . At prompts that request a size, .Ql * may be entered to indicate the rest of the available space, .Sq % for percentage of total, and .Sq & for percentage free. Commands may be aborted by entering .Ql ^D
q Control-D . Entering .Ql ^D at the main prompt will exit the editor.
p The editor commands are as follows: l -tag -width "p [unit] " t Cm ? | h Display help message with all available commands. There is also
q simple context-sensitive help available at most prompts. t Cm A Allocate all the disk space in the recommended manner. See .Sx AUTOMATIC DISK ALLOCATION , below. t Cm a Op Ar part Add new partition. This option adds a new partition to the disk label. If no partition letter is specified
q a-p , the user will be prompted for one. t Cm b Set .Ox disk boundaries. This option tells .Nm which parts of the disk it is allowed to modify. This option is probably only useful for ports with .Xr fdisk 8 partition tables where the ending sector in the MBR is incorrect. The user may enter .Ql * at the .Dq Size prompt to indicate the entire size of the disk
q minus the starting sector . This is useful for disks where the fdisk partition table is incapable of storing the real size. Note: data may become corrupted if boundaries are extended such that they overlap with other resident operating systems. t Cm c Op Ar part Change the size of an existing partition. If no partition is specified, the user will be prompted for one. The new size may be in terms of the aforementioned units and may also be prefixed with .Ql + or .Ql - to change the size by a relative amount. t Cm D Sets the disk label to the default values as reported by the kernel. This simulates the case where there is no disk label. t Cm d Op Ar part Delete an existing partition (or .Ql * to delete all partitions). If no partition is specified, the user will be prompted for one. t Cm e Edit label description, e.g. 'UMIS RPJTJ256MED'. t Cm i Change the disklabel UID, specified as a 16-character hexadecimal string. If set to all zeros, a new UID will automatically be allocated when the disklabel is written to disk. t Cm l Op Ar unit Print the disk label header. t Cm M Display this manual page. The manual page is piped through the pager specified by the .Ev PAGER environment variable or 'less' if .Ev PAGER is not set. t Cm m Op Ar part Modify parameters for an existing partition. If no partition is specified, the user will be prompted for one. This option allows the user to change the filesystem type, starting offset, partition size, and mount point for the specified partition. t Cm n Op Ar part Name the mount point for an existing partition. If no partition is specified, the user will be prompted for one. This option is only valid if .Nm was invoked with the .Fl f flag. t Cm p Op Ar unit Print the current partition list. If a .Em unit is given, the size and offsets are displayed in terms of the specified unit. If the unit is .Sq * , it is automatically determined by the size of the smallest partition. t Cm q Quit the editor. If any changes have been made, the user will be asked whether or not to save the changes to the on-disk label. t Cm R Op Ar part Resize a partition in an automatically allocated label, compacting unused space between partitions with a higher offset. The last partition will be shrunk if necessary. Works only for automatically allocated labels with no spoofed partitions. t Cm r Recalculate free space. This command displays all the free areas on the disk and the total number of free sectors. t Cm s Op Ar path Save the label to a file in ASCII format (suitable for loading via the .Fl R option). If no path is specified, the user will be prompted for one. t Cm U Undo all changes made since entering the editor. t Cm u Undo
q or redo last change. Entering .Em u once will undo the last change. Entering it again will restore the change. t Cm w Write the label to disk. This option will commit any changes to the on-disk label. t Cm x Exit the editor without saving any changes to the on-disk label. t Cm z Zero out the existing partition table and mount point information, leaving only the 'c' partition. The drive parameters are not changed. .El
p In the restore form of the command
q fifth form , the prototype file used to create the label should be in the same format as that produced when reading or editing a label. Comments are delimited by .Ar # and newline.
p Note that when a disk has no real x disklabel, the kernel creates a default label so that the disk can be used. This default label will include other partitions found on the disk if they are supported on your architecture. For example, on systems that support .Xr fdisk 8 partitions the default label will also include DOS and Linux partitions. However, these entries are not dynamic, they are fixed at the time .Nm is run. That means that subsequent changes that affect
f non- Ox partitions will not be present in the default label, though they may be updated by hand. To see the default label, run .Nm with the .Fl d flag. .Nm can then be run with the .Fl e flag and any entries pasted as desired from the default label into the real one. .Sh AUTOMATIC DISK ALLOCATION The .Fl A option and the editor command .Cm A create disklabels that distribute a disk's free space into a set of partitions appropriate for an .Ox installation. The exact set of partitions created depends on available free space, how fragmented the free space is and some machine dependent variables, but will be approximately: l -column "/usr/X11R6" \ "999MB \(en 999MB" "999MB \(en 999MB" "999MB \(en 999MB" \ "< 700MB" t \ Ta Sy > 10GB Free Ta Sy > 2.5GB Ta Sy > 700MB Ta \ Sy < 700MB t Sy / \ Ta 150MB \(en \0\01GB Ta 800MB \(en \0\02GB Ta 700MB \(en \0\04GB Ta \ 1MB \(en 2GB t Sy swap \ Ta \080MB \(en 256MB Ta \080MB \(en 256MB Ta \0\01MB \(en 256MB Ta t Sy /usr \ Ta 1.5GB \(en \030GB Ta 1.5GB \(en \030GB Ta Ta t Sy /home \ Ta \0\01GB \(en 300GB Ta 256MB \(en \0\02GB Ta Ta t Sy /tmp \ Ta 120MB \(en \0\04GB Ta Ta Ta t Sy /var \ Ta \080MB \(en \0\04GB Ta Ta Ta t Sy /usr/X11R6 \ Ta 384MB \(en \0\01GB Ta Ta Ta t Sy /usr/local \ Ta \0\01GB \(en \020GB Ta Ta Ta t Sy /usr/src \ Ta \0\02GB \(en \0\05GB Ta Ta Ta t Sy /usr/obj \ Ta \0\05GB \(en \0\06GB Ta Ta Ta .El
p The .Fl A option displays the partition set that would be created and .Fl wA writes it to disk.
p The default set can be overridden with .Fl T . Each line of input uses three fields to describe a partition. There must not be whitespace before the first field, fields are separated by whitespace and fields cannot contain whitespace.
p The first field is the partition's mount point or one of the special tokens .Sq RAID or .Sq SWAP .
p The second field is the partition size. This can be .Sq * to make the partition as large as possible, an exact size (e.g. 1G) or a size range (e.g. 1M-10G or 1G-*).
p The third field is the partition's share of any space left after all minimum sizes are accounted for. This is expressed as a percentage from 0 (the default) to 100 (e.g. 37%). The last partition receives all remaining free space up to its maximum size no matter what percentage is specified. .Sh FILES l -tag -width "/etc/disktabXXX" t Pa /etc/disktab Disk description file. .El .Sh EXAMPLES Display, respectively, the current label, the default label and the default auto allocation for sd0: d -literal -offset indent # disklabel sd0 # disklabel -d sd0 # disklabel -A sd0 .Ed
p Write the default auto allocation to sd0:
p .Dl # disklabel -wA sd0
p Edit the label for the disk with DUID 3eb7f9da875cb9ee:
p .Dl # disklabel -E 3eb7f9da875cb9ee
p Restore the label for sd0 from information in
a mylabel :
p .Dl # disklabel -R sd0 mylabel
p Put largest contiguous area of free space on sd0 into a single RAID partition: .Dl # echo 'RAID *' | disklabel -wAT- sd0
p Write the auto allocation defined in
a /template to sd0:
p .Dl # disklabel -wAT/template sd0
p A template file that results in an auto allocation similar to the default one for a disk with 5GB of free space is: l -column /home 1300MM256M 75% -offset indent t / Ta \0800M\(en2G Ta \05% t swap Ta \0\080M\(en256M Ta 10% t /usr Ta 1300M\(en\)3G Ta 75% t /home Ta \0256M\(en2G Ta 10% .El .Sh DIAGNOSTICS The kernel device drivers will not allow the size of a disk partition to be decreased or the offset of a partition to be changed while it is open. Some device drivers create a label containing only a single large partition if a disk is unlabeled; thus, the label must be written to the .Sq a partition of the disk while it is open. This sometimes requires the desired label to be set in two steps, the first one creating at least one other partition, and the second setting the label on the new partition while shrinking the .Sq a partition. .Sh SEE ALSO .Xr softraid 4 , .Xr disklabel 5 , .Xr disktab 5 , .Xr installboot 8 , .Xr scan_ffs 8 .Sh HISTORY The .Nm utility appeared in x 4.3 Tahoe . .Sh CAVEATS The maximum disk and partition size is 64PB.
p On some machines, such as Sparc64, partition tables may not exhibit the full functionality described above.