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