diff options
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/.gitignore | 4 | ||||
-rw-r--r-- | doc/man/Makefile.am | 31 | ||||
-rw-r--r-- | doc/man/gnunet-ats.1 | 114 | ||||
-rw-r--r-- | doc/man/gnunet-config.1 | 2 | ||||
-rw-r--r-- | doc/man/gnunet-core.1 | 6 | ||||
-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 | ||||
-rw-r--r-- | doc/man/gnunet-did.1 | 108 | ||||
-rw-r--r-- | doc/man/gnunet-dns2gns.1 | 1 | ||||
-rw-r--r-- | doc/man/gnunet-identity.1 | 35 | ||||
-rw-r--r-- | doc/man/gnunet-messenger.1 (renamed from doc/man/gnunet-peerinfo.1) | 75 | ||||
-rw-r--r-- | doc/man/gnunet-namestore-dbtool.1 (renamed from doc/man/gnunet-testbed-profiler.1) | 48 | ||||
-rw-r--r-- | doc/man/gnunet-namestore-zonefile.1 (renamed from doc/man/gnunet-namestore-fcfsd.1) | 50 | ||||
-rw-r--r-- | doc/man/gnunet-namestore.1 | 105 | ||||
-rw-r--r-- | doc/man/gnunet-nse.1 | 3 | ||||
-rw-r--r-- | doc/man/gnunet-reclaim.1 | 9 | ||||
-rw-r--r-- | doc/man/gnunet-search.1 | 313 | ||||
-rw-r--r-- | doc/man/meson.build | 62 | ||||
-rwxr-xr-x | doc/man/produce_html.sh.in | 9 |
21 files changed, 1025 insertions, 297 deletions
diff --git a/doc/man/.gitignore b/doc/man/.gitignore index 38ed67872..decad311d 100644 --- a/doc/man/.gitignore +++ b/doc/man/.gitignore | |||
@@ -3,3 +3,7 @@ groff_lint.log | |||
3 | *.html | 3 | *.html |
4 | gnunet-c-tutorial.7 | 4 | gnunet-c-tutorial.7 |
5 | gnunet-documentation.7 | 5 | gnunet-documentation.7 |
6 | gana.* | ||
7 | gnunet.* | ||
8 | gnunet-dev.* | ||
9 | lsd.* | ||
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index e7045e8bf..6ab720826 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am | |||
@@ -1,20 +1,10 @@ | |||
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 | ||
8 | if TEXI2MDOC_GENERATION | ||
9 | gnunet-tutorial.7: Makefile | ||
10 | @texi2mdoc -I../tutorial:../tutorial/chapters ../tutorial/tutorial.texi > gnunet-tutorial.7 | ||
11 | |||
12 | gnunet-documentation.7: Makefile | ||
13 | @texi2mdoc -I../handbook:../handbook/chapters ../handbook/gnunet.texi > gnunet-documentation.7 | ||
14 | |||
15 | CLEANFILES += gnunet-documentation.7 gnunet-tutorial.7 | ||
16 | endif | ||
17 | |||
18 | if HAVE_EXPERIMENTAL | 8 | if HAVE_EXPERIMENTAL |
19 | if HAVE_MANDOC | 9 | if HAVE_MANDOC |
20 | # After I went through the alternatives with the focus | 10 | # After I went through the alternatives with the focus |
@@ -24,7 +14,7 @@ if HAVE_MANDOC | |||
24 | # I want and that the alternatives are depressing and | 14 | # I want and that the alternatives are depressing and |
25 | # nonfunctional. | 15 | # nonfunctional. |
26 | produce_html.sh: produce_html.sh.in Makefile | 16 | produce_html.sh: produce_html.sh.in Makefile |
27 | $(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 |
28 | @chmod +x produce_html.sh | 18 | @chmod +x produce_html.sh |
29 | 19 | ||
30 | CLEANFILES += produce_html.sh | 20 | CLEANFILES += produce_html.sh |
@@ -48,7 +38,6 @@ endif | |||
48 | man_MANS = \ | 38 | man_MANS = \ |
49 | gnunet.conf.5 \ | 39 | gnunet.conf.5 \ |
50 | gnunet-arm.1 \ | 40 | gnunet-arm.1 \ |
51 | gnunet-ats.1 \ | ||
52 | gnunet-auto-share.1 \ | 41 | gnunet-auto-share.1 \ |
53 | gnunet-base32.1 \ | 42 | gnunet-base32.1 \ |
54 | gnunet-bcd.1 \ | 43 | gnunet-bcd.1 \ |
@@ -57,10 +46,15 @@ man_MANS = \ | |||
57 | gnunet-core.1 \ | 46 | gnunet-core.1 \ |
58 | gnunet-conversation.1 \ | 47 | gnunet-conversation.1 \ |
59 | 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 \ | ||
60 | gnunet-directory.1 \ | 53 | gnunet-directory.1 \ |
61 | gnunet-dns2gns.1 \ | 54 | gnunet-dns2gns.1 \ |
62 | gnunet-datastore.1 \ | 55 | gnunet-datastore.1 \ |
63 | gnunet-download.1 \ | 56 | gnunet-download.1 \ |
57 | gnunet-did.1 \ | ||
64 | gnunet-ecc.1 \ | 58 | gnunet-ecc.1 \ |
65 | gnunet-fs.1 \ | 59 | gnunet-fs.1 \ |
66 | gnunet-gns.1 \ | 60 | gnunet-gns.1 \ |
@@ -68,14 +62,15 @@ man_MANS = \ | |||
68 | gnunet-gns-proxy-setup-ca.1 \ | 62 | gnunet-gns-proxy-setup-ca.1 \ |
69 | gnunet-identity.1 \ | 63 | gnunet-identity.1 \ |
70 | gnunet-cadet.1 \ | 64 | gnunet-cadet.1 \ |
65 | gnunet-messenger.1 \ | ||
71 | gnunet-namecache.1 \ | 66 | gnunet-namecache.1 \ |
72 | gnunet-namestore.1 \ | 67 | gnunet-namestore.1 \ |
73 | gnunet-namestore-fcfsd.1 \ | 68 | gnunet-namestore-dbtool.1 \ |
69 | gnunet-namestore-zonefile.1 \ | ||
74 | gnunet-nat.1 \ | 70 | gnunet-nat.1 \ |
75 | gnunet-nat-auto.1 \ | 71 | gnunet-nat-auto.1 \ |
76 | gnunet-nat-server.1 \ | 72 | gnunet-nat-server.1 \ |
77 | gnunet-nse.1 \ | 73 | gnunet-nse.1 \ |
78 | gnunet-peerinfo.1 \ | ||
79 | gnunet-publish.1 \ | 74 | gnunet-publish.1 \ |
80 | gnunet-qr.1 \ | 75 | gnunet-qr.1 \ |
81 | gnunet-reclaim.1 \ | 76 | gnunet-reclaim.1 \ |
@@ -85,7 +80,7 @@ man_MANS = \ | |||
85 | gnunet-scrypt.1 \ | 80 | gnunet-scrypt.1 \ |
86 | gnunet-search.1 \ | 81 | gnunet-search.1 \ |
87 | gnunet-statistics.1 \ | 82 | gnunet-statistics.1 \ |
88 | gnunet-testbed-profiler.1 \ | 83 | gnunet-testing.1 \ |
89 | gnunet-testing-run-service.1 \ | 84 | gnunet-testing-run-service.1 \ |
90 | gnunet-timeout.1 \ | 85 | gnunet-timeout.1 \ |
91 | gnunet-transport.1 \ | 86 | gnunet-transport.1 \ |
@@ -95,10 +90,6 @@ man_MANS = \ | |||
95 | gnunet-vpn.1 \ | 90 | gnunet-vpn.1 \ |
96 | gnunet-zoneimport.1 | 91 | gnunet-zoneimport.1 |
97 | 92 | ||
98 | if TEXI2MDOC_GENERATION | ||
99 | man_MANS += gnunet-tutorial.7 gnunet-documentation.7 | ||
100 | endif | ||
101 | |||
102 | EXTRA_DIST = ${man_MANS} \ | 93 | EXTRA_DIST = ${man_MANS} \ |
103 | gnunet.conf.5.in \ | 94 | gnunet.conf.5.in \ |
104 | produce_html.sh.in \ | 95 | produce_html.sh.in \ |
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-config.1 b/doc/man/gnunet-config.1 index 93d943758..c454765cf 100644 --- a/doc/man/gnunet-config.1 +++ b/doc/man/gnunet-config.1 | |||
@@ -47,7 +47,7 @@ | |||
47 | .Sh DESCRIPTION | 47 | .Sh DESCRIPTION |
48 | .Nm | 48 | .Nm |
49 | can be used to read or modify GNUnet configuration files. | 49 | can be used to read or modify GNUnet configuration files. |
50 | It can also provide informations to properly build applications on top of | 50 | It can also provide information to properly build applications on top of |
51 | GNUnet, like appropriate values for CFLAGS or the installation prefix. | 51 | GNUnet, like appropriate values for CFLAGS or the installation prefix. |
52 | .Bl -tag -width indent | 52 | .Bl -tag -width indent |
53 | .It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND | 53 | .It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND |
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-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 . | ||
diff --git a/doc/man/gnunet-did.1 b/doc/man/gnunet-did.1 new file mode 100644 index 000000000..283561920 --- /dev/null +++ b/doc/man/gnunet-did.1 | |||
@@ -0,0 +1,108 @@ | |||
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-DID 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-did | ||
29 | .Nd command line tool to create and manage gnunet identity DIDs. | ||
30 | .Sh SYNOPSIS | ||
31 | .Nm | ||
32 | .Op Fl A | -show-all | ||
33 | .Op Fl C | -create | ||
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 | ||
39 | .Op Fl h | -help | ||
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 | ||
46 | .Op Fl v | -version | ||
47 | .Sh DESCRIPTION | ||
48 | .Nm | ||
49 | is a command line tool to create and manage gnunet identity DIDs. | ||
50 | .Sh OPTIONS | ||
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. | ||
56 | .It Fl c Ar FILENAME | Fl -config= Ns Ar 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 . | ||
71 | .It Fl h | -help | ||
72 | Print short help on options. | ||
73 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
74 | Use LOGLEVEL for logging. | ||
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 . | ||
89 | .It Fl v | -version | ||
90 | Print GNUnet version number. | ||
91 | .El | ||
92 | .Sh SEE ALSO | ||
93 | The full documentation for gnunet is maintained as a Texinfo manual. | ||
94 | If the | ||
95 | .Xr info 1 | ||
96 | and gnunet programs are properly installed at your site, the command | ||
97 | .Pp | ||
98 | .Dl info gnunet | ||
99 | .Pp | ||
100 | should give you access to the complete handbook. | ||
101 | .sp | ||
102 | .\".Sh HISTORY | ||
103 | .\".Sh AUTHORS | ||
104 | .Sh BUGS | ||
105 | Report bugs by using | ||
106 | .Lk https://bugs.gnunet.org | ||
107 | or by sending electronic mail to | ||
108 | .Aq Mt gnunet-developers@gnu.org . | ||
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-identity.1 b/doc/man/gnunet-identity.1 index 599d3b269..d693d3688 100644 --- a/doc/man/gnunet-identity.1 +++ b/doc/man/gnunet-identity.1 | |||
@@ -26,7 +26,7 @@ | |||
26 | .Os | 26 | .Os |
27 | .Sh NAME | 27 | .Sh NAME |
28 | .Nm gnunet-identity | 28 | .Nm gnunet-identity |
29 | .Nd create, delete or list egos | 29 | .Nd maintain (create, delete or list) or perform actions with egos |
30 | .Sh SYNOPSIS | 30 | .Sh SYNOPSIS |
31 | .Nm | 31 | .Nm |
32 | .Op Fl C Ar NAME | Fl -create= Ns Ar NAME | 32 | .Op Fl C Ar NAME | Fl -create= Ns Ar NAME |
@@ -34,11 +34,13 @@ | |||
34 | .Op Fl d | -display | 34 | .Op Fl d | -display |
35 | .Op Fl e Ar NAME | Fl -ego= Ns Ar NAME | 35 | .Op Fl e Ar NAME | Fl -ego= Ns Ar NAME |
36 | .Op Fl h | -help | 36 | .Op Fl h | -help |
37 | .Op Fl k Ar PUBLIC_KEY | Fl -key= Ns Ar PUBLIC_KEY | ||
37 | .Op Fl m | -monitor | 38 | .Op Fl m | -monitor |
38 | .Op Fl p | -private-keys | 39 | .Op Fl p | -private-keys |
39 | .Op Fl q | -quiet | 40 | .Op Fl q | -quiet |
40 | .Op Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM | 41 | .Op Fl R Ar MESSAGE | Fl -read= Ns Ar MESSAGE |
41 | .Op Fl V | -verbose | 42 | .Op Fl V | -verbose |
43 | .Op Fl W Ar MESSAGE | Fl -write= Ns Ar MESSAGE | ||
42 | .Op Fl X | -eddsa | 44 | .Op Fl X | -eddsa |
43 | .Sh DESCRIPTION | 45 | .Sh DESCRIPTION |
44 | .Nm | 46 | .Nm |
@@ -51,6 +53,9 @@ created locally, to create new egos, and to delete | |||
51 | existing egos (the namespace will continue to exist, but it will | 53 | existing egos (the namespace will continue to exist, but it will |
52 | be impossible to add additional data to it). | 54 | be impossible to add additional data to it). |
53 | .Pp | 55 | .Pp |
56 | In addition, it is possible to encrypt and decrypt messages (arbitrary strings) | ||
57 | using a given public key (for encryption) or ego (for decryption). | ||
58 | .Pp | ||
54 | Creating a new ego requires using the | 59 | Creating a new ego requires using the |
55 | .Fl C | 60 | .Fl C |
56 | option together with an identifier (name) that is to be used for | 61 | option together with an identifier (name) that is to be used for |
@@ -72,6 +77,11 @@ Perform "set" operation with the respective ego or restrict "display" | |||
72 | operation to the respective ego. | 77 | operation to the respective ego. |
73 | .It Fl h | -help | 78 | .It Fl h | -help |
74 | Print the help page. | 79 | Print the help page. |
80 | .It Fl k Ar PUBLIC_KEY | Fl -key= Ns Ar PUBLIC_KEY | ||
81 | The public key to use for a message recipient. Use together with | ||
82 | .Fl W . | ||
83 | The recipient can obtain the desired ego's public key using the "display" | ||
84 | operation. | ||
75 | .It Fl m | -monitor | 85 | .It Fl m | -monitor |
76 | Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. | 86 | Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. |
77 | Each ego is listed together with a unique pointer value; if | 87 | Each ego is listed together with a unique pointer value; if |
@@ -83,18 +93,21 @@ keys. The second column shows the public key, the third column shows the | |||
83 | private key. | 93 | private key. |
84 | .It Fl q | -quiet | 94 | .It Fl q | -quiet |
85 | Be quiet, in particular outputs only the public key when listing egos. | 95 | Be quiet, in particular outputs only the public key when listing egos. |
86 | .It Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM | 96 | .It Fl R Ar MESSAGE | Fl -read= Ns Ar MESSAGE |
87 | Perform "set" operation for the specified | 97 | Decrypt (read) a message using the respective ego private key. Use together with |
88 | .Ar SUBSYSTEM | ||
89 | with the respective ego. | ||
90 | Needs to be used together with option | ||
91 | .Fl e . | 98 | .Fl e . |
92 | After this, the given SUBSYSTEM will use the ego with the specified NAME. | 99 | The message consists of an ephemeral key and the ciphertext, separated by a dot. |
93 | This will fail if | 100 | Such messages can be created with |
94 | .Ar NAME | 101 | .Fl W . |
95 | does not yet exist. | ||
96 | .It Fl V | -verbose | 102 | .It Fl V | -verbose |
97 | Be verbose, in particular outputs the public key of freshly created egos. | 103 | Be verbose, in particular outputs the public key of freshly created egos. |
104 | .It Fl W Ar MESSAGE | Fl -write= Ns Ar MESSAGE | ||
105 | Encrypt (write) the given message for the identity given with | ||
106 | .Fl k . | ||
107 | The output contains an ephemeral message public key and the message separated | ||
108 | by a dot. The entire line needs to be transferred to the recipient, who can use | ||
109 | .Fl R | ||
110 | to decrypt the message. | ||
98 | .It Fl X | -eddsa | 111 | .It Fl X | -eddsa |
99 | Use EdDSA instead of ECDSA. | 112 | Use EdDSA instead of ECDSA. |
100 | .El | 113 | .El |
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-messenger.1 index 94951af86..9dfe86227 100644 --- a/doc/man/gnunet-peerinfo.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,59 +21,51 @@ | |||
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-MESSENGER 1 |
26 | .Os | 26 | .Os |
27 | .Sh NAME | 27 | .Sh NAME |
28 | .Nm gnunet-peerinfo | 28 | .Nm gnunet-messenger |
29 | .Nd display information about other peers | 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 g | -get-hello | 33 | .Op Fl d Ar PEERIDENTITY | Fl -door= Ns Ar PEERIDENTITY |
34 | .Op Fl e Ar IDENTITY | Fl -ego= Ns Ar IDENTITY | ||
34 | .Op Fl h | -help | 35 | .Op Fl h | -help |
35 | .Op Fl i | -info | ||
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 | -numeric | 38 | .Op Fl p | -private |
39 | .Op Fl p Ar HELLO | Fl -put-hello= Ns Ar HELLO | 39 | .Op Fl r Ar ROOMKEY | Fl -room= Ns Ar ROOMKEY |
40 | .Op Fl q | -quiet | ||
41 | .Op Fl s | -self | ||
42 | .Op Fl v | -version | 40 | .Op Fl v | -version |
43 | .Sh DESCRIPTION | 41 | .Sh DESCRIPTION |
44 | .Nm | 42 | .Nm |
45 | displays the known addresses and trust of known peers. | 43 | is a command line tool to connect to rooms using the MESSENGER service to chat. |
44 | .Sh OPTIONS | ||
46 | .Bl -tag -width indent | 45 | .Bl -tag -width indent |
47 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 46 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
48 | Load config file, default FILENAME of the config is | 47 | Use the specified configuration file |
49 | .Pa ~/.config/gnunet.conf . | 48 | .Ar FILENAME . |
50 | .It Fl g | -get-hello | 49 | .It Fl d Ar PEERIDENTITY | Fl -did= Ns Ar PEERIDENTITY |
51 | Output HELLO uri(s) | 50 | peer identity to entry into the room. |
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 the help page. | 54 | Print short help on options. |
54 | .It Fl i | -info | ||
55 | List all known peers (and their addresses). | ||
56 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 55 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
57 | Set the loglevel | 56 | Use LOGLEVEL for logging. |
58 | .It Fl l Ar LOGFILE | Fl -logfile= ns Ar LOGFILE | 57 | Valid values are DEBUG, INFO, WARNING and ERROR. |
59 | Log messages to LOGFILE | 58 | .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE |
60 | .It Fl n | -numeric | 59 | Configure logging to write logs to |
61 | Disable resolution of IPs to hostnames | 60 | .Ar LOGFILE . |
62 | .It Fl p Ar HELLO | Fl -put-hello= Ns Ar HELLO | 61 | .It Fl p | -private |
63 | Add given HELLO uri to the database | 62 | flag to enable private mode. |
64 | .It Fl q | -quiet | 63 | .It Fl r Ar ROOMKEY | Fl -room= Ns Ar ROOMKEY |
65 | Do not print anything but the peer identities | 64 | key of the room to connect to. |
66 | .It Fl s | -self | ||
67 | Print only our own identity. | ||
68 | Together with | ||
69 | .Fl q , | ||
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. | ||
71 | .It Fl v | -version | 65 | .It Fl v | -version |
72 | Print the version number | 66 | Print GNUnet version number. |
73 | .El | 67 | .El |
74 | .Sh SEE ALSO | 68 | .Sh SEE ALSO |
75 | .Xr gnunet.conf 5 | ||
76 | .sp | ||
77 | The full documentation for gnunet is maintained as a Texinfo manual. | 69 | The full documentation for gnunet is maintained as a Texinfo manual. |
78 | If the | 70 | If the |
79 | .Xr info 1 | 71 | .Xr info 1 |
@@ -81,15 +73,8 @@ and gnunet programs are properly installed at your site, the command | |||
81 | .Pp | 73 | .Pp |
82 | .Dl info gnunet | 74 | .Dl info gnunet |
83 | .Pp | 75 | .Pp |
84 | should give you access to the complete handbook, | 76 | 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 | 77 | .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 | 78 | .\".Sh HISTORY |
94 | .\".Sh AUTHORS | 79 | .\".Sh AUTHORS |
95 | .Sh BUGS | 80 | .Sh BUGS |
diff --git a/doc/man/gnunet-testbed-profiler.1 b/doc/man/gnunet-namestore-dbtool.1 index d079609ad..af882209b 100644 --- a/doc/man/gnunet-testbed-profiler.1 +++ b/doc/man/gnunet-namestore-dbtool.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) 2001-2022 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,50 +21,48 @@ | |||
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 September 30, 2022 |
25 | .Dt GNUNET-TESTBED-PROFILER 1 | 25 | .Dt GNUNET-NAMESTORE-DBTOOL 1 |
26 | .Os | 26 | .Os |
27 | .Sh NAME | 27 | .Sh NAME |
28 | .Nm gnunet-testbed-profiler | 28 | .Nm gnunet-namestore-dbtool |
29 | .Nd profiling driver for the testbed | 29 | .Nd manipulate GNU Name System (GNS) namestore database |
30 | .Sh SYNOPSIS | 30 | .Sh SYNOPSIS |
31 | .Nm | 31 | .Nm |
32 | .Op Fl i | -initialize | ||
32 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 33 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
33 | .Op Fl e Ar COUNT | Fl -num-errors= Ns Ar COUNT | 34 | .Op Fl r | -reset |
34 | .Op Fl H Ar FILENAME | Fl -hosts= Ns Ar FILENAME | ||
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 p Ar PLUGIN | Fl -plugin= Ns Ar PLUGIN |
38 | .Op Fl n | -non-interactive | ||
39 | .Op Fl p Ar COUNT | Fl -num-peers= Ns Ar COUNT | ||
40 | .Op Fl v | -version | 38 | .Op Fl v | -version |
41 | .Sh DESCRIPTION | 39 | .Sh DESCRIPTION |
42 | .Nm | 40 | .Nm |
43 | is a command line profiling driver for the testbed. | 41 | can be used to initialize or reset the namestore database. |
44 | .Sh OPTIONS | 42 | .Pp |
43 | The options are as follows: | ||
45 | .Bl -tag -width indent | 44 | .Bl -tag -width indent |
46 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 45 | .It Fl i | -initialize |
47 | Use the configuration file FILENAME. | 46 | Desired operation is initialization of a database. |
48 | .It Fl e Ar COUNT | Fl -num-errors= Ns Ar COUNT | 47 | .It Fl p Ar PLUGINNAME | Fl -plugin= Ns Ar PLUGINNAME |
49 | Tolerate COUNT number of continuous timeout failures. | 48 | Use the plugin PLUGINNAME. |
50 | .It Fl H Ar FILENAME | Fl -hosts= Ns Ar FILENAME | 49 | .It Fl r | -reset |
51 | Name of the file with the login information for the testbed. | 50 | Desired operation is reset and reinitialization of a database |
52 | .It Fl h | -help | 51 | .It Fl h | -help |
53 | Print short help on options. | 52 | Print short help on options. |
54 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 53 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
55 | Use LOGLEVEL for logging. | 54 | Use LOGLEVEL for logging. |
56 | Valid values are DEBUG, INFO, WARNING and ERROR. | 55 | 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 LOGFILE. | ||
59 | .It Fl n | -non-interactive | ||
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 Ar COUNT | Fl -num-peers= Ns Ar COUNT | ||
62 | Create COUNT number of peers. | ||
63 | .It Fl v | -version | 56 | .It Fl v | -version |
64 | Print GNUnet version number. | 57 | Print GNUnet version number. |
65 | .El | 58 | .El |
59 | .\".Sh EXAMPLES | ||
60 | .\".Sh FILES | ||
66 | .Sh SEE ALSO | 61 | .Sh SEE ALSO |
67 | The full documentation for gnunet is maintained as a Texinfo manual. | 62 | .Xr gnunet-gns 1 , |
63 | .Xr gnunet-namestore 1 | ||
64 | .sp | ||
65 | The full documentation for GNUnet is maintained as a Texinfo manual. | ||
68 | If the | 66 | If the |
69 | .Xr info 1 | 67 | .Xr info 1 |
70 | and gnunet programs are properly installed at your site, the command | 68 | and gnunet programs are properly installed at your site, the command |
diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-namestore-zonefile.1 index 39bb9fcbc..2b602b8df 100644 --- a/doc/man/gnunet-namestore-fcfsd.1 +++ b/doc/man/gnunet-namestore-zonefile.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) 2022 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,39 +21,30 @@ | |||
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 Friday 21, 2022 |
25 | .Dt GNUNET-NAMESTORE-FCFSD 1 | 25 | .Dt GNUNET-NAMESTORE-ZONEFILE 1 |
26 | .Os | 26 | .Os |
27 | .Sh NAME | 27 | .Sh NAME |
28 | .Nm gnunet-namestore-fcfsd | 28 | .Nm gnunet-namestore-zonefile |
29 | .Nd HTTP server for GNU Name System First-Come-First-Served name registration | 29 | .Nd Import GNU Name System (GNS) zone data using zonefiles. |
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 h | -help | 33 | .Op Fl h | -help |
34 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 34 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
35 | .Op Fl v | -version | 35 | .Op Fl v | -version |
36 | .Op Fl z Ar EGO | -zone= Ns Ar EGO | 36 | .Op Fl z Ar EGO | Fl -zone= Ns Ar EGO |
37 | .Sh DESCRIPTION | 37 | .Sh DESCRIPTION |
38 | Most users will not want to run an FCFS-zone and thus will not need this program. | ||
39 | .Pp | ||
40 | .Nm | 38 | .Nm |
41 | runs a web server where users can register names to be mapped to their GNS zone. | 39 | can be used to manipulate records in a GNS zone. |
42 | Names are made available on a First Come First Served basis (hence fcfs). | 40 | .Pp |
43 | Registered names do not expire. | 41 | The zonefile is read from standard input. |
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 | 42 | .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". | 43 | $ORIGIN entries in the zonefile will be treated as ego names (without the trailing ".") and created if missing. |
47 | .Pp | 44 | .Pp |
48 | An FCFS-zone is run at | 45 | To implicity give an initial $ORIGIN, use the --ego flag. |
49 | .Lk http://gnunet.org/fcfs/ . | ||
50 | GNS users are encouraged to register their zone with the gnunet.org FCFS authority. | ||
51 | .Pp | 46 | .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 | 47 | All records will be created public and with relative expiration times set to the value provided in $TTL entries. |
53 | .Fl z | ||
54 | option. | ||
55 | After that, you can start the FCFSD service (possibly using | ||
56 | .Xr gnunet-arm 1 Ns ). | ||
57 | .Pp | 48 | .Pp |
58 | The options are as follows: | 49 | The options are as follows: |
59 | .Bl -tag -width indent | 50 | .Bl -tag -width indent |
@@ -66,19 +57,22 @@ Use LOGLEVEL for logging. | |||
66 | Valid values are DEBUG, INFO, WARNING and ERROR. | 57 | Valid values are DEBUG, INFO, WARNING and ERROR. |
67 | .It Fl v | -version | 58 | .It Fl v | -version |
68 | Print GNUnet version number. | 59 | Print GNUnet version number. |
69 | .It Fl z Ar EGO | -zone= Ns Ar EGO | 60 | .It Fl z Ar EGO | Fl -zone= Ns Ar EGO |
70 | Specifies for which | 61 | Specifies the name of the ego controlling the private key for the |
71 | .Ar EGO | 62 | zone. If not provided, we will attempt to use the default identity set |
72 | FCFSD should manage the zone. | 63 | for the "namestore". Alternatively, a private key may be passed in |
64 | Base32-encoding using the GNUNET_NAMESTORE_EGO_PRIVATE_KEY environment | ||
65 | variable. The latter is useful to improve performance of tools like | ||
66 | Ascension as it allows the command to skip IPC with the identity | ||
67 | management subsystem. | ||
73 | .El | 68 | .El |
74 | .\".Sh EXAMPLES | 69 | .\".Sh EXAMPLES |
75 | .\".Sh FILES | 70 | .\".Sh FILES |
76 | .Sh SEE ALSO | 71 | .Sh SEE ALSO |
77 | .Xr gnunet-identity 1 , | ||
78 | .Xr gnunet-gns 1 , | 72 | .Xr gnunet-gns 1 , |
79 | .Xr gnunet-gns-proxy 1 | 73 | .Xr gnunet-namestore 1 |
80 | .sp | 74 | .sp |
81 | The full documentation for gnunet is maintained as a Texinfo manual. | 75 | The full documentation for GNUnet is maintained as a Texinfo manual. |
82 | If the | 76 | If the |
83 | .Xr info 1 | 77 | .Xr info 1 |
84 | and gnunet programs are properly installed at your site, the command | 78 | and gnunet programs are properly installed at your site, the command |
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1 index 73bbe5a5c..6915aed6e 100644 --- a/doc/man/gnunet-namestore.1 +++ b/doc/man/gnunet-namestore.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) 2001-2022 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 |
@@ -39,15 +39,20 @@ | |||
39 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 39 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
40 | .Op Fl m | -monitor | 40 | .Op Fl m | -monitor |
41 | .Op Fl n Ar NAME | Fl -name= Ns Ar NAME | 41 | .Op Fl n Ar NAME | Fl -name= Ns Ar NAME |
42 | .Op Fl O | -list-orphans | ||
43 | .Op Fl o | -omit-private | ||
44 | .Op Fl P | -purge-orphans | ||
42 | .Op Fl p | -public | 45 | .Op Fl p | -public |
43 | .Op Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY | ||
44 | .Op Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE | ||
45 | .Op Fl s | -shadow | 46 | .Op Fl s | -shadow |
47 | .Op Fl S | -from-stdin | ||
48 | .Op Fl T | -include-maintenance | ||
46 | .Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE | 49 | .Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE |
47 | .Op Fl u Ar URI | Fl -uri= Ns Ar URI | 50 | .Op Fl u Ar URI | Fl -uri= Ns Ar URI |
48 | .Op Fl v | -version | 51 | .Op Fl v | -version |
49 | .Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE | 52 | .Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE |
53 | .Op Fl X | -purge-zone-records | ||
50 | .Op Fl z Ar EGO | Fl -zone= Ns Ar EGO | 54 | .Op Fl z Ar EGO | Fl -zone= Ns Ar EGO |
55 | .Op Fl Z Ar KEY | Fl -zone-to-name= Ns Ar KEY | ||
51 | .Sh DESCRIPTION | 56 | .Sh DESCRIPTION |
52 | .Nm | 57 | .Nm |
53 | can be used to manipulate records in a GNS zone. | 58 | can be used to manipulate records in a GNS zone. |
@@ -88,26 +93,53 @@ Monitor changes to the zone on an ongoing basis (in contrast to -D, | |||
88 | which merely displays the current records). | 93 | which merely displays the current records). |
89 | .It Fl n Ar NAME | Fl -name= Ns Ar NAME | 94 | .It Fl n Ar NAME | Fl -name= Ns Ar NAME |
90 | Label or name of the record to add/delete/display. | 95 | Label or name of the record to add/delete/display. |
96 | .It Fl O | -list-orphans | ||
97 | List orphaned records. | ||
98 | .It Fl o | -omit-private | ||
99 | Filter private records. Use in combination with --display. | ||
100 | .It Fl P | -purge-orphans | ||
101 | Delete orphaned records from namestore. | ||
91 | .It Fl p | -public | 102 | .It Fl p | -public |
92 | Create a record that is public (shared with other users that know the | 103 | Create a record that is public (shared with other users that know the |
93 | label). | 104 | label). |
94 | .It Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY | 105 | .It Fl r | -recordline |
95 | Determine our GNS name for the given public key (reverse lookup of the | 106 | Changes the output format of zones and records to recordline. |
96 | PKEY) in the given zone. | ||
97 | .It Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE | ||
98 | Sets record set to values given in RECORDLINE. | ||
99 | This option can be specified multiple times to provide multiple | ||
100 | records for the record set. | ||
101 | Existing records under the same label will be deleted. | ||
102 | The format for the RECORDLINE is "TTL TYPE FLAGS VALUE" where TTL is | ||
103 | the time to live in seconds (unit must not be given explicitly, | ||
104 | seconds is always implied), TYPE is the DNS/GNS record type, | ||
105 | FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC". | ||
106 | The VALUE follows the usual human-readable value format(s) of DNS/GNS. | ||
107 | .It Fl s | -shadow | 107 | .It Fl s | -shadow |
108 | Create a record that is a shadow record. | 108 | Create a record that is a shadow record. |
109 | Shadow records are only used once all other records of the same type | 109 | Shadow records are only used once all other records of the same type |
110 | under the same label have expired. | 110 | under the same label have expired. |
111 | .It Fl S | -from-stdin | ||
112 | Read recordlines from stdin until EOF is encountered. | ||
113 | The format uses | ||
114 | .B recordlines | ||
115 | : | ||
116 | A record in a recordline follows the format | ||
117 | |||
118 | NAME.EGO: | ||
119 | TYPE EXPIRATION [FLAGS] VALUE | ||
120 | ... | ||
121 | Multiple records may be provided for a name. | ||
122 | |||
123 | EXPIRATION is given in microseconds without a unit (e.g. 3600000000 for 3600 seconds). | ||
124 | |||
125 | FLAGS is a concatenation of record flags. | ||
126 | Possible values for flags and their meaning are: | ||
127 | .Pp | ||
128 | p: Public | ||
129 | s: Shadow | ||
130 | S: Supplemental | ||
131 | C: Critical | ||
132 | r: Relative expiration | ||
133 | |||
134 | TYPE and VALUE are used in the same way as for the "-t" and "-V" options. | ||
135 | Example formats for recordlines can be output using the "-D" flag combined | ||
136 | with "--recordline". | ||
137 | An example record set in recordline format can be found in the examples. | ||
138 | It is possible to specify multiple record sets. | ||
139 | Can only be used in combination with "-a" to add the parsed record sets. | ||
140 | Existing record sets under names will be replaced. | ||
141 | .It Fl T | -include-maintenance | ||
142 | Show maintenance records such as TOMBSTONEs. Use in combination with --display. | ||
111 | .It Fl t Ar TYPE | Fl -type= Ns Ar TYPE | 143 | .It Fl t Ar TYPE | Fl -type= Ns Ar TYPE |
112 | Type of the record to add/delete/display ("A"; "AAAA"; "NS"; "PKEY"; "MX"; etc.). | 144 | Type of the record to add/delete/display ("A"; "AAAA"; "NS"; "PKEY"; "MX"; etc.). |
113 | .It Fl u Ar URI | Fl -uri= Ns Ar URI | 145 | .It Fl u Ar URI | Fl -uri= Ns Ar URI |
@@ -121,6 +153,8 @@ Specific format depends on the record type. | |||
121 | A records expect a dotted decimal IPv4 address, AAAA records an IPv6 | 153 | A records expect a dotted decimal IPv4 address, AAAA records an IPv6 |
122 | address, PKEY a public key in GNUnet's printable format, and CNAME and | 154 | address, PKEY a public key in GNUnet's printable format, and CNAME and |
123 | NS records should be a domain name. | 155 | NS records should be a domain name. |
156 | .It Fl X | -purge-zone-records | ||
157 | Delete all records in a zone. | ||
124 | .It Fl z Ar EGO | Fl -zone= Ns Ar EGO | 158 | .It Fl z Ar EGO | Fl -zone= Ns Ar EGO |
125 | Specifies the name of the ego controlling the private key for the | 159 | Specifies the name of the ego controlling the private key for the |
126 | zone. If not provided, we will attempt to use the default identity set | 160 | zone. If not provided, we will attempt to use the default identity set |
@@ -129,8 +163,45 @@ Base32-encoding using the GNUNET_NAMESTORE_EGO_PRIVATE_KEY environment | |||
129 | variable. The latter is useful to improve performance of tools like | 163 | variable. The latter is useful to improve performance of tools like |
130 | Ascension as it allows the command to skip IPC with the identity | 164 | Ascension as it allows the command to skip IPC with the identity |
131 | management subsystem. | 165 | management subsystem. |
166 | .It Fl Z Ar KEY | Fl -zone-to-name= Ns Ar KEY | ||
167 | Determine our GNS name for the given public key (reverse lookup of the | ||
168 | KEY) in the given zone. | ||
132 | .El | 169 | .El |
133 | .\".Sh EXAMPLES | 170 | .Sh EXAMPLES |
171 | .Tp | ||
172 | .Nm | ||
173 | -z example -a -n www -t A -V "1.2.3.4" -e 1d -p | ||
174 | .Tp | ||
175 | .Pp | ||
176 | .Dl Add a public record for ego "example" with name "www" containing an IP address. | ||
177 | .sp | ||
178 | .Tp | ||
179 | .Nm | ||
180 | -z example -D | ||
181 | .Tp | ||
182 | .Pp | ||
183 | .Dl Show all records for ego "example". | ||
184 | .sp | ||
185 | .Tp | ||
186 | .Nm | ||
187 | -z example -D -r | ||
188 | .Tp | ||
189 | .Pp | ||
190 | .Dl Show all records for ego "example" in recordline format. | ||
191 | .sp | ||
192 | .Tp | ||
193 | .Nm | ||
194 | --add --from-stdin <<EOF | ||
195 | www.alice: | ||
196 | A 3600000000 [pr] 1.2.3.4 | ||
197 | TXT 3600000001 [pr] Hello World | ||
198 | |||
199 | www.bob: | ||
200 | A 12345679000000 [pr] 4.3.2.1 | ||
201 | EOF | ||
202 | .Tp | ||
203 | .Pp | ||
204 | .Dl Read record sets in recordline format from stdin. | ||
134 | .\".Sh FILES | 205 | .\".Sh FILES |
135 | .Sh SEE ALSO | 206 | .Sh SEE ALSO |
136 | .Xr gnunet-gns 1 , | 207 | .Xr gnunet-gns 1 , |
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/gnunet-reclaim.1 b/doc/man/gnunet-reclaim.1 index 70c63666c..a38d9c9e0 100644 --- a/doc/man/gnunet-reclaim.1 +++ b/doc/man/gnunet-reclaim.1 | |||
@@ -39,6 +39,9 @@ | |||
39 | .Op Fl d Ar ID | Fl -delete= Ns Ar ID | 39 | .Op Fl d Ar ID | Fl -delete= Ns Ar ID |
40 | .Op Fl r Ar RP | Fl -rp= Ns Ar RP | 40 | .Op Fl r Ar RP | Fl -rp= Ns Ar RP |
41 | .Op Fl D | -dump | 41 | .Op Fl D | -dump |
42 | .Op Fl A | -credentials | ||
43 | .Op Fl I | -credential-id Ns Ar CREDENTIAL_ID | ||
44 | .Op Fl N | -credential-name Ns AR NAME | ||
42 | .Op Fl i Ar A1,A2,... | Fl -issue= Ns Ar A1,A2,... | 45 | .Op Fl i Ar A1,A2,... | Fl -issue= Ns Ar A1,A2,... |
43 | .Op Fl C Ar TICKET | Fl -consume= Ns Ar TICKET | 46 | .Op Fl C Ar TICKET | Fl -consume= Ns Ar TICKET |
44 | .Op Fl R Ar TICKET | Fl -revoke= Ns Ar TICKET | 47 | .Op Fl R Ar TICKET | Fl -revoke= Ns Ar TICKET |
@@ -73,6 +76,12 @@ Delete an attribute with ID. | |||
73 | Specify relative expiration interval (freshness) of attribute. | 76 | Specify relative expiration interval (freshness) of attribute. |
74 | .It Fl D | -dump | 77 | .It Fl D | -dump |
75 | List all attributes for given identity. | 78 | List all attributes for given identity. |
79 | .It Fl A | -credentials | ||
80 | List credentials for a given identity. | ||
81 | .It Fl I | -credential-id= Ns Ar CREDENTIAL_ID | ||
82 | Credential ID to use when creating an attribute backed by a credential | ||
83 | .It Fl N | -credential-name= Ns Ar NAME | ||
84 | The name of the credential to add. | ||
76 | .It Fl i Ar A1,A2,... | Fl -issue= Ns Ar A1,A2,... | 85 | .It Fl i Ar A1,A2,... | Fl -issue= Ns Ar A1,A2,... |
77 | Authorize a relying party to access a set of attributes. Must be | 86 | Authorize a relying party to access a set of attributes. Must be |
78 | used in conjunction with -r. Returns a TICKET. | 87 | used in conjunction with -r. Returns a TICKET. |
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1 index 4ec5189de..3145842a4 100644 --- a/doc/man/gnunet-search.1 +++ b/doc/man/gnunet-search.1 | |||
@@ -21,7 +21,7 @@ | |||
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 February 25, 2012 | 24 | .Dd February 12, 2022 |
25 | .Dt GNUNET-SEARCH 1 | 25 | .Dt GNUNET-SEARCH 1 |
26 | .Os | 26 | .Os |
27 | .Sh NAME | 27 | .Sh NAME |
@@ -30,13 +30,18 @@ | |||
30 | .Sh SYNOPSIS | 30 | .Sh SYNOPSIS |
31 | .Nm | 31 | .Nm |
32 | .Op Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL | 32 | .Op Fl a Ar LEVEL | Fl -anonymity= Ns Ar LEVEL |
33 | .Op Fl b | -bookmark-only | ||
33 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 34 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
35 | .Op Fl F Ar FORMAT | Fl -dir-printf= Ns Ar FORMAT | ||
36 | .Op Fl f Ar FORMAT | Fl -printf= Ns Ar FORMAT | ||
34 | .Op Fl h | -help | 37 | .Op Fl h | -help |
38 | .Op Fl i Ar FORMAT | Fl -iter-printf= Ns Ar FORMAT | ||
35 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 39 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
36 | .Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME | 40 | .Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME |
37 | .Op Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME | 41 | .Op Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME |
38 | .Op Fl n | -no-network | 42 | .Op Fl n | -no-network |
39 | .Op Fl N Ar VALUE | Fl -results= Ns Ar VALUE | 43 | .Op Fl N Ar VALUE | Fl -results= Ns Ar VALUE |
44 | .Op Fl s | -silent | ||
40 | .Op Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY | 45 | .Op Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY |
41 | .Op Fl v | -version | 46 | .Op Fl v | -version |
42 | .Op Fl V | -verbose | 47 | .Op Fl V | -verbose |
@@ -63,40 +68,207 @@ The specific numeric value (for anonymity levels above 1) is simple: | |||
63 | Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period. | 68 | Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period. |
64 | The time-period is twice the average delay by which GNUnet artificially delays traffic. | 69 | The time-period is twice the average delay by which GNUnet artificially delays traffic. |
65 | Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. | 70 | Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1. |
71 | .It Fl b | -bookmark-only | ||
72 | Do not search, print only the URI that points to the search with the given keywords. | ||
66 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | 73 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
67 | Use the configuration file | 74 | Use the configuration file |
68 | .Ar FILENAME | 75 | .Ar FILENAME |
69 | (default: | 76 | (default: |
70 | .Pa ~/.config/gnunet.conf ) | 77 | .Pa ~/.config/gnunet.conf Ns |
78 | ). | ||
79 | .It Fl F Ar FORMAT | Fl -dir-printf= Ns Ar FORMAT | ||
80 | Write the search results for directories according to | ||
81 | .Ar FORMAT Ns | ||
82 | \&. The directives supported here are identical to those supported in the | ||
83 | .Fl -printf | ||
84 | argument (please refer to it for more information). If missing, | ||
85 | .Fl -dir-printf | ||
86 | defaults to | ||
87 | .Fl -printf Ns | ||
88 | \&. If | ||
89 | .Fl -printf | ||
90 | is missing too | ||
91 | .Fl -dir-printf | ||
92 | defaults to | ||
93 | .Ql #%n:\engnunet-download -o Qo %f Qc -R %u\en\en Ns | ||
94 | \&. | ||
95 | .It Fl f Ar FORMAT | Fl -printf= Ns Ar FORMAT | ||
96 | Write the search results according to | ||
97 | .Ar FORMAT Ns | ||
98 | , in which | ||
99 | .Ql \e | ||
100 | and | ||
101 | .Ql % | ||
102 | directives are interpreted as follows: | ||
103 | .Bl -tag -width indent | ||
104 | .It Li \e\e | ||
105 | a literal backslash | ||
106 | .No ( Ql \e Ns ) | ||
107 | .It Li \ea | ||
108 | an alarm bell | ||
109 | .It Li \eb | ||
110 | a backspace | ||
111 | .It Li \ee | ||
112 | an escape | ||
113 | .It Li \ef | ||
114 | a form feed | ||
115 | .It Li \en | ||
116 | a newline | ||
117 | .It Li \er | ||
118 | a carriage return | ||
119 | .It Li \et | ||
120 | a horizontal tab | ||
121 | .It Li \ev | ||
122 | a vertical tab | ||
123 | .It Li \e0 | ||
124 | an ASCII NUL. | ||
125 | .It Li \eN... | ||
126 | the character whose ASCII code is N..., expressed in octal digits | ||
127 | .It Li \exX... | ||
128 | the character whose ASCII code is X..., expressed in hexadecimal digits | ||
129 | .Pp | ||
130 | .El | ||
131 | .Sy Note: | ||
132 | The | ||
133 | .Ql \e | ||
134 | character followed by any other character not listed above is treated as an ordinary character, so both characters are printed. | ||
135 | .Bl -tag -width indent | ||
136 | .It Li %% | ||
137 | a percent sign | ||
138 | .It Li %a | ||
139 | the complete list of all the printable metadata properties available, displayed according to the | ||
140 | .Fl -iter-printf | ||
141 | argument; this specifier optionally supports metatype filtering via hash sign | ||
142 | .No (e.g. | ||
143 | .Ql %2#a | ||
144 | prints all embedded file names, if present - see libextractor's metatypes for the complete list of numerical identifiers) | ||
145 | .It Li %f | ||
146 | the file's name | ||
147 | .It Li %j | ||
148 | the first printable metadata property available, displayed according to the | ||
149 | .Fl -iter-printf | ||
150 | argument; this specifier optionally supports metatype filtering via hash sign | ||
151 | .No (e.g. | ||
152 | .Ql %5#j | ||
153 | prints a book title, if present); see libextractor's metatypes for the complete list of numerical identifiers) | ||
154 | .It Li %l | ||
155 | the file name's length | ||
156 | .It Li %m | ||
157 | the file's mime type | ||
158 | .It Li %n | ||
159 | the search result number | ||
160 | .It Li %s | ||
161 | the file's size in bytes | ||
162 | .It Li %u | ||
163 | the file's URI | ||
164 | .El | ||
165 | .Pp | ||
166 | .Sy Note: | ||
167 | The | ||
168 | .Ql % | ||
169 | character followed by any other character not listed above is treated as an ordinary character, so both characters are printed. | ||
170 | .Pp | ||
171 | If missing, | ||
172 | .Fl -printf | ||
173 | defaults to | ||
174 | .Ql #%n:\engnunet-download -o Qo %f Qc %u\en\en Ns | ||
175 | \&. | ||
71 | .It Fl h | -help | 176 | .It Fl h | -help |
72 | Print the help page. | 177 | Print the help page. |
178 | .It Fl i Ar FORMAT | Fl -iter-printf= Ns Ar FORMAT | ||
179 | When the | ||
180 | .Ql %a | ||
181 | or | ||
182 | .Ql %j | ||
183 | format specifiers appear in | ||
184 | .Fl -printf | ||
185 | or | ||
186 | .Fl -dir-printf Ns | ||
187 | , list each metadata property according to | ||
188 | .Ar FORMAT Ns | ||
189 | , in which the | ||
190 | .Ql \e | ||
191 | directives are interpreted as in | ||
192 | .Fl -printf | ||
193 | and | ||
194 | .Fl -dir-printf Ns | ||
195 | , while the | ||
196 | .Ql % | ||
197 | directives are interpreted as follows: | ||
198 | .Bl -tag -width indent | ||
199 | .It Li %% | ||
200 | a percent sign | ||
201 | .It Li %p | ||
202 | the property's content | ||
203 | .It Li %l | ||
204 | the property content's length in bytes | ||
205 | .It Li %i | ||
206 | the property type's unique identifier | ||
207 | .It Li %n | ||
208 | the property number | ||
209 | .It Li %t | ||
210 | the property type (available only if compiled with libextractor) | ||
211 | .It Li %w | ||
212 | the name of the plugin that provided the information | ||
213 | .El | ||
214 | .Pp | ||
215 | .Sy Note: | ||
216 | The | ||
217 | .Ql % | ||
218 | character followed by any other character not listed above is treated as an ordinary character, so both characters are printed. | ||
219 | .Pp | ||
220 | If missing, | ||
221 | .Fl -iter-printf | ||
222 | defaults to | ||
223 | .Ql \& \& %t: %p\en | ||
224 | or | ||
225 | .Ql \& \& MetaType #%i: %p\en Ns | ||
226 | , depending on whether the program was compiled with libextractor or not. | ||
73 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 227 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
74 | Change the loglevel. | 228 | Change the loglevel. |
75 | Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. | 229 | Possible values for |
230 | .Ar LOGLEVEL | ||
231 | are ERROR, WARNING, INFO and DEBUG. | ||
76 | .It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME | 232 | .It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME |
77 | Write logs to | 233 | Write logs to |
78 | .Ar FILENAME . | 234 | .Ar FILENAME . |
79 | .It Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME | 235 | .It Fl o Ar FILENAME | Fl -output= Ns Ar FILENAME |
80 | Writes a GNUnet directory containing all of the search results to | 236 | Writes a GNUnet directory containing all of the search results to |
81 | .Ar FILENAME . | 237 | .Ar FILENAME |
238 | .No (e.g. | ||
239 | .Ql gnunet-search --output=commons.gnd commons Ns | ||
240 | ). | ||
82 | .It Fl n | -no-network | 241 | .It Fl n | -no-network |
83 | Only search locally, do not forward requests to other peers. | 242 | Only search locally, do not forward requests to other peers. |
84 | .It Fl N Ar VALUE | Fl -results= Ns Ar VALUE | 243 | .It Fl N Ar VALUE | Fl -results= Ns Ar VALUE |
85 | Automatically terminate the search after receiving | 244 | Automatically terminate the search after receiving |
86 | .Ar VALUE | 245 | .Ar VALUE |
87 | results. | 246 | results. |
247 | .It Fl s | -silent | ||
248 | Enable silent mode and do not print any result (the | ||
249 | .Fl -output | ||
250 | argument is required). | ||
88 | .It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY | 251 | .It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY |
89 | Automatically timeout search after | 252 | Automatically timeout search after |
90 | .Ar DELAY . | 253 | .Ar DELAY . |
91 | The value given must be a number followed by a space and a time unit, for example "500 ms". | 254 | The value given must be a number followed by a space and a time unit, for example |
92 | Note that the quotes are required on the shell. | 255 | .Qo 500 ms Qc . Note that the quotes are required on the shell. Without a unit it defaults to microseconds (1000000 = 1 second). |
93 | Otherwise the search runs until gnunet-search is aborted with CTRL-C. | 256 | If 0 or omitted the search runs until gnunet-search is aborted with CTRL-C. |
94 | .It Fl v | -version | 257 | .It Fl v | -version |
95 | print the version number | 258 | print the version number |
96 | .It Fl V | -verbose | 259 | .It Fl V | -verbose |
97 | print meta data from search results as well | 260 | append |
261 | .Ql %a\en | ||
262 | to the default | ||
263 | .Fl -printf | ||
264 | and | ||
265 | .Fl -dir-printf | ||
266 | arguments \[u2013] ignored when these are provided by the user | ||
98 | .El | 267 | .El |
99 | You can run gnunet-search with an URI instead of a keyword. | 268 | .Pp |
269 | It is possible to run | ||
270 | .Nm gnunet-search | ||
271 | with an URI instead of a keyword. | ||
100 | The URI can have the format for a namespace search or for a keyword search. | 272 | The URI can have the format for a namespace search or for a keyword search. |
101 | For a namespace search, the format is | 273 | For a namespace search, the format is |
102 | .Pp | 274 | .Pp |
@@ -108,46 +280,137 @@ For a keyword search, use | |||
108 | .Pp | 280 | .Pp |
109 | If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly. | 281 | If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly. |
110 | .sp | 282 | .sp |
111 | If multiple keywords are passed, gnunet-search will look for content matching any of the keywords. | 283 | If multiple keywords are passed, |
112 | The prefix "+" makes a keyword mandatory. | 284 | .Nm gnunet-search |
285 | will look for content matching any of the keywords. | ||
286 | The | ||
287 | .Ql + | ||
288 | prefix makes a keyword mandatory. | ||
113 | .Sh FILES | 289 | .Sh FILES |
114 | .Pa ~/.config/gnunet.conf | 290 | .Pa ~/.config/gnunet.conf |
115 | GNUnet configuration file; specifies the default value for the timeout | 291 | GNUnet configuration file; specifies the default value for the timeout |
116 | .Sh EXAMPLES | 292 | .Sh EXAMPLES |
117 | .Dl $ gnunet-search "Das Kapital" | 293 | Example 1: |
294 | .Pp | ||
295 | .Dl $ gnunet-search 'Das Kapital' | ||
118 | .Pp | 296 | .Pp |
119 | Searches for content matching the keyword "Das Kapital". | 297 | searches for content matching the keyword |
298 | .Dq Das Kapital Ns | ||
299 | . | ||
300 | .Pp | ||
301 | Example 2: | ||
302 | .Pp | ||
303 | .Dl $ gnunet-search Das Kapital | ||
304 | .Pp | ||
305 | searches for content matching either keyword | ||
306 | .Dq Das | ||
307 | or keyword | ||
308 | .Dq Kapital Ns | ||
309 | . | ||
310 | .Pp | ||
311 | Example 3: | ||
120 | .Pp | 312 | .Pp |
121 | .Dl $ gnunet-search +Das +Kapital | 313 | .Dl $ gnunet-search +Das +Kapital |
122 | .Pp | 314 | .Pp |
123 | Searches for content matching both mandatory keywords "Das" and "Kapital". | 315 | searches for content matching both mandatory keywords |
316 | .Dq Das | ||
317 | and | ||
318 | .Dq Kapital Ns | ||
319 | . | ||
124 | .sp | 320 | .sp |
125 | Search results are printed by gnunet-search like this: | 321 | Search results are printed by |
322 | .Nm gnunet-search | ||
323 | like this: | ||
126 | .Pp | 324 | .Pp |
127 | .ad l | 325 | .ad l |
128 | gnunet-download -o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE | 326 | gnunet-download -o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE |
129 | Description: The GNU General Public License | 327 | .Pp |
130 | Mime-type: text/plain | 328 | Description: The GNU General Public License |
329 | Mime-type: text/plain | ||
330 | ... | ||
131 | .ad b | 331 | .ad b |
132 | 332 | .Pp | |
133 | The first line contains the command to run to download the file. | 333 | The first line contains the command to run to download the file. |
134 | The suggested filename in the example is COPYING. | 334 | The suggested filename in the example is |
135 | The GNUnet URI consists of the key and query hash of the file and finally the size of the file. | 335 | .Ql COPYING Ns |
136 | After the command to download the file, GNUnet will print meta-data about the file as advertised in the search result. | 336 | \&. The GNUnet URI consists of the key and query hash of the file and finally the size of the file. |
137 | The meta-data here is the description ("The GNU General Public License") and the mime-type ("text-plain"). | 337 | If the |
338 | .Fl -verbose | ||
339 | option was provided, after the command to download the file, GNUnet will print metadata about the file as advertised in the search result. | ||
340 | The metadata here is the description | ||
341 | .No ( Ns | ||
342 | .Dq The GNU General Public License Ns | ||
343 | ) and the mime-type | ||
344 | .No ( Ns | ||
345 | .Dq text-plain Ns | ||
346 | ). | ||
138 | See the options for | 347 | See the options for |
139 | .Xr gnunet-publish 1 | 348 | .Xr gnunet-publish 1 |
140 | on how to supply meta-data by hand. | 349 | on how to supply metadata by hand. |
350 | .Pp | ||
351 | The | ||
352 | .Fl -printf | ||
353 | .No ( Ns | ||
354 | .Fl f Ns | ||
355 | ), | ||
356 | .Fl -dir-printf | ||
357 | .No ( Ns | ||
358 | .Fl F Ns | ||
359 | ) and | ||
360 | .Fl -iter-printf | ||
361 | .No ( Ns | ||
362 | .Fl i Ns | ||
363 | ) arguments offer powerful tools for manipulating the output printed. For instance, | ||
364 | .Pp | ||
365 | Example 4: | ||
366 | .Pp | ||
367 | .ad l | ||
368 | $ gnunet-search -f '%f (%s bytes)\en' commons | ||
369 | .Pp | ||
370 | will print a simple list of the results that match the | ||
371 | .Dq commons | ||
372 | keyword, with only the file name and the size printed, without any URI. Or, for instance, | ||
373 | .Pp | ||
374 | Example 5: | ||
375 | .Pp | ||
376 | .ad l | ||
377 | #!/bin/sh | ||
378 | { | ||
379 | printf '<list>' | ||
380 | gnunet-search -f ' | ||
381 | <file uri="%u"> | ||
382 | <filename len="%l">%f</filename> | ||
383 | <size>%s</size> | ||
384 | <mimetype>%m</mimetype> | ||
385 | <result_id>%n</result_id> | ||
386 | <metadata>%a | ||
387 | </metadata> | ||
388 | </file>' \e | ||
389 | -i ' | ||
390 | <property tid="%i" type="%t"> | ||
391 | <content len="%l">%p</content> | ||
392 | <property_id>%n</property_id> | ||
393 | <provided_by>%w</provided_by> | ||
394 | </property>' \e | ||
395 | -t '2 s' commons | ||
396 | printf '\en</list>\en' | ||
397 | } > commons.xml | ||
398 | .Pp | ||
399 | will run for two seconds and then create a file named | ||
400 | .Pa commons.xml Ns | ||
401 | , containing the search results that match the | ||
402 | .Dq commons | ||
403 | keyword in XML format. | ||
141 | .Sh SEE ALSO | 404 | .Sh SEE ALSO |
142 | .Xr gnunet-download 1 , | 405 | .Xr gnunet-download 1 , |
143 | .Xr gnunet-fs-gtk 1 , | 406 | .Xr gnunet-fs-gtk 1 , |
144 | .Xr gnunet-publish 1 , | 407 | .Xr gnunet-publish 1 , |
145 | .Xr gnunet.conf 5 | 408 | .Xr gnunet.conf 5 |
146 | .sp | 409 | .sp |
147 | The full documentation for gnunet is maintained as a Texinfo manual. | 410 | The full documentation for GNUnet is maintained as a Texinfo manual. |
148 | If the | 411 | If the |
149 | .Xr info 1 | 412 | .Xr info 1 |
150 | and gnunet programs are properly installed at your site, the command | 413 | and gnunet packages are properly installed at your site, the command |
151 | .Pp | 414 | .Pp |
152 | .Dl info gnunet | 415 | .Dl info gnunet |
153 | .Pp | 416 | .Pp |
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 | |||
diff --git a/doc/man/produce_html.sh.in b/doc/man/produce_html.sh.in index 8680c0106..e9581622f 100755 --- a/doc/man/produce_html.sh.in +++ b/doc/man/produce_html.sh.in | |||
@@ -1,13 +1,6 @@ | |||
1 | #!/bin/bash | 1 | #!/bin/bash |
2 | 2 | ||
3 | if test -e @PKGDATADIRECTORY@/existence.sh | 3 | if command -v mandoc >/dev/null 2>&1; |
4 | then | ||
5 | . @PKGDATADIRECTORY@/existence.sh | ||
6 | else | ||
7 | . $dir/../../contrib/build-common/sh/lib.sh/existence.sh | ||
8 | fi | ||
9 | |||
10 | if existence mandoc; | ||
11 | then | 4 | then |
12 | for f in `find . -name \*\.[1-9]`; | 5 | for f in `find . -name \*\.[1-9]`; |
13 | do | 6 | do |