DOC: Add long overdue DHT man pages.

author: Martin Schanzenbach <schanzen@gnunet.org> 2023-01-05 22:40:08 +0900
committer: Martin Schanzenbach <schanzen@gnunet.org> 2023-01-05 22:40:08 +0900
commit: 7c22b60b93f9d6b1dbc2ed963d38ba282ba5c87b (patch)
tree: 61761b8da75ec9494f896e560434d872f4d6f500 /doc
parent: 246c58548efa2f15952fcf80b3b1f294d445c80f (diff)
download: gnunet-7c22b60b93f9d6b1dbc2ed963d38ba282ba5c87b.tar.gz
gnunet-7c22b60b93f9d6b1dbc2ed963d38ba282ba5c87b.zip
5 files changed, 351 insertions, 0 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 44d99e7e4..7a80a93d8 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -47,6 +47,10 @@ man_MANS = \
  gnunet-core.1 \
  gnunet-conversation.1 \
  gnunet-conversation-test.1 \
+  gnunet-dht-get.1 \
+  gnunet-dht-put.1 \
+  gnunet-dht-monitor.1 \
+  gnunet-dht-hello.1 \
  gnunet-directory.1 \
  gnunet-dns2gns.1 \
  gnunet-datastore.1 \
diff --git a/doc/man/gnunet-dht-get.1 b/doc/man/gnunet-dht-get.1
new file mode 100644
index 000000000..bd411f2f0
--- /dev/null
+++ b/doc/man/gnunet-dht-get.1
@@ -0,0 +1,90 @@
+.\" This file is part of GNUnet.
+.\" Copyright (C) 2023 GNUnet e.V.
+.\"
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.3 or
+.\" any later version published by the Free Software Foundation; with no
+.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
+.\" copy of the license is included in the file
+.\" FDL-1.3.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
+.\"
+.\" Alternately, this document is also available under the General
+.\" Public License, version 3 or later, as published by the Free Software
+.\" Foundation.  A copy of the license is included in the file
+.\" GPL3.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
+.\"
+.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
+.\"
+.Dd January 5, 2023
+.Dt GNUNET-DHT-GET 1
+.Os
+.Sh NAME
+.Nm gnunet-dht-get
+.Nd Issue a GET request to the DHT. Prints results.
+.Sh SYNOPSIS
+.Nm
+.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+.Op Fl h | -help
+.Op Fl k Ar KEY | Fl -key= Ns Ar KEY
+.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
+.Op Fl R | -record
+.Op Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL
+.Op Fl T Ar TYPE | Fl -type= Ns Ar TYPE
+.Op Fl V | -verbose
+.Op Fl v | -version
+.Op Fl x | -demultiplex
+.Sh DESCRIPTION
+.Nm
+is a command line tool to issue GET requests to the DHT.
+.Sh OPTIONS
+.Bl -tag -width indent
+.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+Use the configuration file
+.Ar FILENAME .
+.It Fl h | -help
+Print short help on options.
+.It Fl k Ar KEY | Fl -key= Ns Ar KEY
+use the query key
+.Ar KEY .
+.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+Use LOGLEVEL for logging.
+Valid values are DEBUG, INFO, WARNING and ERROR.
+.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
+Configure logging to write logs to
+.Ar LOGFILE .
+.It Fl R | -record
+Set DHT's record route option for the request.
+.It Fl r Ar LEVEL | -replication-level= Ns Ar LEVEL
+Use the DHT replication level
+.Ar LEVEL .
+.It Fl t Ar TYPE | -type= Ns Ar TYPE
+the block type to look for under
+.Ar KEY .
+.It Fl V | -verbose
+be verbose.
+.It Fl v | -version
+Print GNUnet version number.
+.It Fl x | -demultiplex
+Set DHT's demultiplex everywhere option.
+.El
+.Sh SEE ALSO
+The full documentation for gnunet is maintained as a Texinfo manual.
+If the
+.Xr info 1
+and gnunet programs are properly installed at your site, the command
+.Pp
+.Dl info gnunet
+.\".Sh HISTORY
+.\".Sh AUTHORS
+.Sh BUGS
+Report bugs by using
+.Lk https://bugs.gnunet.org
+or by sending electronic mail to
+.Aq Mt gnunet-developers@gnu.org .
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 @@
+.\" This file is part of GNUnet.
+.\" Copyright (C) 2023 GNUnet e.V.
+.\"
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.3 or
+.\" any later version published by the Free Software Foundation; with no
+.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
+.\" copy of the license is included in the file
+.\" FDL-1.3.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
+.\"
+.\" Alternately, this document is also available under the General
+.\" Public License, version 3 or later, as published by the Free Software
+.\" Foundation.  A copy of the license is included in the file
+.\" GPL3.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
+.\"
+.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
+.\"
+.Dd January 5, 2023
+.Dt GNUNET-DHT-HELLO 1
+.Os
+.Sh NAME
+.Nm gnunet-dht-hello
+.Nd Obtain HELLO from DHT or provide HELLO to DHT for bootstrapping.
+.Sh SYNOPSIS
+.Nm
+.Op Ar URL
+.El
+.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+.Op Fl h | -help
+.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
+.Op Fl V | -verbose
+.Op Fl v | -version
+.Sh DESCRIPTION
+.Nm
+is a command line tool to either get a HELLO for your own peer (no arguments) or to
+parse a HELLO URL by providing it as the sole argument.
+.Sh OPTIONS
+.Bl -tag -width indent
+.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+Use the configuration file
+.Ar FILENAME .
+.It Fl h | -help
+Print short help on options.
+.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+Use LOGLEVEL for logging.
+Valid values are DEBUG, INFO, WARNING and ERROR.
+.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
+Configure logging to write logs to
+.Ar LOGFILE .
+.It Fl V | -verbose
+be verbose.
+.It Fl v | -version
+Print GNUnet version number.
+.El
+.Sh SEE ALSO
+The full documentation for gnunet is maintained as a Texinfo manual.
+If the
+.Xr info 1
+and gnunet programs are properly installed at your site, the command
+.Pp
+.Dl info gnunet
+.\".Sh HISTORY
+.\".Sh AUTHORS
+.Sh BUGS
+Report bugs by using
+.Lk https://bugs.gnunet.org
+or by sending electronic mail to
+.Aq Mt gnunet-developers@gnu.org .
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 @@
+.\" This file is part of GNUnet.
+.\" Copyright (C) 2023 GNUnet e.V.
+.\"
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.3 or
+.\" any later version published by the Free Software Foundation; with no
+.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
+.\" copy of the license is included in the file
+.\" FDL-1.3.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
+.\"
+.\" Alternately, this document is also available under the General
+.\" Public License, version 3 or later, as published by the Free Software
+.\" Foundation.  A copy of the license is included in the file
+.\" GPL3.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
+.\"
+.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
+.\"
+.Dd January 5, 2023
+.Dt GNUNET-DHT-MONITOR 1
+.Os
+.Sh NAME
+.Nm gnunet-dht-monitor
+.Nd Print packets that go through the DHT on this peer.
+.Sh SYNOPSIS
+.Nm
+.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+.Op Fl h | -help
+.Op Fl k Ar KEY | Fl -key= Ns Ar KEY
+.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
+.Op Fl T Ar TIMEOUT | Fl -timeout= Ns Ar TIMEOUT
+.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE
+.Op Fl V | -verbose
+.Op Fl v | -version
+.Sh DESCRIPTION
+.Nm
+is a command line tool to monitor DHT packets that go through this peer.
+.Sh OPTIONS
+.Bl -tag -width indent
+.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+Use the configuration file
+.Ar FILENAME .
+.It Fl h | -help
+Print short help on options.
+.It Fl k Ar KEY | Fl -key= Ns Ar KEY
+use the query key
+.Ar KEY .
+.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+Use LOGLEVEL for logging.
+Valid values are DEBUG, INFO, WARNING and ERROR.
+.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
+Configure logging to write logs to
+.Ar LOGFILE .
+.It Fl T Ar TIMEOUT | -timeout= Ns Ar TIMEOUT
+how long should the monitor command run.
+.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
+the block type to filter for.
+.It Fl V | -verbose
+be verbose.
+.It Fl v | -version
+Print GNUnet version number.
+.El
+.Sh SEE ALSO
+The full documentation for gnunet is maintained as a Texinfo manual.
+If the
+.Xr info 1
+and gnunet programs are properly installed at your site, the command
+.Pp
+.Dl info gnunet
+.\".Sh HISTORY
+.\".Sh AUTHORS
+.Sh BUGS
+Report bugs by using
+.Lk https://bugs.gnunet.org
+or by sending electronic mail to
+.Aq Mt gnunet-developers@gnu.org .
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 @@
+.\" This file is part of GNUnet.
+.\" Copyright (C) 2023 GNUnet e.V.
+.\"
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.3 or
+.\" any later version published by the Free Software Foundation; with no
+.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
+.\" copy of the license is included in the file
+.\" FDL-1.3.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
+.\"
+.\" Alternately, this document is also available under the General
+.\" Public License, version 3 or later, as published by the Free Software
+.\" Foundation.  A copy of the license is included in the file
+.\" GPL3.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
+.\"
+.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
+.\"
+.Dd January 5, 2023
+.Dt GNUNET-DHT-PUT 1
+.Os
+.Sh NAME
+.Nm gnunet-dht-put
+.Nd Issue a PUT request to the DHT to insert
+.Ar DATA
+under
+.Ar KEY .
+.Sh SYNOPSIS
+.Nm
+.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+.Op Fl d Ar DATA | Fl -data= Ns Ar DATA
+.Op Fl e Ar EXPIRATION | Fl -expiration= Ns Ar EXPIRATION
+.Op Fl h | -help
+.Op Fl k Ar KEY | Fl -key= Ns Ar KEY
+.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
+.Op Fl R | -record
+.Op Fl r Ar LEVEL | Fl -replication= Ns Ar LEVEL
+.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE
+.Op Fl V | -verbose
+.Op Fl v | -version
+.Op Fl x | -demultiplex
+.Sh DESCRIPTION
+.Nm
+is a command line tool to issue PUT requests to the DHT.
+.Sh OPTIONS
+.Bl -tag -width indent
+.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+Use the configuration file
+.Ar FILENAME .
+.It Fl d Ar DATA | Fl -data= Ns Ar DATA
+the data to insert under
+.Ar KEY .
+.It Fl e Ar EXPIRATION | Fl -expiration= Ns Ar EXPIRATION
+how long to store this entry in the DHT (in seconds)
+.It Fl h | -help
+Print short help on options.
+.It Fl k Ar KEY | Fl -key= Ns Ar KEY
+use the query key
+.Ar KEY .
+.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+Use LOGLEVEL for logging.
+Valid values are DEBUG, INFO, WARNING and ERROR.
+.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
+Configure logging to write logs to
+.Ar LOGFILE .
+.It Fl R | -record
+Set DHT's record route option for the request.
+.It Fl r Ar LEVEL | -replication-level= Ns Ar LEVEL
+Use the DHT replication level
+.Ar LEVEL .
+.It Fl t Ar TYPE | -type= Ns Ar TYPE
+the block type of
+.Ar DATA .
+.It Fl V | -verbose
+be verbose.
+.It Fl v | -version
+Print GNUnet version number.
+.It Fl x | -demultiplex
+Set DHT's demultiplex everywhere option.
+.El
+.Sh SEE ALSO
+The full documentation for gnunet is maintained as a Texinfo manual.
+If the
+.Xr info 1
+and gnunet programs are properly installed at your site, the command
+.Pp
+.Dl info gnunet
+.\".Sh HISTORY
+.\".Sh AUTHORS
+.Sh BUGS
+Report bugs by using
+.Lk https://bugs.gnunet.org
+or by sending electronic mail to
+.Aq Mt gnunet-developers@gnu.org .
author	Martin Schanzenbach <schanzen@gnunet.org>	2023-01-05 22:40:08 +0900
committer	Martin Schanzenbach <schanzen@gnunet.org>	2023-01-05 22:40:08 +0900
commit	7c22b60b93f9d6b1dbc2ed963d38ba282ba5c87b (patch)
tree	61761b8da75ec9494f896e560434d872f4d6f500 /doc
parent	246c58548efa2f15952fcf80b3b1f294d445c80f (diff)
download	gnunet-7c22b60b93f9d6b1dbc2ed963d38ba282ba5c87b.tar.gz gnunet-7c22b60b93f9d6b1dbc2ed963d38ba282ba5c87b.zip

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 44d99e7e4..7a80a93d8 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am
@@ -47,6 +47,10 @@ man_MANS = \
47	gnunet-core.1 \	47	gnunet-core.1 \
48	gnunet-conversation.1 \	48	gnunet-conversation.1 \
49	gnunet-conversation-test.1 \	49	gnunet-conversation-test.1 \
		50	gnunet-dht-get.1 \
		51	gnunet-dht-put.1 \
		52	gnunet-dht-monitor.1 \
		53	gnunet-dht-hello.1 \
