summaryrefslogtreecommitdiff
path: root/doc/man/gnunet-cadet.1
blob: 272f04232197b09a1f985df3fefc8e38630212a6 (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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
.Dd May 3, 2016
.Dt GNUNET-CADET 1
.Os
.Sh NAME
.Nm gnunet-cadet
.Nd
create or obtain information about CADET tunnels and peers
.Sh SYNOPSIS
.Nm
.Op Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID
.Op Fl d | \-dump
.Op Fl e | \-echo
.Op Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET
.Op Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID
.Op Fl P | \-peers
.Op Fl T | \-tunnels
.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
.Op Fl h | \-help
.Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
.Op Fl v | \-version
.Ao Ar PEER_ID SHARED_SECRET Ac
.Sh DESCRIPTION
.Nm
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
.Xr gnunet-social 1
may be better suited, however.
.Bl -tag -width Ds
.It Fl C Ar CONNECTION_ID | Fl \-connection= Ns Ar CONNECTION_ID
Provide information about a particular connection.
.It Fl d | \-dump
Dump debug information to STDERR.
.It Fl e | \-echo
Activate echo mode.
.It Fl o Ar SHARED_SECRET | Fl \-open-port= Ns Ar SHARED_SECRET
Listen for connections using a shared secret among sender and recipient.
.It Fl p Ar PEER_ID | Fl \-peer= Ns Ar PEER_ID
Provide information about a patricular peer.
.It Fl P | \-peers
Provide information about all peers.
.It Fl T | \-tunnels
Provide information about all tunnels.
.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
Use the configuration file FILENAME.
.It Fl h | \-help
Print short help on options.
.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
Configure logging to write logs to FILENAME.
.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
Use LOGLEVEL for logging.
Valid values are DEBUG, INFO, WARNING and ERROR.
.It Fl v | \-version
Print GNUnet version number.
.El
.Sh SEE ALSO
The full documentation for gnunet is maintained as a Texinfo manual.
If the
.Xr info 1
and gnunet programs are properly installed at your site, the command
.Pp
.Dl info gnunet
.Pp
should give you access to the complete handbook,
.Pp
.Dl info gnunet-c-tutorial
.Pp
will give you access to a tutorial for developers.
.sp
Depending on your installation, this information is also available in
.Xr gnunet 7 and
.Xr gnunet-c-tutorial 7 .
.\".Sh HISTORY
.\".Sh AUTHORS
.Sh BUGS
Report bugs by using
.Lk https://bugs.gnunet.org
or by sending electronic mail to
.Aq Mt gnunet-developers@gnu.org .