doc/man/5,1: in SEE ALSO mention that the main documentation is maintained in texinfo...
[oweals/gnunet.git] / doc / man / gnunet-ats.1
1 .TH GNUNET\-ATS 1 "Oct 16, 2015" "GNUnet"
2
3 .SH NAME
4 gnunet\-ats \- display information about transport resource allocation
5
6 .SH SYNOPSIS
7 .B gnunet\-ats
8 .RI [ options ]
9 .br
10
11 .SH DESCRIPTION
12 \fBgnunet\-ats\fP can be used to display information about the GNUnet's
13 transport selection mechanism. It shows information about the
14 addresses and the assigned input and output bandwidth.
15
16 .SH OPTIONS
17 .B
18 .IP "\-a,  \-\-aa"
19 List all addresses currently known to ats.
20 .B
21 .IP "\-c FILENAME,  \-\-config=FILENAME"
22 Use the configuration file FILENAME.
23 .B
24 .IP "\-C, \-\-connect=PEERID"
25 Ask ATS to suggest an address for PEERID to transport to establish a connection.
26 Note that you can use the gnunet\-transport command\-line tool to force disconnects.
27 .B
28 .IP "\-h, \-\-help"
29 Print short help on options.
30 .B
31 .IP "\-i, \-\-id=PEERID"
32 Print information for a specific peer identity only
33 .B
34 .IP "\-k, \-\-value=VALUE"
35 Value to set for when changing preference values
36 .B
37 .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
38 Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
39 .B
40 .IP "\-m, \-\-monitor"
41 Monitor changes to the bandwidth assignments continuously
42 .B
43 .IP "\-n, \-\-numeric"
44 Do not resolve IP addresses to hostnames
45 .B
46 .IP "\-k, \-\-preference=E"
47 Set preference values, \-i, \-k and \-t required
48 .B
49 .IP "\-q, \-\-quotas"
50 Print quotas for all network types
51 .B
52 .IP "\-t, \-\-type=VALUE"
53 Preference type to change: latency | bandwidth
54 .B
55 .IP "\-u, \-\-used"
56 Print addresses actively used only
57 .B
58 .IP "\-V, \-\-verbose"
59 Print verbose output (include ATS address properties)
60 .B
61 .IP "\-v, \-\-version"
62 Print GNUnet version number.
63
64 .SH BUGS
65 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
66 electronic mail to <bug\-gnunet@gnu.org>
67
68 .SH SEE ALSO
69 gnunet\-transport(1)
70 The full documentation for
71 .B gnunet
72 is maintained as a Texinfo manual.  If the
73 .B info
74 and
75 .B gnunet
76 programs are properly installed at your site, the command
77 .IP
78 .B info gnunet
79 .PP
80 should give you access to the complete handbook,
81 .IP
82 .B info gnunet-c-tutorial
83 .PP
84 will give you access to a tutorial for developers.
85 .PP
86 Depending on your installation, this information is also
87 available in
88 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).