summaryrefslogtreecommitdiff
path: root/doc/man/gnunet-vpn.1
blob: f4e445c21b1ddb04185e362e65e4b164053d9d0e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
.TH GNUNET\-VPN 1 "25 Feb 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.  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.

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
.B
.IP "\-4, \-\-ipv4"
Desired IP address on this end of the tunnel should be an IPv4 address.
.B
.IP "\-6, \-\-ipv6"
Desired IP address on this end of the tunnel should be an IPv6 address.
.B
.IP "\-c FILENAME,  \-\-config=FILENAME"
Use the configuration file FILENAME.
.B
.IP "\-d TIME, \-\-duration 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".
Note that the quotes are required on the shell. Default is 5 minutes.
.B
.IP "\-h, \-\-help"
Print short help on options.
.B
.IP "\-i IP, \-\-ip 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).
.B
.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
.B
.IP "\-p PEERID,  \-\-peer=PEERID"
Name of the peer offering the service to connect to.  Cannot be used
in conjunction with "\-i", requires "\-s".
.B
.IP "\-s NAME,  \-\-service=NAME"
Name of the service running on the target peer.  Cannot be used in
conjunction with "\-i", requires "\-p".
.B
.IP "\-t, \-\-tcp"
Service runs TCP.  Either "\-t" or "\-u" must be specified when using "\-s".
.B
.IP "\-u, \-\-udp"
Service runs UDP.  Either "\-t" or "\-u" must be specified when using "\-s".
.B
.IP "\-V, \-\-verbose"
Be verbose.
.B
.IP "\-v, \-\-version"
Print GNUnet version number.


.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> 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
should give you access to the complete handbook,
.IP
.B 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).