Add manual page for geom(8) utility.

Supported by:	Wheel - Open Technologies - http://www.wheel.pl

1 files changed, 121 insertions, 0 deletions

diff --git a/sbin/geom/core/geom.8 b/sbin/geom/core/geom.8
new file mode 100644
index 000000000000..4fc067a9e061
--- /dev/null
+++ b/sbin/geom/core/geom.8
@@ -0,0 +1,121 @@
+.\" Copyright (c) 2004 Pawel Jakub Dawidek <pjd@FreeBSD.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd May 21, 2004
+.Dt GEOM 8
+.Os
+.Sh NAME
+.Nm geom
+.Nd "universal control utility for GEOM classes"
+.Sh SYNOPSIS
+.Nm
+.Ar class
+.Ar command
+.Op Ar options
+.Sh DESCRIPTION
+The
+.Nm
+utility is used to control various GEOM classes.
+A class has to be aware of
+.Xr geom 8
+comunication methods, but there are also some standard commands
+which can be used for existing, not
+.Xr geom 8
+aware classes.
+Here is the list of standard commands:
+.Bl -tag -width ".Cm unload"
+.It Cm help
+List all available commands for the given class.
+.It Cm list
+Print detailed information (within the given class) about all providers
+(if no additional arguments were specified) or the given providers.
+This command is only available if the given class exists in the kernel.
+.It Cm load
+Load the kernel module that implements the given class.
+This command is only available if the class doesn't yet exist in the kernel and
+the file
+.Pa geom_<class>.ko
+can be found in one of the directories specifed in
+.Va kern.module_path
+sysctl.
+.It Cm unload
+Unload the kernel module which implements the given class.
+This command is only available if the given class is loaded as a
+kernel module.
+.El
+.Pp
+Class-specific commands are implemented as shared libraries which
+are stored in
+.Pa /lib/geom/
+directory and are loaded via
+.Xr dlopen 3
+function when the class name is known.
+When a class-specific shared library exists, a direct utility should also be
+available under the name of
+.Nm g<class> .
+.Pp
+Currently available classes which are aware of
+.Xr geom 8 :
+.Bl -bullet -offset indent -compact
+.It
+CONCAT
+.It
+NOP
+.It
+STRIPE
+.El
+.Sh EXAMPLES
+The following example shows how to set up a stripe on three disks for automatic
+configuration:
+.Bd -literal -offset indent
+geom stripe label -v -s 65536 data /dev/da0 /dev/da1 /dev/da2
+or:
+gstripe label -v -s 65536 data /dev/da0 /dev/da1 /dev/da2
+.Ed
+.Pp
+Print the list of all providers from the DISK class:
+.Bd -literal -offset indent
+geom disk list
+.Ed
+.Pp
+Unload a kernel module which implements the MD class:
+.Bd -literal -offset indent
+geom md unload
+.Ed
+.Sh DIAGNOSTICS
+Exit status is 0 on success, and 1 if the command fails.
+.Sh SEE ALSO
+.Xr geom 4 ,
+.Xr gconcat 8 ,
+.Xr gnop 8 ,
+.Xr gstripe 8
+.Sh HISTORY
+The
+.Nm
+utility appeared in
+.Fx 5.3 .
+.Sh AUTHORS
+.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org