Embellish the man page after trying to migrate to gstripe from ccd(4).

1 files changed, 27 insertions, 4 deletions

diff --git a/sbin/geom/class/stripe/gstripe.8 b/sbin/geom/class/stripe/gstripe.8
index ddf7d90..6565a22 100644
--- a/sbin/geom/class/stripe/gstripe.8
+++ b/sbin/geom/class/stripe/gstripe.8
@@ -102,7 +102,9 @@ Set up a striped device from the given devices with specified
 .Ar name .
 This is the
 .Dq manual
-method.
+method and the stripe will not exist after a reboot (see
+.Cm DESCRIPTION
+above).
 The kernel module
 .Pa geom_stripe.ko
 will be loaded if it is not loaded already.
@@ -145,7 +147,10 @@ Force the removal of the specified striped device.
 .It Fl h
 Hardcode providers' names in metadata.
 .It Fl s Ar stripesize
-Specifies size of stripe block.
+Specifies size of stripe block in bytes.
+The
+.Ar stripesize
+must be a multiple of the largest sector size of all the providers.
 .It Fl v
 Be more verbose.
 .El
@@ -194,8 +199,10 @@ If this value is big, you should considern increasing
 value.
 .El
 .Sh EXAMPLES
-The following example shows how to set up striped device from four disks
-for automatic configuration, create a file system on it, and mount it:
+The following example shows how to set up striped device from four disks with a
+4 KB stripe size for automatic configuration,
+create a file system on it,
+and mount it:
 .Bd -literal -offset indent
 gstripe label -v -s 4096 data /dev/da0 /dev/da1 /dev/da2 /dev/da3
 newfs /dev/stripe/data
@@ -207,9 +214,25 @@ gstripe unload
 .Ed
 .Sh DIAGNOSTICS
 Exit status is 0 on success, and 1 if the command fails.
+.Sh COMPATIBILITY
+.Nm
+interleave is in number of bytes,
+unlike
+.Xr ccdconfig 8
+and
+.Xr atacontrol 8
+which uses number of sectors.
+A a
+.Xr ccdconfig 8
+.Ar ileave
+of `128' is 64 KB (128 512B sectors).
+The same stripe interleave would be specified as '65536' for
+.Nm .
 .Sh SEE ALSO
 .Xr geom 4 ,
 .Xr loader.conf 5 ,
+.Xr atacontrol 8 ,
+.Xr ccdconfig 8 ,
 .Xr geom 8 ,
 .Xr mount 8 ,
 .Xr newfs 8 ,