summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-04-02 20:40:02 +0000
committerng0 <ng0@n0.is>2019-04-02 20:40:02 +0000
commitd89900c55d05a3924b6f858b1db84c8fdef91607 (patch)
treea93962828199d915f2c47606e8d4c3fd5a6393f0 /doc
parent173f529ff2bc63d61ab7964f79a7acb28f8ed645 (diff)
man: fix and adjust vpn
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-vpn.1126
1 files changed, 68 insertions, 58 deletions
diff --git a/doc/man/gnunet-vpn.1 b/doc/man/gnunet-vpn.1
index 76ce52cb4..e0fd2b78c 100644
--- a/doc/man/gnunet-vpn.1
+++ b/doc/man/gnunet-vpn.1
@@ -1,88 +1,98 @@
-.TH GNUNET\-VPN 1 "February 25, 2012" "GNUnet"
-.SH NAME
-gnunet\-vpn \- manually setup a GNUnet VPN tunnel
-.SH SYNOPSIS
-.B gnunet\-vpn
-.RI [ options ]
-.br
-.SH DESCRIPTION
-\fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the
-GNUnet network.
+.Dd February 25, 2012
+.Dt GNUNET-VPN 1
+.Sh NAME
+.Nm gnunet-vpn
+.Nd
+manually setup a GNUnet VPN tunnel
+.Sh SYNOPSIS
+.Nm
+.Op Fl 4 | \-ipv4
+.Op Fl 6 | \-ipv6
+.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
+.Op Fl d Ar TIME | Fl \-duration Ar TIME
+.Op Fl h | \-help
+.Op Fl i Ar IP | Fl \-ip Ar IP
+.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+.Op Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID
+.Op Fl s Ar NAME | Fl \-service= Ns Ar NAME
+.Op Fl t | \-tcp
+.Op Fl u | \-udp
+.Op Fl V | \-verbose
+.Op Fl v | \-version
+.Sh DESCRIPTION
+.Nm
+can be used to manually setup a VPN tunnel via the GNUnet network.
There are two main types of tunnels.
-Tunnels to an exit node which routes the traffic to the global
-Internet, and tunnels to a node that runs a service only within
-GNUnet.
+Tunnels to an exit node which routes the traffic to the global Internet, and tunnels to a node that runs a service only within GNUnet.
Depending on the type of tunnel, gnunet\-vpn takes different options.
-The "\-i" option is required for tunnels to an exit node, whereas the
-"\-p" and "\-s" options in conjunction with either "\-u" or "\-t" are
-required for tunnels to services.
+The "\-i" option is required for tunnels to an exit node, whereas the "\-p" and "\-s" options in conjunction with either "\-u" or "\-t" are required for tunnels to services.
For exit tunnels, both UDP and TCP traffic will be redirected.
-For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will
-be redirected.
+For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will be redirected.
The tool will display the IP address for this end of the tunnel.
-The address can be displayed as soon as it has been allocated, or only
-after ("\-a") the tunnel has been created.
-.SH OPTIONS
-.IP "\-4, \-\-ipv4"
+The address can be displayed as soon as it has been allocated, or only after ("\-a") the tunnel has been created.
+.Bl -tag -width Ds
+.It Fl 4 | \-ipv4
Desired IP address on this end of the tunnel should be an IPv4 address.
-.IP "\-6, \-\-ipv6"
+.It Fl 6 | \-ipv6
Desired IP address on this end of the tunnel should be an IPv6 address.
-.IP "\-c FILENAME, \-\-config=FILENAME"
+.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
Use the configuration file FILENAME.
-.IP "\-d TIME, \-\-duration TIME"
+.It Fl d Ar TIME | Fl \-duration Ar TIME
The mapping should be established for TIME.
-The value given must be a number followed by a space and a time unit,
-for example "500 ms".
+The value given must be a number followed by a space and a time unit, for example "500 ms".
Note that the quotes are required on the shell.
Default is 5 minutes.
-.IP "\-h, \-\-help"
+.It Fl h | \-help
Print short help on options.
-.IP "\-i IP, \-\-ip IP"
+.It Fl i Ar IP | Fl \-ip Ar IP
Tunnel should be to an exit node and connect to the given IPv4 or IPv6
IP address.
Note that you can specify an IPv6 address as the target here, even in
combination with "\-4" (4to6) and similarly you can specify an IPv4
address in combination with "\-6" (6to4).
-.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
+.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
Use LOGLEVEL for logging.
Valid values are DEBUG, INFO, WARNING and ERROR.
-.IP "\-p PEERID, \-\-peer=PEERID"
+.It Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID
Name of the peer offering the service to connect to.
Cannot be used in conjunction with "\-i", requires "\-s".
-.IP "\-s NAME, \-\-service=NAME"
+.It Fl s Ar NAME | Fl \-service= Ns Ar NAME
Name of the service running on the target peer.
Cannot be used in conjunction with "\-i", requires "\-p".
-.IP "\-t, \-\-tcp"
+.It Fl t | \-tcp
Service runs TCP.
Either "\-t" or "\-u" must be specified when using "\-s".
-.IP "\-u, \-\-udp"
+.It Fl u | \-udp
Service runs UDP.
Either "\-t" or "\-u" must be specified when using "\-s".
-.IP "\-V, \-\-verbose"
+.It Fl V | \-verbose
Be verbose.
-.IP "\-v, \-\-version"
+.It Fl v | \-version
Print GNUnet version number.
-.SH BUGS
-Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
-electronic mail to <gnunet\-developers@gnu.org>
-.SH SEE ALSO
-gnunet\-setup(1)
-The full documentation for
-.B gnunet
-is maintained as a Texinfo manual. If the
-.B info
-and
-.B gnunet
-programs are properly installed at your site, the command
-.IP
-.B info gnunet
-.PP
+.El
+.Sh SEE ALSO
+.Xr gnunet-setup 1
+.sp
+The full documentation for gnunet is maintained as a Texinfo manual.
+If the
+.Xr info 1
+and gnunet programs are properly installed at your site, the command
+.Pp
+.Dl info gnunet
+.Pp
should give you access to the complete handbook,
-.IP
-.B info gnunet-c-tutorial
-.PP
+.Pp
+.Dl info gnunet-c-tutorial
+.Pp
will give you access to a tutorial for developers.
-.PP
-Depending on your installation, this information is also
-available in
-\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
+.sp
+Depending on your installation, this information is also available in
+.Xr gnunet 7 and
+.Xr gnunet-c-tutorial 7 .
+.\".Sh HISTORY
+.\".Sh AUTHORS
+.Sh BUGS
+Report bugs by using
+.Lk https://bugs.gnunet.org
+or by sending electronic mail to
+.Aq Mt gnunet-developers@gnu.org .