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
27 .Dd September 14, 2018
32 .Nd "universal control utility for GEOM classes"
63 utility is used to control various GEOM classes.
64 A class has to be aware of
66 communication methods, but there are also some standard commands
67 which can be used for existing
70 Here is the list of standard commands:
71 .Bl -tag -width ".Cm status"
73 List all available commands for the given class.
75 Print detailed information (within the given class) about all geoms
76 (if no additional arguments were specified) or the given geoms.
77 This command is only available if the given class exists in the kernel.
78 Additional options include:
79 .Bl -tag -width ".Fl a"
81 Print information for geoms without providers.
84 Print general information (within the given class) about all geoms
85 (if no additional arguments were specified) or the given geoms.
86 This command is only available if the given class exists in the kernel.
88 Additional options include:
89 .Bl -tag -width ".Fl s"
91 When used with -g, print status for geoms without providers.
93 Report statuses for geoms instead of providers.
95 Produce script-friendly output.
98 Load the kernel module that implements the given class.
99 This command is only available if the class does not yet exist in the kernel and
101 .Pa geom_ Ns Ao Ar class Ac Ns Pa .ko
102 can be found in one of the directories specified in
106 Unload the kernel module which implements the given class.
107 This command is only available if the given class is loaded as a
111 Additional options include:
112 .Bl -tag -width ".Cm status"
113 .It Fl p Ar provider-name
114 Print detailed information about the geom which provides
117 Display geoms hierarchy as a tree.
120 Class-specific commands are implemented as shared libraries which
123 directory and are loaded via
125 function when the class name is known.
126 When a class-specific shared library exists, a direct utility should also be
127 available under the name of
130 Currently available classes which are aware of
133 .Bl -bullet -offset indent -compact
168 The following environment variables affect the execution of
170 .Bl -tag -width ".Ev GEOM_LIBRARY_PATH"
171 .It Ev GEOM_LIBRARY_PATH
172 Specifies the path where shared libraries are stored instead of
174 Multiple paths can be specified with a colon-separated list of paths.
177 Exit status is 0 on success, and 1 if the command fails.
179 The following example shows how to set up a stripe on three disks for automatic
181 .Bd -literal -offset indent
182 geom stripe label -v -s 65536 data /dev/da0 /dev/da1 /dev/da2
184 gstripe label -v -s 65536 data /dev/da0 /dev/da1 /dev/da2
187 Print the list of all providers from the DISK class:
188 .Bd -literal -offset indent
192 Unload a kernel module which implements the MD class:
193 .Bd -literal -offset indent
220 .An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org