Merge branch 'master' of ssh://gnunet.org/gnunet
[oweals/gnunet.git] / doc / man / gnunet-cadet.1
1 .TH GNUNET\-CADET 1 "May 3, 2016" "GNUnet"
2
3 .SH NAME
4 gnunet\-cadet \- Create or obtain information about CADET tunnels and peers
5
6 .SH SYNOPSIS
7 .B gnunet\-cadet
8 .RI [ options ]
9 .I [ \fIPEER_ID SHARED_SECRET\fR ]
10 .br
11
12 .SH DESCRIPTION
13 \fBgnunet\-cadet\fP prints information about CADET tunnels and peers.
14 It can also be used for command-line based CADET tunnels using the
15 \fI-o SHARED_SECRET\fR option to open a port on a receiving PEER_ID
16 and using "\fBgnunet\-cadet\fP \fIPEER_ID SHARED_SECRET\fR" to
17 establish one circuit to that peer from any other peer. The receiving
18 process will only accept one incoming circuit, but several commands
19 using the same \fI-o\fR can be issued to satisfy multiple requests.
20 For one-to-many communication \fBgnunet\-social\fP may be better
21 suited, however.
22
23 .SH SPECIFIC OPTIONS
24 .B
25 .IP "\-C CONNECTION_ID,  \-\-connection=CONNECTION_ID"
26 Provide information about a particular connection.
27 .B
28 .IP "\-d,  \-\-dump"
29 Dump debug information to STDERR.
30 .B
31 .IP "\-e,  \-\-echo"
32 Activate echo mode.
33 .B
34 .IP "\-o SHARED_SECRET,  \-\-open-port=SHARED_SECRET"
35 Listen for connections using a shared secret among sender and recipient.
36 .B
37 .IP "\-p PEER_ID,  \-\-peer=PEER_ID"
38 Provide information about a patricular peer.
39 .B
40 .IP "\-P,  \-\-peers"
41 Provide information about all peers.
42 .B
43 .IP "\-t TUNNEL_ID,  \-\-tunnel=TUNNEL_ID"
44 Provide information about a patricular tunnel.
45 .B
46 .IP "\-T,  \-\-tunnels"
47 Provide information about all tunnels.
48
49 .SH STANDARD OPTIONS
50 .B
51 .IP "\-c FILENAME,  \-\-config=FILENAME"
52 Use the configuration file FILENAME.
53 .B
54 .IP "\-h, \-\-help"
55 Print short help on options.
56 .B
57 .IP "\-l LOGFILE, \-\-logfile=LOGFILE"
58 Configure logging to write logs to LOGFILE.
59 .B
60 .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
61 Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
62 .B
63 .IP "\-v, \-\-version"
64 Print GNUnet version number.
65
66 .SH BUGS
67 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>