aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-vpn.1
diff options
context:
space:
mode:
authorNils Gillmann <ng0@n0.is>2018-10-26 16:08:14 +0000
committerNils Gillmann <ng0@n0.is>2018-10-26 16:08:14 +0000
commit4be442739c7f6745848a2f5544a59592f06a6cb3 (patch)
treef8ef204dd70d64d4fc8349551f584fb75323abd9 /doc/man/gnunet-vpn.1
parent19fe19822004e33b89d2f71c154c28f8eff1c936 (diff)
downloadgnunet-4be442739c7f6745848a2f5544a59592f06a6cb3.tar.gz
gnunet-4be442739c7f6745848a2f5544a59592f06a6cb3.zip
Start fixing the man pages via linting and style.
Signed-off-by: Nils Gillmann <ng0@n0.is>
Diffstat (limited to 'doc/man/gnunet-vpn.1')
-rw-r--r--doc/man/gnunet-vpn.170
1 files changed, 36 insertions, 34 deletions
diff --git a/doc/man/gnunet-vpn.1 b/doc/man/gnunet-vpn.1
index f4e445c21..838624d98 100644
--- a/doc/man/gnunet-vpn.1
+++ b/doc/man/gnunet-vpn.1
@@ -1,29 +1,27 @@
1.TH GNUNET\-VPN 1 "25 Feb 2012" "GNUnet" 1.TH GNUNET\-VPN 1 "February 25, 2012" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-vpn \- manually setup a GNUnet VPN tunnel 3gnunet\-vpn \- manually setup a GNUnet VPN tunnel
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-vpn 5.B gnunet\-vpn
8.RI [ options ] 6.RI [ options ]
9.br 7.br
10
11.SH DESCRIPTION 8.SH DESCRIPTION
12\fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the 9\fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the
13GNUnet network. There are two main types of tunnels. Tunnels to an 10GNUnet network.
14exit node which routes the traffic to the global Internet, and tunnels 11There are two main types of tunnels.
15to a node that runs a service only within GNUnet. Depending on the 12Tunnels to an exit node which routes the traffic to the global
16type of tunnel, gnunet\-vpn takes different options. The "\-i" option 13Internet, and tunnels to a node that runs a service only within
17is required for tunnels to an exit node, whereas the "\-p" and "\-s" 14GNUnet.
18options in conjunction with either "\-u" or "\-t" are required for 15Depending on the type of tunnel, gnunet\-vpn takes different options.
19tunnels to services. For exit tunnels, both UDP and TCP traffic will 16The "\-i" option is required for tunnels to an exit node, whereas the
20be redirected. For service tunnels, either UDP ("\-u") or TCP ("\-t") 17"\-p" and "\-s" options in conjunction with either "\-u" or "\-t" are
21traffic will be redirected. 18required for tunnels to services.
22 19For exit tunnels, both UDP and TCP traffic will be redirected.
23The tool will display the IP address for this end of the tunnel. The 20For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will
24address can be displayed as soon as it has been allocated, or only 21be redirected.
22The tool will display the IP address for this end of the tunnel.
23The address can be displayed as soon as it has been allocated, or only
25after ("\-a") the tunnel has been created. 24after ("\-a") the tunnel has been created.
26
27.SH OPTIONS 25.SH OPTIONS
28.B 26.B
29.IP "\-4, \-\-ipv4" 27.IP "\-4, \-\-ipv4"
@@ -36,46 +34,50 @@ Desired IP address on this end of the tunnel should be an IPv6 address.
36Use the configuration file FILENAME. 34Use the configuration file FILENAME.
37.B 35.B
38.IP "\-d TIME, \-\-duration TIME" 36.IP "\-d TIME, \-\-duration TIME"
39The mapping should be established for TIME. The value given must be a 37The mapping should be established for TIME.
40number followed by a space and a time unit, for example "500 ms". 38The value given must be a number followed by a space and a time unit,
41Note that the quotes are required on the shell. Default is 5 minutes. 39for example "500 ms".
40Note that the quotes are required on the shell.
41Default is 5 minutes.
42.B 42.B
43.IP "\-h, \-\-help" 43.IP "\-h, \-\-help"
44Print short help on options. 44Print short help on options.
45.B 45.B
46.IP "\-i IP, \-\-ip IP" 46.IP "\-i IP, \-\-ip IP"
47Tunnel should be to an exit node and connect to the given IPv4 or IPv6 47Tunnel should be to an exit node and connect to the given IPv4 or IPv6
48IP address. Note that you can specify an IPv6 address as the target 48IP address.
49here, even in combination with "\-4" (4to6) and similarly you can 49Note that you can specify an IPv6 address as the target here, even in
50specify an IPv4 address in combination with "\-6" (6to4). 50combination with "\-4" (4to6) and similarly you can specify an IPv4
51address in combination with "\-6" (6to4).
51.B 52.B
52.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 53.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
53Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 54Use LOGLEVEL for logging.
55Valid values are DEBUG, INFO, WARNING and ERROR.
54.B 56.B
55.IP "\-p PEERID, \-\-peer=PEERID" 57.IP "\-p PEERID, \-\-peer=PEERID"
56Name of the peer offering the service to connect to. Cannot be used 58Name of the peer offering the service to connect to.
57in conjunction with "\-i", requires "\-s". 59Cannot be used in conjunction with "\-i", requires "\-s".
58.B 60.B
59.IP "\-s NAME, \-\-service=NAME" 61.IP "\-s NAME, \-\-service=NAME"
60Name of the service running on the target peer. Cannot be used in 62Name of the service running on the target peer.
61conjunction with "\-i", requires "\-p". 63Cannot be used in conjunction with "\-i", requires "\-p".
62.B 64.B
63.IP "\-t, \-\-tcp" 65.IP "\-t, \-\-tcp"
64Service runs TCP. Either "\-t" or "\-u" must be specified when using "\-s". 66Service runs TCP.
67Either "\-t" or "\-u" must be specified when using "\-s".
65.B 68.B
66.IP "\-u, \-\-udp" 69.IP "\-u, \-\-udp"
67Service runs UDP. Either "\-t" or "\-u" must be specified when using "\-s". 70Service runs UDP.
71Either "\-t" or "\-u" must be specified when using "\-s".
68.B 72.B
69.IP "\-V, \-\-verbose" 73.IP "\-V, \-\-verbose"
70Be verbose. 74Be verbose.
71.B 75.B
72.IP "\-v, \-\-version" 76.IP "\-v, \-\-version"
73Print GNUnet version number. 77Print GNUnet version number.
74
75
76.SH BUGS 78.SH BUGS
77Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 79Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
78 80electronic mail to <gnunet\-developers@gnu.org>
79.SH SEE ALSO 81.SH SEE ALSO
80gnunet\-setup(1) 82gnunet\-setup(1)
81The full documentation for 83The full documentation for