50	gnunet-directory.1 \	54	gnunet-directory.1 \
51	gnunet-dns2gns.1 \	55	gnunet-dns2gns.1 \
52	gnunet-datastore.1 \	56	gnunet-datastore.1 \


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


diff --git a/doc/man/gnunet-dht-hello.1 b/doc/man/gnunet-dht-hello.1 new file mode 100644 index 000000000..b50736f65 --- /dev/null +++ b/doc/man/gnunet-dht-hello.1
@@ -0,0 +1,75 @@
		1	.\" This file is part of GNUnet.
		2	.\" Copyright (C) 2023 GNUnet e.V.
		3	.\"
		4	.\" Permission is granted to copy, distribute and/or modify this document
		5	.\" under the terms of the GNU Free Documentation License, Version 1.3 or
		6	.\" any later version published by the Free Software Foundation; with no
		7	.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
		8	.\" copy of the license is included in the file
		9	.\" FDL-1.3.
		10	.\"
		11	.\" A copy of the license is also available from the Free Software
		12	.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
		13	.\"
		14	.\" Alternately, this document is also available under the General
		15	.\" Public License, version 3 or later, as published by the Free Software
		16	.\" Foundation. A copy of the license is included in the file
		17	.\" GPL3.
		18	.\"
		19	.\" A copy of the license is also available from the Free Software
		20	.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
		21	.\"
		22	.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
		23	.\"
		24	.Dd January 5, 2023
		25	.Dt GNUNET-DHT-HELLO 1
		26	.Os
		27	.Sh NAME
		28	.Nm gnunet-dht-hello
		29	.Nd Obtain HELLO from DHT or provide HELLO to DHT for bootstrapping.
		30	.Sh SYNOPSIS
		31	.Nm
		32	.Op Ar URL
		33	.El
		34	.Op Fl c Ar FILENAME \| Fl -config= Ns Ar FILENAME
		35	.Op Fl h \| -help
		36	.Op Fl L Ar LOGLEVEL \| Fl -loglevel= Ns Ar LOGLEVEL
		37	.Op Fl l Ar LOGFILE \| Fl -logfile= Ns Ar LOGFILE
		38	.Op Fl V \| -verbose
		39	.Op Fl v \| -version
		40	.Sh DESCRIPTION
		41	.Nm
		42	is a command line tool to either get a HELLO for your own peer (no arguments) or to
		43	parse a HELLO URL by providing it as the sole argument.
		44	.Sh OPTIONS
		45	.Bl -tag -width indent
		46	.It Fl c Ar FILENAME \| Fl -config= Ns Ar FILENAME
		47	Use the configuration file
		48	.Ar FILENAME .
		49	.It Fl h \| -help
		50	Print short help on options.
		51	.It Fl L Ar LOGLEVEL \| Fl -loglevel= Ns Ar LOGLEVEL
		52	Use LOGLEVEL for logging.
		53	Valid values are DEBUG, INFO, WARNING and ERROR.
		54	.It Fl l Ar LOGFILE \| Fl -logfile= Ns Ar LOGFILE
		55	Configure logging to write logs to
		56	.Ar LOGFILE .
		57	.It Fl V \| -verbose
		58	be verbose.
		59	.It Fl v \| -version
		60	Print GNUnet version number.
		61	.El
		62	.Sh SEE ALSO
		63	The full documentation for gnunet is maintained as a Texinfo manual.
		64	If the
		65	.Xr info 1
		66	and gnunet programs are properly installed at your site, the command
		67	.Pp
		68	.Dl info gnunet
		69	.\".Sh HISTORY
		70	.\".Sh AUTHORS
		71	.Sh BUGS
		72	Report bugs by using
		73	.Lk https://bugs.gnunet.org
		74	or by sending electronic mail to
		75	.Aq Mt gnunet-developers@gnu.org .


