Index: head/sbin/ggate/ggatec/ggatec.8 =================================================================== --- head/sbin/ggate/ggatec/ggatec.8 (revision 285537) +++ head/sbin/ggate/ggatec/ggatec.8 (revision 285538) @@ -1,180 +1,180 @@ .\" 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 April 2, 2015 +.Dd July 14, 2015 .Dt GGATEC 8 .Os .Sh NAME .Nm ggatec .Nd "GEOM Gate network client and control utility" .Sh SYNOPSIS .Nm .Cm create .Op Fl n .Op Fl v .Op Fl o Cm ro | wo | rw .Op Fl p Ar port .Op Fl q Ar queue_size .Op Fl R Ar rcvbuf .Op Fl S Ar sndbuf .Op Fl s Ar sectorsize .Op Fl t Ar timeout .Op Fl u Ar unit .Ar host .Ar path .Nm .Cm rescue .Op Fl n .Op Fl v .Op Fl o Cm ro | wo | rw .Op Fl p Ar port .Op Fl R Ar rcvbuf .Op Fl S Ar sndbuf .Fl u Ar unit .Ar host .Ar path .Nm .Cm destroy .Op Fl f .Fl u Ar unit .Nm .Cm list .Op Fl v .Op Fl u Ar unit .Sh DESCRIPTION The .Nm utility is a network client for the GEOM Gate class. It is responsible for the creation of .Nm ggate devices and forwarding I/O requests between the -.Nm geom_gate.ko -kernel module and the +.Nm GEOM Gate +kernel subsystem and the .Xr ggated 8 network daemon. Available commands: .Bl -tag -width ".Cm destroy" .It Cm create Connect to a .Xr ggated 8 daemon on the specified host and create a .Nm ggate provider for the specified remote file or device. .It Cm rescue Create a new connection after the .Nm process has died or been killed. The new connection to the .Xr ggated 8 daemon handles pending and future requests. .It Cm destroy Destroy the given .Nm ggate provider. .It Cm list List .Nm ggate providers. .El .Pp Available options: .Bl -tag -width ".Fl s Cm ro | wo | rw" .It Fl f Forcibly destroy .Nm ggate provider (cancels all pending requests). .It Fl n Do not use .Dv TCP_NODELAY option on TCP sockets. .It Fl o Cm ro | wo | rw -Specify permission to use when opening the file or device: read-only +Specify permissions to use when opening the file or device: read-only .Pq Cm ro , write-only .Pq Cm wo , or read-write .Pq Cm rw . Default is .Cm rw . .It Fl p Ar port Port to connect to on the remote host. Default is 3080. .It Fl q Ar queue_size Number of pending I/O requests that can be queued before they will start to be canceled. Default is 1024. .It Fl R Ar rcvbuf Size of receive buffer to use. Default is 131072 (128kB). .It Fl S Ar sndbuf Size of send buffer to use. Default is 131072 (128kB). .It Fl s Ar sectorsize Sector size for .Nm ggate provider. -If not specified, it is taken from device, or set to 512 bytes for files. +If not specified, it is taken from the device, or set to 512 bytes for files. .It Fl t Ar timeout Number of seconds to wait before an I/O request will be canceled. Default is 0, which means no timeout. .It Fl u Ar unit Unit number to use. .It Fl v Do not fork, run in foreground and print debug information on standard output. .It Ar host Remote host to connect to. .It Ar path Path to a regular file or device. .El .Sh EXIT STATUS Exit status is 0 on success, or 1 if the command fails. To get details about the failure, .Nm should be called with the .Fl v option. .Sh EXAMPLES Use a CD-ROM device on a remote host. .Bd -literal -offset indent server# cat /etc/gg.exports client RO /dev/acd0 server# ggated client# ggatec create -o ro server /dev/acd0 ggate0 client# mount_cd9660 /dev/ggate0 /cdrom .Ed .Sh SEE ALSO .Xr geom 4 , .Xr ggated 8 , .Xr ggatel 8 , .Xr mount_cd9660 8 .Sh AUTHORS The .Nm utility as well as this manual page was written by .An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org . Index: head/sbin/ggate/ggated/ggated.8 =================================================================== --- head/sbin/ggate/ggated/ggated.8 (revision 285537) +++ head/sbin/ggate/ggated/ggated.8 (revision 285538) @@ -1,111 +1,111 @@ .\" 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 April 29, 2004 +.Dd July 14, 2015 .Dt GGATED 8 .Os .Sh NAME .Nm ggated .Nd "GEOM Gate network daemon" .Sh SYNOPSIS .Nm .Op Fl h .Op Fl n .Op Fl v .Op Fl a Ar address .Op Fl p Ar port .Op Fl R Ar rcvbuf .Op Fl S Ar sndbuf .Op Ar "exports file" .Sh DESCRIPTION The .Nm -utility is a network server for GEOM Gate class. +utility is a network server for the GEOM Gate class. It runs on a server machine to service GEOM Gate requests from workers placed on a client machine. -Keep in mind, that connection between +Keep in mind, that connections between .Xr ggatec 8 and .Nm -is not encrypted. +are not encrypted. .Pp Available options: .Bl -tag -width ".Ar exports\ file" .It Fl a Ar address Specifies an IP address to bind to. .It Fl h Print available options. .It Fl n Do not use .Dv TCP_NODELAY option on TCP sockets. .It Fl p Ar port Port on which .Nm -listens for connection. +listens for connections. Default is 3080. .It Fl R Ar rcvbuf Size of receive buffer to use. Default is 131072 (128kB). .It Fl S Ar sndbuf Size of send buffer to use. Default is 131072 (128kB). .It Fl v -Do not fork, run in foreground and print debug informations on standard +Do not fork, run in foreground and print debug information on standard output. .It Ar "exports file" An alternate location for the exports file. .El .Pp The format of an exports file is as follows: .Bd -literal -offset indent 1.2.3.4 RO /dev/acd0 1.2.3.0/24 RW /tmp/test.img hostname WO /tmp/image .Ed .Sh EXIT STATUS Exit status is 0 on success, or 1 if the command fails. To get details about the failure, .Nm should be called with the .Fl v option. .Sh EXAMPLES Export CD-ROM device and a file: .Bd -literal -offset indent # echo "1.2.3.0/24 RO /dev/acd0" > /etc/gg.exports # echo "client RW /image" >> /etc/gg.exports # ggated .Ed .Sh SEE ALSO .Xr geom 4 , .Xr ggatec 8 , .Xr ggatel 8 .Sh AUTHORS The .Nm utility as well as this manual page was written by .An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org . Index: head/sbin/ggate/ggatel/ggatel.8 =================================================================== --- head/sbin/ggate/ggatel/ggatel.8 (revision 285537) +++ head/sbin/ggate/ggatel/ggatel.8 (revision 285538) @@ -1,157 +1,158 @@ .\" 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 April 9, 2015 +.Dd July 14, 2015 .Dt GGATEL 8 .Os .Sh NAME .Nm ggatel .Nd "GEOM Gate local control utility" .Sh SYNOPSIS .Nm .Cm create .Op Fl v .Op Fl o Cm ro | wo | rw .Op Fl s Ar sectorsize .Op Fl t Ar timeout .Op Fl u Ar unit .Ar path .Nm .Cm destroy .Op Fl f .Fl u Ar unit .Nm .Cm list .Op Fl v .Op Fl u Ar unit .Nm .Cm rescue .Op Fl v .Op Fl o Cm ro | wo | rw .Fl u Ar unit .Ar path .Sh DESCRIPTION The .Nm utility is a local GEOM Gate class consumer. It can be used as a replacement for .Xr md 4 devices or as a .Dq GEOMificator for non GEOM-aware devices, but it was mainly created as an example -on how to use and how to communicate with the GEOM Gate kernel module. +on how to use and how to communicate with the GEOM Gate kernel subsystem. .Pp Available commands: .Bl -tag -width ".Cm destroy" .It Cm create Create a .Nm ggate provider related to the given regular file or device. .It Cm destroy Destroy the given .Nm ggate provider. .It Cm list List .Nm ggate providers. .It Cm rescue Take over a previously created provider and handle pending and future requests. This is useful if the initial .Nm -process died. To prevent data loss, the given path must lead to the +process died. +To prevent data loss, the given path must lead to the regular file or device that was used to create the provider. .El .Pp Available options: .Bl -tag -width ".Fl s Cm ro | wo | rw" .It Fl f Forcibly destroy .Nm ggate provider (cancels all pending requests). .It Fl o Cm ro | wo | rw -Specify permission to use when opening the file or device: read-only +Specify permissions to use when opening the file or device: read-only .Pq Cm ro , write-only .Pq Cm wo , or read-write .Pq Cm rw . Default is .Cm rw . .It Fl s Ar sectorsize Sector size for .Nm ggate provider. -If not specified, it is taken from device, or set to 512 bytes for files. +If not specified, it is taken from the device, or set to 512 bytes for files. .It Fl t Ar timeout Number of seconds to wait before an I/O request will be canceled. 0 means no timeout. Default is 30. .It Fl u Ar unit Unit number to use. .It Fl v Do not fork, run in foreground and print debug information on standard output. .It Ar path Path to a regular file or device. .El .Sh EXIT STATUS Exit status is 0 on success, or 1 if the command fails. To get details about the failure, .Nm should be called with the .Fl v option. .Sh EXAMPLES .Dq GEOMify the .Dq Li fd0 device and use .Xr gbde 8 -to encrypt data on a floppy. +to encrypt data on a floppy disk. .Bd -literal -offset indent ggatel create -u 5 /dev/fd0 gbde init /dev/ggate5 gbde attach ggate5 newfs /dev/ggate5.bde mount /dev/ggate5.bde /secret cp /private/foo /secret/ umount /secret gbde detach ggate5 ggatel destroy -u 5 .Ed .Sh SEE ALSO .Xr geom 4 , .Xr gbde 8 , .Xr ggatec 8 , .Xr ggated 8 , .Xr mount 8 , .Xr newfs 8 .Sh AUTHORS The .Nm utility as well as this manual page was written by .An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org .