geom.8 (fa9896e082a1046ff4fbc75fcba4d18d1f2efc19) geom.8 (a5770eb54f7d13717098b5c34cc2dd51d2772021)
1.\"-
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
1.\" Copyright (c) 2004-2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.

--- 13 unchanged lines hidden (view full) ---

22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd May 9, 2023
26.Dt GEOM 8
27.Os
28.Sh NAME
29.Nm geom
4.\" Copyright (c) 2004-2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\" notice, this list of conditions and the following disclaimer.

--- 13 unchanged lines hidden (view full) ---

25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd May 9, 2023
29.Dt GEOM 8
30.Os
31.Sh NAME
32.Nm geom
30.Nd "universal control utility for GEOM classes"
33.Nd universal control utility for GEOM classes
31.Sh SYNOPSIS
32.Nm
33.Ar class
34.Cm help
35.Nm
36.Ar class
37.Cm list
38.Op Fl a

--- 22 unchanged lines hidden (view full) ---

61utility is used to control various GEOM classes.
62A class has to be aware of
63.Nm
64communication methods, but there are also some standard commands
65which can be used for existing
66.Nm
67unaware classes.
68Here is the list of standard commands:
34.Sh SYNOPSIS
35.Nm
36.Ar class
37.Cm help
38.Nm
39.Ar class
40.Cm list
41.Op Fl a

--- 22 unchanged lines hidden (view full) ---

64utility is used to control various GEOM classes.
65A class has to be aware of
66.Nm
67communication methods, but there are also some standard commands
68which can be used for existing
69.Nm
70unaware classes.
71Here is the list of standard commands:
69.Bl -tag -width ".Cm status"
72.Bl -tag -width indent
70.It Cm help
71List all available commands for the given class.
72.It Cm list
73Print detailed information (within the given class) about all geoms
74(if no additional arguments were specified) or the given geoms.
75This command is only available if the given class exists in the kernel.
76Additional options include:
73.It Cm help
74List all available commands for the given class.
75.It Cm list
76Print detailed information (within the given class) about all geoms
77(if no additional arguments were specified) or the given geoms.
78This command is only available if the given class exists in the kernel.
79Additional options include:
77.Bl -tag -width ".Fl a"
80.Bl -tag -width "-a"
78.It Fl a
79Print information for geoms without providers.
80.El
81.It Cm status
82Print general information (within the given class) about all geoms
83(if no additional arguments were specified) or the given geoms.
84This command is only available if the given class exists in the kernel.
85.Pp
86Additional options include:
81.It Fl a
82Print information for geoms without providers.
83.El
84.It Cm status
85Print general information (within the given class) about all geoms
86(if no additional arguments were specified) or the given geoms.
87This command is only available if the given class exists in the kernel.
88.Pp
89Additional options include:
87.Bl -tag -width ".Fl s"
90.Bl -tag -width "-s"
88.It Fl a
91.It Fl a
89When used with -g, print status for geoms without providers.
92When used with
93.Fl g ,
94print status for geoms without providers.
90.It Fl g
91Report statuses for geoms instead of providers.
92.It Fl s
93Produce script-friendly output.
94.El
95.It Cm load
96Load the kernel module that implements the given class.
97This command is only available if the class does not yet exist in the kernel and

--- 4 unchanged lines hidden (view full) ---

102sysctl.
103.It Cm unload
104Unload the kernel module which implements the given class.
105This command is only available if the given class is loaded as a
106kernel module.
107.El
108.Pp
109Additional options include:
95.It Fl g
96Report statuses for geoms instead of providers.
97.It Fl s
98Produce script-friendly output.
99.El
100.It Cm load
101Load the kernel module that implements the given class.
102This command is only available if the class does not yet exist in the kernel and

--- 4 unchanged lines hidden (view full) ---

107sysctl.
108.It Cm unload
109Unload the kernel module which implements the given class.
110This command is only available if the given class is loaded as a
111kernel module.
112.El
113.Pp
114Additional options include:
110.Bl -tag -width ".Cm status"
115.Bl -tag -width indent
111.It Fl p Ar provider-name
112Print detailed information about the geom which provides
113.Ar provider-name .
114.It Fl t
115Display geoms hierarchy as a tree.
116.El
117.Pp
118Class-specific commands are implemented as shared libraries which

--- 46 unchanged lines hidden (view full) ---

165.It
166VINUM (deprecated)
167.It
168VIRSTOR
169.El
170.Sh ENVIRONMENT
171The following environment variables affect the execution of
172.Nm :
116.It Fl p Ar provider-name
117Print detailed information about the geom which provides
118.Ar provider-name .
119.It Fl t
120Display geoms hierarchy as a tree.
121.El
122.Pp
123Class-specific commands are implemented as shared libraries which

--- 46 unchanged lines hidden (view full) ---

170.It
171VINUM (deprecated)
172.It
173VIRSTOR
174.El
175.Sh ENVIRONMENT
176The following environment variables affect the execution of
177.Nm :
173.Bl -tag -width ".Ev GEOM_LIBRARY_PATH"
178.Bl -tag -width "GEOM_LIBRARY_PATH"
174.It Ev GEOM_LIBRARY_PATH
175Specifies the path where shared libraries are stored instead of
176.Pa /lib/geom/ .
177Multiple paths can be specified with a colon-separated list of paths.
178.El
179.Sh EXIT STATUS
180Exit status is 0 on success, and 1 if the command fails.
181.Sh EXAMPLES

--- 26 unchanged lines hidden (view full) ---

208.Xr gjournal 8 ,
209.Xr glabel 8 ,
210.Xr gmirror 8 ,
211.Xr gmountver 8 ,
212.Xr gmultipath 8 ,
213.Xr gnop 8 ,
214.Xr gpart 8 ,
215.Xr graid3 8 ,
179.It Ev GEOM_LIBRARY_PATH
180Specifies the path where shared libraries are stored instead of
181.Pa /lib/geom/ .
182Multiple paths can be specified with a colon-separated list of paths.
183.El
184.Sh EXIT STATUS
185Exit status is 0 on success, and 1 if the command fails.
186.Sh EXAMPLES

--- 26 unchanged lines hidden (view full) ---

213.Xr gjournal 8 ,
214.Xr glabel 8 ,
215.Xr gmirror 8 ,
216.Xr gmountver 8 ,
217.Xr gmultipath 8 ,
218.Xr gnop 8 ,
219.Xr gpart 8 ,
220.Xr graid3 8 ,
216.Xr gsched 8 ,
217.Xr gshsec 8 ,
218.Xr gstripe 8 ,
219.Xr gunion 8 ,
220.Xr gvinum 8 ,
221.Xr gvirstor 8
222.Sh HISTORY
223The
224.Nm
225utility appeared in
226.Fx 5.3 .
227.Sh AUTHORS
228.An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org
221.Xr gshsec 8 ,
222.Xr gstripe 8 ,
223.Xr gunion 8 ,
224.Xr gvinum 8 ,
225.Xr gvirstor 8
226.Sh HISTORY
227The
228.Nm
229utility appeared in
230.Fx 5.3 .
231.Sh AUTHORS
232.An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org