aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-04-20 11:45:57 +0000
committerng0 <ng0@n0.is>2019-04-20 11:45:57 +0000
commit9522926cc78a18ab5a1ef8cdf3f58312d675c2e5 (patch)
tree3adb87e69702477b76e2133788d7aebcc65d0572
parentdd50dce42086ac7ec7021f2f39ff2833085cb5e3 (diff)
downloadgnunet-9522926cc78a18ab5a1ef8cdf3f58312d675c2e5.tar.gz
gnunet-9522926cc78a18ab5a1ef8cdf3f58312d675c2e5.zip
gnunet-vpn.1: style. use Pq macro
-rw-r--r--doc/man/gnunet-vpn.150
1 files changed, 41 insertions, 9 deletions
diff --git a/doc/man/gnunet-vpn.1 b/doc/man/gnunet-vpn.1
index 87751e705..652e3e516 100644
--- a/doc/man/gnunet-vpn.1
+++ b/doc/man/gnunet-vpn.1
@@ -25,12 +25,28 @@ manually setup a GNUnet VPN tunnel
25can be used to manually setup a VPN tunnel via the GNUnet network. 25can be used to manually setup a VPN tunnel via the GNUnet network.
26There are two main types of tunnels. 26There are two main types of tunnels.
27Tunnels to an exit node which routes the traffic to the global Internet, and tunnels to a node that runs a service only within GNUnet. 27Tunnels to an exit node which routes the traffic to the global Internet, and tunnels to a node that runs a service only within GNUnet.
28Depending on the type of tunnel, gnunet\-vpn takes different options. 28Depending on the type of tunnel, gnunet-vpn takes different options.
29The "\-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. 29The
30.Fl i
31option is required for tunnels to an exit node, whereas the
32.Fl p
33and
34.Fl s
35options in conjunction with either
36.Fl u
37or
38.Fl t
39are required for tunnels to services.
30For exit tunnels, both UDP and TCP traffic will be redirected. 40For exit tunnels, both UDP and TCP traffic will be redirected.
31For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will be redirected. 41For service tunnels, either UDP
42.Pq Fl u
43or TCP
44.Pq Fl t
45traffic will be redirected.
32The tool will display the IP address for this end of the tunnel. 46The tool will display the IP address for this end of the tunnel.
33The address can be displayed as soon as it has been allocated, or only after ("\-a") the tunnel has been created. 47The address can be displayed as soon as it has been allocated, or only after
48.Pq Fl a
49the tunnel has been created.
34.Bl -tag -width Ds 50.Bl -tag -width Ds
35.It Fl 4 | \-ipv4 51.It Fl 4 | \-ipv4
36Desired IP address on this end of the tunnel should be an IPv4 address. 52Desired IP address on this end of the tunnel should be an IPv4 address.
@@ -42,7 +58,7 @@ Use the configuration file FILENAME.
42The mapping should be established for TIME. 58The mapping should be established for TIME.
43The value given must be a number followed by a space and a time unit, for example "500 ms". 59The value given must be a number followed by a space and a time unit, for example "500 ms".
44Note that the quotes are required on the shell. 60Note that the quotes are required on the shell.
45Default is 5 minutes. 61The default vaue is 5 minutes.
46.It Fl h | \-help 62.It Fl h | \-help
47Print short help on options. 63Print short help on options.
48.It Fl i Ar IP | Fl \-ip Ar IP 64.It Fl i Ar IP | Fl \-ip Ar IP
@@ -56,16 +72,32 @@ Use LOGLEVEL for logging.
56Valid values are DEBUG, INFO, WARNING and ERROR. 72Valid values are DEBUG, INFO, WARNING and ERROR.
57.It Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID 73.It Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID
58Name of the peer offering the service to connect to. 74Name of the peer offering the service to connect to.
59Cannot be used in conjunction with "\-i", requires "\-s". 75Cannot be used in conjunction with
76.Fl i ,
77requires
78.Fl s .
60.It Fl s Ar NAME | Fl \-service= Ns Ar NAME 79.It Fl s Ar NAME | Fl \-service= Ns Ar NAME
61Name of the service running on the target peer. 80Name of the service running on the target peer.
62Cannot be used in conjunction with "\-i", requires "\-p". 81Cannot be used in conjunction with
82.Fl i ,
83requires
84.Fl p .
63.It Fl t | \-tcp 85.It Fl t | \-tcp
64Service runs TCP. 86Service runs TCP.
65Either "\-t" or "\-u" must be specified when using "\-s". 87Either
88.Fl t
89or
90.Fl u
91must be specified when using
92.Fl s .
66.It Fl u | \-udp 93.It Fl u | \-udp
67Service runs UDP. 94Service runs UDP.
68Either "\-t" or "\-u" must be specified when using "\-s". 95Either
96.Fl t
97or
98.Fl u
99must be specified when using
100.Fl s .
69.It Fl V | \-verbose 101.It Fl V | \-verbose
70Be verbose. 102Be verbose.
71.It Fl v | \-version 103.It Fl v | \-version