xref: /freebsd/sbin/ggate/ggated/ggated.8 (revision 2f1217877e155a8a7de97e74eb7e82096a5ef316)
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 29, 2004
28.Dt GGATED 8
29.Os
30.Sh NAME
31.Nm ggated
32.Nd "GEOM Gate network daemon"
33.Sh SYNOPSIS
34.Nm
35.Op Fl h
36.Op Fl n
37.Op Fl v
38.Op Fl a Ar address
39.Op Fl p Ar port
40.Op Fl R Ar rcvbuf
41.Op Fl S Ar sndbuf
42.Op Ar "exports file"
43.Sh DESCRIPTION
44The
45.Nm
46utility is a network server for GEOM Gate class.
47It runs on a server machine to service GEOM Gate requests from workers
48placed on a client machine.
49Keep in mind, that connection between
50.Xr ggatec 8
51and
52.Nm
53is not encrypted.
54.Pp
55Available options:
56.Bl -tag -width ".Ar exports\ file"
57.It Fl a Ar address
58Specifies an IP address to bind to.
59.It Fl h
60Print available options.
61.It Fl n
62Do not use
63.Dv TCP_NODELAY
64option on TCP sockets.
65.It Fl p Ar port
66Port on which
67.Nm
68listens for connection.
69Default is 3080.
70.It Fl R Ar rcvbuf
71Size of receive buffer to use.
72Default is 131072 (128kB).
73.It Fl S Ar sndbuf
74Size of send buffer to use.
75Default is 131072 (128kB).
76.It Fl v
77Do not fork, run in foreground and print debug informations on standard
78output.
79.It Ar "exports file"
80An alternate location for the exports file.
81.El
82.Pp
83The format of an exports file is as follows:
84.Bd -literal -offset indent
851.2.3.4		RO	/dev/acd0
861.2.3.0/24	RW	/tmp/test.img
87hostname	WO	/tmp/image
88.Ed
89.Sh EXIT STATUS
90Exit status is 0 on success, or 1 if the command fails.
91To get details about the failure,
92.Nm
93should be called with the
94.Fl v
95option.
96.Sh EXAMPLES
97Export CD-ROM device and a file:
98.Bd -literal -offset indent
99# echo "1.2.3.0/24 RO /dev/acd0" > /etc/gg.exports
100# echo "client RW /image" >> /etc/gg.exports
101# ggated
102.Ed
103.Sh SEE ALSO
104.Xr geom 4 ,
105.Xr ggatec 8 ,
106.Xr ggatel 8
107.Sh AUTHORS
108The
109.Nm
110utility as well as this manual page was written by
111.An Pawel Jakub Dawidek Aq Mt pjd@FreeBSD.org .
112