Added manual page for gconcat utility.

Approved by:	scottl (mentor) (implicity)
Reviewed by:	simon

1 files changed, 141 insertions, 0 deletions

diff --git a/sbin/gconcat/gconcat.8 b/sbin/gconcat/gconcat.8
new file mode 100644
index 0000000..f3df0fe
--- /dev/null
+++ b/sbin/gconcat/gconcat.8
@@ -0,0 +1,141 @@
+.\" Copyright (c) 2004 Pawel Jakub Dawidek <pjd@FreeBSD.org>
+.\" 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 February 22, 2004
+.Dt GCONCAT 8
+.Os
+.Sh NAME
+.Nm gconcat
+.Nd "disk concatenation control utility"
+.Sh SYNOPSIS
+.Nm
+.Ar create
+.Op Fl v
+.Ar name
+.Ar dev1
+.Ar dev2
+.Op Ar dev3 Op Ar ...
+.Nm
+.Ar label
+.Op Fl v
+.Ar name
+.Ar dev1
+.Ar dev2
+.Op Ar dev3 Op Ar ...
+.Nm
+.Ar destroy
+.Op Fl fv
+.Ar name
+.Nm
+.Ar clear
+.Op Fl v
+.Ar dev1
+.Op Ar dev2 Op Ar ...
+.Nm
+.Ar list
+.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
+indicate an action to be performed:
+.Bl -tag -width ".Ar destroy"
+.It Ar 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 Ar 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 Ar destroy
+Turn off existing concatenate device by its
+.Ar name .
+.It Ar clear
+Clear metadata on given device(s).
+.It Ar list
+List currently configured device(s).
+.El
+.Pp
+Additional options:
+.Bl -tag -width ".Fl f"
+.It Fl f
+Force removal of specified concatenated device.
+.It Fl v
+Be more verbose.
+.El
+.Sh EXAMPLES
+The following example show how to configure four disks for automatic
+concatenation, create file system on it, and mount it:
+.Pp
+.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 AUTHORS
+.An -split
+The
+.Nm
+utility as well as this manual page was written by
+.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org .
+.Sh HISTORY
+The
+.Nm
+utility appeared in
+.Fx 5.3 .