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