doc/man/gnunet-ats.1

   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 .\"
  24 .TH GNUNET\-ATS 1 "October 16, 2015" "GNUnet"
  25 .SH NAME
  26 gnunet\-ats \- display information about transport resource allocation
  27 .SH SYNOPSIS
  28 .B gnunet\-ats
  29 .RI [-a\ |\ --aa]
  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]
  44 .SH DESCRIPTION
  45 \fBgnunet\-ats\fP can be used to display information about the GNUnet's transport selection mechanism.
  46 It shows information about the addresses and the assigned input and output bandwidth.
  47 .SH OPTIONS
  48 .IP "\-a\ |\ \-\-aa"
  49 List all addresses currently known to ats.
  50 .IP "\-c FILENAME\ |\ \-\-config=FILENAME"
  51 Use the configuration file FILENAME.
  52 .IP "\-C\ |\ -\-connect=PEERID"
  53 Ask ATS to suggest an address for PEERID to transport to establish a connection.
  54 Note that you can use the gnunet\-transport command\-line tool to force disconnects.
  55 .IP "\-h\ |\ -\-help"
  56 Print short help on options.
  57 .IP "\-i\ |\ -\-id=PEERID"
  58 Print information for a specific peer identity only
  59 .IP "\-k\ |\ -\-value=VALUE"
  60 Value to set for when changing preference values
  61 .IP "\-L LOGLEVEL\ |\ -\-loglevel=LOGLEVEL"
  62 Use LOGLEVEL for logging.
  63 Valid values are DEBUG, INFO, WARNING and ERROR.
  64 .IP "\-m\ |\ -\-monitor"
  65 Monitor changes to the bandwidth assignments continuously
  66 .IP "\-n\ |\ -\-numeric"
  67 Do not resolve IP addresses to hostnames
  68 .IP "\-k\ |\ -\-preference=E"
  69 Set preference values, -i, -k and -t required.
  70 .IP "\-q\ |\ -\-quotas"
  71 Print quotas for all network types
  72 .IP "\-t\ |\ -\-type=VALUE"
  73 Preference type to change: latency | bandwidth
  74 .IP "\-u\ |\ -\-used"
  75 Print addresses actively used only
  76 .IP "\-V\ |\ -\-verbose"
  77 Print verbose output (include ATS address properties)
  78 .IP "\-v\ |\ -\-version"
  79 Print GNUnet version number.
  80 .SH SEE ALSO
  81 gnunet\-transport(1)
  82 The full documentation for
  83 .B gnunet
  84 is maintained as a Texinfo manual.  If the
  85 .B info
  86 and
  87 .B gnunet
  88 programs are properly installed at your site, the command
  89 .IP
  90 .B info gnunet
  91 .PP
  92 should give you access to the complete handbook,
  93 .IP
  94 .B info gnunet-c-tutorial
  95 .PP
  96 will give you access to a tutorial for developers.
  97 .PP
  98 Depending on your installation, this information is also
  99 available in
 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>.