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 April 26, 2004 28.Dt GGATEC 8 29.Os 30.Sh NAME 31.Nm ggatec 32.Nd "GEOM Gate network client and control utility" 33.Sh SYNOPSIS 34.Nm 35.Cm create 36.Op Fl n 37.Op Fl v 38.Op Fl o Cm ro | wo | rw 39.Op Fl p Ar port 40.Op Fl q Ar queue_size 41.Op Fl R Ar rcvbuf 42.Op Fl S Ar sndbuf 43.Op Fl s Ar sectorsize 44.Op Fl t Ar timeout 45.Op Fl u Ar unit 46.Ar host 47.Ar path 48.Nm 49.Cm attach 50.Op Fl n 51.Op Fl v 52.Op Fl o Cm ro | wo | rw 53.Op Fl p Ar port 54.Op Fl R Ar rcvbuf 55.Op Fl S Ar sndbuf 56.Fl u Ar unit 57.Ar host 58.Ar path 59.Nm 60.Cm destroy 61.Op Fl f 62.Fl u Ar unit 63.Nm 64.Cm list 65.Op Fl v 66.Op Fl u Ar unit 67.Sh DESCRIPTION 68The 69.Nm 70utility is a network client for GEOM Gate class. 71It is responsible for creation of 72.Nm ggate 73devices and forwarding I/O requests between 74.Nm geom_gate.ko 75kernel module and 76.Xr ggated 8 77network daemon. 78Available commands: 79.Bl -tag -width ".Cm destroy" 80.It Cm create 81Connect to given 82.Xr ggated 8 83daemon and create a 84.Nm ggate 85provider related to the given remote file or device. 86.It Cm attach 87Attach a worker process to an existing 88.Nm ggate 89provider (create a new connection to the 90.Xr ggated 8 91daemon). 92.It Cm destroy 93Destroy the given 94.Nm ggate 95provider. 96.It Cm list 97List 98.Nm ggate 99providers. 100.El 101.Pp 102Available options: 103.Bl -tag -width ".Fl s Cm ro | wo | rw" 104.It Fl f 105Forcibly destroy 106.Nm ggate 107provider (cancels all pending requests). 108.It Fl n 109Do not use 110.Dv TCP_NODELAY 111option on TCP sockets. 112.It Fl o Cm ro | wo | rw 113Specify permission to use when opening the file or device: read-only 114.Pq Cm ro , 115write-only 116.Pq Cm wo , 117or read-write 118.Pq Cm rw . 119Default is 120.Cm rw . 121.It Fl p Ar port 122Port to connect to on the remote host. 123Default is 3080. 124.It Fl q Ar queue_size 125Number of pending I/O requests that can be queued before they will 126start to be canceled. 127Default is 1024. 128.It Fl R Ar rcvbuf 129Size of receive buffer to use. 130Default is 131072 (128kB). 131.It Fl S Ar sndbuf 132Size of send buffer to use. 133Default is 131072 (128kB). 134.It Fl s Ar sectorsize 135Sector size for 136.Nm ggate 137provider. 138If not specified, it is taken from device, or set to 512 bytes for files. 139.It Fl t Ar timeout 140Number of seconds to wait before an I/O request will be canceled. 1410 means no timeout. 142Default is 30. 143.It Fl u Ar unit 144Unit number to use. 145.It Fl v 146Do not fork, run in foreground and print debug informations on standard 147output. 148.It Ar host 149Remote host to connect to. 150.It Ar path 151Path to a regular file or device. 152.El 153.Sh EXAMPLES 154Made use of CD-ROM device from remote host. 155.Bd -literal -offset indent 156server# cat /etc/gg.exports 157client RO /dev/acd0 158server# ggated 159 160client# ggatec create -o ro server /dev/acd0 161ggate0 162client# mount_cd9660 /dev/ggate0 /cdrom 163.Ed 164.Sh DIAGNOSTICS 165Exit status is 0 on success, or 1 if the command fails. 166To get details about the failure, 167.Nm 168should be called with the 169.Fl v 170option. 171.Sh SEE ALSO 172.Xr geom 4 , 173.Xr ggated 8 , 174.Xr ggatel 8 , 175.Xr mount_cd9660 8 176.Sh AUTHORS 177The 178.Nm 179utility as well as this manual page was written by 180.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org . 181