aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-ats.1
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-05-30 12:33:31 +0000
committerng0 <ng0@n0.is>2019-05-30 12:34:16 +0000
commit4b2496fc954b18b89d9cebc160b375f1bcf40864 (patch)
tree1eca56732938bed75c7f3892c61e21008f3a20e5 /doc/man/gnunet-ats.1
parent6c525438677cfeeb602a45ddc953f775f196d50c (diff)
downloadgnunet-4b2496fc954b18b89d9cebc160b375f1bcf40864.tar.gz
gnunet-4b2496fc954b18b89d9cebc160b375f1bcf40864.zip
un-texify the man pages headers.
Diffstat (limited to 'doc/man/gnunet-ats.1')
-rw-r--r--doc/man/gnunet-ats.186
1 files changed, 45 insertions, 41 deletions
diff --git a/doc/man/gnunet-ats.1 b/doc/man/gnunet-ats.1
index 1e7b7731c..311501002 100644
--- a/doc/man/gnunet-ats.1
+++ b/doc/man/gnunet-ats.1
@@ -6,18 +6,18 @@
6.\" any later version published by the Free Software Foundation; with no 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 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.\" copy of the license is included in the file 8.\" copy of the license is included in the file
9.\" ``FDL-1.3''. 9.\" FDL-1.3.
10.\" 10.\"
11.\" A copy of the license is also available from the Free Software 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}. 12.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
13.\" 13.\"
14.\" Alternately, this document is also available under the General 14.\" Alternately, this document is also available under the General
15.\" Public License, version 3 or later, as published by the Free Software 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 16.\" Foundation. A copy of the license is included in the file
17.\" ``GPL3''. 17.\" GPL3.
18.\" 18.\"
19.\" A copy of the license is also available from the Free Software 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}. 20.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
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.\"
@@ -26,62 +26,66 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-ats 28.Nm gnunet-ats
29.Nd 29.Nd display information about transport resource allocation
30display information about transport resource allocation
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl a | \-all 32.Op Fl a | -all
34.Op Fl C Ar PEERID | Fl \-connect= Ns Ar PEERID 33.Op Fl C Ar PEERID | Fl -connect= Ns Ar PEERID
35.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 34.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
36.Op Fl h | \-help 35.Op Fl h | -help
37.Op Fl i Ar PEERID | Fl \-id= Ns Ar PEERID 36.Op Fl i Ar PEERID | Fl -id= Ns Ar PEERID
38.Op Fl k Ar VALUE | Fl \-value= Ns Ar VALUE 37.Op Fl k Ar VALUE | Fl -value= Ns Ar VALUE
39.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 38.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
40.Op Fl m | \-monitor 39.Op Fl m | -monitor
41.Op Fl n | \-numeric 40.Op Fl n | -numeric
42.Op Fl p Ar PREFERENCE | Fl \-preference= Ns Ar PREFERENCE 41.Op Fl p Ar PREFERENCE | Fl -preference= Ns Ar PREFERENCE
43.Op Fl q | \-quotas 42.Op Fl q | -quotas
44.Op Fl t Ar TYPE | Fl \-type= Ns Ar TYPE 43.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE
45.Op Fl u | \-used 44.Op Fl u | -used
46.Op Fl V | \-verbose 45.Op Fl V | -verbose
47.Op Fl v | \-version 46.Op Fl v | -version
48.Sh DESCRIPTION 47.Sh DESCRIPTION
49.Nm 48.Nm
50can be used to display information about the GNUnet's transport selection mechanism. 49can be used to display information about the
51It shows information about the addresses and the assigned input and output bandwidth. 50GNUnet's transport selection mechanism.
51It shows information about the addresses and
52the assigned input and output bandwidth.
52.Sh OPTIONS 53.Sh OPTIONS
53.Bl -tag -width Ds 54.Bl -tag -width indent
54.It Fl a | \-all 55.It Fl a | -all
55List all addresses currently known to ats. 56List all addresses currently known to ats.
56.It Fl C Ar PEERID | Fl \-connect= Ns Ar PEERID 57.It Fl C Ar PEERID | Fl -connect= Ns Ar PEERID
57Ask ATS to suggest an address for PEERID to transport to establish a connection. 58Ask ATS to suggest an address for PEERID to transport
58Note that you can use the gnunet-transport commandline tool to force disconnects. 59to establish a connection.
59.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 60Note that you can use the
61.Xr gnunet-transport 1
62commandline tool to force disconnects.
63.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
60Use the configuration file FILENAME. 64Use the configuration file FILENAME.
61.It Fl h | \-help 65.It Fl h | -help
62Print short help on options. 66Print short help on options.
63.It Fl i Ar PEERID | Fl \-id= Ns Ar PEERID 67.It Fl i Ar PEERID | Fl -id= Ns Ar PEERID
64Print information for a specific peer identity only. 68Print information for a specific peer identity only.
65.It Fl k Ar VALUE | Fl \-value= Ns Ar VALUE 69.It Fl k Ar VALUE | Fl -value= Ns Ar VALUE
66Value to set for when changing preference values. 70Value to set for when changing preference values.
67.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 71.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
68Use LOGLEVEL for logging. 72Use LOGLEVEL for logging.
69Valid values are DEBUG, INFO, WARNING and ERROR. 73Valid values are DEBUG, INFO, WARNING and ERROR.
70.It Fl m | \-monitor 74.It Fl m | -monitor
71Monitor changes to the bandwidth assignments continuously. 75Monitor changes to the bandwidth assignments continuously.
72.It Fl n | \-numeric 76.It Fl n | -numeric
73Do not resolve IP addresses to hostnames. 77Do not resolve IP addresses to hostnames.
74.It Fl p Ar PREFERENCE | Fl \-preference= Ns Ar PREFERENCE 78.It Fl p Ar PREFERENCE | Fl -preference= Ns Ar PREFERENCE
75Set preference values, -i, -k and -t required. 79Set preference values, -i, -k and -t required.
76.It Fl q | \-quotas 80.It Fl q | -quotas
77Print quotas for all network types 81Print quotas for all network types
78.It Fl t Ar TYPE | Fl \-type= Ns Ar TYPE 82.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
79Preference type to change: latency | bandwidth 83Preference type to change: latency | bandwidth
80.It Fl u | \-used 84.It Fl u | -used
81Print addresses actively used only 85Print addresses actively used only
82.It Fl V | \-verbose 86.It Fl V | -verbose
83Print verbose output (include ATS address properties) 87Print verbose output (include ATS address properties)
84.It v | \-version 88.It v | -version
85Print GNUnet version number. 89Print GNUnet version number.
86.El 90.El
87.Sh SEE ALSO 91.Sh SEE ALSO