diff options
author | psyc://loupsycedyglgamf.onion/~lynX <BM-NB7xa9gEpmJgYp9PVnEdACiZcGmmEJcY> | 2017-03-08 23:15:55 +0000 |
---|---|---|
committer | psyc://loupsycedyglgamf.onion/~lynX <BM-NB7xa9gEpmJgYp9PVnEdACiZcGmmEJcY> | 2017-03-08 23:15:55 +0000 |
commit | 5939efa5df9e8a19ec3c8c56dc0593464e5e72da (patch) | |
tree | 34bdbc2a5f4ea8761cfc88e8062c5c4fa3705df0 /doc/man | |
parent | 99350928f4087a116de62350d7d3f293e50e468c (diff) | |
download | gnunet-5939efa5df9e8a19ec3c8c56dc0593464e5e72da.tar.gz gnunet-5939efa5df9e8a19ec3c8c56dc0593464e5e72da.zip |
upstyle gnunet-cadet docs
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/gnunet-cadet.1 | 49 |
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 |
4 | gnunet\-cadet \- Print information about CADET tunnels and peers | 4 | gnunet\-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. |
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. | ||
13 | 22 | ||
14 | .SH OPTIONS | 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 | ||
15 | .B | 50 | .B |
16 | .IP "\-c FILENAME, \-\-config=FILENAME" | 51 | .IP "\-c FILENAME, \-\-config=FILENAME" |
17 | Use the configuration file FILENAME. | 52 | Use the configuration file FILENAME. |
@@ -19,17 +54,11 @@ Use the configuration file FILENAME. | |||
19 | .IP "\-h, \-\-help" | 54 | .IP "\-h, \-\-help" |
20 | Print short help on options. | 55 | Print short help on options. |
21 | .B | 56 | .B |
22 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | ||
23 | Use 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" |
26 | Configure logging to write logs to LOGFILE. | 58 | Configure logging to write logs to LOGFILE. |
27 | .B | 59 | .B |
28 | .IP "\-m, \-\-monitor" | 60 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
29 | Provide information about all tunnels (continuously) NOT IMPLEMENTED. | 61 | Use 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" | ||
32 | Provide information about a particular tunnel. | ||
33 | .B | 62 | .B |
34 | .IP "\-v, \-\-version" | 63 | .IP "\-v, \-\-version" |
35 | Print GNUnet version number. | 64 | Print GNUnet version number. |