1 .\" Copyright (c) 2004-2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd "universal control utility for GEOM classes"
57 utility is used to control various GEOM classes.
58 A class has to be aware of
60 comunication methods, but there are also some standard commands
61 which can be used for existing
64 Here is the list of standard commands:
65 .Bl -tag -width ".Cm status"
67 List all available commands for the given class.
69 Print detailed information (within the given class) about all geoms
70 (if no additional arguments were specified) or the given geoms.
71 This command is only available if the given class exists in the kernel.
73 Print general information (within the given class) about all geoms
74 (if no additional arguments were specified) or the given geoms.
75 This command is only available if the given class exists in the kernel.
77 Additional options include:
78 .Bl -tag -width ".Fl s"
80 Produce script-friendly output.
83 Load the kernel module that implements the given class.
84 This command is only available if the class does not yet exist in the kernel and
86 .Pa geom_ Ns Ao Ar class Ac Ns Pa .ko
87 can be found in one of the directories specifed in
91 Unload the kernel module which implements the given class.
92 This command is only available if the given class is loaded as a
96 Class-specific commands are implemented as shared libraries which
99 directory and are loaded via
101 function when the class name is known.
102 When a class-specific shared library exists, a direct utility should also be
103 available under the name of
106 Currently available classes which are aware of
109 .Bl -bullet -offset indent -compact
138 The following environment variables affect the execution of
140 .Bl -tag -width ".Ev GEOM_LIBRARY_PATH"
141 .It Ev GEOM_LIBRARY_PATH
142 Specifies the path where shared libraries are stored instead of
144 Multiple paths can be specified with a colon-separated list of paths.
147 Exit status is 0 on success, and 1 if the command fails.
149 The following example shows how to set up a stripe on three disks for automatic
151 .Bd -literal -offset indent
152 geom stripe label -v -s 65536 data /dev/da0 /dev/da1 /dev/da2
154 gstripe label -v -s 65536 data /dev/da0 /dev/da1 /dev/da2
157 Print the list of all providers from the DISK class:
158 .Bd -literal -offset indent
162 Unload a kernel module which implements the MD class:
163 .Bd -literal -offset indent
187 .An Pawel Jakub Dawidek Aq pjd@FreeBSD.org