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