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