From 79048abe0228a3212509675af5b94dec020b7d67 Mon Sep 17 00:00:00 2001 From: pjd Date: Fri, 21 May 2004 22:12:24 +0000 Subject: Add manual pages for gconcat(8), gstripe(8) and gnop(8) utilities. Supported by: Wheel - Open Technologies - http://www.wheel.pl --- sbin/geom/class/concat/Makefile | 1 - sbin/geom/class/concat/gconcat.8 | 151 ++++++++++++++++++++++++++++++++++++++ sbin/geom/class/nop/Makefile | 1 - sbin/geom/class/nop/gnop.8 | 124 +++++++++++++++++++++++++++++++ sbin/geom/class/stripe/Makefile | 1 - sbin/geom/class/stripe/gstripe.8 | 155 +++++++++++++++++++++++++++++++++++++++ 6 files changed, 430 insertions(+), 3 deletions(-) create mode 100644 sbin/geom/class/concat/gconcat.8 create mode 100644 sbin/geom/class/nop/gnop.8 create mode 100644 sbin/geom/class/stripe/gstripe.8 (limited to 'sbin') diff --git a/sbin/geom/class/concat/Makefile b/sbin/geom/class/concat/Makefile index 16f81a5..b3a3e23 100644 --- a/sbin/geom/class/concat/Makefile +++ b/sbin/geom/class/concat/Makefile @@ -3,6 +3,5 @@ .PATH: ${.CURDIR}/../../misc CLASS= concat -NOMAN= notyet .include diff --git a/sbin/geom/class/concat/gconcat.8 b/sbin/geom/class/concat/gconcat.8 new file mode 100644 index 0000000..deb68a2 --- /dev/null +++ b/sbin/geom/class/concat/gconcat.8 @@ -0,0 +1,151 @@ +.\" Copyright (c) 2004 Pawel Jakub Dawidek +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd May 21, 2004 +.Dt GCONCAT 8 +.Os +.Sh NAME +.Nm gconcat +.Nd "disk concatenation control utility" +.Sh SYNOPSIS +.Nm +.Cm create +.Op Fl v +.Ar name +.Ar dev1 +.Ar dev2 +.Op Ar dev3 Op Ar ... +.Nm +.Cm label +.Op Fl v +.Ar name +.Ar dev1 +.Ar dev2 +.Op Ar dev3 Op Ar ... +.Nm +.Cm destroy +.Op Fl fv +.Ar name +.Op Ar name2 Op Ar ... +.Nm +.Cm clear +.Op Fl v +.Ar dev1 +.Op Ar dev2 Op Ar ... +.Nm +.Cm list +.Nm +.Cm load +.Op Fl v +.Nm +.Cm unload +.Op Fl v +.Sh DESCRIPTION +The +.Nm +utility is used for device concatenation configuration. +The concatenation can be configured using two different methods: +.Dq manual +or +.Dq automatic . +When using the +.Dq manual +method, no metadata are stored on the devices, so the concatenated +device has to be configured by hand every time it is needed. +The +.Dq automatic +method use on-disk metadata to detect devices. +Once devices are labeled, they will be automatically detected and +configured. +.Pp +The first argument to +.Nm +indicates an action to be performed: +.Bl -tag -width ".Cm destroy" +.It Cm create +Concatenate the given devices with specified +.Ar name . +This is the +.Dq manual +method. +The kernel module +.Pa geom_concat.ko +will be loaded if it is not loaded already. +.It Cm label +Concatenate the given devices with the specified +.Ar name . +This is the +.Dq automatic +method, where metadata are stored in every device's last sector. +The kernel module +.Pa geom_concat.ko +will be loaded if it is not loaded already. +.It Cm destroy +Turn off existing concatenate device by its +.Ar name . +.It Cm clear +Clear metadata on the given devices. +.It Cm list +List currently configured devices. +.It Cm load +Load +.Pa geom_concat.ko +kernel module. +.It Cm unload +Unload +.Pa geom_concat.ko +kernel module. +.El +.Pp +Additional options: +.Bl -tag -width indent +.It Fl f +Force the removal of the specified concatenated device. +.It Fl v +Be more verbose. +.El +.Sh EXAMPLES +The following example shows how to configure four disks for automatic +concatenation, create file system on it, and mount it: +.Bd -literal -offset indent +gconcat label -v data /dev/da0 /dev/da1 /dev/da2 /dev/da3 +newfs /dev/data.concat +mount /dev/data.concat /mnt +.Ed +.Sh DIAGNOSTICS +Exit status is 0 on success, and 1 if the command fails. +.Sh SEE ALSO +.Xr geom 4 , +.Xr mount 8 , +.Xr newfs 8 , +.Xr vinum 8 +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 5.3 . +.Sh AUTHORS +.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org diff --git a/sbin/geom/class/nop/Makefile b/sbin/geom/class/nop/Makefile index dc668aa..75a2037 100644 --- a/sbin/geom/class/nop/Makefile +++ b/sbin/geom/class/nop/Makefile @@ -3,6 +3,5 @@ .PATH: ${.CURDIR}/../../misc CLASS= nop -NOMAN= notyet .include diff --git a/sbin/geom/class/nop/gnop.8 b/sbin/geom/class/nop/gnop.8 new file mode 100644 index 0000000..c7e6a8a --- /dev/null +++ b/sbin/geom/class/nop/gnop.8 @@ -0,0 +1,124 @@ +.\" Copyright (c) 2004 Pawel Jakub Dawidek +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd May 21, 2004 +.Dt GNOP 8 +.Os +.Sh NAME +.Nm gnop +.Nd "control utility for NOP GEOM class" +.Sh SYNOPSIS +.Nm +.Cm create +.Op Fl v +.Op Fl f Ar failprob +.Ar dev1 +.Op Ar dev2 Op Ar ... +.Nm +.Cm configure +.Op Fl v +.Op Fl f Ar failprob +.Ar dev1 +.Op Ar dev2 Op Ar ... +.Nm +.Cm destroy +.Op Fl fv +.Ar dev1 +.Op Ar dev2 Op Ar ... +.Nm +.Cm list +.Nm +.Cm load +.Op Fl v +.Nm +.Cm unload +.Op Fl v +.Sh DESCRIPTION +The +.Nm +utility is used for setting up transparent providers on existing ones. +Its main purpose is testing other GEOM classes, as it allows force providers +removal and I/O errors symulation with a given probability. +It is also a good starting point for implementing new GEOM classes. +.Pp +The first argument to +.Nm +indicates an action to be performed: +.Bl -tag -width ".Cm configure" +.It Cm create +Setup a transparent provider on the given devices. +If operation succeded, new provider should appear with name +.Pa /dev/.nop . +The kernel module +.Pa geom_nop.ko +will be loaded if it is not loaded already. +.It Cm configure +Configure existing transparent provider. At the moment it is only used +for changing failure probability. +The kernel module +.Pa geom_nop.ko +will be loaded if it is not loaded already. +.It Cm destroy +Turn off transparent providers for the given devices. +.It Cm list +List currently configured providers. +.It Cm load +Load +.Pa geom_nop.ko +kernel module. +.It Cm unload +Unload +.Pa geom_nop.ko +kernel module. +.El +.Pp +Additional options: +.Bl -tag -width ".Fl f Ar failprob" +.It Fl f +Force the removal of the specified striped device. +.It Fl f Ar failprob +Specifies failure probability in percentage. +.It Fl v +Be more verbose. +.El +.Sh EXAMPLES +The following example shows how to create transparent provider for disk +.Pa /dev/da0 +with 50% failure probability. +.Bd -literal -offset indent +gnop create -v -f 50 /dev/da0 +.Ed +.Sh DIAGNOSTICS +Exit status is 0 on success, and 1 if the command fails. +.Sh SEE ALSO +.Xr geom 4 +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 5.3 . +.Sh AUTHORS +.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org diff --git a/sbin/geom/class/stripe/Makefile b/sbin/geom/class/stripe/Makefile index 35e9f13..53a35ff 100644 --- a/sbin/geom/class/stripe/Makefile +++ b/sbin/geom/class/stripe/Makefile @@ -3,6 +3,5 @@ .PATH: ${.CURDIR}/../../misc CLASS= stripe -NOMAN= notyet .include diff --git a/sbin/geom/class/stripe/gstripe.8 b/sbin/geom/class/stripe/gstripe.8 new file mode 100644 index 0000000..3c6c6da --- /dev/null +++ b/sbin/geom/class/stripe/gstripe.8 @@ -0,0 +1,155 @@ +.\" Copyright (c) 2004 Pawel Jakub Dawidek +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd May 21, 2004 +.Dt GSTRIPE 8 +.Os +.Sh NAME +.Nm gstripe +.Nd "control utility for striped devices" +.Sh SYNOPSIS +.Nm +.Cm create +.Op Fl v +.Op Fl s Ar stripesize +.Ar name +.Ar dev1 +.Ar dev2 +.Op Ar dev3 Op Ar ... +.Nm +.Cm label +.Op Fl v +.Op Fl s Ar stripesize +.Ar name +.Ar dev1 +.Ar dev2 +.Op Ar dev3 Op Ar ... +.Nm +.Cm destroy +.Op Fl fv +.Ar name +.Op Ar name2 Op Ar ... +.Nm +.Cm clear +.Op Fl v +.Ar dev1 +.Op Ar dev2 Op Ar ... +.Nm +.Cm list +.Nm +.Cm load +.Op Fl v +.Nm +.Cm unload +.Op Fl v +.Sh DESCRIPTION +The +.Nm +utility is used for setting up stripe on two or more disks. +The striped device can be configured using two different methods: +.Dq manual +or +.Dq automatic . +When using the +.Dq manual +method, no metadata are stored on the devices, so the striped +device has to be configured by hand every time it is needed. +The +.Dq automatic +method use on-disk metadata to detect devices. +Once devices are labeled, they will be automatically detected and +configured. +.Pp +The first argument to +.Nm +indicates an action to be performed: +.Bl -tag -width ".Cm destroy" +.It Cm create +Setup a striped device from the given devices with specified +.Ar name . +This is the +.Dq manual +method. +The kernel module +.Pa geom_stripe.ko +will be loaded if it is not loaded already. +.It Cm label +Setup a striped device from the given devices with the specified +.Ar name . +This is the +.Dq automatic +method, where metadata are stored in every device's last sector. +The kernel module +.Pa geom_stripe.ko +will be loaded if it is not loaded already. +.It Cm destroy +Turn off existing striped device by its +.Ar name . +.It Cm clear +Clear metadata on the given devices. +.It Cm list +List currently configured devices. +.It Cm load +Load +.Pa geom_stripe.ko +kernel module. +.It Cm unload +Unload +.Pa geom_stripe.ko +kernel module. +.El +.Pp +Additional options: +.Bl -tag -width ".Fl s Ar stripesize" +.It Fl f +Force the removal of the specified striped device. +.It Fl s Ar stripesize +Specifies size of stripe block. +.It Fl v +Be more verbose. +.El +.Sh EXAMPLES +The following example shows how to configure four disks for automatic +configuration, create file system on it, and mount it: +.Bd -literal -offset indent +gstripe label -v -s 65536 data /dev/da0 /dev/da1 /dev/da2 /dev/da3 +newfs /dev/data.concat +mount /dev/data.concat /mnt +.Ed +.Sh DIAGNOSTICS +Exit status is 0 on success, and 1 if the command fails. +.Sh SEE ALSO +.Xr geom 4 , +.Xr mount 8 , +.Xr newfs 8 , +.Xr vinum 8 +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 5.3 . +.Sh AUTHORS +.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org -- cgit v1.1