diff options
Diffstat (limited to 'doc/man/gnunet-ats.1')
-rw-r--r-- | doc/man/gnunet-ats.1 | 171 |
1 files changed, 98 insertions, 73 deletions
diff --git a/doc/man/gnunet-ats.1 b/doc/man/gnunet-ats.1 index c098ed576..1e7b7731c 100644 --- a/doc/man/gnunet-ats.1 +++ b/doc/man/gnunet-ats.1 | |||
@@ -1,85 +1,110 @@ | |||
1 | .TH GNUNET\-ATS 1 "October 16, 2015" "GNUnet" | 1 | .\" This file is part of GNUnet. |
2 | .SH NAME | 2 | .\" Copyright (C) 2001-2019 GNUnet e.V. |
3 | gnunet\-ats \- display information about transport resource allocation | 3 | .\" |
4 | .SH SYNOPSIS | 4 | .\" Permission is granted to copy, distribute and/or modify this document |
5 | .B gnunet\-ats | 5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or |
6 | .RI [ options ] | 6 | .\" any later version published by the Free Software Foundation; with no |
7 | .br | 7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A |
8 | .SH DESCRIPTION | 8 | .\" copy of the license is included in the file |
9 | \fBgnunet\-ats\fP can be used to display information about the GNUnet's | 9 | .\" ``FDL-1.3''. |
10 | transport selection mechanism. It shows information about the | 10 | .\" |
11 | addresses and the assigned input and output bandwidth. | 11 | .\" A copy of the license is also available from the Free Software |
12 | .SH OPTIONS | 12 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}. |
13 | .B | 13 | .\" |
14 | .IP "\-a, \-\-aa" | 14 | .\" Alternately, this document is also available under the General |
15 | .\" Public License, version 3 or later, as published by the Free Software | ||
16 | .\" Foundation. A copy of the license is included in the file | ||
17 | .\" ``GPL3''. | ||
18 | .\" | ||
19 | .\" A copy of the license is also available from the Free Software | ||
20 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}. | ||
21 | .\" | ||
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
23 | .\" | ||
24 | .Dd October 16, 2015 | ||
25 | .Dt GNUNET-ATS 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-ats | ||
29 | .Nd | ||
30 | display information about transport resource allocation | ||
31 | .Sh SYNOPSIS | ||
32 | .Nm | ||
33 | .Op Fl a | \-all | ||
34 | .Op Fl C Ar PEERID | Fl \-connect= Ns Ar PEERID | ||
35 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
36 | .Op Fl h | \-help | ||
37 | .Op Fl i Ar PEERID | Fl \-id= Ns Ar PEERID | ||
38 | .Op Fl k Ar VALUE | Fl \-value= Ns Ar VALUE | ||
39 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | ||
40 | .Op Fl m | \-monitor | ||
41 | .Op Fl n | \-numeric | ||
42 | .Op Fl p Ar PREFERENCE | Fl \-preference= Ns Ar PREFERENCE | ||
43 | .Op Fl q | \-quotas | ||
44 | .Op Fl t Ar TYPE | Fl \-type= Ns Ar TYPE | ||
45 | .Op Fl u | \-used | ||
46 | .Op Fl V | \-verbose | ||
47 | .Op Fl v | \-version | ||
48 | .Sh DESCRIPTION | ||
49 | .Nm | ||
50 | can be used to display information about the GNUnet's transport selection mechanism. | ||
51 | It shows information about the addresses and the assigned input and output bandwidth. | ||
52 | .Sh OPTIONS | ||
53 | .Bl -tag -width Ds | ||
54 | .It Fl a | \-all | ||
15 | List all addresses currently known to ats. | 55 | List all addresses currently known to ats. |
16 | .B | 56 | .It Fl C Ar PEERID | Fl \-connect= Ns Ar PEERID |
17 | .IP "\-c FILENAME, \-\-config=FILENAME" | 57 | Ask ATS to suggest an address for PEERID to transport to establish a connection. |
58 | Note that you can use the gnunet-transport commandline tool to force disconnects. | ||
59 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
18 | Use the configuration file FILENAME. | 60 | Use the configuration file FILENAME. |
19 | .B | 61 | .It Fl h | \-help |
20 | .IP "\-C, \-\-connect=PEERID" | ||
21 | Ask ATS to suggest an address for PEERID to transport to establish a | ||
22 | connection. | ||
23 | Note that you can use the gnunet\-transport command\-line tool to | ||
24 | force disconnects. | ||
25 | .B | ||
26 | .IP "\-h, \-\-help" | ||
27 | Print short help on options. | 62 | Print short help on options. |
28 | .B | 63 | .It Fl i Ar PEERID | Fl \-id= Ns Ar PEERID |
29 | .IP "\-i, \-\-id=PEERID" | 64 | Print information for a specific peer identity only. |
30 | Print information for a specific peer identity only | 65 | .It Fl k Ar VALUE | Fl \-value= Ns Ar VALUE |
31 | .B | 66 | Value to set for when changing preference values. |
32 | .IP "\-k, \-\-value=VALUE" | 67 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
33 | Value to set for when changing preference values | ||
34 | .B | ||
35 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | ||
36 | Use LOGLEVEL for logging. | 68 | Use LOGLEVEL for logging. |
37 | Valid values are DEBUG, INFO, WARNING and ERROR. | 69 | Valid values are DEBUG, INFO, WARNING and ERROR. |
38 | .B | 70 | .It Fl m | \-monitor |
39 | .IP "\-m, \-\-monitor" | 71 | Monitor changes to the bandwidth assignments continuously. |
40 | Monitor changes to the bandwidth assignments continuously | 72 | .It Fl n | \-numeric |
41 | .B | 73 | Do not resolve IP addresses to hostnames. |
42 | .IP "\-n, \-\-numeric" | 74 | .It Fl p Ar PREFERENCE | Fl \-preference= Ns Ar PREFERENCE |
43 | Do not resolve IP addresses to hostnames | 75 | Set preference values, -i, -k and -t required. |
44 | .B | 76 | .It Fl q | \-quotas |
45 | .IP "\-k, \-\-preference=E" | ||
46 | Set preference values, \-i, \-k and \-t required | ||
47 | .B | ||
48 | .IP "\-q, \-\-quotas" | ||
49 | Print quotas for all network types | 77 | Print quotas for all network types |
50 | .B | 78 | .It Fl t Ar TYPE | Fl \-type= Ns Ar TYPE |
51 | .IP "\-t, \-\-type=VALUE" | ||
52 | Preference type to change: latency | bandwidth | 79 | Preference type to change: latency | bandwidth |
53 | .B | 80 | .It Fl u | \-used |
54 | .IP "\-u, \-\-used" | ||
55 | Print addresses actively used only | 81 | Print addresses actively used only |
56 | .B | 82 | .It Fl V | \-verbose |
57 | .IP "\-V, \-\-verbose" | ||
58 | Print verbose output (include ATS address properties) | 83 | Print verbose output (include ATS address properties) |
59 | .B | 84 | .It v | \-version |
60 | .IP "\-v, \-\-version" | ||
61 | Print GNUnet version number. | 85 | Print GNUnet version number. |
62 | .SH BUGS | 86 | .El |
63 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 87 | .Sh SEE ALSO |
64 | electronic mail to <bug\-gnunet@gnu.org> | 88 | .Xr gnunet-transport 1 |
65 | .SH SEE ALSO | 89 | .sp |
66 | gnunet\-transport(1) | 90 | The full documentation for gnunet is maintained as a Texinfo manual. |
67 | The full documentation for | 91 | If the |
68 | .B gnunet | 92 | .Xr info 1 |
69 | is maintained as a Texinfo manual. If the | 93 | and gnunet programs are properly installed at your site, the command |
70 | .B info | 94 | .Pp |
71 | and | 95 | .Dl info gnunet |
72 | .B gnunet | 96 | .Pp |
73 | programs are properly installed at your site, the command | ||
74 | .IP | ||
75 | .B info gnunet | ||
76 | .PP | ||
77 | should give you access to the complete handbook, | 97 | should give you access to the complete handbook, |
78 | .IP | 98 | .Pp |
79 | .B info gnunet-c-tutorial | 99 | .Dl info gnunet-c-tutorial |
80 | .PP | 100 | .Pp |
81 | will give you access to a tutorial for developers. | 101 | will give you access to a tutorial for developers. |
82 | .PP | 102 | .Pp |
83 | Depending on your installation, this information is also | 103 | Depending on your installation, this information is also available in |
84 | available in | 104 | .Xr gnunet 7 and |
85 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 105 | .Xr gnunet-c-tutorial 7 . |
106 | .Sh BUGS | ||
107 | Report bugs by using | ||
108 | .Lk https://bugs.gnunet.org | ||
109 | or by sending electronic mail to | ||
110 | .Aq Mt bug-gnunet@gnu.org . | ||