aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-ats.1
blob: 6ead870d4dcaff4fcd102f5685f40c2552b52c90 (plain) (blame)
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
100
101
102
.\" This file is part of GNUnet.
.\" Copyright (C) 2001-2019 GNUnet e.V.
.\"
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.3 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
.\" copy of the license is included in the file
.\" ``FDL-1.3''.
.\"
.\" A copy of the license is also available from the Free Software
.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
.\"
.\" Alternately, this document is also available under the General
.\" Public License, version 3 or later, as published by the Free Software
.\" Foundation.  A copy of the license is included in the file
.\" ``GPL3''.
.\"
.\" A copy of the license is also available from the Free Software
.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
.\"
.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
.\"
.TH GNUNET\-ATS 1 "October 16, 2015" "GNUnet"
.SH NAME
gnunet\-ats \- display information about transport resource allocation
.SH SYNOPSIS
.B gnunet\-ats
.RI [-a\ |\ --aa]
.RI [-c\ FILENAME\ |\ --config=FILENAME]
.RI [-C\ |\ --connect=PEERID]
.RI [-h\ |\ --help]
.RI [-i\ |\ --id=PEERID]
.RI [-k\ |\ --value=VALUE]
.RI [-L\ LOGLEVEL\ |\ --loglevel=LOGLEVEL]
.RI [-m\ |\ --monitor]
.RI [-n\ |\ --numeric]
.RI [-k\ |\ --preference=E]
.RI [-q\ |\ --quotas]
.RI [-t\ |\ --type=VALUE]
.RI [-u\ |\ --used]
.RI [-V\ |\ --verbose]
.RI [-v\ |\ --version]
.SH DESCRIPTION
\fBgnunet\-ats\fP can be used to display information about the GNUnet's transport selection mechanism.
It shows information about the addresses and the assigned input and output bandwidth.
.SH OPTIONS
.IP "\-a\ |\ \-\-aa"
List all addresses currently known to ats.
.IP "\-c FILENAME\ |\ \-\-config=FILENAME"
Use the configuration file FILENAME.
.IP "\-C\ |\ -\-connect=PEERID"
Ask ATS to suggest an address for PEERID to transport to establish a connection.
Note that you can use the gnunet\-transport command\-line tool to force disconnects.
.IP "\-h\ |\ -\-help"
Print short help on options.
.IP "\-i\ |\ -\-id=PEERID"
Print information for a specific peer identity only
.IP "\-k\ |\ -\-value=VALUE"
Value to set for when changing preference values
.IP "\-L LOGLEVEL\ |\ -\-loglevel=LOGLEVEL"
Use LOGLEVEL for logging.
Valid values are DEBUG, INFO, WARNING and ERROR.
.IP "\-m\ |\ -\-monitor"
Monitor changes to the bandwidth assignments continuously
.IP "\-n\ |\ -\-numeric"
Do not resolve IP addresses to hostnames
.IP "\-k\ |\ -\-preference=E"
Set preference values, -i, -k and -t required.
.IP "\-q\ |\ -\-quotas"
Print quotas for all network types
.IP "\-t\ |\ -\-type=VALUE"
Preference type to change: latency | bandwidth
.IP "\-u\ |\ -\-used"
Print addresses actively used only
.IP "\-V\ |\ -\-verbose"
Print verbose output (include ATS address properties)
.IP "\-v\ |\ -\-version"
Print GNUnet version number.
.SH SEE ALSO
gnunet\-transport(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).
.SH BUGS
Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending electronic mail to <bug\-gnunet@gnu.org>.