doc/man/gnunet-transport.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 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 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 17, 2015
  25 .Dt GNUNET-TRANSPORT 1
  26 .Os
  27 .Sh NAME
  28 .Nm gnunet-transport
  29 .Nd measure and control the transport subsystem
  30 .Sh SYNOPSIS
  31 .Nm
  32 .Op Fl b | -benchmark
  33 .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  34 .Op Fl D | -disconnect
  35 .Op Fl e | -events
  36 .Op Fl h | -help
  37 .Op Fl i | -information
  38 .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
  39 .Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
  40 .Op Fl m | -monitor
  41 .Op Fl p Ar PEER | Fl -peer= Ns Ar PEER
  42 .Op Fl P | -plugins
  43 .Op Fl s | -send
  44 .Op Fl v | -version
  45 .Op Fl V | -verbose
  46 .Sh DESCRIPTION
  47 .Nm
  48 is a tool to access various functions of GNUnet's transport subsystem
  49 from the command-line.
  50 Most of these are not expected to be useful for end-users.
  51 gnunet-transport can be used to evaluate the performance of
  52 the transports, force a peer to connect to another peer (if possible).
  53 Other functions should be added in the near future.
  54 .Bl -tag -width indent
  55 .It Fl b | -benchmark
  56 Measure how fast we are receiving data (from all connections).
  57 On exit, the data rate will be reported.
  58 Runs until aborted with CTRL-C.
  59 .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  60 configuration file to use
  61 .It Fl D | -disconnect
  62 Force disconnection from a peer (used in conjunction with
  63 .Fl p Ns ).
  64 Note that you can use the gnunet-ats command-line tool to suggest connects.
  65 .It Fl e | -events
  66 Provide information about all connect and disconnect events (continuously).
  67 .It Fl h | -help
  68 Print the help page.
  69 .It Fl i | -information
  70 Print information about our current connections (once).
  71 .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
  72 Change the loglevel.
  73 Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
  74 .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
  75 Configure logging to write logs to LOGFILE.
  76 .It Fl m | -monitor
  77 Print information about our current connections (continuously).
  78 .It Fl p Ar PEER | Fl -peer= Ns Ar PEER
  79 The peer identity to connect to or monitor.
  80 .It Fl P | -plugins
  81 Monitor session state of transport plugins.
  82 .It Fl s | -send
  83 Transmit (dummy) traffic as quickly as possible to the peer specified with the
  84 .Fl p
  85 option.
  86 The rate will still be limited by the quota(s) determined by
  87 the peers (ATS subsystem).
  88 Will run until CTRL-C is pressed or until the connection
  89 to the other peer is disrupted.
  90 .It Fl v | -version
  91 Print out the version number.
  92 .It Fl V | -verbose
  93 be verbose
  94 .El
  95 .Sh SEE ALSO
  96 .Xr gnunet-arm 1 ,
  97 .Xr gnunet-ats 1
  98 .sp
  99 The full documentation for gnunet is maintained as a Texinfo manual.
 100 If the
 101 .Xr info 1
 102 and gnunet programs are properly installed at your site, the command
 103 .Pp
 104 .Dl info gnunet
 105 .Pp
 106 should give you access to the complete handbook,
 107 .Pp
 108 .Dl info gnunet-c-tutorial
 109 .Pp
 110 will give you access to a tutorial for developers.
 111 .sp
 112 Depending on your installation, this information is also available in
 113 .Xr gnunet 7 and
 114 .Xr gnunet-c-tutorial 7 .
 115 .\".Sh HISTORY
 116 .\".Sh AUTHORS
 117 .Sh BUGS
 118 Report bugs by using
 119 .Lk https://bugs.gnunet.org
 120 or by sending electronic mail to
 121 .Aq Mt gnunet-developers@gnu.org .