diff options
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/Makefile.am | 17 | ||||
-rw-r--r-- | doc/man/gnunet-ats.1 | 114 | ||||
-rw-r--r-- | doc/man/gnunet-core.1 | 6 | ||||
-rw-r--r-- | doc/man/gnunet-dht-get.1 (renamed from doc/man/gnunet-peerinfo.1) | 85 | ||||
-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 | ||||
-rw-r--r-- | doc/man/gnunet-did.1 (renamed from doc/man/gnunet-namestore-fcfsd.1) | 95 | ||||
-rw-r--r-- | doc/man/gnunet-dns2gns.1 | 1 | ||||
-rw-r--r-- | doc/man/gnunet-messenger.1 (renamed from doc/man/gnunet-testbed-profiler.1) | 55 | ||||
-rw-r--r-- | doc/man/gnunet-nse.1 | 3 | ||||
-rw-r--r-- | doc/man/meson.build | 62 |
12 files changed, 449 insertions, 246 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index cad20306d..6ab720826 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am | |||
@@ -1,7 +1,7 @@ | |||
1 | # This Makefile.am is in the public domain | 1 | # This Makefile.am is in the public domain |
2 | 2 | ||
3 | gnunet.conf.5: gnunet.conf.5.in Makefile | 3 | gnunet.conf.5: gnunet.conf.5.in Makefile |
4 | $(AWK) -v bdir="$(bindir)" -v py="$(PYTHON)" -v awkay="$(AWK_BINARY)" -v pfx="$(prefix)" -v prl="$(PERL)" -v sysconfdirectory="$(sysconfdir)" -v pkgdatadirectory="$(pkgdatadir)" -f $(top_srcdir)/bin/dosubst.awk < $(srcdir)/gnunet.conf.5.in > $(srcdir)/gnunet.conf.5 | 4 | $(AWK) -v bdir="$(bindir)" -v py="$(PYTHON)" -v awkay="$(AWK_BINARY)" -v pfx="$(prefix)" -v prl="$(PERL)" -v sysconfdirectory="$(sysconfdir)" -v pkgdatadirectory="$(pkgdatadir)" -f $(top_srcdir)/scripts/dosubst.awk < $(srcdir)/gnunet.conf.5.in > $(srcdir)/gnunet.conf.5 |
5 | 5 | ||
6 | CLEANFILES = gnunet.conf.5 | 6 | CLEANFILES = gnunet.conf.5 |
7 | 7 | ||
@@ -14,7 +14,7 @@ if HAVE_MANDOC | |||
14 | # I want and that the alternatives are depressing and | 14 | # I want and that the alternatives are depressing and |
15 | # nonfunctional. | 15 | # nonfunctional. |
16 | produce_html.sh: produce_html.sh.in Makefile | 16 | produce_html.sh: produce_html.sh.in Makefile |
17 | $(AWK) -v bdir="$(bindir)" -v py="$(PYTHON)" -v awkay="$(AWK_BINARY)" -v pfx="$(prefix)" -v prl="$(PERL)" -v sysconfdirectory="$(sysconfdir)" -v pkgdatadirectory="$(pkgdatadir)" -f $(top_srcdir)/bin/dosubst.awk < $(srcdir)/produce_html.sh.in > produce_html.sh | 17 | $(AWK) -v bdir="$(bindir)" -v py="$(PYTHON)" -v awkay="$(AWK_BINARY)" -v pfx="$(prefix)" -v prl="$(PERL)" -v sysconfdirectory="$(sysconfdir)" -v pkgdatadirectory="$(pkgdatadir)" -f $(top_srcdir)/scripts/dosubst.awk < $(srcdir)/produce_html.sh.in > produce_html.sh |
18 | @chmod +x produce_html.sh | 18 | @chmod +x produce_html.sh |
19 | 19 | ||
20 | CLEANFILES += produce_html.sh | 20 | CLEANFILES += produce_html.sh |
@@ -38,7 +38,6 @@ endif | |||
38 | man_MANS = \ | 38 | man_MANS = \ |
39 | gnunet.conf.5 \ | 39 | gnunet.conf.5 \ |
40 | gnunet-arm.1 \ | 40 | gnunet-arm.1 \ |
41 | gnunet-ats.1 \ | ||
42 | gnunet-auto-share.1 \ | 41 | gnunet-auto-share.1 \ |
43 | gnunet-base32.1 \ | 42 | gnunet-base32.1 \ |
44 | gnunet-bcd.1 \ | 43 | gnunet-bcd.1 \ |
@@ -47,10 +46,15 @@ man_MANS = \ | |||
47 | gnunet-core.1 \ | 46 | gnunet-core.1 \ |
48 | gnunet-conversation.1 \ | 47 | gnunet-conversation.1 \ |
49 | gnunet-conversation-test.1 \ | 48 | gnunet-conversation-test.1 \ |
49 | gnunet-dht-get.1 \ | ||
50 | gnunet-dht-put.1 \ | ||
51 | gnunet-dht-monitor.1 \ | ||
52 | gnunet-dht-hello.1 \ | ||
50 | gnunet-directory.1 \ | 53 | gnunet-directory.1 \ |
51 | gnunet-dns2gns.1 \ | 54 | gnunet-dns2gns.1 \ |
52 | gnunet-datastore.1 \ | 55 | gnunet-datastore.1 \ |
53 | gnunet-download.1 \ | 56 | gnunet-download.1 \ |
57 | gnunet-did.1 \ | ||
54 | gnunet-ecc.1 \ | 58 | gnunet-ecc.1 \ |
55 | gnunet-fs.1 \ | 59 | gnunet-fs.1 \ |
56 | gnunet-gns.1 \ | 60 | gnunet-gns.1 \ |
@@ -58,16 +62,15 @@ man_MANS = \ | |||
58 | gnunet-gns-proxy-setup-ca.1 \ | 62 | gnunet-gns-proxy-setup-ca.1 \ |
59 | gnunet-identity.1 \ | 63 | gnunet-identity.1 \ |
60 | gnunet-cadet.1 \ | 64 | gnunet-cadet.1 \ |
65 | gnunet-messenger.1 \ | ||
61 | gnunet-namecache.1 \ | 66 | gnunet-namecache.1 \ |
62 | gnunet-namestore.1 \ | 67 | gnunet-namestore.1 \ |
63 | gnunet-namestore-fcfsd.1 \ | ||
64 | gnunet-namestore-dbtool.1 \ | 68 | gnunet-namestore-dbtool.1 \ |
65 | gnunet-namestore-zonefile.1 \ | 69 | gnunet-namestore-zonefile.1 \ |
66 | gnunet-nat.1 \ | 70 | gnunet-nat.1 \ |
67 | gnunet-nat-auto.1 \ | 71 | gnunet-nat-auto.1 \ |
68 | gnunet-nat-server.1 \ | 72 | gnunet-nat-server.1 \ |
69 | gnunet-nse.1 \ | 73 | gnunet-nse.1 \ |
70 | gnunet-peerinfo.1 \ | ||
71 | gnunet-publish.1 \ | 74 | gnunet-publish.1 \ |
72 | gnunet-qr.1 \ | 75 | gnunet-qr.1 \ |
73 | gnunet-reclaim.1 \ | 76 | gnunet-reclaim.1 \ |
@@ -77,7 +80,7 @@ man_MANS = \ | |||
77 | gnunet-scrypt.1 \ | 80 | gnunet-scrypt.1 \ |
78 | gnunet-search.1 \ | 81 | gnunet-search.1 \ |
79 | gnunet-statistics.1 \ | 82 | gnunet-statistics.1 \ |
80 | gnunet-testbed-profiler.1 \ | 83 | gnunet-testing.1 \ |
81 | gnunet-testing-run-service.1 \ | 84 | gnunet-testing-run-service.1 \ |
82 | gnunet-timeout.1 \ | 85 | gnunet-timeout.1 \ |
83 | gnunet-transport.1 \ | 86 | gnunet-transport.1 \ |
diff --git a/doc/man/gnunet-ats.1 b/doc/man/gnunet-ats.1 deleted file mode 100644 index 311501002..000000000 --- a/doc/man/gnunet-ats.1 +++ /dev/null | |||
@@ -1,114 +0,0 @@ | |||
1 | .\" This file is part of GNUnet. | ||
2 | .\" Copyright (C) 2001-2019 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 October 16, 2015 | ||
25 | .Dt GNUNET-ATS 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-ats | ||
29 | .Nd display information about transport resource allocation | ||
30 | .Sh SYNOPSIS | ||
31 | .Nm | ||
32 | .Op Fl a | -all | ||
33 | .Op Fl C Ar PEERID | Fl -connect= Ns Ar PEERID | ||
34 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
35 | .Op Fl h | -help | ||
36 | .Op Fl i Ar PEERID | Fl -id= Ns Ar PEERID | ||
37 | .Op Fl k Ar VALUE | Fl -value= Ns Ar VALUE | ||
38 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
39 | .Op Fl m | -monitor | ||
40 | .Op Fl n | -numeric | ||
41 | .Op Fl p Ar PREFERENCE | Fl -preference= Ns Ar PREFERENCE | ||
42 | .Op Fl q | -quotas | ||
43 | .Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE | ||
44 | .Op Fl u | -used | ||
45 | .Op Fl V | -verbose | ||
46 | .Op Fl v | -version | ||
47 | .Sh DESCRIPTION | ||
48 | .Nm | ||
49 | can be used to display information about the | ||
50 | GNUnet's transport selection mechanism. | ||
51 | It shows information about the addresses and | ||
52 | the assigned input and output bandwidth. | ||
53 | .Sh OPTIONS | ||
54 | .Bl -tag -width indent | ||
55 | .It Fl a | -all | ||
56 | List all addresses currently known to ats. | ||
57 | .It Fl C Ar PEERID | Fl -connect= Ns Ar PEERID | ||
58 | Ask ATS to suggest an address for PEERID to transport | ||
59 | to establish a connection. | ||
60 | Note that you can use the | ||
61 | .Xr gnunet-transport 1 | ||
62 | commandline tool to force disconnects. | ||
63 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
64 | Use the configuration file FILENAME. | ||
65 | .It Fl h | -help | ||
66 | Print short help on options. | ||
67 | .It Fl i Ar PEERID | Fl -id= Ns Ar PEERID | ||
68 | Print information for a specific peer identity only. | ||
69 | .It Fl k Ar VALUE | Fl -value= Ns Ar VALUE | ||
70 | Value to set for when changing preference values. | ||
71 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
72 | Use LOGLEVEL for logging. | ||
73 | Valid values are DEBUG, INFO, WARNING and ERROR. | ||
74 | .It Fl m | -monitor | ||
75 | Monitor changes to the bandwidth assignments continuously. | ||
76 | .It Fl n | -numeric | ||
77 | Do not resolve IP addresses to hostnames. | ||
78 | .It Fl p Ar PREFERENCE | Fl -preference= Ns Ar PREFERENCE | ||
79 | Set preference values, -i, -k and -t required. | ||
80 | .It Fl q | -quotas | ||
81 | Print quotas for all network types | ||
82 | .It Fl t Ar TYPE | Fl -type= Ns Ar TYPE | ||
83 | Preference type to change: latency | bandwidth | ||
84 | .It Fl u | -used | ||
85 | Print addresses actively used only | ||
86 | .It Fl V | -verbose | ||
87 | Print verbose output (include ATS address properties) | ||
88 | .It v | -version | ||
89 | Print GNUnet version number. | ||
90 | .El | ||
91 | .Sh SEE ALSO | ||
92 | .Xr gnunet-transport 1 | ||
93 | .sp | ||
94 | The full documentation for gnunet is maintained as a Texinfo manual. | ||
95 | If the | ||
96 | .Xr info 1 | ||
97 | and gnunet programs are properly installed at your site, the command | ||
98 | .Pp | ||
99 | .Dl info gnunet | ||
100 | .Pp | ||
101 | should give you access to the complete handbook, | ||
102 | .Pp | ||
103 | .Dl info gnunet-c-tutorial | ||
104 | .Pp | ||
105 | will give you access to a tutorial for developers. | ||
106 | .Pp | ||
107 | Depending on your installation, this information is also available in | ||
108 | .Xr gnunet 7 and | ||
109 | .Xr gnunet-c-tutorial 7 . | ||
110 | .Sh BUGS | ||
111 | Report bugs by using | ||
112 | .Lk https://bugs.gnunet.org | ||
113 | or by sending electronic mail to | ||
114 | .Aq Mt bug-gnunet@gnu.org . | ||
diff --git a/doc/man/gnunet-core.1 b/doc/man/gnunet-core.1 index 745a666b8..921f2ead6 100644 --- a/doc/man/gnunet-core.1 +++ b/doc/man/gnunet-core.1 | |||
@@ -39,8 +39,6 @@ | |||
39 | .Nm | 39 | .Nm |
40 | is a tool to access various functions of GNUnet's core subsystem | 40 | is a tool to access various functions of GNUnet's core subsystem |
41 | from the command-line. | 41 | from the command-line. |
42 | The only function right now is to monitor the status of peers | ||
43 | known to the CORE service. | ||
44 | .Bl -tag -width indent | 42 | .Bl -tag -width indent |
45 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 43 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
46 | Configuration file to use. | 44 | Configuration file to use. |
@@ -52,6 +50,10 @@ Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. | |||
52 | .It Fl m | -monitor | 50 | .It Fl m | -monitor |
53 | In monitor mode, gnunet-core will continuously print the connection status, | 51 | In monitor mode, gnunet-core will continuously print the connection status, |
54 | instead of giving just a snapshot. | 52 | instead of giving just a snapshot. |
53 | .It Fl i | -show-identity | ||
54 | Output current local peer identity. | ||
55 | .It Fl s | -connection-status | ||
56 | Show current peer connection status. | ||
55 | .It Fl v | -version | 57 | .It Fl v | -version |
56 | Print the version number. | 58 | Print the version number. |
57 | .It Fl V | -verbose | 59 | .It Fl V | -verbose |
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-dht-get.1 index 94951af86..bd411f2f0 100644 --- a/doc/man/gnunet-peerinfo.1 +++ b/doc/man/gnunet-dht-get.1 | |||
@@ -1,5 +1,5 @@ | |||
1 | .\" This file is part of GNUnet. | 1 | .\" This file is part of GNUnet. |
2 | .\" Copyright (C) 2001-2019 GNUnet e.V. | 2 | .\" Copyright (C) 2023 GNUnet e.V. |
3 | .\" | 3 | .\" |
4 | .\" Permission is granted to copy, distribute and/or modify this document | 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 | 5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or |
@@ -21,75 +21,66 @@ | |||
21 | .\" | 21 | .\" |
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | 22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later |
23 | .\" | 23 | .\" |
24 | .Dd March 4, 2013 | 24 | .Dd January 5, 2023 |
25 | .Dt GNUNET-PEERINFO 1 | 25 | .Dt GNUNET-DHT-GET 1 |
26 | .Os | 26 | .Os |
27 | .Sh NAME | 27 | .Sh NAME |
28 | .Nm gnunet-peerinfo | 28 | .Nm gnunet-dht-get |
29 | .Nd display information about other peers | 29 | .Nd Issue a GET request to the DHT. Prints results. |
30 | .Sh SYNOPSIS | 30 | .Sh SYNOPSIS |
31 | .Nm | 31 | .Nm |
32 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 32 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
33 | .Op Fl g | -get-hello | ||
34 | .Op Fl h | -help | 33 | .Op Fl h | -help |
35 | .Op Fl i | -info | 34 | .Op Fl k Ar KEY | Fl -key= Ns Ar KEY |
36 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 35 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
37 | .Op Fl l Ar LOGFILE | Fl -logfile= ns Ar LOGFILE | 36 | .Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE |
38 | .Op Fl n | -numeric | 37 | .Op Fl R | -record |
39 | .Op Fl p Ar HELLO | Fl -put-hello= Ns Ar HELLO | 38 | .Op Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL |
40 | .Op Fl q | -quiet | 39 | .Op Fl T Ar TYPE | Fl -type= Ns Ar TYPE |
41 | .Op Fl s | -self | 40 | .Op Fl V | -verbose |
42 | .Op Fl v | -version | 41 | .Op Fl v | -version |
42 | .Op Fl x | -demultiplex | ||
43 | .Sh DESCRIPTION | 43 | .Sh DESCRIPTION |
44 | .Nm | 44 | .Nm |
45 | displays the known addresses and trust of known peers. | 45 | is a command line tool to issue GET requests to the DHT. |
46 | .Sh OPTIONS | ||
46 | .Bl -tag -width indent | 47 | .Bl -tag -width indent |
47 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 48 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
48 | Load config file, default FILENAME of the config is | 49 | Use the configuration file |
49 | .Pa ~/.config/gnunet.conf . | 50 | .Ar FILENAME . |
50 | .It Fl g | -get-hello | ||
51 | Output HELLO uri(s) | ||
52 | .It Fl h | -help | 51 | .It Fl h | -help |
53 | Print the help page. | 52 | Print short help on options. |
54 | .It Fl i | -info | 53 | .It Fl k Ar KEY | Fl -key= Ns Ar KEY |
55 | List all known peers (and their addresses). | 54 | use the query key |
55 | .Ar KEY . | ||
56 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 56 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
57 | Set the loglevel | 57 | Use LOGLEVEL for logging. |
58 | .It Fl l Ar LOGFILE | Fl -logfile= ns Ar LOGFILE | 58 | Valid values are DEBUG, INFO, WARNING and ERROR. |
59 | Log messages to LOGFILE | 59 | .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE |
60 | .It Fl n | -numeric | 60 | Configure logging to write logs to |
61 | Disable resolution of IPs to hostnames | 61 | .Ar LOGFILE . |
62 | .It Fl p Ar HELLO | Fl -put-hello= Ns Ar HELLO | 62 | .It Fl R | -record |
63 | Add given HELLO uri to the database | 63 | Set DHT's record route option for the request. |
64 | .It Fl q | -quiet | 64 | .It Fl r Ar LEVEL | -replication-level= Ns Ar LEVEL |
65 | Do not print anything but the peer identities | 65 | Use the DHT replication level |
66 | .It Fl s | -self | 66 | .Ar LEVEL . |
67 | Print only our own identity. | 67 | .It Fl t Ar TYPE | -type= Ns Ar TYPE |
68 | Together with | 68 | the block type to look for under |
69 | .Fl q , | 69 | .Ar KEY . |
70 | this is the exact line that other peers would have to put in to their friends file in order to consider this peer one of their friends in F2F mode. | 70 | .It Fl V | -verbose |
71 | be verbose. | ||
71 | .It Fl v | -version | 72 | .It Fl v | -version |
72 | Print the version number | 73 | Print GNUnet version number. |
74 | .It Fl x | -demultiplex | ||
75 | Set DHT's demultiplex everywhere option. | ||
73 | .El | 76 | .El |
74 | .Sh SEE ALSO | 77 | .Sh SEE ALSO |
75 | .Xr gnunet.conf 5 | ||
76 | .sp | ||
77 | The full documentation for gnunet is maintained as a Texinfo manual. | 78 | The full documentation for gnunet is maintained as a Texinfo manual. |
78 | If the | 79 | If the |
79 | .Xr info 1 | 80 | .Xr info 1 |
80 | and gnunet programs are properly installed at your site, the command | 81 | and gnunet programs are properly installed at your site, the command |
81 | .Pp | 82 | .Pp |
82 | .Dl info gnunet | 83 | .Dl info gnunet |
83 | .Pp | ||
84 | should give you access to the complete handbook, | ||
85 | .Pp | ||
86 | .Dl info gnunet-c-tutorial | ||
87 | .Pp | ||
88 | will give you access to a tutorial for developers. | ||
89 | .sp | ||
90 | Depending on your installation, this information is also available in | ||
91 | .Xr gnunet 7 and | ||
92 | .Xr gnunet-c-tutorial 7 . | ||
93 | .\".Sh HISTORY | 84 | .\".Sh HISTORY |
94 | .\".Sh AUTHORS | 85 | .\".Sh AUTHORS |
95 | .Sh BUGS | 86 | .Sh BUGS |
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 . | ||
diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-did.1 index 39bb9fcbc..283561920 100644 --- a/doc/man/gnunet-namestore-fcfsd.1 +++ b/doc/man/gnunet-did.1 | |||
@@ -1,5 +1,5 @@ | |||
1 | .\" This file is part of GNUnet. | 1 | .\" This file is part of GNUnet. |
2 | .\" Copyright (C) 2001-2019 GNUnet e.V. | 2 | .\" Copyright (C) 2023 GNUnet e.V. |
3 | .\" | 3 | .\" |
4 | .\" Permission is granted to copy, distribute and/or modify this document | 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 | 5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or |
@@ -21,63 +21,75 @@ | |||
21 | .\" | 21 | .\" |
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | 22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later |
23 | .\" | 23 | .\" |
24 | .Dd September 5, 2013 | 24 | .Dd January 5, 2023 |
25 | .Dt GNUNET-NAMESTORE-FCFSD 1 | 25 | .Dt GNUNET-DID 1 |
26 | .Os | 26 | .Os |
27 | .Sh NAME | 27 | .Sh NAME |
28 | .Nm gnunet-namestore-fcfsd | 28 | .Nm gnunet-did |
29 | .Nd HTTP server for GNU Name System First-Come-First-Served name registration | 29 | .Nd command line tool to create and manage gnunet identity DIDs. |
30 | .Sh SYNOPSIS | 30 | .Sh SYNOPSIS |
31 | .Nm | 31 | .Nm |
32 | .Op Fl A | -show-all | ||
33 | .Op Fl C | -create | ||
32 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 34 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
35 | .Op Fl d Ar DID | Fl -did= Ns Ar DID | ||
36 | .Op Fl D Ar DID_DOCUMENT | Fl -did-document= Ns Ar DID_DOCUMENT | ||
37 | .Op Fl e Ar EGO | Fl -ego= Ns Ar EGO | ||
38 | .Op Fl g | -get | ||
33 | .Op Fl h | -help | 39 | .Op Fl h | -help |
34 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 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 | -remove | ||
43 | .Op Fl R | -replace | ||
44 | .Op Fl s | -show | ||
45 | .Op Fl t Ar TIME | Fl -expiration-time= Ns Ar TIME | ||
35 | .Op Fl v | -version | 46 | .Op Fl v | -version |
36 | .Op Fl z Ar EGO | -zone= Ns Ar EGO | ||
37 | .Sh DESCRIPTION | 47 | .Sh DESCRIPTION |
38 | Most users will not want to run an FCFS-zone and thus will not need this program. | ||
39 | .Pp | ||
40 | .Nm | 48 | .Nm |
41 | runs a web server where users can register names to be mapped to their GNS zone. | 49 | is a command line tool to create and manage gnunet identity DIDs. |
42 | Names are made available on a First Come First Served basis (hence fcfs). | 50 | .Sh OPTIONS |
43 | Registered names do not expire. | ||
44 | The HTTP server is run on the port that is specified in the configuration file in section "[fcfsd]" under the name "HTTPPORT". | ||
45 | .Pp | ||
46 | It is possible to manage gnunet-gns-fcfsd using gnunet-(service-arm) by starting the daemon using "gnunet-arm -i fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your configuration and the "-z ZONE" in as the "OPTION". | ||
47 | .Pp | ||
48 | An FCFS-zone is run at | ||
49 | .Lk http://gnunet.org/fcfs/ . | ||
50 | GNS users are encouraged to register their zone with the gnunet.org FCFS authority. | ||
51 | .Pp | ||
52 | If you want to run your own FCFS registrar, you need to first create a pseudonym (using "gnunet-identity -C NAME"), and use it with the | ||
53 | .Fl z | ||
54 | option. | ||
55 | After that, you can start the FCFSD service (possibly using | ||
56 | .Xr gnunet-arm 1 Ns ). | ||
57 | .Pp | ||
58 | The options are as follows: | ||
59 | .Bl -tag -width indent | 51 | .Bl -tag -width indent |
52 | .It Fl A | -show-all | ||
53 | List all DIDs for all egos. | ||
54 | .It Fl C | -create | ||
55 | Create a DID Document and display the DID. | ||
60 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 56 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
61 | Use the configuration file FILENAME. | 57 | Use the specified configuration file |
58 | .Ar FILENAME . | ||
59 | .It Fl d Ar DID | Fl -did= Ns Ar DID | ||
60 | The to use for the operation is | ||
61 | .Ar DID . | ||
62 | .It Fl D Ar DID_DOCUMENT | Fl -did-document= Ns Ar DID_DOCUMENT | ||
63 | The DID Document to use is | ||
64 | .Ar DID_DOCUMENT . | ||
65 | .It Fl e Ar EGO | Fl -ego= Ns Ar EGO | ||
66 | The ego to use is | ||
67 | .Ar EGO . | ||
68 | .It Fl g | -get | ||
69 | Get the DID Document associated with the DID given in | ||
70 | .Ar DID . | ||
62 | .It Fl h | -help | 71 | .It Fl h | -help |
63 | Print short help on options. | 72 | Print short help on options. |
64 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 73 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
65 | Use LOGLEVEL for logging. | 74 | Use LOGLEVEL for logging. |
66 | Valid values are DEBUG, INFO, WARNING and ERROR. | 75 | Valid values are DEBUG, INFO, WARNING and ERROR. |
76 | .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | ||
77 | Configure logging to write logs to | ||
78 | .Ar LOGFILE . | ||
79 | .It Fl r | -remove | ||
80 | Remove the DID given in --did. | ||
81 | .It Fl R | -replace | ||
82 | Replace the DID Docuemnt given in --did-document for the DID given in | ||
83 | .Ar DID . | ||
84 | .It Fl s | -show | ||
85 | Show the DID for the ego given in --ego. | ||
86 | .It Fl t | -expiration-time | ||
87 | The expiration time to use in the GNS record for the DID Document given in | ||
88 | Ar. DID_DOCUMENT . | ||
67 | .It Fl v | -version | 89 | .It Fl v | -version |
68 | Print GNUnet version number. | 90 | Print GNUnet version number. |
69 | .It Fl z Ar EGO | -zone= Ns Ar EGO | ||
70 | Specifies for which | ||
71 | .Ar EGO | ||
72 | FCFSD should manage the zone. | ||
73 | .El | 91 | .El |
74 | .\".Sh EXAMPLES | ||
75 | .\".Sh FILES | ||
76 | .Sh SEE ALSO | 92 | .Sh SEE ALSO |
77 | .Xr gnunet-identity 1 , | ||
78 | .Xr gnunet-gns 1 , | ||
79 | .Xr gnunet-gns-proxy 1 | ||
80 | .sp | ||
81 | The full documentation for gnunet is maintained as a Texinfo manual. | 93 | The full documentation for gnunet is maintained as a Texinfo manual. |
82 | If the | 94 | If the |
83 | .Xr info 1 | 95 | .Xr info 1 |
@@ -85,15 +97,8 @@ and gnunet programs are properly installed at your site, the command | |||
85 | .Pp | 97 | .Pp |
86 | .Dl info gnunet | 98 | .Dl info gnunet |
87 | .Pp | 99 | .Pp |
88 | should give you access to the complete handbook, | 100 | should give you access to the complete handbook. |
89 | .Pp | ||
90 | .Dl info gnunet-c-tutorial | ||
91 | .Pp | ||
92 | will give you access to a tutorial for developers. | ||
93 | .sp | 101 | .sp |
94 | Depending on your installation, this information is also available in | ||
95 | .Xr gnunet 7 and | ||
96 | .Xr gnunet-c-tutorial 7 . | ||
97 | .\".Sh HISTORY | 102 | .\".Sh HISTORY |
98 | .\".Sh AUTHORS | 103 | .\".Sh AUTHORS |
99 | .Sh BUGS | 104 | .Sh BUGS |
diff --git a/doc/man/gnunet-dns2gns.1 b/doc/man/gnunet-dns2gns.1 index 0993fb419..72a7785d7 100644 --- a/doc/man/gnunet-dns2gns.1 +++ b/doc/man/gnunet-dns2gns.1 | |||
@@ -57,7 +57,6 @@ Valid values are DEBUG, INFO, WARNING and ERROR. | |||
57 | Print GNUnet version number. | 57 | Print GNUnet version number. |
58 | .El | 58 | .El |
59 | .Sh SEE ALSO | 59 | .Sh SEE ALSO |
60 | .Xr gnunet-gns-fcfs 1 , | ||
61 | .Xr gnunet-gns 1 , | 60 | .Xr gnunet-gns 1 , |
62 | .Xr gnunet-identity 1 | 61 | .Xr gnunet-identity 1 |
63 | .Pp | 62 | .Pp |
diff --git a/doc/man/gnunet-testbed-profiler.1 b/doc/man/gnunet-messenger.1 index d079609ad..9dfe86227 100644 --- a/doc/man/gnunet-testbed-profiler.1 +++ b/doc/man/gnunet-messenger.1 | |||
@@ -1,5 +1,5 @@ | |||
1 | .\" This file is part of GNUnet. | 1 | .\" This file is part of GNUnet. |
2 | .\" Copyright (C) 2001-2019 GNUnet e.V. | 2 | .\" Copyright (C) 2023 GNUnet e.V. |
3 | .\" | 3 | .\" |
4 | .\" Permission is granted to copy, distribute and/or modify this document | 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 | 5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or |
@@ -21,45 +21,47 @@ | |||
21 | .\" | 21 | .\" |
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | 22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later |
23 | .\" | 23 | .\" |
24 | .Dd September 13, 2014 | 24 | .Dd January 5, 2023 |
25 | .Dt GNUNET-TESTBED-PROFILER 1 | 25 | .Dt GNUNET-MESSENGER 1 |
26 | .Os | 26 | .Os |
27 | .Sh NAME | 27 | .Sh NAME |
28 | .Nm gnunet-testbed-profiler | 28 | .Nm gnunet-messenger |
29 | .Nd profiling driver for the testbed | 29 | .Nd Open and connect to rooms using the MESSENGER service to chat. |
30 | .Sh SYNOPSIS | 30 | .Sh SYNOPSIS |
31 | .Nm | 31 | .Nm |
32 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 32 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
33 | .Op Fl e Ar COUNT | Fl -num-errors= Ns Ar COUNT | 33 | .Op Fl d Ar PEERIDENTITY | Fl -door= Ns Ar PEERIDENTITY |
34 | .Op Fl H Ar FILENAME | Fl -hosts= Ns Ar FILENAME | 34 | .Op Fl e Ar IDENTITY | Fl -ego= Ns Ar IDENTITY |
35 | .Op Fl h | -help | 35 | .Op Fl h | -help |
36 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 36 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
37 | .Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | 37 | .Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE |
38 | .Op Fl n | -non-interactive | 38 | .Op Fl p | -private |
39 | .Op Fl p Ar COUNT | Fl -num-peers= Ns Ar COUNT | 39 | .Op Fl r Ar ROOMKEY | Fl -room= Ns Ar ROOMKEY |
40 | .Op Fl v | -version | 40 | .Op Fl v | -version |
41 | .Sh DESCRIPTION | 41 | .Sh DESCRIPTION |
42 | .Nm | 42 | .Nm |
43 | is a command line profiling driver for the testbed. | 43 | is a command line tool to connect to rooms using the MESSENGER service to chat. |
44 | .Sh OPTIONS | 44 | .Sh OPTIONS |
45 | .Bl -tag -width indent | 45 | .Bl -tag -width indent |
46 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 46 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
47 | Use the configuration file FILENAME. | 47 | Use the specified configuration file |
48 | .It Fl e Ar COUNT | Fl -num-errors= Ns Ar COUNT | 48 | .Ar FILENAME . |
49 | Tolerate COUNT number of continuous timeout failures. | 49 | .It Fl d Ar PEERIDENTITY | Fl -did= Ns Ar PEERIDENTITY |
50 | .It Fl H Ar FILENAME | Fl -hosts= Ns Ar FILENAME | 50 | peer identity to entry into the room. |
51 | Name of the file with the login information for the testbed. | 51 | .It Fl e Ar IDENTITY | Fl -ego= Ns Ar IDENTITY |
52 | identity to use for messaging | ||
52 | .It Fl h | -help | 53 | .It Fl h | -help |
53 | Print short help on options. | 54 | Print short help on options. |
54 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 55 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
55 | Use LOGLEVEL for logging. | 56 | Use LOGLEVEL for logging. |
56 | Valid values are DEBUG, INFO, WARNING and ERROR. | 57 | Valid values are DEBUG, INFO, WARNING and ERROR. |
57 | .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | 58 | .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE |
58 | Configure logging to write logs to LOGFILE. | 59 | Configure logging to write logs to |
59 | .It Fl n | -non-interactive | 60 | .Ar LOGFILE . |
60 | Run profiler in non-interactive mode where upon testbed setup the profiler does not wait for a keystroke but continues to run until a termination signal is received. | 61 | .It Fl p | -private |
61 | .It Fl p Ar COUNT | Fl -num-peers= Ns Ar COUNT | 62 | flag to enable private mode. |
62 | Create COUNT number of peers. | 63 | .It Fl r Ar ROOMKEY | Fl -room= Ns Ar ROOMKEY |
64 | key of the room to connect to. | ||
63 | .It Fl v | -version | 65 | .It Fl v | -version |
64 | Print GNUnet version number. | 66 | Print GNUnet version number. |
65 | .El | 67 | .El |
@@ -71,15 +73,8 @@ and gnunet programs are properly installed at your site, the command | |||
71 | .Pp | 73 | .Pp |
72 | .Dl info gnunet | 74 | .Dl info gnunet |
73 | .Pp | 75 | .Pp |
74 | should give you access to the complete handbook, | 76 | should give you access to the complete handbook. |
75 | .Pp | ||
76 | .Dl info gnunet-c-tutorial | ||
77 | .Pp | ||
78 | will give you access to a tutorial for developers. | ||
79 | .sp | 77 | .sp |
80 | Depending on your installation, this information is also available in | ||
81 | .Xr gnunet 7 and | ||
82 | .Xr gnunet-c-tutorial 7 . | ||
83 | .\".Sh HISTORY | 78 | .\".Sh HISTORY |
84 | .\".Sh AUTHORS | 79 | .\".Sh AUTHORS |
85 | .Sh BUGS | 80 | .Sh BUGS |
diff --git a/doc/man/gnunet-nse.1 b/doc/man/gnunet-nse.1 index 5f2d02bfa..193173381 100644 --- a/doc/man/gnunet-nse.1 +++ b/doc/man/gnunet-nse.1 | |||
@@ -48,6 +48,9 @@ Use LOGLEVEL for logging. | |||
48 | Valid values are DEBUG, INFO, WARNING and ERROR. | 48 | Valid values are DEBUG, INFO, WARNING and ERROR. |
49 | .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | 49 | .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE |
50 | Configure logging to write logs to LOGFILE. | 50 | Configure logging to write logs to LOGFILE. |
51 | .It Fl m | -monitor | ||
52 | In monitor mode, gnunet-nse will continuously print the NSE estimates, | ||
53 | instead of giving just a snapshot. | ||
51 | .It Fl v | -version | 54 | .It Fl v | -version |
52 | Print GNUnet version number. | 55 | Print GNUnet version number. |
53 | .El | 56 | .El |
diff --git a/doc/man/meson.build b/doc/man/meson.build new file mode 100644 index 000000000..fbd8179ba --- /dev/null +++ b/doc/man/meson.build | |||
@@ -0,0 +1,62 @@ | |||
1 | five = configure_file(input : 'gnunet.conf.5.in', | ||
2 | output : 'gnunet.conf.5', | ||
3 | configuration : cdata, | ||
4 | install: false, | ||
5 | install_dir: get_option('mandir')) | ||
6 | |||
7 | install_man( | ||
8 | [ | ||
9 | five, | ||
10 | 'gnunet-arm.1', | ||
11 | 'gnunet-auto-share.1', | ||
12 | 'gnunet-base32.1', | ||
13 | 'gnunet-bcd.1', | ||
14 | 'gnunet-bugreport.1', | ||
15 | 'gnunet-config.1', | ||
16 | 'gnunet-core.1', | ||
17 | 'gnunet-conversation.1', | ||
18 | 'gnunet-conversation-test.1', | ||
19 | 'gnunet-dht-get.1', | ||
20 | 'gnunet-dht-put.1', | ||
21 | 'gnunet-dht-monitor.1', | ||
22 | 'gnunet-dht-hello.1', | ||
23 | 'gnunet-directory.1', | ||
24 | 'gnunet-dns2gns.1', | ||
25 | 'gnunet-datastore.1', | ||
26 | 'gnunet-download.1', | ||
27 | 'gnunet-did.1', | ||
28 | 'gnunet-ecc.1', | ||
29 | 'gnunet-fs.1', | ||
30 | 'gnunet-gns.1', | ||
31 | 'gnunet-gns-proxy.1', | ||
32 | 'gnunet-gns-proxy-setup-ca.1', | ||
33 | 'gnunet-identity.1', | ||
34 | 'gnunet-cadet.1', | ||
35 | 'gnunet-messenger.1', | ||
36 | 'gnunet-namecache.1', | ||
37 | 'gnunet-namestore.1', | ||
38 | 'gnunet-namestore-dbtool.1', | ||
39 | 'gnunet-namestore-zonefile.1', | ||
40 | 'gnunet-nat.1', | ||
41 | 'gnunet-nat-auto.1', | ||
42 | 'gnunet-nat-server.1', | ||
43 | 'gnunet-nse.1', | ||
44 | 'gnunet-publish.1', | ||
45 | 'gnunet-qr.1', | ||
46 | 'gnunet-reclaim.1', | ||
47 | 'gnunet-resolver.1', | ||
48 | 'gnunet-revocation.1', | ||
49 | 'gnunet-scalarproduct.1', | ||
50 | 'gnunet-scrypt.1', | ||
51 | 'gnunet-search.1', | ||
52 | 'gnunet-statistics.1', | ||
53 | 'gnunet-testing.1', | ||
54 | 'gnunet-testing-run-service.1', | ||
55 | 'gnunet-timeout.1', | ||
56 | 'gnunet-transport.1', | ||
57 | 'gnunet-transport-certificate-creation.1', | ||
58 | 'gnunet-unindex.1', | ||
59 | 'gnunet-uri.1', | ||
60 | 'gnunet-vpn.1', | ||
61 | 'gnunet-zoneimport.1']) | ||
62 | |||