summaryrefslogtreecommitdiff
path: root/doc/man/gnunet-cadet.1
blob: d95cf851c450af0e0f3fcabdf362213644ca09e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
.TH GNUNET\-CADET 1 "May 3, 2016" "GNUnet"

.SH NAME
gnunet\-cadet \- Create or obtain information about CADET tunnels and peers

.SH SYNOPSIS
.B gnunet\-cadet
.RI [ options ]
.I [ \fIPEER_ID SHARED_SECRET\fR ]
.br

.SH DESCRIPTION
\fBgnunet\-cadet\fP prints information about CADET tunnels and peers.
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. 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.
For one-to-many communication \fBgnunet\-social\fP may be better
suited, however.

.SH SPECIFIC OPTIONS
.B
.IP "\-C CONNECTION_ID,  \-\-connection=CONNECTION_ID"
Provide information about a particular connection.
.B
.IP "\-d,  \-\-dump"
Dump debug information to STDERR.
.B
.IP "\-e,  \-\-echo"
Activate echo mode.
.B
.IP "\-o SHARED_SECRET,  \-\-open-port=SHARED_SECRET"
Listen for connections using a shared secret among sender and recipient.
.B
.IP "\-p PEER_ID,  \-\-peer=PEER_ID"
Provide information about a patricular peer.
.B
.IP "\-P,  \-\-peers"
Provide information about all peers.
.B
.IP "\-t TUNNEL_ID,  \-\-tunnel=TUNNEL_ID"
Provide information about a patricular tunnel.
.B
.IP "\-T,  \-\-tunnels"
Provide information about all tunnels.

.SH STANDARD OPTIONS
.B
.IP "\-c FILENAME,  \-\-config=FILENAME"
Use the configuration file FILENAME.
.B
.IP "\-h, \-\-help"
Print short help on options.
.B
.IP "\-l LOGFILE, \-\-logfile=LOGFILE"
Configure logging to write logs to LOGFILE.
.B
.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
.B
.IP "\-v, \-\-version"
Print GNUnet version number.

.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>