sbin/gpt/gpt.8

   1 .\" Copyright (c) 2002 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 .\"
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/sbin/gpt/gpt.8,v 1.17 2006/06/22 22:22:32 marcel Exp $
  26 .\" $DragonFly: src/sbin/gpt/gpt.8,v 1.2 2007/06/17 08:15:08 dillon Exp $
  27 .\"
  28 .Dd June 22, 2006
  29 .Os
  30 .Dt GPT 8
  31 .Sh NAME
  32 .Nm gpt
  33 .Nd "GUID partition table maintenance utility"
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Ar general_options
  37 .Ar command
  38 .Op Ar command_options
  39 .Ar device ...
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 utility provides the necessary functionality to manipulate GUID partition
  44 tables (GPTs), but see
  45 .Sx BUGS
  46 below for how and where functionality is missing.
  47 The basic usage model of the
  48 .Nm
  49 tool follows that of the
  50 .Xr cvs 1
  51 tool.
  52 The general options are described in the following paragraph.
  53 The remaining paragraphs describe the individual commands with their options.
  54 Here we conclude by mentioning that a
  55 .Ar device
  56 is either a special file
  57 corresponding to a disk-like device or a regular file.
  58 The command is applied to each
  59 .Ar device
  60 listed on the command line.
  61 .Ss General Options
  62 The general options allow the user to change default settings or otherwise
  63 change the behaviour that is applicable to all commands.
  64 Not all commands use all default settings, so some general options may not
  65 have an effect on all commands.
  66 .Pp
  67 The
  68 .Fl p Ar count
  69 option allows the user to change the number of partitions the GPT can
  70 accomodate.
  71 This is used whenever a new GPT is created.
  72 By default, the
  73 .Nm
  74 utility will create space for 128 partitions (or 32 sectors of 512 bytes).
  75 .Pp
  76 The
  77 .Fl r
  78 option causes the
  79 .Nm
  80 utility to open the device for reading only.
  81 Currently this option is primarily useful for the
  82 .Ic show
  83 command, but the intent
  84 is to use it to implement dry-run behaviour.
  85 .Pp
  86 The
  87 .Fl v
  88 option controls the verbosity level.
  89 The level increases with every occurrence of this option.
  90 There is no formalized definition of the different levels yet.
  91 .Ss Commands
  92 .Bl -tag -width indent
  93 .\" ==== add ====
  94 .It Xo
  95 .Nm
  96 .Ic add
  97 .Op Fl b Ar number
  98 .Op Fl i Ar index
  99 .Op Fl s Ar count
 100 .Op Fl t Ar type
 101 .Ar device ...
 102 .Xc
 103 The
 104 .Ic add
 105 command allows the user to add a new partition to an existing table.
 106 By default, it will create a UFS partition covering the first available block
 107 of an unused disk space.
 108 The command-specific options can be used to control this behaviour.
 109 .Pp
 110 The
 111 .Fl b Ar number
 112 option allows the user to specify the starting (beginning) sector number of
 113 the partition.
 114 The minimum sector number is 1, but has to fall inside an unused region of
 115 disk space that is covered by the GPT.
 116 .Pp
 117 The
 118 .Fl i Ar index
 119 option allows the user to specify which (free) entry in the GPT table is to
 120 be used for the new partition.
 121 By default, the first free entry is selected.
 122 .Pp
 123 The
 124 .Fl s Ar count
 125 option allows the user to specify the size of the partition in sectors.
 126 The minimum size is 1.
 127 .Pp
 128 The
 129 .Fl t Ar type
 130 option allows the user to specify the partition type.
 131 The type is given as an UUID, but
 132 .Nm
 133 accepts
 134 .Cm efi , swap , ufs , hfs , linux , dfly ,
 135 and
 136 .Cm windows
 137 as aliases for the most commonly used partition types.
 138 You may also specify any symbolic name in the system uuids file.
 139 .\" ==== create ====
 140 .It Nm Ic create Oo Fl fp Oc Ar device ...
 141 The
 142 .Ic create
 143 command allows the user to create a new (empty) GPT.
 144 By default, one cannot create a GPT when the device contains a MBR,
 145 however this can be overridden with the
 146 .Fl f
 147 option.
 148 If the
 149 .Fl f
 150 option is specified, an existing MBR is destroyed and any partitions
 151 described by the MBR are lost.
 152 .Pp
 153 The
 154 .Fl p
 155 option tells
 156 .Nm
 157 to create only the primary table and not the backup table.
 158 This option is only useful for debugging and should not be used otherwise.
 159 .\" ==== destroy ====
 160 .It Nm Ic destroy Oo Fl r Oc Ar device ...
 161 The
 162 .Ic destroy
 163 command allows the user to destroy an existing, possibly not empty GPT.
 164 .Pp
 165 The
 166 .Fl r
 167 option instructs
 168 .Nm
 169 to destroy the table in a way that it can be recovered.
 170 .\" ==== label ====
 171 .It Xo
 172 .Nm
 173 .Ic label
 174 .Op Fl a
 175 .Aq Fl f Ar file | Fl l Ar label
 176 .Ar device ...
 177 .Xc
 178 .It Xo
 179 .Nm
 180 .Ic label
 181 .Op Fl b Ar number
 182 .Op Fl i Ar index
 183 .Op Fl s Ar count
 184 .Op Fl t Ar type
 185 .Aq Fl f Ar file | Fl l Ar label
 186 .Ar device ...
 187 .Xc
 188 The
 189 .Ic label
 190 command allows the user to label any partitions that match the selection.
 191 At least one of the following selection options must be specified.
 192 .Pp
 193 The
 194 .Fl a
 195 option specifies that all partitions should be labeled.
 196 It is mutually exclusive with all other selection options.
 197 .Pp
 198 The
 199 .Fl b Ar number
 200 option selects the partition that starts at the given block number.
 201 .Pp
 202 The
 203 .Fl i Ar index
 204 option selects the partition with the given partition number.
 205 .Pp
 206 The
 207 .Fl s Ar count
 208 option selects all partitions that have the given size.
 209 This can cause multiple partitions to be removed.
 210 .Pp
 211 The
 212 .Fl t Ar type
 213 option selects all partitions that have the given type.
 214 The type is given as an UUID or by the aliases that the
 215 .Ic add
 216 command accepts.
 217 This can cause multiple partitions to be removed.
 218 .Pp
 219 The
 220 .Fl f Ar file
 221 or
 222 .Fl l Ar label
 223 options specify the new label to be assigned to the selected partitions.
 224 The
 225 .Fl f Ar file
 226 option is used to read the label from the specified file.
 227 Only the first line is read from the file and the trailing newline
 228 character is stripped.
 229 If the file name is the dash or minus sign
 230 .Pq Fl ,
 231 the label is read from
 232 the standard input.
 233 The
 234 .Fl l Ar label
 235 option is used to specify the label in the command line.
 236 The label is assumed to be encoded in UTF-8.
 237 .\" ==== migrate ====
 238 .It Nm Ic migrate Oo Fl fs Oc Ar device ...
 239 The
 240 .Ic migrate
 241 command allows the user to migrate an MBR-based disk partitioning into a
 242 GPT-based partitioning.
 243 By default, the MBR is not migrated when it contains partitions of an unknown
 244 type.
 245 This can be overridden with the
 246 .Fl f
 247 option.
 248 Specifying the
 249 .Fl f
 250 option will cause unknown partitions to be ignored and any data in it
 251 to be lost.
 252 .Pp
 253 The
 254 .Fl s
 255 option prevents migrating
 256 .Bx
 257 disk labels into GPT partitions by creating
 258 the GPT equivalent of a slice.
 259 .\" ==== remove ====
 260 .It Nm Ic remove Oo Fl a Oc Ar device ...
 261 .It Xo
 262 .Nm
 263 .Ic remove
 264 .Op Fl b Ar number
 265 .Op Fl i Ar index
 266 .Op Fl s Ar count
 267 .Op Fl t Ar type
 268 .Ar device ...
 269 .Xc
 270 The
 271 .Ic remove
 272 command allows the user to remove any and all partitions that match the
 273 selection.
 274 It uses the same selection options as the
 275 .Ic label
 276 command.
 277 See above for a description of these options.
 278 Partitions are removed by clearing the partition type.
 279 No other information is changed.
 280 .\" ==== show ====
 281 .It Nm Ic show Oo Fl lu Oc Ar device ...
 282 The
 283 .Ic show
 284 command displays the current partitioning on the listed devices and gives
 285 an overall view of the disk contents.
 286 With the
 287 .Fl l
 288 option the GPT partition label will be displayed instead of the GPT partition
 289 type.
 290 The option has no effect on non-GPT partitions.
 291 With the
 292 .Fl u
 293 option the GPT partition type is displayed as an UUID instead of in a
 294 user friendly form.
 295 The
 296 .Fl l
 297 option takes precedence over the
 298 .Fl u
 299 option.
 300 .El
 301 .Sh SEE ALSO
 302 .Xr fdisk 8 ,
 303 .Xr mount 8 ,
 304 .Xr newfs 8 ,
 305 .Xr swapon 8
 306 .Sh HISTORY
 307 The
 308 .Nm
 309 utility appeared in
 310 .Fx 5.0
 311 for ia64.
 312 .Sh BUGS
 313 The development of the
 314 .Nm
 315 utility is still work in progress.
 316 Many necessary features are missing or partially implemented.
 317 In practice this means that the manual page, supposed to describe these
 318 features, is farther removed from being complete or useful.
 319 As such, missing functionality is not even documented as missing.
 320 However, it is believed that the currently present functionality is reliable
 321 and stable enough that this tool can be used without bullet-proof footware if
 322 one thinks one does not make mistakes.
 323 .Pp
 324 It is expected that the basic usage model does not change, but it is
 325 possible that future versions will not be compatible in the strictest sense
 326 of the word.
 327 For example, the
 328 .Fl p Ar count
 329 option may be changed to a command option rather than a generic option.
 330 There are only two commands that use it so there is a chance that the natural
 331 tendency for people is to use it as a command option.
 332 Also, options primarily intended for diagnostic or debug purposes may be
 333 removed in future versions.
 334 .Pp
 335 Another possibility is that the current usage model is accompanied by
 336 other interfaces to make the tool usable as a back-end.
 337 This all depends on demand and thus feedback.