1.\" Copyright (c) 2004 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. 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. 12.\" 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 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd May 21, 2004 28.Dt GEOM 8 29.Os 30.Sh NAME 31.Nm geom 32.Nd "universal control utility for GEOM classes" 33.Sh SYNOPSIS 34.Nm 35.Ar class 36.Ar command 37.Op Ar options 38.Sh DESCRIPTION 39The 40.Nm 41utility is used to control various GEOM classes. 42A class has to be aware of 43.Xr geom 8 44comunication methods, but there are also some standard commands 45which can be used for existing, not 46.Xr geom 8 47aware classes. 48Here is the list of standard commands: 49.Bl -tag -width ".Cm unload" 50.It Cm help 51List all available commands for the given class. 52.It Cm list 53Print detailed information (within the given class) about all providers 54(if no additional arguments were specified) or the given providers. 55This command is only available if the given class exists in the kernel. 56.It Cm load 57Load the kernel module that implements the given class. 58This command is only available if the class doesn't yet exist in the kernel and 59the file 60.Pa geom_<class>.ko 61can be found in one of the directories specifed in 62.Va kern.module_path 63sysctl. 64.It Cm unload 65Unload the kernel module which implements the given class. 66This command is only available if the given class is loaded as a 67kernel module. 68.El 69.Pp 70Class-specific commands are implemented as shared libraries which 71are stored in 72.Pa /lib/geom/ 73directory and are loaded via 74.Xr dlopen 3 75function when the class name is known. 76When a class-specific shared library exists, a direct utility should also be 77available under the name of 78.Nm g<class> . 79.Pp 80Currently available classes which are aware of 81.Xr geom 8 : 82.Bl -bullet -offset indent -compact 83.It 84CONCAT 85.It 86NOP 87.It 88STRIPE 89.El 90.Sh EXAMPLES 91The following example shows how to set up a stripe on three disks for automatic 92configuration: 93.Bd -literal -offset indent 94geom stripe label -v -s 65536 data /dev/da0 /dev/da1 /dev/da2 95or: 96gstripe label -v -s 65536 data /dev/da0 /dev/da1 /dev/da2 97.Ed 98.Pp 99Print the list of all providers from the DISK class: 100.Bd -literal -offset indent 101geom disk list 102.Ed 103.Pp 104Unload a kernel module which implements the MD class: 105.Bd -literal -offset indent 106geom md unload 107.Ed 108.Sh DIAGNOSTICS 109Exit status is 0 on success, and 1 if the command fails. 110.Sh SEE ALSO 111.Xr geom 4 , 112.Xr gconcat 8 , 113.Xr gnop 8 , 114.Xr gstripe 8 115.Sh HISTORY 116The 117.Nm 118utility appeared in 119.Fx 5.3 . 120.Sh AUTHORS 121.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org 122