aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-cadet.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-cadet.1')
-rw-r--r--doc/man/gnunet-cadet.149
1 files changed, 39 insertions, 10 deletions
diff --git a/doc/man/gnunet-cadet.1 b/doc/man/gnunet-cadet.1
index 867a59f65..d95cf851c 100644
--- a/doc/man/gnunet-cadet.1
+++ b/doc/man/gnunet-cadet.1
@@ -1,17 +1,52 @@
1.TH GNUNET\-CADET 1 "May 3, 2016" "GNUnet" 1.TH GNUNET\-CADET 1 "May 3, 2016" "GNUnet"
2 2
3.SH NAME 3.SH NAME
4gnunet\-cadet \- Print information about CADET tunnels and peers 4gnunet\-cadet \- Create or obtain information about CADET tunnels and peers
5 5
6.SH SYNOPSIS 6.SH SYNOPSIS
7.B gnunet\-cadet 7.B gnunet\-cadet
8.RI [ options ] 8.RI [ options ]
9.I [ \fIPEER_ID SHARED_SECRET\fR ]
9.br 10.br
10 11
11.SH DESCRIPTION 12.SH DESCRIPTION
12\fBgnunet\-cadet\fP prints information about CADET tunnels and peers. 13\fBgnunet\-cadet\fP prints information about CADET tunnels and peers.
14It 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
16and using "\fBgnunet\-cadet\fP \fIPEER_ID SHARED_SECRET\fR" to
17establish one circuit to that peer from any other peer. The receiving
18process will only accept one incoming circuit, but several commands
19using the same \fI-o\fR can be issued to satisfy multiple requests.
20For one-to-many communication \fBgnunet\-social\fP may be better
21suited, however.
13 22
14.SH OPTIONS 23.SH SPECIFIC OPTIONS
24.B
25.IP "\-C CONNECTION_ID, \-\-connection=CONNECTION_ID"
26Provide information about a particular connection.
27.B
28.IP "\-d, \-\-dump"
29Dump debug information to STDERR.
30.B
31.IP "\-e, \-\-echo"
32Activate echo mode.
33.B
34.IP "\-o SHARED_SECRET, \-\-open-port=SHARED_SECRET"
35Listen for connections using a shared secret among sender and recipient.
36.B
37.IP "\-p PEER_ID, \-\-peer=PEER_ID"
38Provide information about a patricular peer.
39.B
40.IP "\-P, \-\-peers"
41Provide information about all peers.
42.B
43.IP "\-t TUNNEL_ID, \-\-tunnel=TUNNEL_ID"
44Provide information about a patricular tunnel.
45.B
46.IP "\-T, \-\-tunnels"
47Provide information about all tunnels.
48
49.SH STANDARD OPTIONS
15.B 50.B
16.IP "\-c FILENAME, \-\-config=FILENAME" 51.IP "\-c FILENAME, \-\-config=FILENAME"
17Use the configuration file FILENAME. 52Use the configuration file FILENAME.
@@ -19,17 +54,11 @@ Use the configuration file FILENAME.
19.IP "\-h, \-\-help" 54.IP "\-h, \-\-help"
20Print short help on options. 55Print short help on options.
21.B 56.B
22.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
23Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
24.B
25.IP "\-l LOGFILE, \-\-logfile=LOGFILE" 57.IP "\-l LOGFILE, \-\-logfile=LOGFILE"
26Configure logging to write logs to LOGFILE. 58Configure logging to write logs to LOGFILE.
27.B 59.B
28.IP "\-m, \-\-monitor" 60.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
29Provide information about all tunnels (continuously) NOT IMPLEMENTED. 61Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
30.B
31.IP "\-t OWNER\_ID:TUNNEL\_ID, \-\-tunnel=OWNER\_ID:TUNNEL\_ID"
32Provide information about a particular tunnel.
33.B 62.B
34.IP "\-v, \-\-version" 63.IP "\-v, \-\-version"
35Print GNUnet version number. 64Print GNUnet version number.