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 46.Xr geom 8 47unaware 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 geoms 54(if no additional arguments were specified) or the given geoms. 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 does not yet exist in the kernel and 59the file 60.Pa geom_ Ns Ao Ar class Ac Ns Pa .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 Ns Ar class . 79.Pp 80Currently available classes which are aware of 81.Xr geom 8 : 82.Pp 83.Bl -bullet -offset indent -compact 84.It 85CONCAT 86.It 87LABEL 88.It 89MIRROR 90.It 91NOP 92.It 93RAID3 94.It 95SHSEC 96.It 97STRIPE 98.El 99.Sh ENVIRONMENT 100The following environment variables affect the execution of 101.Nm : 102.Bl -tag -width ".Ev GEOM_LIBRARY_PATH" 103.It Ev GEOM_LIBRARY_PATH 104Specifies the path where shared libraries are stored instead of 105.Pa /lib/geom/ . 106.El 107.Sh EXIT STATUS 108Exit status is 0 on success, and 1 if the command fails. 109.Sh EXAMPLES 110The following example shows how to set up a stripe on three disks for automatic 111configuration: 112.Bd -literal -offset indent 113geom stripe label -v -s 65536 data /dev/da0 /dev/da1 /dev/da2 114or: 115gstripe label -v -s 65536 data /dev/da0 /dev/da1 /dev/da2 116.Ed 117.Pp 118Print the list of all providers from the DISK class: 119.Bd -literal -offset indent 120geom disk list 121.Ed 122.Pp 123Unload a kernel module which implements the MD class: 124.Bd -literal -offset indent 125geom md unload 126.Ed 127.Sh SEE ALSO 128.Xr geom 4 , 129.Xr gconcat 8 , 130.Xr glabel 8 , 131.Xr gmirror 8 , 132.Xr gnop 8 , 133.Xr graid3 8 , 134.Xr gshsec 8 , 135.Xr gstripe 8 136.Sh HISTORY 137The 138.Nm 139utility appeared in 140.Fx 5.3 . 141.Sh AUTHORS 142.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org 143