diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/Makefile.am | 4 | ||||
-rw-r--r-- | doc/man/gnunet-dht-get.1 | 90 | ||||
-rw-r--r-- | doc/man/gnunet-dht-hello.1 | 75 | ||||
-rw-r--r-- | doc/man/gnunet-dht-monitor.1 | 82 | ||||
-rw-r--r-- | doc/man/gnunet-dht-put.1 | 100 |
5 files changed, 351 insertions, 0 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 44d99e7e4..7a80a93d8 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am | |||
@@ -47,6 +47,10 @@ man_MANS = \ | |||
47 | gnunet-core.1 \ | 47 | gnunet-core.1 \ |
48 | gnunet-conversation.1 \ | 48 | gnunet-conversation.1 \ |
49 | gnunet-conversation-test.1 \ | 49 | gnunet-conversation-test.1 \ |
50 | gnunet-dht-get.1 \ | ||
51 | gnunet-dht-put.1 \ | ||
52 | gnunet-dht-monitor.1 \ | ||
53 | gnunet-dht-hello.1 \ | ||
50 | gnunet-directory.1 \ | 54 | gnunet-directory.1 \ |
51 | gnunet-dns2gns.1 \ | 55 | gnunet-dns2gns.1 \ |
52 | gnunet-datastore.1 \ | 56 | gnunet-datastore.1 \ |
diff --git a/doc/man/gnunet-dht-get.1 b/doc/man/gnunet-dht-get.1 new file mode 100644 index 000000000..bd411f2f0 --- /dev/null +++ b/doc/man/gnunet-dht-get.1 | |||
@@ -0,0 +1,90 @@ | |||
1 | .\" This file is part of GNUnet. | ||
2 | .\" Copyright (C) 2023 GNUnet e.V. | ||
3 | .\" | ||
4 | .\" Permission is granted to copy, distribute and/or modify this document | ||
5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or | ||
6 | .\" any later version published by the Free Software Foundation; with no | ||
7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A | ||
8 | .\" copy of the license is included in the file | ||
9 | .\" FDL-1.3. | ||
10 | .\" | ||
11 | .\" A copy of the license is also available from the Free Software | ||
12 | .\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}. | ||
13 | .\" | ||
14 | .\" Alternately, this document is also available under the General | ||
15 | .\" Public License, version 3 or later, as published by the Free Software | ||
16 | .\" Foundation. A copy of the license is included in the file | ||
17 | .\" GPL3. | ||
18 | .\" | ||
19 | .\" A copy of the license is also available from the Free Software | ||
20 | .\" Foundation Web site at http://www.gnu.org/licenses/gpl.html | ||
21 | .\" | ||
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
23 | .\" | ||
24 | .Dd January 5, 2023 | ||
25 | .Dt GNUNET-DHT-GET 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-dht-get | ||
29 | .Nd Issue a GET request to the DHT. Prints results. | ||
30 | .Sh SYNOPSIS | ||
31 | .Nm | ||
32 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
33 | .Op Fl h | -help | ||
34 | .Op Fl k Ar KEY | Fl -key= Ns Ar KEY | ||
35 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
36 | .Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | ||
37 | .Op Fl R | -record | ||
38 | .Op Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL | ||
39 | .Op Fl T Ar TYPE | Fl -type= Ns Ar TYPE | ||
40 | .Op Fl V | -verbose | ||
41 | .Op Fl v | -version | ||
42 | .Op Fl x | -demultiplex | ||
43 | .Sh DESCRIPTION | ||
44 | .Nm | ||
45 | is a command line tool to issue GET requests to the DHT. | ||
46 | .Sh OPTIONS | ||
47 | .Bl -tag -width indent | ||
48 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
49 | Use the configuration file | ||
50 | .Ar FILENAME . | ||
51 | .It Fl h | -help | ||
52 | Print short help on options. | ||
53 | .It Fl k Ar KEY | Fl -key= Ns Ar KEY | ||
54 | use the query key | ||
55 | .Ar KEY . | ||
56 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
57 | Use LOGLEVEL for logging. | ||
58 | Valid values are DEBUG, INFO, WARNING and ERROR. | ||
59 | .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | ||
60 | Configure logging to write logs to | ||
61 | .Ar LOGFILE . | ||
62 | .It Fl R | -record | ||
63 | Set DHT's record route option for the request. | ||
64 | .It Fl r Ar LEVEL | -replication-level= Ns Ar LEVEL | ||
65 | Use the DHT replication level | ||
66 | .Ar LEVEL . | ||
67 | .It Fl t Ar TYPE | -type= Ns Ar TYPE | ||
68 | the block type to look for under | ||
69 | .Ar KEY . | ||
70 | .It Fl V | -verbose | ||
71 | be verbose. | ||
72 | .It Fl v | -version | ||
73 | Print GNUnet version number. | ||
74 | .It Fl x | -demultiplex | ||
75 | Set DHT's demultiplex everywhere option. | ||
76 | .El | ||
77 | .Sh SEE ALSO | ||
78 | The full documentation for gnunet is maintained as a Texinfo manual. | ||
79 | If the | ||
80 | .Xr info 1 | ||
81 | and gnunet programs are properly installed at your site, the command | ||
82 | .Pp | ||
83 | .Dl info gnunet | ||
84 | .\".Sh HISTORY | ||
85 | .\".Sh AUTHORS | ||
86 | .Sh BUGS | ||
87 | Report bugs by using | ||
88 | .Lk https://bugs.gnunet.org | ||
89 | or by sending electronic mail to | ||
90 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-dht-hello.1 b/doc/man/gnunet-dht-hello.1 new file mode 100644 index 000000000..b50736f65 --- /dev/null +++ b/doc/man/gnunet-dht-hello.1 | |||
@@ -0,0 +1,75 @@ | |||
1 | .\" This file is part of GNUnet. | ||
2 | .\" Copyright (C) 2023 GNUnet e.V. | ||
3 | .\" | ||
4 | .\" Permission is granted to copy, distribute and/or modify this document | ||
5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or | ||
6 | .\" any later version published by the Free Software Foundation; with no | ||
7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A | ||
8 | .\" copy of the license is included in the file | ||
9 | .\" FDL-1.3. | ||
10 | .\" | ||
11 | .\" A copy of the license is also available from the Free Software | ||
12 | .\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}. | ||
13 | .\" | ||
14 | .\" Alternately, this document is also available under the General | ||
15 | .\" Public License, version 3 or later, as published by the Free Software | ||
16 | .\" Foundation. A copy of the license is included in the file | ||
17 | .\" GPL3. | ||
18 | .\" | ||
19 | .\" A copy of the license is also available from the Free Software | ||
20 | .\" Foundation Web site at http://www.gnu.org/licenses/gpl.html | ||
21 | .\" | ||
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
23 | .\" | ||
24 | .Dd January 5, 2023 | ||
25 | .Dt GNUNET-DHT-HELLO 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-dht-hello | ||
29 | .Nd Obtain HELLO from DHT or provide HELLO to DHT for bootstrapping. | ||
30 | .Sh SYNOPSIS | ||
31 | .Nm | ||
32 | .Op Ar URL | ||
33 | .El | ||
34 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
35 | .Op Fl h | -help | ||
36 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
37 | .Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | ||
38 | .Op Fl V | -verbose | ||
39 | .Op Fl v | -version | ||
40 | .Sh DESCRIPTION | ||
41 | .Nm | ||
42 | is a command line tool to either get a HELLO for your own peer (no arguments) or to | ||
43 | parse a HELLO URL by providing it as the sole argument. | ||
44 | .Sh OPTIONS | ||
45 | .Bl -tag -width indent | ||
46 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
47 | Use the configuration file | ||
48 | .Ar FILENAME . | ||
49 | .It Fl h | -help | ||
50 | Print short help on options. | ||
51 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
52 | Use LOGLEVEL for logging. | ||
53 | Valid values are DEBUG, INFO, WARNING and ERROR. | ||
54 | .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | ||
55 | Configure logging to write logs to | ||
56 | .Ar LOGFILE . | ||
57 | .It Fl V | -verbose | ||
58 | be verbose. | ||
59 | .It Fl v | -version | ||
60 | Print GNUnet version number. | ||
61 | .El | ||
62 | .Sh SEE ALSO | ||
63 | The full documentation for gnunet is maintained as a Texinfo manual. | ||
64 | If the | ||
65 | .Xr info 1 | ||
66 | and gnunet programs are properly installed at your site, the command | ||
67 | .Pp | ||
68 | .Dl info gnunet | ||
69 | .\".Sh HISTORY | ||
70 | .\".Sh AUTHORS | ||
71 | .Sh BUGS | ||
72 | Report bugs by using | ||
73 | .Lk https://bugs.gnunet.org | ||
74 | or by sending electronic mail to | ||
75 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-dht-monitor.1 b/doc/man/gnunet-dht-monitor.1 new file mode 100644 index 000000000..08707f6bb --- /dev/null +++ b/doc/man/gnunet-dht-monitor.1 | |||
@@ -0,0 +1,82 @@ | |||
1 | .\" This file is part of GNUnet. | ||
2 | .\" Copyright (C) 2023 GNUnet e.V. | ||
3 | .\" | ||
4 | .\" Permission is granted to copy, distribute and/or modify this document | ||
5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or | ||
6 | .\" any later version published by the Free Software Foundation; with no | ||
7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A | ||
8 | .\" copy of the license is included in the file | ||
9 | .\" FDL-1.3. | ||
10 | .\" | ||
11 | .\" A copy of the license is also available from the Free Software | ||
12 | .\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}. | ||
13 | .\" | ||
14 | .\" Alternately, this document is also available under the General | ||
15 | .\" Public License, version 3 or later, as published by the Free Software | ||
16 | .\" Foundation. A copy of the license is included in the file | ||
17 | .\" GPL3. | ||
18 | .\" | ||
19 | .\" A copy of the license is also available from the Free Software | ||
20 | .\" Foundation Web site at http://www.gnu.org/licenses/gpl.html | ||
21 | .\" | ||
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
23 | .\" | ||
24 | .Dd January 5, 2023 | ||
25 | .Dt GNUNET-DHT-MONITOR 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-dht-monitor | ||
29 | .Nd Print packets that go through the DHT on this peer. | ||
30 | .Sh SYNOPSIS | ||
31 | .Nm | ||
32 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
33 | .Op Fl h | -help | ||
34 | .Op Fl k Ar KEY | Fl -key= Ns Ar KEY | ||
35 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
36 | .Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | ||
37 | .Op Fl T Ar TIMEOUT | Fl -timeout= Ns Ar TIMEOUT | ||
38 | .Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE | ||
39 | .Op Fl V | -verbose | ||
40 | .Op Fl v | -version | ||
41 | .Sh DESCRIPTION | ||
42 | .Nm | ||
43 | is a command line tool to monitor DHT packets that go through this peer. | ||
44 | .Sh OPTIONS | ||
45 | .Bl -tag -width indent | ||
46 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
47 | Use the configuration file | ||
48 | .Ar FILENAME . | ||
49 | .It Fl h | -help | ||
50 | Print short help on options. | ||
51 | .It Fl k Ar KEY | Fl -key= Ns Ar KEY | ||
52 | use the query key | ||
53 | .Ar KEY . | ||
54 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
55 | Use LOGLEVEL for logging. | ||
56 | Valid values are DEBUG, INFO, WARNING and ERROR. | ||
57 | .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | ||
58 | Configure logging to write logs to | ||
59 | .Ar LOGFILE . | ||
60 | .It Fl T Ar TIMEOUT | -timeout= Ns Ar TIMEOUT | ||
61 | how long should the monitor command run. | ||
62 | .It Fl t Ar TYPE | Fl -type= Ns Ar TYPE | ||
63 | the block type to filter for. | ||
64 | .It Fl V | -verbose | ||
65 | be verbose. | ||
66 | .It Fl v | -version | ||
67 | Print GNUnet version number. | ||
68 | .El | ||
69 | .Sh SEE ALSO | ||
70 | The full documentation for gnunet is maintained as a Texinfo manual. | ||
71 | If the | ||
72 | .Xr info 1 | ||
73 | and gnunet programs are properly installed at your site, the command | ||
74 | .Pp | ||
75 | .Dl info gnunet | ||
76 | .\".Sh HISTORY | ||
77 | .\".Sh AUTHORS | ||
78 | .Sh BUGS | ||
79 | Report bugs by using | ||
80 | .Lk https://bugs.gnunet.org | ||
81 | or by sending electronic mail to | ||
82 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-dht-put.1 b/doc/man/gnunet-dht-put.1 new file mode 100644 index 000000000..ec6b38c44 --- /dev/null +++ b/doc/man/gnunet-dht-put.1 | |||
@@ -0,0 +1,100 @@ | |||
1 | .\" This file is part of GNUnet. | ||
2 | .\" Copyright (C) 2023 GNUnet e.V. | ||
3 | .\" | ||
4 | .\" Permission is granted to copy, distribute and/or modify this document | ||
5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or | ||
6 | .\" any later version published by the Free Software Foundation; with no | ||
7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A | ||
8 | .\" copy of the license is included in the file | ||
9 | .\" FDL-1.3. | ||
10 | .\" | ||
11 | .\" A copy of the license is also available from the Free Software | ||
12 | .\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}. | ||
13 | .\" | ||
14 | .\" Alternately, this document is also available under the General | ||
15 | .\" Public License, version 3 or later, as published by the Free Software | ||
16 | .\" Foundation. A copy of the license is included in the file | ||
17 | .\" GPL3. | ||
18 | .\" | ||
19 | .\" A copy of the license is also available from the Free Software | ||
20 | .\" Foundation Web site at http://www.gnu.org/licenses/gpl.html | ||
21 | .\" | ||
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
23 | .\" | ||
24 | .Dd January 5, 2023 | ||
25 | .Dt GNUNET-DHT-PUT 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-dht-put | ||
29 | .Nd Issue a PUT request to the DHT to insert | ||
30 | .Ar DATA | ||
31 | under | ||
32 | .Ar KEY . | ||
33 | .Sh SYNOPSIS | ||
34 | .Nm | ||
35 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
36 | .Op Fl d Ar DATA | Fl -data= Ns Ar DATA | ||
37 | .Op Fl e Ar EXPIRATION | Fl -expiration= Ns Ar EXPIRATION | ||
38 | .Op Fl h | -help | ||
39 | .Op Fl k Ar KEY | Fl -key= Ns Ar KEY | ||
40 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
41 | .Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | ||
42 | .Op Fl R | -record | ||
43 | .Op Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL | ||
44 | .Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE | ||
45 | .Op Fl V | -verbose | ||
46 | .Op Fl v | -version | ||
47 | .Op Fl x | -demultiplex | ||
48 | .Sh DESCRIPTION | ||
49 | .Nm | ||
50 | is a command line tool to issue PUT requests to the DHT. | ||
51 | .Sh OPTIONS | ||
52 | .Bl -tag -width indent | ||
53 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
54 | Use the configuration file | ||
55 | .Ar FILENAME . | ||
56 | .It Fl d Ar DATA | Fl -data= Ns Ar DATA | ||
57 | the data to insert under | ||
58 | .Ar KEY . | ||
59 | .It Fl e Ar EXPIRATION | Fl -expiration= Ns Ar EXPIRATION | ||
60 | how long to store this entry in the DHT (in seconds) | ||
61 | .It Fl h | -help | ||
62 | Print short help on options. | ||
63 | .It Fl k Ar KEY | Fl -key= Ns Ar KEY | ||
64 | use the query key | ||
65 | .Ar KEY . | ||
66 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
67 | Use LOGLEVEL for logging. | ||
68 | Valid values are DEBUG, INFO, WARNING and ERROR. | ||
69 | .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | ||
70 | Configure logging to write logs to | ||
71 | .Ar LOGFILE . | ||
72 | .It Fl R | -record | ||
73 | Set DHT's record route option for the request. | ||
74 | .It Fl r Ar LEVEL | -replication-level= Ns Ar LEVEL | ||
75 | Use the DHT replication level | ||
76 | .Ar LEVEL . | ||
77 | .It Fl t Ar TYPE | -type= Ns Ar TYPE | ||
78 | the block type of | ||
79 | .Ar DATA . | ||
80 | .It Fl V | -verbose | ||
81 | be verbose. | ||
82 | .It Fl v | -version | ||
83 | Print GNUnet version number. | ||
84 | .It Fl x | -demultiplex | ||
85 | Set DHT's demultiplex everywhere option. | ||
86 | .El | ||
87 | .Sh SEE ALSO | ||
88 | The full documentation for gnunet is maintained as a Texinfo manual. | ||
89 | If the | ||
90 | .Xr info 1 | ||
91 | and gnunet programs are properly installed at your site, the command | ||
92 | .Pp | ||
93 | .Dl info gnunet | ||
94 | .\".Sh HISTORY | ||
95 | .\".Sh AUTHORS | ||
96 | .Sh BUGS | ||
97 | Report bugs by using | ||
98 | .Lk https://bugs.gnunet.org | ||
99 | or by sending electronic mail to | ||
100 | .Aq Mt gnunet-developers@gnu.org . | ||