|
| From: | gnunet |
| Subject: | [gnunet] 01/02: DOC: Add long overdue DHT man pages. |
| Date: | Thu, 05 Jan 2023 14:55:13 +0100 |
This is an automated email from the git hooks/post-receive script.
martin-schanzenbach pushed a commit to branch master
in repository gnunet.
commit 7c22b60b93f9d6b1dbc2ed963d38ba282ba5c87b
Author: Martin Schanzenbach <schanzen@gnunet.org>
AuthorDate: Thu Jan 5 22:40:08 2023 +0900
DOC: Add long overdue DHT man pages.
---
doc/man/Makefile.am | 4 ++
doc/man/gnunet-dht-get.1 | 90 ++++++++++++++++++++++++++++++++++++++
doc/man/gnunet-dht-hello.1 | 75 ++++++++++++++++++++++++++++++++
doc/man/gnunet-dht-monitor.1 | 82 +++++++++++++++++++++++++++++++++++
doc/man/gnunet-dht-put.1 | 100 +++++++++++++++++++++++++++++++++++++++++++
5 files changed, 351 insertions(+)
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 .
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
| [Prev in Thread] | Current Thread | [Next in Thread] |