doc/man/gnunet-cadet.1

   1 .Dd May 3, 2016
   2 .Dt GNUNET-CADET 1
   3 .Os
   4 .Sh NAME
   5 .Nm gnunet-cadet
   6 .Nd
   7 create or obtain information about CADET tunnels and peers
   8 .Sh SYNOPSIS
   9 .Nm
  10 .Op Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID
  11 .Op Fl d | \-dump
  12 .Op Fl e | \-echo
  13 .Op Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET
  14 .Op Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID
  15 .Op Fl P | \-peers
  16 .Op Fl T | \-tunnels
  17 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  18 .Op Fl h | \-help
  19 .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  20 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  21 .Op Fl v | \-version
  22 .Ao Ar PEER_ID SHARED_SECRET Ac
  23 .Sh DESCRIPTION
  24 .Nm
  25 prints information about CADET tunnels and peers.
  26 It can also be used for command-line based CADET tunnels using the \fI-o SHARED_SECRET\fR option to open a port on a receiving PEER_ID and using "\fBgnunet\-cadet\fP \fIPEER_ID SHARED_SECRET\fR" to establish one circuit to that peer from any other peer.
  27 The receiving process will only accept one incoming circuit, but several commands using the same \fI-o\fR can be issued to satisfy multiple requests.
  28 For one\-to\-many communication
  29 .Xr gnunet-social 1
  30 may be better suited, however.
  31 .Bl -tag -width Ds
  32 .It Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID
  33 Provide information about a particular connection.
  34 .It Fl d | \-dump
  35 Dump debug information to STDERR.
  36 .It Fl e | \-echo
  37 Activate echo mode.
  38 .It Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET
  39 Listen for connections using a shared secret among sender and recipient.
  40 .It Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID
  41 Provide information about a patricular peer.
  42 .It Fl P | \-peers
  43 Provide information about all peers.
  44 .It Fl T | \-tunnels
  45 Provide information about all tunnels.
  46 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  47 Use the configuration file FILENAME.
  48 .It Fl h | \-help
  49 Print short help on options.
  50 .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  51 Configure logging to write logs to FILENAME.
  52 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  53 Use LOGLEVEL for logging.
  54 Valid values are DEBUG, INFO, WARNING and ERROR.
  55 .It Fl v | \-version
  56 Print GNUnet version number.
  57 .El
  58 .Sh SEE ALSO
  59 The full documentation for gnunet is maintained as a Texinfo manual.
  60 If the
  61 .Xr info 1
  62 and gnunet programs are properly installed at your site, the command
  63 .Pp
  64 .Dl info gnunet
  65 .Pp
  66 should give you access to the complete handbook,
  67 .Pp
  68 .Dl info gnunet-c-tutorial
  69 .Pp
  70 will give you access to a tutorial for developers.
  71 .sp
  72 Depending on your installation, this information is also available in
  73 .Xr gnunet 7 and
  74 .Xr gnunet-c-tutorial 7 .
  75 .\".Sh HISTORY
  76 .\".Sh AUTHORS
  77 .Sh BUGS
  78 Report bugs by using
  79 .Lk https://bugs.gnunet.org
  80 or by sending electronic mail to
  81 .Aq Mt gnunet-developers@gnu.org .