diff options
author | ng0 <ng0@n0.is> | 2019-04-02 20:40:02 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-04-02 20:40:02 +0000 |
commit | d89900c55d05a3924b6f858b1db84c8fdef91607 (patch) | |
tree | a93962828199d915f2c47606e8d4c3fd5a6393f0 /doc/man/gnunet-vpn.1 | |
parent | 173f529ff2bc63d61ab7964f79a7acb28f8ed645 (diff) | |
download | gnunet-d89900c55d05a3924b6f858b1db84c8fdef91607.tar.gz gnunet-d89900c55d05a3924b6f858b1db84c8fdef91607.zip |
man: fix and adjust vpn
Diffstat (limited to 'doc/man/gnunet-vpn.1')
-rw-r--r-- | doc/man/gnunet-vpn.1 | 126 |
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 @@ | |||
1 | .TH GNUNET\-VPN 1 "February 25, 2012" "GNUnet" | 1 | .Dd February 25, 2012 |
2 | .SH NAME | 2 | .Dt GNUNET-VPN 1 |
3 | gnunet\-vpn \- manually setup a GNUnet VPN tunnel | 3 | .Sh NAME |
4 | .SH SYNOPSIS | 4 | .Nm gnunet-vpn |
5 | .B gnunet\-vpn | 5 | .Nd |
6 | .RI [ options ] | 6 | manually setup a GNUnet VPN tunnel |
7 | .br | 7 | .Sh SYNOPSIS |
8 | .SH DESCRIPTION | 8 | .Nm |
9 | \fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the | 9 | .Op Fl 4 | \-ipv4 |
10 | GNUnet network. | 10 | .Op Fl 6 | \-ipv6 |
11 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
12 | .Op Fl d Ar TIME | Fl \-duration Ar TIME | ||
13 | .Op Fl h | \-help | ||
14 | .Op Fl i Ar IP | Fl \-ip Ar IP | ||
15 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | ||
16 | .Op Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID | ||
17 | .Op Fl s Ar NAME | Fl \-service= Ns Ar NAME | ||
18 | .Op Fl t | \-tcp | ||
19 | .Op Fl u | \-udp | ||
20 | .Op Fl V | \-verbose | ||
21 | .Op Fl v | \-version | ||
22 | .Sh DESCRIPTION | ||
23 | .Nm | ||
24 | can be used to manually setup a VPN tunnel via the GNUnet network. | ||
11 | There are two main types of tunnels. | 25 | There are two main types of tunnels. |
12 | Tunnels to an exit node which routes the traffic to the global | 26 | 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. |
13 | Internet, and tunnels to a node that runs a service only within | ||
14 | GNUnet. | ||
15 | Depending on the type of tunnel, gnunet\-vpn takes different options. | 27 | Depending on the type of tunnel, gnunet\-vpn takes different options. |
16 | The "\-i" option is required for tunnels to an exit node, whereas the | 28 | 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. |
17 | "\-p" and "\-s" options in conjunction with either "\-u" or "\-t" are | ||
18 | required for tunnels to services. | ||
19 | For exit tunnels, both UDP and TCP traffic will be redirected. | 29 | For exit tunnels, both UDP and TCP traffic will be redirected. |
20 | For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will | 30 | For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will be redirected. |
21 | be redirected. | ||
22 | The tool will display the IP address for this end of the tunnel. | 31 | The tool will display the IP address for this end of the tunnel. |
23 | The address can be displayed as soon as it has been allocated, or only | 32 | The address can be displayed as soon as it has been allocated, or only after ("\-a") the tunnel has been created. |
24 | after ("\-a") the tunnel has been created. | 33 | .Bl -tag -width Ds |
25 | .SH OPTIONS | 34 | .It Fl 4 | \-ipv4 |
26 | .IP "\-4, \-\-ipv4" | ||
27 | Desired IP address on this end of the tunnel should be an IPv4 address. | 35 | Desired IP address on this end of the tunnel should be an IPv4 address. |
28 | .IP "\-6, \-\-ipv6" | 36 | .It Fl 6 | \-ipv6 |
29 | Desired IP address on this end of the tunnel should be an IPv6 address. | 37 | Desired IP address on this end of the tunnel should be an IPv6 address. |
30 | .IP "\-c FILENAME, \-\-config=FILENAME" | 38 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
31 | Use the configuration file FILENAME. | 39 | Use the configuration file FILENAME. |
32 | .IP "\-d TIME, \-\-duration TIME" | 40 | .It Fl d Ar TIME | Fl \-duration Ar TIME |
33 | The mapping should be established for TIME. | 41 | The mapping should be established for TIME. |
34 | The value given must be a number followed by a space and a time unit, | 42 | The value given must be a number followed by a space and a time unit, for example "500 ms". |
35 | for example "500 ms". | ||
36 | Note that the quotes are required on the shell. | 43 | Note that the quotes are required on the shell. |
37 | Default is 5 minutes. | 44 | Default is 5 minutes. |
38 | .IP "\-h, \-\-help" | 45 | .It Fl h | \-help |
39 | Print short help on options. | 46 | Print short help on options. |
40 | .IP "\-i IP, \-\-ip IP" | 47 | .It Fl i Ar IP | Fl \-ip Ar IP |
41 | Tunnel should be to an exit node and connect to the given IPv4 or IPv6 | 48 | Tunnel should be to an exit node and connect to the given IPv4 or IPv6 |
42 | IP address. | 49 | IP address. |
43 | Note that you can specify an IPv6 address as the target here, even in | 50 | Note that you can specify an IPv6 address as the target here, even in |
44 | combination with "\-4" (4to6) and similarly you can specify an IPv4 | 51 | combination with "\-4" (4to6) and similarly you can specify an IPv4 |
45 | address in combination with "\-6" (6to4). | 52 | address in combination with "\-6" (6to4). |
46 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 53 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
47 | Use LOGLEVEL for logging. | 54 | Use LOGLEVEL for logging. |
48 | Valid values are DEBUG, INFO, WARNING and ERROR. | 55 | Valid values are DEBUG, INFO, WARNING and ERROR. |
49 | .IP "\-p PEERID, \-\-peer=PEERID" | 56 | .It Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID |
50 | Name of the peer offering the service to connect to. | 57 | Name of the peer offering the service to connect to. |
51 | Cannot be used in conjunction with "\-i", requires "\-s". | 58 | Cannot be used in conjunction with "\-i", requires "\-s". |
52 | .IP "\-s NAME, \-\-service=NAME" | 59 | .It Fl s Ar NAME | Fl \-service= Ns Ar NAME |
53 | Name of the service running on the target peer. | 60 | Name of the service running on the target peer. |
54 | Cannot be used in conjunction with "\-i", requires "\-p". | 61 | Cannot be used in conjunction with "\-i", requires "\-p". |
55 | .IP "\-t, \-\-tcp" | 62 | .It Fl t | \-tcp |
56 | Service runs TCP. | 63 | Service runs TCP. |
57 | Either "\-t" or "\-u" must be specified when using "\-s". | 64 | Either "\-t" or "\-u" must be specified when using "\-s". |
58 | .IP "\-u, \-\-udp" | 65 | .It Fl u | \-udp |
59 | Service runs UDP. | 66 | Service runs UDP. |
60 | Either "\-t" or "\-u" must be specified when using "\-s". | 67 | Either "\-t" or "\-u" must be specified when using "\-s". |
61 | .IP "\-V, \-\-verbose" | 68 | .It Fl V | \-verbose |
62 | Be verbose. | 69 | Be verbose. |
63 | .IP "\-v, \-\-version" | 70 | .It Fl v | \-version |
64 | Print GNUnet version number. | 71 | Print GNUnet version number. |
65 | .SH BUGS | 72 | .El |
66 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 73 | .Sh SEE ALSO |
67 | electronic mail to <gnunet\-developers@gnu.org> | 74 | .Xr gnunet-setup 1 |
68 | .SH SEE ALSO | 75 | .sp |
69 | gnunet\-setup(1) | 76 | The full documentation for gnunet is maintained as a Texinfo manual. |
70 | The full documentation for | 77 | If the |
71 | .B gnunet | 78 | .Xr info 1 |
72 | is maintained as a Texinfo manual. If the | 79 | and gnunet programs are properly installed at your site, the command |
73 | .B info | 80 | .Pp |
74 | and | 81 | .Dl info gnunet |
75 | .B gnunet | 82 | .Pp |
76 | programs are properly installed at your site, the command | ||
77 | .IP | ||
78 | .B info gnunet | ||
79 | .PP | ||
80 | should give you access to the complete handbook, | 83 | should give you access to the complete handbook, |
81 | .IP | 84 | .Pp |
82 | .B info gnunet-c-tutorial | 85 | .Dl info gnunet-c-tutorial |
83 | .PP | 86 | .Pp |
84 | will give you access to a tutorial for developers. | 87 | will give you access to a tutorial for developers. |
85 | .PP | 88 | .sp |
86 | Depending on your installation, this information is also | 89 | Depending on your installation, this information is also available in |
87 | available in | 90 | .Xr gnunet 7 and |
88 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 91 | .Xr gnunet-c-tutorial 7 . |
92 | .\".Sh HISTORY | ||
93 | .\".Sh AUTHORS | ||
94 | .Sh BUGS | ||
95 | Report bugs by using | ||
96 | .Lk https://bugs.gnunet.org | ||
97 | or by sending electronic mail to | ||
98 | .Aq Mt gnunet-developers@gnu.org . | ||