svn commit: r245273 - stable/8/sbin/geom/class/part

[Warren Block]

Author: wblock (doc committer)
Date: Thu Jan 10 23:39:28 2013
New Revision: 245273
URL: http://svnweb.freebsd.org/changeset/base/245273

Log:
  MFC r245012:
  
  Document the output of the show command.  Modified version of patch
  provided by Bas Smeelen <b.smeelen at ose.nl>.  Use of 'gpart list'
  suggested by by Andrey V. Elsukov <ae at FreeBSD.org>.
  
  PR:		docs/174270
  Submitted by:	Ronald F.Guilmette <rfg at tristatelogic.com>
  Reviewed by:	ae (block sizes)

Modified:
  stable/8/sbin/geom/class/part/gpart.8
Directory Properties:
  stable/8/sbin/geom/class/part/   (props changed)

Modified: stable/8/sbin/geom/class/part/gpart.8
==============================================================================
--- stable/8/sbin/geom/class/part/gpart.8	Thu Jan 10 23:36:02 2013	(r245272)
+++ stable/8/sbin/geom/class/part/gpart.8	Thu Jan 10 23:39:28 2013	(r245273)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd March 19, 2012
+.Dd January 3, 2013
 .Dt GPART 8
 .Os
 .Sh NAME
@@ -453,8 +453,14 @@ about its use.
 .El
 .\" ==== SHOW ====
 .It Cm show
-Show the current partition information of the specified geoms
-or all geoms if none are specified.
+Show current partition information for the specified geoms, or all
+geoms if none are specified.
+The default output includes the logical starting block of each
+partition, the partition size in blocks, the partition index number,
+the partition type, and a human readable partition size.
+Block sizes and locations are based on the device's Sectorsize
+as shown by
+.Cm gpart list .
 Additional options include:
 .Bl -tag -width 10n
 .It Fl l
@@ -919,7 +925,7 @@ and
 .Cm list
 will report about corrupt tables.
 .Pp
-If the size of the device has changed (e.g.\& volume expansion) the
+If the size of the device has changed (e.g.,\& volume expansion) the
 secondary GPT header will no longer be located in the last sector.
 This is not a metadata corruption, but it is dangerous because any
 corruption of the primary GPT will lead to loss of the partition table.
@@ -979,14 +985,14 @@ This may break a mirrored volume and lea
 Exit status is 0 on success, and 1 if the command fails.
 .Sh EXAMPLES
 Create a GPT scheme on
-.Pa ad0 :
+.Pa ada0 :
 .Bd -literal -offset indent
-/sbin/gpart create -s GPT ad0
+/sbin/gpart create -s GPT ada0
 .Ed
 .Pp
 Embed GPT bootstrap code into a protective MBR:
 .Bd -literal -offset indent
-/sbin/gpart bootcode -b /boot/pmbr ad0
+/sbin/gpart bootcode -b /boot/pmbr ada0
 .Ed
 .Pp
 Create a dedicated
@@ -1002,19 +1008,19 @@ or the GPT boot you are planning to writ
 A size of 15 blocks (7680 bytes) would be sufficient for
 booting from UFS but 128 blocks (64 KB) is used in
 this example to reserve some space for potential
-future need (e.g.\& a larger
+future need (e.g.,\& a larger
 .Pa /boot/gptzfsboot
 for booting from a ZFS partition).
 .Bd -literal -offset indent
-/sbin/gpart add -b 34 -s 128 -t freebsd-boot ad0
-/sbin/gpart bootcode -p /boot/gptboot -i 1 ad0
+/sbin/gpart add -b 34 -s 128 -t freebsd-boot ada0
+/sbin/gpart bootcode -p /boot/gptboot -i 1 ada0
 .Ed
 .Pp
 Create a 512MB-sized
 .Cm freebsd-ufs
 partition to contain a UFS filesystem from which the system can boot.
 .Bd -literal -offset indent
-/sbin/gpart add -b 162 -s 1048576 -t freebsd-ufs ad0
+/sbin/gpart add -b 162 -s 1048576 -t freebsd-ufs ada0
 .Ed
 .Pp
 Create an MBR scheme on