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