diff --git a/doc/man/gnunet-dht-monitor.1 b/doc/man/gnunet-dht-monitor.1 new file mode 100644 index 000000000..08707f6bb --- /dev/null +++ b/doc/man/gnunet-dht-monitor.1
@@ -0,0 +1,82 @@
		1	.\" This file is part of GNUnet.
		2	.\" Copyright (C) 2023 GNUnet e.V.
		3	.\"
		4	.\" Permission is granted to copy, distribute and/or modify this document
		5	.\" under the terms of the GNU Free Documentation License, Version 1.3 or
		6	.\" any later version published by the Free Software Foundation; with no
		7	.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
		8	.\" copy of the license is included in the file
		9	.\" FDL-1.3.
		10	.\"
		11	.\" A copy of the license is also available from the Free Software
		12	.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
		13	.\"
		14	.\" Alternately, this document is also available under the General
		15	.\" Public License, version 3 or later, as published by the Free Software
		16	.\" Foundation. A copy of the license is included in the file
		17	.\" GPL3.
		18	.\"
		19	.\" A copy of the license is also available from the Free Software
		20	.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
		21	.\"
		22	.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
		23	.\"
		24	.Dd January 5, 2023
		25	.Dt GNUNET-DHT-MONITOR 1
		26	.Os
		27	.Sh NAME
		28	.Nm gnunet-dht-monitor
		29	.Nd Print packets that go through the DHT on this peer.
		30	.Sh SYNOPSIS
		31	.Nm
		32	.Op Fl c Ar FILENAME \| Fl -config= Ns Ar FILENAME
		33	.Op Fl h \| -help
		34	.Op Fl k Ar KEY \| Fl -key= Ns Ar KEY
		35	.Op Fl L Ar LOGLEVEL \| Fl -loglevel= Ns Ar LOGLEVEL
		36	.Op Fl l Ar LOGFILE \| Fl -logfile= Ns Ar LOGFILE
		37	.Op Fl T Ar TIMEOUT \| Fl -timeout= Ns Ar TIMEOUT
		38	.Op Fl t Ar TYPE \| Fl -type= Ns Ar TYPE
		39	.Op Fl V \| -verbose
		40	.Op Fl v \| -version
		41	.Sh DESCRIPTION
		42	.Nm
		43	is a command line tool to monitor DHT packets that go through this peer.
		44	.Sh OPTIONS
		45	.Bl -tag -width indent
		46	.It Fl c Ar FILENAME \| Fl -config= Ns Ar FILENAME
		47	Use the configuration file
		48	.Ar FILENAME .
		49	.It Fl h \| -help
		50	Print short help on options.
		51	.It Fl k Ar KEY \| Fl -key= Ns Ar KEY
		52	use the query key
		53	.Ar KEY .
		54	.It Fl L Ar LOGLEVEL \| Fl -loglevel= Ns Ar LOGLEVEL
		55	Use LOGLEVEL for logging.
		56	Valid values are DEBUG, INFO, WARNING and ERROR.
		57	.It Fl l Ar LOGFILE \| Fl -logfile= Ns Ar LOGFILE
		58	Configure logging to write logs to
		59	.Ar LOGFILE .
		60	.It Fl T Ar TIMEOUT \| -timeout= Ns Ar TIMEOUT
		61	how long should the monitor command run.
		62	.It Fl t Ar TYPE \| Fl -type= Ns Ar TYPE
		63	the block type to filter for.
		64	.It Fl V \| -verbose
		65	be verbose.
		66	.It Fl v \| -version
		67	Print GNUnet version number.
		68	.El
		69	.Sh SEE ALSO
		70	The full documentation for gnunet is maintained as a Texinfo manual.
		71	If the
		72	.Xr info 1
		73	and gnunet programs are properly installed at your site, the command
		74	.Pp
		75	.Dl info gnunet
		76	.\".Sh HISTORY
		77	.\".Sh AUTHORS
		78	.Sh BUGS
		79	Report bugs by using
		80	.Lk https://bugs.gnunet.org
		81	or by sending electronic mail to
		82	.Aq Mt gnunet-developers@gnu.org .


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