aboutsummaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/.gitignore4
-rw-r--r--doc/man/Makefile.am17
-rw-r--r--doc/man/gnunet-ats.1114
-rw-r--r--doc/man/gnunet-core.16
-rw-r--r--doc/man/gnunet-dht-get.190
-rw-r--r--doc/man/gnunet-dht-hello.175
-rw-r--r--doc/man/gnunet-dht-monitor.182
-rw-r--r--doc/man/gnunet-dht-put.1100
-rw-r--r--doc/man/gnunet-did.1108
-rw-r--r--doc/man/gnunet-dns2gns.11
-rw-r--r--doc/man/gnunet-identity.111
-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.1105
-rw-r--r--doc/man/gnunet-nse.13
-rw-r--r--doc/man/gnunet-reclaim.19
-rw-r--r--doc/man/meson.build62
18 files changed, 711 insertions, 249 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
4gnunet-c-tutorial.7 4gnunet-c-tutorial.7
5gnunet-documentation.7 5gnunet-documentation.7
6gana.*
7gnunet.*
8gnunet-dev.*
9lsd.*
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 4050ae896..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
3gnunet.conf.5: gnunet.conf.5.in Makefile 3gnunet.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
6CLEANFILES = gnunet.conf.5 6CLEANFILES = 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.
16produce_html.sh: produce_html.sh.in Makefile 16produce_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
20CLEANFILES += produce_html.sh 20CLEANFILES += produce_html.sh
@@ -38,7 +38,6 @@ endif
38man_MANS = \ 38man_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,14 +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 \ 68 gnunet-namestore-dbtool.1 \
69 gnunet-namestore-zonefile.1 \
64 gnunet-nat.1 \ 70 gnunet-nat.1 \
65 gnunet-nat-auto.1 \ 71 gnunet-nat-auto.1 \
66 gnunet-nat-server.1 \ 72 gnunet-nat-server.1 \
67 gnunet-nse.1 \ 73 gnunet-nse.1 \
68 gnunet-peerinfo.1 \
69 gnunet-publish.1 \ 74 gnunet-publish.1 \
70 gnunet-qr.1 \ 75 gnunet-qr.1 \
71 gnunet-reclaim.1 \ 76 gnunet-reclaim.1 \
@@ -75,7 +80,7 @@ man_MANS = \
75 gnunet-scrypt.1 \ 80 gnunet-scrypt.1 \
76 gnunet-search.1 \ 81 gnunet-search.1 \
77 gnunet-statistics.1 \ 82 gnunet-statistics.1 \
78 gnunet-testbed-profiler.1 \ 83 gnunet-testing.1 \
79 gnunet-testing-run-service.1 \ 84 gnunet-testing-run-service.1 \
80 gnunet-timeout.1 \ 85 gnunet-timeout.1 \
81 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
49can be used to display information about the
50GNUnet's transport selection mechanism.
51It shows information about the addresses and
52the assigned input and output bandwidth.
53.Sh OPTIONS
54.Bl -tag -width indent
55.It Fl a | -all
56List all addresses currently known to ats.
57.It Fl C Ar PEERID | Fl -connect= Ns Ar PEERID
58Ask ATS to suggest an address for PEERID to transport
59to establish a connection.
60Note that you can use the
61.Xr gnunet-transport 1
62commandline tool to force disconnects.
63.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
64Use the configuration file FILENAME.
65.It Fl h | -help
66Print short help on options.
67.It Fl i Ar PEERID | Fl -id= Ns Ar PEERID
68Print information for a specific peer identity only.
69.It Fl k Ar VALUE | Fl -value= Ns Ar VALUE
70Value to set for when changing preference values.
71.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
72Use LOGLEVEL for logging.
73Valid values are DEBUG, INFO, WARNING and ERROR.
74.It Fl m | -monitor
75Monitor changes to the bandwidth assignments continuously.
76.It Fl n | -numeric
77Do not resolve IP addresses to hostnames.
78.It Fl p Ar PREFERENCE | Fl -preference= Ns Ar PREFERENCE
79Set preference values, -i, -k and -t required.
80.It Fl q | -quotas
81Print quotas for all network types
82.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
83Preference type to change: latency | bandwidth
84.It Fl u | -used
85Print addresses actively used only
86.It Fl V | -verbose
87Print verbose output (include ATS address properties)
88.It v | -version
89Print GNUnet version number.
90.El
91.Sh SEE ALSO
92.Xr gnunet-transport 1
93.sp
94The full documentation for gnunet is maintained as a Texinfo manual.
95If the
96.Xr info 1
97and gnunet programs are properly installed at your site, the command
98.Pp
99.Dl info gnunet
100.Pp
101should give you access to the complete handbook,
102.Pp
103.Dl info gnunet-c-tutorial
104.Pp
105will give you access to a tutorial for developers.
106.Pp
107Depending on your installation, this information is also available in
108.Xr gnunet 7 and
109.Xr gnunet-c-tutorial 7 .
110.Sh BUGS
111Report bugs by using
112.Lk https://bugs.gnunet.org
113or 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
40is a tool to access various functions of GNUnet's core subsystem 40is a tool to access various functions of GNUnet's core subsystem
41from the command-line. 41from the command-line.
42The only function right now is to monitor the status of peers
43known 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
46Configuration file to use. 44Configuration 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
53In monitor mode, gnunet-core will continuously print the connection status, 51In monitor mode, gnunet-core will continuously print the connection status,
54instead of giving just a snapshot. 52instead of giving just a snapshot.
53.It Fl i | -show-identity
54Output current local peer identity.
55.It Fl s | -connection-status
56Show current peer connection status.
55.It Fl v | -version 57.It Fl v | -version
56Print the version number. 58Print 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
45is 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
49Use the configuration file
50.Ar FILENAME .
51.It Fl h | -help
52Print short help on options.
53.It Fl k Ar KEY | Fl -key= Ns Ar KEY
54use the query key
55.Ar KEY .
56.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
57Use LOGLEVEL for logging.
58Valid values are DEBUG, INFO, WARNING and ERROR.
59.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
60Configure logging to write logs to
61.Ar LOGFILE .
62.It Fl R | -record
63Set DHT's record route option for the request.
64.It Fl r Ar LEVEL | -replication-level= Ns Ar LEVEL
65Use the DHT replication level
66.Ar LEVEL .
67.It Fl t Ar TYPE | -type= Ns Ar TYPE
68the block type to look for under
69.Ar KEY .
70.It Fl V | -verbose
71be verbose.
72.It Fl v | -version
73Print GNUnet version number.
74.It Fl x | -demultiplex
75Set DHT's demultiplex everywhere option.
76.El
77.Sh SEE ALSO
78The full documentation for gnunet is maintained as a Texinfo manual.
79If the
80.Xr info 1
81and 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
87Report bugs by using
88.Lk https://bugs.gnunet.org
89or 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
42is a command line tool to either get a HELLO for your own peer (no arguments) or to
43parse 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
47Use the configuration file
48.Ar FILENAME .
49.It Fl h | -help
50Print short help on options.
51.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
52Use LOGLEVEL for logging.
53Valid values are DEBUG, INFO, WARNING and ERROR.
54.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
55Configure logging to write logs to
56.Ar LOGFILE .
57.It Fl V | -verbose
58be verbose.
59.It Fl v | -version
60Print GNUnet version number.
61.El
62.Sh SEE ALSO
63The full documentation for gnunet is maintained as a Texinfo manual.
64If the
65.Xr info 1
66and 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
72Report bugs by using
73.Lk https://bugs.gnunet.org
74or 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
43is 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
47Use the configuration file
48.Ar FILENAME .
49.It Fl h | -help
50Print short help on options.
51.It Fl k Ar KEY | Fl -key= Ns Ar KEY
52use the query key
53.Ar KEY .
54.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
55Use LOGLEVEL for logging.
56Valid values are DEBUG, INFO, WARNING and ERROR.
57.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
58Configure logging to write logs to
59.Ar LOGFILE .
60.It Fl T Ar TIMEOUT | -timeout= Ns Ar TIMEOUT
61how long should the monitor command run.
62.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
63the block type to filter for.
64.It Fl V | -verbose
65be verbose.
66.It Fl v | -version
67Print GNUnet version number.
68.El
69.Sh SEE ALSO
70The full documentation for gnunet is maintained as a Texinfo manual.
71If the
72.Xr info 1
73and 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
79Report bugs by using
80.Lk https://bugs.gnunet.org
81or 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
31under
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
50is 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
54Use the configuration file
55.Ar FILENAME .
56.It Fl d Ar DATA | Fl -data= Ns Ar DATA
57the data to insert under
58.Ar KEY .
59.It Fl e Ar EXPIRATION | Fl -expiration= Ns Ar EXPIRATION
60how long to store this entry in the DHT (in seconds)
61.It Fl h | -help
62Print short help on options.
63.It Fl k Ar KEY | Fl -key= Ns Ar KEY
64use the query key
65.Ar KEY .
66.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
67Use LOGLEVEL for logging.
68Valid values are DEBUG, INFO, WARNING and ERROR.
69.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
70Configure logging to write logs to
71.Ar LOGFILE .
72.It Fl R | -record
73Set DHT's record route option for the request.
74.It Fl r Ar LEVEL | -replication-level= Ns Ar LEVEL
75Use the DHT replication level
76.Ar LEVEL .
77.It Fl t Ar TYPE | -type= Ns Ar TYPE
78the block type of
79.Ar DATA .
80.It Fl V | -verbose
81be verbose.
82.It Fl v | -version
83Print GNUnet version number.
84.It Fl x | -demultiplex
85Set DHT's demultiplex everywhere option.
86.El
87.Sh SEE ALSO
88The full documentation for gnunet is maintained as a Texinfo manual.
89If the
90.Xr info 1
91and 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
97Report bugs by using
98.Lk https://bugs.gnunet.org
99or 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
49is 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
53List all DIDs for all egos.
54.It Fl C | -create
55Create a DID Document and display the DID.
56.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
57Use the specified configuration file
58.Ar FILENAME .
59.It Fl d Ar DID | Fl -did= Ns Ar DID
60The to use for the operation is
61.Ar DID .
62.It Fl D Ar DID_DOCUMENT | Fl -did-document= Ns Ar DID_DOCUMENT
63The DID Document to use is
64.Ar DID_DOCUMENT .
65.It Fl e Ar EGO | Fl -ego= Ns Ar EGO
66The ego to use is
67.Ar EGO .
68.It Fl g | -get
69Get the DID Document associated with the DID given in
70.Ar DID .
71.It Fl h | -help
72Print short help on options.
73.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
74Use LOGLEVEL for logging.
75Valid values are DEBUG, INFO, WARNING and ERROR.
76.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
77Configure logging to write logs to
78.Ar LOGFILE .
79.It Fl r | -remove
80Remove the DID given in --did.
81.It Fl R | -replace
82Replace the DID Docuemnt given in --did-document for the DID given in
83.Ar DID .
84.It Fl s | -show
85Show the DID for the ego given in --ego.
86.It Fl t | -expiration-time
87The expiration time to use in the GNS record for the DID Document given in
88Ar. DID_DOCUMENT .
89.It Fl v | -version
90Print GNUnet version number.
91.El
92.Sh SEE ALSO
93The full documentation for gnunet is maintained as a Texinfo manual.
94If the
95.Xr info 1
96and gnunet programs are properly installed at your site, the command
97.Pp
98.Dl info gnunet
99.Pp
100should give you access to the complete handbook.
101.sp
102.\".Sh HISTORY
103.\".Sh AUTHORS
104.Sh BUGS
105Report bugs by using
106.Lk https://bugs.gnunet.org
107or 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.
57Print GNUnet version number. 57Print 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 835dfb225..d693d3688 100644
--- a/doc/man/gnunet-identity.1
+++ b/doc/man/gnunet-identity.1
@@ -39,7 +39,6 @@
39.Op Fl p | -private-keys 39.Op Fl p | -private-keys
40.Op Fl q | -quiet 40.Op Fl q | -quiet
41.Op Fl R Ar MESSAGE | Fl -read= Ns Ar MESSAGE 41.Op Fl R Ar MESSAGE | Fl -read= Ns Ar MESSAGE
42.Op Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM
43.Op Fl V | -verbose 42.Op Fl V | -verbose
44.Op Fl W Ar MESSAGE | Fl -write= Ns Ar MESSAGE 43.Op Fl W Ar MESSAGE | Fl -write= Ns Ar MESSAGE
45.Op Fl X | -eddsa 44.Op Fl X | -eddsa
@@ -100,16 +99,6 @@ Decrypt (read) a message using the respective ego private key. Use together with
100The message consists of an ephemeral key and the ciphertext, separated by a dot. 99The message consists of an ephemeral key and the ciphertext, separated by a dot.
101Such messages can be created with 100Such messages can be created with
102.Fl W . 101.Fl W .
103.It Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM
104Perform "set" operation for the specified
105.Ar SUBSYSTEM
106with the respective ego.
107Needs to be used together with option
108.Fl e .
109After this, the given SUBSYSTEM will use the ego with the specified NAME.
110This will fail if
111.Ar NAME
112does not yet exist.
113.It Fl V | -verbose 102.It Fl V | -verbose
114Be verbose, in particular outputs the public key of freshly created egos. 103Be verbose, in particular outputs the public key of freshly created egos.
115.It Fl W Ar MESSAGE | Fl -write= Ns Ar MESSAGE 104.It Fl W Ar MESSAGE | Fl -write= Ns Ar MESSAGE
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
45displays the known addresses and trust of known peers. 43is 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
48Load config file, default FILENAME of the config is 47Use 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
51Output HELLO uri(s) 50peer identity to entry into the room.
51.It Fl e Ar IDENTITY | Fl -ego= Ns Ar IDENTITY
52identity to use for messaging
52.It Fl h | -help 53.It Fl h | -help
53Print the help page. 54Print short help on options.
54.It Fl i | -info
55List 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
57Set the loglevel 56Use LOGLEVEL for logging.
58.It Fl l Ar LOGFILE | Fl -logfile= ns Ar LOGFILE 57Valid values are DEBUG, INFO, WARNING and ERROR.
59Log messages to LOGFILE 58.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
60.It Fl n | -numeric 59Configure logging to write logs to
61Disable 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
63Add given HELLO uri to the database 62flag to enable private mode.
64.It Fl q | -quiet 63.It Fl r Ar ROOMKEY | Fl -room= Ns Ar ROOMKEY
65Do not print anything but the peer identities 64key of the room to connect to.
66.It Fl s | -self
67Print only our own identity.
68Together with
69.Fl q ,
70this 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
72Print the version number 66Print GNUnet version number.
73.El 67.El
74.Sh SEE ALSO 68.Sh SEE ALSO
75.Xr gnunet.conf 5
76.sp
77The full documentation for gnunet is maintained as a Texinfo manual. 69The full documentation for gnunet is maintained as a Texinfo manual.
78If the 70If 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
84should give you access to the complete handbook, 76should give you access to the complete handbook.
85.Pp
86.Dl info gnunet-c-tutorial
87.Pp
88will give you access to a tutorial for developers.
89.sp 77.sp
90Depending 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
43is a command line profiling driver for the testbed. 41can be used to initialize or reset the namestore database.
44.Sh OPTIONS 42.Pp
43The 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
47Use the configuration file FILENAME. 46Desired 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
49Tolerate COUNT number of continuous timeout failures. 48Use the plugin PLUGINNAME.
50.It Fl H Ar FILENAME | Fl -hosts= Ns Ar FILENAME 49.It Fl r | -reset
51Name of the file with the login information for the testbed. 50Desired operation is reset and reinitialization of a database
52.It Fl h | -help 51.It Fl h | -help
53Print short help on options. 52Print 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
55Use LOGLEVEL for logging. 54Use LOGLEVEL for logging.
56Valid values are DEBUG, INFO, WARNING and ERROR. 55Valid values are DEBUG, INFO, WARNING and ERROR.
57.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
58Configure logging to write logs to LOGFILE.
59.It Fl n | -non-interactive
60Run 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
62Create COUNT number of peers.
63.It Fl v | -version 56.It Fl v | -version
64Print GNUnet version number. 57Print GNUnet version number.
65.El 58.El
59.\".Sh EXAMPLES
60.\".Sh FILES
66.Sh SEE ALSO 61.Sh SEE ALSO
67The full documentation for gnunet is maintained as a Texinfo manual. 62.Xr gnunet-gns 1 ,
63.Xr gnunet-namestore 1
64.sp
65The full documentation for GNUnet is maintained as a Texinfo manual.
68If the 66If the
69.Xr info 1 67.Xr info 1
70and gnunet programs are properly installed at your site, the command 68and 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
38Most users will not want to run an FCFS-zone and thus will not need this program.
39.Pp
40.Nm 38.Nm
41runs a web server where users can register names to be mapped to their GNS zone. 39can be used to manipulate records in a GNS zone.
42Names are made available on a First Come First Served basis (hence fcfs). 40.Pp
43Registered names do not expire. 41The zonefile is read from standard input.
44The 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
46It 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
48An FCFS-zone is run at 45To implicity give an initial $ORIGIN, use the --ego flag.
49.Lk http://gnunet.org/fcfs/ .
50GNS users are encouraged to register their zone with the gnunet.org FCFS authority.
51.Pp 46.Pp
52If 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 47All records will be created public and with relative expiration times set to the value provided in $TTL entries.
53.Fl z
54option.
55After that, you can start the FCFSD service (possibly using
56.Xr gnunet-arm 1 Ns ).
57.Pp 48.Pp
58The options are as follows: 49The options are as follows:
59.Bl -tag -width indent 50.Bl -tag -width indent
@@ -66,19 +57,22 @@ Use LOGLEVEL for logging.
66Valid values are DEBUG, INFO, WARNING and ERROR. 57Valid values are DEBUG, INFO, WARNING and ERROR.
67.It Fl v | -version 58.It Fl v | -version
68Print GNUnet version number. 59Print GNUnet version number.
69.It Fl z Ar EGO | -zone= Ns Ar EGO 60.It Fl z Ar EGO | Fl -zone= Ns Ar EGO
70Specifies for which 61Specifies the name of the ego controlling the private key for the
71.Ar EGO 62zone. If not provided, we will attempt to use the default identity set
72FCFSD should manage the zone. 63for the "namestore". Alternatively, a private key may be passed in
64Base32-encoding using the GNUNET_NAMESTORE_EGO_PRIVATE_KEY environment
65variable. The latter is useful to improve performance of tools like
66Ascension as it allows the command to skip IPC with the identity
67management 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
81The full documentation for gnunet is maintained as a Texinfo manual. 75The full documentation for GNUnet is maintained as a Texinfo manual.
82If the 76If the
83.Xr info 1 77.Xr info 1
84and gnunet programs are properly installed at your site, the command 78and 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
53can be used to manipulate records in a GNS zone. 58can 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,
88which merely displays the current records). 93which 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
90Label or name of the record to add/delete/display. 95Label or name of the record to add/delete/display.
96.It Fl O | -list-orphans
97List orphaned records.
98.It Fl o | -omit-private
99Filter private records. Use in combination with --display.
100.It Fl P | -purge-orphans
101Delete orphaned records from namestore.
91.It Fl p | -public 102.It Fl p | -public
92Create a record that is public (shared with other users that know the 103Create a record that is public (shared with other users that know the
93label). 104label).
94.It Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY 105.It Fl r | -recordline
95Determine our GNS name for the given public key (reverse lookup of the 106Changes the output format of zones and records to recordline.
96PKEY) in the given zone.
97.It Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE
98Sets record set to values given in RECORDLINE.
99This option can be specified multiple times to provide multiple
100records for the record set.
101Existing records under the same label will be deleted.
102The format for the RECORDLINE is "TTL TYPE FLAGS VALUE" where TTL is
103the time to live in seconds (unit must not be given explicitly,
104seconds is always implied), TYPE is the DNS/GNS record type,
105FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC".
106The VALUE follows the usual human-readable value format(s) of DNS/GNS.
107.It Fl s | -shadow 107.It Fl s | -shadow
108Create a record that is a shadow record. 108Create a record that is a shadow record.
109Shadow records are only used once all other records of the same type 109Shadow records are only used once all other records of the same type
110under the same label have expired. 110under the same label have expired.
111.It Fl S | -from-stdin
112Read recordlines from stdin until EOF is encountered.
113The format uses
114.B recordlines
115:
116A record in a recordline follows the format
117
118NAME.EGO:
119 TYPE EXPIRATION [FLAGS] VALUE
120 ...
121Multiple records may be provided for a name.
122
123EXPIRATION is given in microseconds without a unit (e.g. 3600000000 for 3600 seconds).
124
125FLAGS is a concatenation of record flags.
126Possible 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
134TYPE and VALUE are used in the same way as for the "-t" and "-V" options.
135Example formats for recordlines can be output using the "-D" flag combined
136with "--recordline".
137An example record set in recordline format can be found in the examples.
138It is possible to specify multiple record sets.
139Can only be used in combination with "-a" to add the parsed record sets.
140Existing record sets under names will be replaced.
141.It Fl T | -include-maintenance
142Show 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
112Type of the record to add/delete/display ("A"; "AAAA"; "NS"; "PKEY"; "MX"; etc.). 144Type 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.
121A records expect a dotted decimal IPv4 address, AAAA records an IPv6 153A records expect a dotted decimal IPv4 address, AAAA records an IPv6
122address, PKEY a public key in GNUnet's printable format, and CNAME and 154address, PKEY a public key in GNUnet's printable format, and CNAME and
123NS records should be a domain name. 155NS records should be a domain name.
156.It Fl X | -purge-zone-records
157Delete 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
125Specifies the name of the ego controlling the private key for the 159Specifies the name of the ego controlling the private key for the
126zone. If not provided, we will attempt to use the default identity set 160zone. 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
129variable. The latter is useful to improve performance of tools like 163variable. The latter is useful to improve performance of tools like
130Ascension as it allows the command to skip IPC with the identity 164Ascension as it allows the command to skip IPC with the identity
131management subsystem. 165management subsystem.
166.It Fl Z Ar KEY | Fl -zone-to-name= Ns Ar KEY
167Determine our GNS name for the given public key (reverse lookup of the
168KEY) 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.
48Valid values are DEBUG, INFO, WARNING and ERROR. 48Valid 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
50Configure logging to write logs to LOGFILE. 50Configure logging to write logs to LOGFILE.
51.It Fl m | -monitor
52In monitor mode, gnunet-nse will continuously print the NSE estimates,
53instead of giving just a snapshot.
51.It Fl v | -version 54.It Fl v | -version
52Print GNUnet version number. 55Print 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.
73Specify relative expiration interval (freshness) of attribute. 76Specify relative expiration interval (freshness) of attribute.
74.It Fl D | -dump 77.It Fl D | -dump
75List all attributes for given identity. 78List all attributes for given identity.
79.It Fl A | -credentials
80List credentials for a given identity.
81.It Fl I | -credential-id= Ns Ar CREDENTIAL_ID
82Credential ID to use when creating an attribute backed by a credential
83.It Fl N | -credential-name= Ns Ar NAME
84The 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,...
77Authorize a relying party to access a set of attributes. Must be 86Authorize a relying party to access a set of attributes. Must be
78used in conjunction with -r. Returns a TICKET. 87used in conjunction with -r. Returns a TICKET.
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 @@
1five = 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
7install_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