doc/man/gnunet-cadet.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 May 3, 2016
  25 .Dt GNUNET-CADET 1
  26 .Os
  27 .Sh NAME
  28 .Nm gnunet-cadet
  29 .Nd
  30 create or obtain information about CADET tunnels and peers
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Op Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID
  34 .Op Fl d | \-dump
  35 .Op Fl e | \-echo
  36 .Op Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET
  37 .Op Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID
  38 .Op Fl P | \-peers
  39 .Op Fl T | \-tunnels
  40 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  41 .Op Fl h | \-help
  42 .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  43 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  44 .Op Fl v | \-version
  45 .Ao Ar PEER_ID Ac
  46 .Ao Ar SHARED_SECRET Ac
  47 .Sh DESCRIPTION
  48 .Nm
  49 prints information about CADET tunnels and peers.
  50 It can also be used for command-line based CADET tunnels using the
  51 .Fl o Ar SHARED_SECRET
  52 option to open a port on a receiving
  53 .Ar PEER_ID
  54 and using
  55 .Nm
  56 .Ao Ar PEER_ID Ac
  57 .Ao Ar SHARED_SECRET Ac
  58 to establish one circuit to that peer from any other peer.
  59 The receiving process will only accept one incoming circuit, but several commands using the same
  60 .Fl o
  61 can be issued to satisfy multiple requests.
  62 For one-to-many communication
  63 .Xr gnunet-social 1
  64 may be better suited, however.
  65 .Bl -tag -width indent
  66 .It Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID
  67 Provide information about the connection
  68 .Ar CONNECTION_ID .
  69 .It Fl d | \-dump
  70 Dump debug information to stderr.
  71 .It Fl e | \-echo
  72 Activate echo mode.
  73 .It Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET
  74 Listen for connections using a shared secret, provided as
  75 .Ar SHARED_SECRET ,
  76 among sender and recipient.
  77 .It Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID
  78 Provide information about the peer
  79 .Ar PEER_ID .
  80 .It Fl P | \-peers
  81 Provide information about all (known) peers.
  82 .It Fl T | \-tunnels
  83 Provide information about all tunnels.
  84 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  85 Use the configuration file
  86 .Ar FILENAME .
  87 .It Fl h | \-help
  88 Print the help page.
  89 .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  90 Configure logging to write logs to
  91 .Ar FILENAME .
  92 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  93 Use LOGLEVEL for logging.
  94 Valid values are DEBUG, INFO, WARNING and ERROR.
  95 .It Fl v | \-version
  96 Print the GNUnet version number.
  97 .El
  98 .Sh SEE ALSO
  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 .