diff options
author | Nils Gillmann <ng0@n0.is> | 2018-05-04 19:57:38 +0000 |
---|---|---|
committer | Nils Gillmann <ng0@n0.is> | 2018-05-04 19:57:38 +0000 |
commit | c3c9fef22fa6e4657c3fc862bad365b440ee2305 (patch) | |
tree | a19406f086fd3a1c059c66b6916b78148f83d5bb /doc/man/gnunet-vpn.1 | |
parent | 295384b197a85ebfb1cb7bbe5d1b02af4c40d342 (diff) | |
download | gnunet-c3c9fef22fa6e4657c3fc862bad365b440ee2305.tar.gz gnunet-c3c9fef22fa6e4657c3fc862bad365b440ee2305.zip |
Follow-up commit to format most of the other man pages code.
Signed-off-by: Nils Gillmann <ng0@n0.is>
Diffstat (limited to 'doc/man/gnunet-vpn.1')
-rw-r--r-- | doc/man/gnunet-vpn.1 | 30 |
1 files changed, 24 insertions, 6 deletions
diff --git a/doc/man/gnunet-vpn.1 b/doc/man/gnunet-vpn.1 index 68a5905d8..6b1b11f7b 100644 --- a/doc/man/gnunet-vpn.1 +++ b/doc/man/gnunet-vpn.1 | |||
@@ -9,9 +9,20 @@ gnunet\-vpn \- manually setup a GNUnet VPN tunnel | |||
9 | .br | 9 | .br |
10 | 10 | ||
11 | .SH DESCRIPTION | 11 | .SH DESCRIPTION |
12 | \fBgnunet\-vpn\fP 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. 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. For exit tunnels, both UDP and TCP traffic will be redirected. For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will be redirected. | 12 | \fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the |
13 | GNUnet network. There are two main types of tunnels. Tunnels to an | ||
14 | exit node which routes the traffic to the global Internet, and tunnels | ||
15 | to a node that runs a service only within GNUnet. Depending on the | ||
16 | type of tunnel, gnunet\-vpn takes different options. The "\-i" option | ||
17 | is required for tunnels to an exit node, whereas the "\-p" and "\-s" | ||
18 | options in conjunction with either "\-u" or "\-t" are required for | ||
19 | tunnels to services. For exit tunnels, both UDP and TCP traffic will | ||
20 | be redirected. For service tunnels, either UDP ("\-u") or TCP ("\-t") | ||
21 | traffic will be redirected. | ||
13 | 22 | ||
14 | 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. | 23 | The tool will display the IP address for this end of the tunnel. The |
24 | address can be displayed as soon as it has been allocated, or only | ||
25 | after ("\-a") the tunnel has been created. | ||
15 | 26 | ||
16 | .SH OPTIONS | 27 | .SH OPTIONS |
17 | .B | 28 | .B |
@@ -25,22 +36,29 @@ Desired IP address on this end of the tunnel should be an IPv6 address. | |||
25 | Use the configuration file FILENAME. | 36 | Use the configuration file FILENAME. |
26 | .B | 37 | .B |
27 | .IP "\-d TIME, \-\-duration TIME" | 38 | .IP "\-d TIME, \-\-duration TIME" |
28 | 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". Note that the quotes are required on the shell. Default is 5 minutes. | 39 | The mapping should be established for TIME. The value given must be a |
40 | number followed by a space and a time unit, for example "500 ms". | ||
41 | Note that the quotes are required on the shell. Default is 5 minutes. | ||
29 | .B | 42 | .B |
30 | .IP "\-h, \-\-help" | 43 | .IP "\-h, \-\-help" |
31 | Print short help on options. | 44 | Print short help on options. |
32 | .B | 45 | .B |
33 | .IP "\-i IP, \-\-ip IP" | 46 | .IP "\-i IP, \-\-ip IP" |
34 | 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). | 47 | Tunnel should be to an exit node and connect to the given IPv4 or IPv6 |
48 | IP address. Note that you can specify an IPv6 address as the target | ||
49 | here, even in combination with "\-4" (4to6) and similarly you can | ||
50 | specify an IPv4 address in combination with "\-6" (6to4). | ||
35 | .B | 51 | .B |
36 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 52 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
37 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 53 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. |
38 | .B | 54 | .B |
39 | .IP "\-p PEERID, \-\-peer=PEERID" | 55 | .IP "\-p PEERID, \-\-peer=PEERID" |
40 | Name of the peer offering the service to connect to. Cannot be used in conjunction with "\-i", requires "\-s". | 56 | Name of the peer offering the service to connect to. Cannot be used |
57 | in conjunction with "\-i", requires "\-s". | ||
41 | .B | 58 | .B |
42 | .IP "\-s NAME, \-\-service=NAME" | 59 | .IP "\-s NAME, \-\-service=NAME" |
43 | Name of the service running on the target peer. Cannot be used in conjunction with "\-i", requires "\-p". | 60 | Name of the service running on the target peer. Cannot be used in |
61 | conjunction with "\-i", requires "\-p". | ||
44 | .B | 62 | .B |
45 | .IP "\-t, \-\-tcp" | 63 | .IP "\-t, \-\-tcp" |
46 | Service runs TCP. Either "\-t" or "\-u" must be specified when using "\-s". | 64 | Service runs TCP. Either "\-t" or "\-u" must be specified when using "\-s". |