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.143
1 files changed, 30 insertions, 13 deletions
diff --git a/doc/man/gnunet-cadet.1 b/doc/man/gnunet-cadet.1
index 272f04232..081b50572 100644
--- a/doc/man/gnunet-cadet.1
+++ b/doc/man/gnunet-cadet.1
@@ -19,41 +19,58 @@ create or obtain information about CADET tunnels and peers
19.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME 19.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
20.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 20.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
21.Op Fl v | \-version 21.Op Fl v | \-version
22.Ao Ar PEER_ID SHARED_SECRET Ac 22.Ao Ar PEER_ID Ac
23.Ao Ar SHARED_SECRET Ac
23.Sh DESCRIPTION 24.Sh DESCRIPTION
24.Nm 25.Nm
25prints information about CADET tunnels and peers. 26prints information about CADET tunnels and peers.
26It 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. 27It can also be used for command-line based CADET tunnels using the
27The 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.Fl o Ar SHARED_SECRET
28For one\-to\-many communication 29option to open a port on a receiving
30.Ar PEER_ID
31and using
32.Nm
33.Ao Ar PEER_ID Ac
34.Ao Ar SHARED_SECRET Ac
35to establish one circuit to that peer from any other peer.
36The receiving process will only accept one incoming circuit, but several commands using the same
37.Fl o
38can be issued to satisfy multiple requests.
39For one-to-many communication
29.Xr gnunet-social 1 40.Xr gnunet-social 1
30may be better suited, however. 41may be better suited, however.
31.Bl -tag -width Ds 42.Bl -tag -width Ds
32.It Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID 43.It Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID
33Provide information about a particular connection. 44Provide information about the connection
45.Ar CONNECTION_ID .
34.It Fl d | \-dump 46.It Fl d | \-dump
35Dump debug information to STDERR. 47Dump debug information to stderr.
36.It Fl e | \-echo 48.It Fl e | \-echo
37Activate echo mode. 49Activate echo mode.
38.It Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET 50.It Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET
39Listen for connections using a shared secret among sender and recipient. 51Listen for connections using a shared secret, provided as
52.Ar SHARED_SECRET ,
53among sender and recipient.
40.It Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID 54.It Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID
41Provide information about a patricular peer. 55Provide information about the peer
56.Ar PEER_ID .
42.It Fl P | \-peers 57.It Fl P | \-peers
43Provide information about all peers. 58Provide information about all (known) peers.
44.It Fl T | \-tunnels 59.It Fl T | \-tunnels
45Provide information about all tunnels. 60Provide information about all tunnels.
46.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 61.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
47Use the configuration file FILENAME. 62Use the configuration file
63.Ar FILENAME .
48.It Fl h | \-help 64.It Fl h | \-help
49Print short help on options. 65Print the help page.
50.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME 66.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
51Configure logging to write logs to FILENAME. 67Configure logging to write logs to
68.Ar FILENAME .
52.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 69.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
53Use LOGLEVEL for logging. 70Use LOGLEVEL for logging.
54Valid values are DEBUG, INFO, WARNING and ERROR. 71Valid values are DEBUG, INFO, WARNING and ERROR.
55.It Fl v | \-version 72.It Fl v | \-version
56Print GNUnet version number. 73Print the GNUnet version number.
57.El 74.El
58.Sh SEE ALSO 75.Sh SEE ALSO
59The full documentation for gnunet is maintained as a Texinfo manual. 76The full documentation for gnunet is maintained as a Texinfo manual.