diff options
author | ng0 <ng0@n0.is> | 2019-04-03 12:18:14 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-04-03 12:18:14 +0000 |
commit | f002ecb549ec33da77e4a034ad1cffe27922112d (patch) | |
tree | eab771900b4675ef7c857073531d6b1ef7d1680a /doc | |
parent | f8227999be132133ca6d2513ac45aa82cbdcbe29 (diff) | |
download | gnunet-f002ecb549ec33da77e4a034ad1cffe27922112d.tar.gz gnunet-f002ecb549ec33da77e4a034ad1cffe27922112d.zip |
man: cadet
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/gnunet-cadet.1 | 130 |
1 files changed, 69 insertions, 61 deletions
diff --git a/doc/man/gnunet-cadet.1 b/doc/man/gnunet-cadet.1 index 44d7fffca..272f04232 100644 --- a/doc/man/gnunet-cadet.1 +++ b/doc/man/gnunet-cadet.1 | |||
@@ -1,73 +1,81 @@ | |||
1 | .TH GNUNET\-CADET 1 "May 3, 2016" "GNUnet" | 1 | .Dd May 3, 2016 |
2 | 2 | .Dt GNUNET-CADET 1 | |
3 | .SH NAME | 3 | .Os |
4 | gnunet\-cadet \- Create or obtain information about CADET tunnels and peers | 4 | .Sh NAME |
5 | 5 | .Nm gnunet-cadet | |
6 | .SH SYNOPSIS | 6 | .Nd |
7 | .B gnunet\-cadet | 7 | create or obtain information about CADET tunnels and peers |
8 | .RI [ options ] | 8 | .Sh SYNOPSIS |
9 | .I [ \fIPEER_ID SHARED_SECRET\fR ] | 9 | .Nm |
10 | .br | 10 | .Op Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID |
11 | 11 | .Op Fl d | \-dump | |
12 | .SH DESCRIPTION | 12 | .Op Fl e | \-echo |
13 | \fBgnunet\-cadet\fP prints information about CADET tunnels and peers. | 13 | .Op Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET |
14 | It can also be used for command-line based CADET tunnels using the | 14 | .Op Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID |
15 | \fI-o SHARED_SECRET\fR option to open a port on a receiving PEER_ID | 15 | .Op Fl P | \-peers |
16 | and using "\fBgnunet\-cadet\fP \fIPEER_ID SHARED_SECRET\fR" to | 16 | .Op Fl T | \-tunnels |
17 | establish one circuit to that peer from any other peer. The receiving | 17 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
18 | process will only accept one incoming circuit, but several commands | 18 | .Op Fl h | \-help |
19 | using the same \fI-o\fR can be issued to satisfy multiple requests. | 19 | .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME |
20 | For one\-to\-many communication \fBgnunet\-social\fP may be better | 20 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
21 | suited, however. | 21 | .Op Fl v | \-version |
22 | 22 | .Ao Ar PEER_ID SHARED_SECRET Ac | |
23 | .SH SPECIFIC OPTIONS | 23 | .Sh DESCRIPTION |
24 | .IP "\-C CONNECTION_ID, \-\-connection=CONNECTION_ID" | 24 | .Nm |
25 | prints information about CADET tunnels and peers. | ||
26 | 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. | ||
27 | 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. | ||
28 | For one\-to\-many communication | ||
29 | .Xr gnunet-social 1 | ||
30 | may be better suited, however. | ||
31 | .Bl -tag -width Ds | ||
32 | .It Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID | ||
25 | Provide information about a particular connection. | 33 | Provide information about a particular connection. |
26 | .IP "\-d, \-\-dump" | 34 | .It Fl d | \-dump |
27 | Dump debug information to STDERR. | 35 | Dump debug information to STDERR. |
28 | .IP "\-e, \-\-echo" | 36 | .It Fl e | \-echo |
29 | Activate echo mode. | 37 | Activate echo mode. |
30 | .IP "\-o SHARED_SECRET, \-\-open-port=SHARED_SECRET" | 38 | .It Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET |
31 | Listen for connections using a shared secret among sender and recipient. | 39 | Listen for connections using a shared secret among sender and recipient. |
32 | .IP "\-p PEER_ID, \-\-peer=PEER_ID" | 40 | .It Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID |
33 | Provide information about a patricular peer. | 41 | Provide information about a patricular peer. |
34 | .IP "\-P, \-\-peers" | 42 | .It Fl P | \-peers |
35 | Provide information about all peers. | 43 | Provide information about all peers. |
36 | .IP "\-T, \-\-tunnels" | 44 | .It Fl T | \-tunnels |
37 | Provide information about all tunnels. | 45 | Provide information about all tunnels. |
38 | 46 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | |
39 | .SH STANDARD OPTIONS | ||
40 | .IP "\-c FILENAME, \-\-config=FILENAME" | ||
41 | Use the configuration file FILENAME. | 47 | Use the configuration file FILENAME. |
42 | .IP "\-h, \-\-help" | 48 | .It Fl h | \-help |
43 | Print short help on options. | 49 | Print short help on options. |
44 | .IP "\-l LOGFILE, \-\-logfile=LOGFILE" | 50 | .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME |
45 | Configure logging to write logs to LOGFILE. | 51 | Configure logging to write logs to FILENAME. |
46 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 52 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
47 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 53 | Use LOGLEVEL for logging. |
48 | .IP "\-v, \-\-version" | 54 | Valid values are DEBUG, INFO, WARNING and ERROR. |
55 | .It Fl v | \-version | ||
49 | Print GNUnet version number. | 56 | Print GNUnet version number. |
50 | 57 | .El | |
51 | .SH BUGS | 58 | .Sh SEE ALSO |
52 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 59 | The full documentation for gnunet is maintained as a Texinfo manual. |
53 | electronic mail to <gnunet\-developers@gnu.org> | 60 | If the |
54 | .SH SEE ALSO | 61 | .Xr info 1 |
55 | The full documentation for | 62 | and gnunet programs are properly installed at your site, the command |
56 | .B gnunet | 63 | .Pp |
57 | is maintained as a Texinfo manual. If the | 64 | .Dl info gnunet |
58 | .B info | 65 | .Pp |
59 | and | ||
60 | .B gnunet | ||
61 | programs are properly installed at your site, the command | ||
62 | .IP | ||
63 | .B info gnunet | ||
64 | .PP | ||
65 | should give you access to the complete handbook, | 66 | should give you access to the complete handbook, |
66 | .IP | 67 | .Pp |
67 | .B info gnunet-c-tutorial | 68 | .Dl info gnunet-c-tutorial |
68 | .PP | 69 | .Pp |
69 | will give you access to a tutorial for developers. | 70 | will give you access to a tutorial for developers. |
70 | .PP | 71 | .sp |
71 | Depending on your installation, this information is also | 72 | Depending on your installation, this information is also available in |
72 | available in | 73 | .Xr gnunet 7 and |
73 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 74 | .Xr gnunet-c-tutorial 7 . |
75 | .\".Sh HISTORY | ||
76 | .\".Sh AUTHORS | ||
77 | .Sh BUGS | ||
78 | Report bugs by using | ||
79 | .Lk https://bugs.gnunet.org | ||
80 | or by sending electronic mail to | ||
81 | .Aq Mt gnunet-developers@gnu.org . | ||