doc/man/gnunet-transport.1

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