sbin/ggate/ggated/ggated.8

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