MFC r1.6 r1.30 r1.28 (HEAD):
authorThomas Nikolajsen <thomas@dragonflybsd.org>
Tue, 16 Sep 2008 21:54:32 +0000 (16 21:54 +0000)
committerThomas Nikolajsen <thomas@dragonflybsd.org>
Tue, 16 Sep 2008 21:54:32 +0000 (16 21:54 +0000)
 * fix markup of `auto' argument
 * add `auto' where missing
 * delete extra synopsis
 * fix wrong single character quoting

Minor wording improvement.

Add an example os how to change label format from 32 bit to 64 bit,
and delete note that it require reboot.

Fix typo: missing line break, which got .Xr hide sentence.

Update disklabel doc:
 - Sync usage() to disklabel.8
 - Add note that this is 32 bit disklabel
 - Move description of `-f' flag from unrelated section (SAVED FILE FORMAT)
 - Improve some wording and mark up a bit

sbin/disklabel/disklabel.5
sbin/disklabel/disklabel.8
sbin/disklabel/disklabel.c

index 75748f9..bb6828c 100644 (file)
 .\"
 .\"     @(#)disklabel.5.5      8.1 (Berkeley) 6/5/93
 .\" $FreeBSD: src/sbin/disklabel/disklabel.5,v 1.7.2.4 2002/08/21 18:58:16 trhodes Exp $
-.\" $DragonFly: src/sbin/disklabel/disklabel.5,v 1.5 2006/05/26 19:39:38 swildner Exp $
+.\" $DragonFly: src/sbin/disklabel/disklabel.5,v 1.5.10.1 2008/09/16 21:54:32 thomas Exp $
 .\"
-.Dd June 5, 1993
+.Dd August 21, 2008
 .Dt DISKLABEL 5
 .Os
 .Sh NAME
 .Nm disklabel
-.Nd disk pack label
+.Nd 32 bit disk pack label
 .Sh SYNOPSIS
 .In sys/disklabel.h
 .Sh DESCRIPTION
@@ -104,7 +104,8 @@ All of these operations are normally done using
 .Xr disklabel 8 .
 .Pp
 The format of the disk label is specified in
-.In sys/disklabel.h .
+.In sys/disklabel32.h .
 .Sh SEE ALSO
+.Xr disklabel64 5 ,
 .Xr disktab 5 ,
 .Xr disklabel 8
index 3f0dce6..d256b49 100644 (file)
 .\"
 .\"    @(#)disklabel.8 8.2 (Berkeley) 4/19/94
 .\" $FreeBSD: src/sbin/disklabel/disklabel.8,v 1.15.2.22 2003/04/17 17:56:34 trhodes Exp $
-.\" $DragonFly: src/sbin/disklabel/disklabel.8,v 1.22.2.1 2008/08/04 20:31:36 thomas Exp $
+.\" $DragonFly: src/sbin/disklabel/disklabel.8,v 1.22.2.2 2008/09/16 21:54:32 thomas Exp $
 .\"
-.Dd July 27, 2008
+.Dd August 21, 2008
 .Dt DISKLABEL 8
 .Os
 .Sh NAME
 .Nm disklabel
-.Nd read and write disk pack label
+.Nd read and write 32 bit disk pack label
 .Sh SYNOPSIS
 .Nm
 .Op Fl r
@@ -50,7 +50,7 @@
 .Fl w
 .Op Fl r
 .Op Fl n
-.Ar disk Ar disktype/auto
+.Ar disk Ar disktype Ns / Ns Cm auto
 .Oo Ar packid Oc
 .Nm
 .Fl e
@@ -73,7 +73,7 @@
 .Fl s Ar boot2
 .Oc
 .Ar disk
-.Oo Ar disktype/auto Oc
+.Oo Ar disktype Ns / Ns Cm auto Oc
 .Nm
 .Fl w
 .Fl B
@@ -82,7 +82,7 @@
 .Fl b Ar boot1
 .Fl s Ar boot2
 .Oc
-.Ar disk Ar disktype/auto
+.Ar disk Ar disktype Ns / Ns Cm auto
 .Oo Ar packid Oc
 .Nm
 .Fl R
@@ -93,7 +93,7 @@
 .Fl s Ar boot2
 .Oc
 .Ar disk Ar protofile
-.Oo Ar disktype/auto Oc
+.Oo Ar disktype Ns / Ns Cm auto Oc
 .Nm
 .Fl f Ar slice_start_lba
 .Oo Ar options Oc
@@ -135,22 +135,20 @@ forms require a disk device name, which should always be the raw
 device name representing the disk or slice.
 .Dx
 uses the following scheme for slice numbering:
-If the disk doesn't use
-.Xr gpt 8 ,
-but e.g. MBR (typically laid out by
+If the disk doesn't use GPT (typically laid out by
+.Xr gpt 8 ,
+but e.g.\& MBR (typically laid out by
 .Xr fdisk 8 ) ,
-then slice 0, e.g.
+then slice 0, e.g.\&
 .Pa da0s0 ,
-represents the entire disk regardless of any DOS partitioning,
-this is called the compatibility slice,
-and slice 1 and onward, e.g.
+represents the entire disk regardless of any DOS partitioning.
+Slice 0 is called the compatibility slice,
+and slice 1 and onward, e.g.\&
 .Pa da0s1 ,
-represents a
+represent
 .Bx
-slice.
-If the disk does use GPT (typically laid out by
-.Xr gpt 8 ) ,
-then all slices are
+slices.
+If the disk does use GPT, then all slices are
 .Bx
 slices, slice 0 isn't special, it is just the first slice on the disk.
 You do not have to include the
@@ -196,16 +194,9 @@ To write a standard label, use the form
 .Fl w
 .Op Fl r
 .Op Fl n
-.Ar disk Ar disktype/auto
+.Ar disk Ar disktype Ns / Ns Cm auto
 .Oo Ar packid Oc
 .Pp
-.Nm
-.Fl w
-.Op Fl r
-.Op Fl n
-.Ar disk
-auto
-.Pp
 The required arguments to
 .Nm
 are the drive to be labeled and the drive type as described in the
@@ -248,7 +239,7 @@ For a virgin disk that is not known to
 .Xr disktab 5 ,
 .Ar disktype
 can be specified as
-.Dq auto .
+.Cm auto .
 In this case, the driver is requested to produce a virgin label for the
 disk.
 This might or might not be successful, depending on whether the
@@ -334,7 +325,7 @@ in ASCII format.
 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 \&#
+.Ql #
 and newline.
 As when writing a new label, any existing bootstrap code will be
 clobbered if
@@ -419,7 +410,7 @@ slice such as
 .Fl b Ar boot1
 .Fl s Ar boot2
 .Oc
-.Ar disk Ar disktype
+.Ar disk Ar disktype Ns / Ns Cm auto
 .Oo Ar packid Oc
 .Pp
 This form corresponds to the
@@ -447,7 +438,7 @@ disklabel that would have been written will be printed to stdout.
 .Fl s Ar boot2
 .Oc
 .Ar disk Ar protofile
-.Oo Ar disktype Oc
+.Oo Ar disktype Ns / Ns Cm auto Oc
 .Pp
 This form corresponds to the
 .Dq restore label
@@ -571,6 +562,25 @@ Your mileage may vary.
 .Nm
 .Fl e
 .Pa da0s1
+.Ss Manual offset
+.Dx
+no longer snoop-adjusts the on-disk label when reading or writing
+raw labels.
+.Nm
+is now responsible for adjusting the label when operating in raw mode.
+Traditional (32 bit
+.Bx )
+disklabels store offsets as absolute block numbers
+rather than slice-relative block numbers.
+If
+.Nm
+is unable to issue the
+.Dv DIOCGPART
+ioctl to get slice information it will
+refuse to read or write the label in raw mode.
+The
+.Fl f
+option may be used to force the operation by supplying a manual offset.
 .Sh FILES
 .Bl -tag -width ".Pa /etc/disktab" -compact
 .It Pa /boot/boot1
@@ -756,25 +766,6 @@ for more details).
 .Pp
 The remainder of the line is a comment and shows the size of the partition
 in MB.
-.Pp
-.Dx
-no longer snoop-adjusts the on-disklabel when reading or writing
-raw labels.
-.Nm
-is now responsible for adjusting the label when operating in raw mode.
-Traditional (32 bit
-.Bx )
-disklabels store offsets as absolute block numbers
-rather than slice-relative block numbers.
-If
-.Nm
-is unable to issue the
-.Dv DIOCGPART
-ioctl to get slice information it will
-refuse to read or write the label in raw mode.
-The
-.Fl f
-option may be used to force the operation by supplying a manual offset.
 .Sh EXAMPLES
 .Dl "disklabel da0s1"
 .Pp
@@ -893,6 +884,20 @@ The
 commands are optional, but may be necessary for some BIOSes to properly
 recognize the disk.
 .Pp
+.Dl disklabel -W da0s1
+.Dl dd if=/dev/zero of=/dev/da0s1 bs=512 count=32
+.Dl disklabel64 -r -w da0s1 auto
+.Dl disklabel64 -N da0s1
+.Pp
+Completely wipe any prior information on the slice,
+changing label format to 64 bit.
+The wiping is needed as
+.Nm disklabel64
+and
+.Nm ,
+as a safety measure,
+won't do any operations if label with other format is already installed.
+.Pp
 This is an example disklabel that uses some of the new partition size types
 such as
 .Cm % , M , G ,
@@ -935,13 +940,13 @@ 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
-.Dq a
+.Ql 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
-.Dq a
+.Ql a
 partition.
 .Pp
 On some machines the bootstrap code may not fit entirely in the area
@@ -974,7 +979,8 @@ Due to
 storing sector numbers in 32 bit format
 .Nm
 is restricted to 2TB, using the prevalent sector size of 512B.
-.Xr disklabel64 5 labels should be used to partition larger disks.
+.Xr disklabel64 5
+labels should be used to partition larger disks.
 .Pp
 The various
 .Bx Ns s
@@ -998,15 +1004,6 @@ for read-only operation.
 .Xr gpt 8 ,
 .Xr vinum 8
 .Sh BUGS
-Installing a
-.Xr disklabel64 8
-label on a slice with a
-.Nm
-label installed requires reboot. First the existing label
-has to be overwritten, e.g. by
-.Xr dd 1 ,
-see above, then a reboot is required before the new label can be installed.
-.Pp
 For the i386 architecture, the primary bootstrap sector contains
 an embedded
 .Em fdisk
@@ -1039,7 +1036,7 @@ Warning
 .Em is
 given if partitions
 overlap; if an absolute offset does not match the expected offset; if the
-.Dq c
+.Ql c
 partition does not start at 0 or does not cover the entire slice; if a
 partition runs past the end of the device; and a number of other errors; but
 no warning is given if space remains unused.
index 055fef8..f10714c 100644 (file)
@@ -37,7 +37,7 @@
  * @(#)disklabel.c     1.2 (Symmetric) 11/28/85
  * @(#)disklabel.c      8.2 (Berkeley) 1/7/94
  * $FreeBSD: src/sbin/disklabel/disklabel.c,v 1.28.2.15 2003/01/24 16:18:16 des Exp $
- * $DragonFly: src/sbin/disklabel/disklabel.c,v 1.27 2008/04/23 21:59:22 thomas Exp $
+ * $DragonFly: src/sbin/disklabel/disklabel.c,v 1.27.2.1 2008/09/16 21:54:32 thomas Exp $
  */
 
 #include <sys/param.h>
@@ -1779,5 +1779,8 @@ usage(void)
                "       disklabel [-NW] disk",
                "\t\t(to write disable/enable label)");
 #endif
+       fprintf(stderr, "%s\n%s\n",
+               "       disklabel [-f slice_start_lba] [options]",
+               "\t\t(to force using manual offset)");
        exit(1);
 }