PERFORCE change 82096 for review

[soc-cjones]

http://perforce.freebsd.org/chv.cgi?CH=82096

Change 82096 by soc-cjones at soc-cjones_ides on 2005/08/17 03:22:52

	Synopses of the commands that work with gvinum.  Still need to add argument data, detail options, and then provide detail on commands.

Affected files ...

.. //depot/projects/soc2005/gvinum/src/sbin/gvinum/gvinum.8#2 edit

Differences ...

==== //depot/projects/soc2005/gvinum/src/sbin/gvinum/gvinum.8#2 (text+ko) ====

@@ -10,7 +10,106 @@
 .Op Fl options
 .Sh COMMANDS
 .Bl -tag -width indent
-TODO
+.It Xo
+.Ic checkparity
+.Op Fl f
+.Op Fl v
+.Ar plex
+.Xc 
+Check the parity blocks of a RAID-5 plex.
+.It Xo
+.Ic create
+.Op Fl f
+.Ar description-file
+.Xc
+Create a volume as described in
+.Ar description-file .
+.It Xo
+.Ic l | list
+.Op Ar volume | plex | subdisk
+.Xc
+List information about specified objects.
+.It Xo
+.Ic ld
+.Op Ar drive
+.Xc
+List information about drive(s).
+.It Xo
+.Ic ls
+.Op Ar subdisk
+.Xc
+List information about subdisk(s).
+.It Xo
+.Ic lp
+.Op Ar plex
+.Xc
+List information about plex(es).
+.It Xo
+.Ic lv
+.Op Ar volume
+.Xc
+List information about volume(s).
+.It Xo
+.Ic mv
+.Fl f
+.Ar drive subdisk ...
+.Xc
+Move the subdisk(s) to the specified drive.
+.It Xo
+.Ic printconfig
+.Op Ar file
+.Xc
+Write a copy of the current configuration to standard output or to 
+.Ar file
+if specified.
+.It Xo
+.Ic quit
+.Xc
+Exit 
+.Nm
+when running in interactive mode.  Normally this would be done 
+by entering the EOF character.
+.It Xo
+.Ic rename
+.Op Fl r
+.Ar drive | subdisk | plex | volume
+.Ar newname
+.Xc
+Change the name of the specified object.
+.It Xo
+.Ic rebuildparity
+.Ar plex
+.Xc
+Rebuild the parity blocks of a RAID-5 plex.
+.It Xo
+.Ic rm
+.Op Fl f
+.Op Fl r
+.Ar volume | plex | subdisk
+.Xc
+Remove an object.
+.It Xo
+.Ic saveconfig
+.Xc
+Save 
+.Nm
+configuration to disk after configuration failures.
+.It Xo
+.Ic setstate
+.Ar state
+.Ar volume | plex | subdisk | drive
+.Xc
+Set state without influencing other objects, for diagnostic purposes 
+only.
+.It Xo
+.Ic start
+.Xc 
+Read configuration from all vinum drives.
+.It Xo
+.Ic start
+.Ar volume | plex | subdisk
+.Xc
+Allow the system to access the objects.
 .El
 .Sh DESCRIPTION
 The
@@ -41,6 +140,7 @@
 directory containing device nodes for
 .Nm
 subdisks
+.El
 .Sh ENVIRONMENT
 .Bl -tag -width EDITOR
 .It Ev EDITOR
@@ -49,10 +149,9 @@
 .Nm vi .
 .El
 .Sh SEE ALSO
-.Xr strftime 3 ,
 .Xr gvinum 4 ,
-.Xr disklabel 8 ,
-.Xr newfs 8
+.Xr vinum 8 ,
+.Xr geom 8
 .Pp
 .Sh AUTHORS
 .An Lukas Ertl Aq le at freebsd.org
@@ -60,4 +159,8 @@
 The
 .Nm
 utility first appeared in 
-.Fx 5.3 .
+.Fx 5.3 .  The 
+.Nm vinum 
+utility, on which
+.Nm
+is based, was written by Greg Lehey.