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