gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[gnunet] branch master updated (246c58548 -> d9f74f175)


From: gnunet
Subject: [gnunet] branch master updated (246c58548 -> d9f74f175)
Date: Thu, 05 Jan 2023 14:55:12 +0100

This is an automated email from the git hooks/post-receive script.

martin-schanzenbach pushed a change to branch master
in repository gnunet.

    from 246c58548 PEERSTORE: Stop installing gnunet-peerstore binary that does 
not do anything.
     new 7c22b60b9 DOC: Add long overdue DHT man pages.
     new d9f74f175 DOC: Add messenger man page. Fixes #7543

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 doc/man/Makefile.am                                |  5 ++
 doc/man/{gnunet-resolver.1 => gnunet-dht-get.1}    | 55 ++++++++++-------
 doc/man/{gnunet-resolver.1 => gnunet-dht-hello.1}  | 40 +++++-------
 .../{gnunet-resolver.1 => gnunet-dht-monitor.1}    | 47 +++++++-------
 doc/man/{gnunet-testing.1 => gnunet-dht-put.1}     | 72 ++++++++++++----------
 doc/man/{gnunet-resolver.1 => gnunet-messenger.1}  | 45 +++++++-------
 6 files changed, 141 insertions(+), 123 deletions(-)
 copy doc/man/{gnunet-resolver.1 => gnunet-dht-get.1} (67%)
 copy doc/man/{gnunet-resolver.1 => gnunet-dht-hello.1} (75%)
 copy doc/man/{gnunet-resolver.1 => gnunet-dht-monitor.1} (71%)
 copy doc/man/{gnunet-testing.1 => gnunet-dht-put.1} (61%)
 copy doc/man/{gnunet-resolver.1 => gnunet-messenger.1} (68%)

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 44d99e7e4..17a23da92 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 \
@@ -59,6 +63,7 @@ man_MANS = \
   gnunet-gns-proxy-setup-ca.1 \
   gnunet-identity.1 \
   gnunet-cadet.1 \
+  gnunet-messenger.1 \
   gnunet-namecache.1 \
   gnunet-namestore.1 \
   gnunet-namestore-fcfsd.1 \
diff --git a/doc/man/gnunet-resolver.1 b/doc/man/gnunet-dht-get.1
similarity index 67%
copy from doc/man/gnunet-resolver.1
copy to doc/man/gnunet-dht-get.1
index 8dc63ff06..bd411f2f0 100644
--- a/doc/man/gnunet-resolver.1
+++ b/doc/man/gnunet-dht-get.1
@@ -1,5 +1,5 @@
 .\" This file is part of GNUnet.
-.\" Copyright (C) 2001-2019 GNUnet e.V.
+.\" 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
@@ -21,40 +21,59 @@
 .\"
 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
 .\"
-.Dd January 4, 2012
-.Dt GNUNET-RESOLVER 1
+.Dd January 5, 2023
+.Dt GNUNET-DHT-GET 1
 .Os
 .Sh NAME
-.Nm gnunet-resolver
-.Nd built-in GNUnet stub resolver
+.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 | -reverse
+.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
-.Ao Ar hostname Ac
+.Op Fl x | -demultiplex
 .Sh DESCRIPTION
 .Nm
-allows you to use the built-in GNUnet stub resolver.
+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 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 LOGFILE.
-.It Fl r | -reverse
-Perform a reverse lookup.
+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 EXAMPLES
 .Sh SEE ALSO
 The full documentation for gnunet is maintained as a Texinfo manual.
 If the
@@ -62,16 +81,6 @@ If the
 and gnunet programs are properly installed at your site, the command
 .Pp
 .Dl info gnunet
-.Pp
-should give you access to the complete handbook,
-.Pp
-.Dl info gnunet-c-tutorial
-.Pp
-will give you access to a tutorial for developers.
-.sp
-Depending on your installation, this information is also available in
-.Xr gnunet 7 and
-.Xr gnunet-c-tutorial 7 .
 .\".Sh HISTORY
 .\".Sh AUTHORS
 .Sh BUGS
diff --git a/doc/man/gnunet-resolver.1 b/doc/man/gnunet-dht-hello.1
similarity index 75%
copy from doc/man/gnunet-resolver.1
copy to doc/man/gnunet-dht-hello.1
index 8dc63ff06..b50736f65 100644
--- a/doc/man/gnunet-resolver.1
+++ b/doc/man/gnunet-dht-hello.1
@@ -1,5 +1,5 @@
 .\" This file is part of GNUnet.
-.\" Copyright (C) 2001-2019 GNUnet e.V.
+.\" 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
@@ -21,40 +21,44 @@
 .\"
 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
 .\"
-.Dd January 4, 2012
-.Dt GNUNET-RESOLVER 1
+.Dd January 5, 2023
+.Dt GNUNET-DHT-HELLO 1
 .Os
 .Sh NAME
-.Nm gnunet-resolver
-.Nd built-in GNUnet stub resolver
+.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 r | -reverse
+.Op Fl V | -verbose
 .Op Fl v | -version
-.Ao Ar hostname Ac
 .Sh DESCRIPTION
 .Nm
-allows you to use the built-in GNUnet stub resolver.
+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 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 LOGFILE.
-.It Fl r | -reverse
-Perform a reverse lookup.
+Configure logging to write logs to
+.Ar LOGFILE .
+.It Fl V | -verbose
+be verbose.
 .It Fl v | -version
 Print GNUnet version number.
 .El
-.\".Sh EXAMPLES
 .Sh SEE ALSO
 The full documentation for gnunet is maintained as a Texinfo manual.
 If the
@@ -62,16 +66,6 @@ If the
 and gnunet programs are properly installed at your site, the command
 .Pp
 .Dl info gnunet
-.Pp
-should give you access to the complete handbook,
-.Pp
-.Dl info gnunet-c-tutorial
-.Pp
-will give you access to a tutorial for developers.
-.sp
-Depending on your installation, this information is also available in
-.Xr gnunet 7 and
-.Xr gnunet-c-tutorial 7 .
 .\".Sh HISTORY
 .\".Sh AUTHORS
 .Sh BUGS
diff --git a/doc/man/gnunet-resolver.1 b/doc/man/gnunet-dht-monitor.1
similarity index 71%
copy from doc/man/gnunet-resolver.1
copy to doc/man/gnunet-dht-monitor.1
index 8dc63ff06..08707f6bb 100644
--- a/doc/man/gnunet-resolver.1
+++ b/doc/man/gnunet-dht-monitor.1
@@ -1,5 +1,5 @@
 .\" This file is part of GNUnet.
-.\" Copyright (C) 2001-2019 GNUnet e.V.
+.\" 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
@@ -21,40 +21,51 @@
 .\"
 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
 .\"
-.Dd January 4, 2012
-.Dt GNUNET-RESOLVER 1
+.Dd January 5, 2023
+.Dt GNUNET-DHT-MONITOR 1
 .Os
 .Sh NAME
-.Nm gnunet-resolver
-.Nd built-in GNUnet stub resolver
+.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 r | -reverse
+.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
-.Ao Ar hostname Ac
 .Sh DESCRIPTION
 .Nm
-allows you to use the built-in GNUnet stub resolver.
+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 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 LOGFILE.
-.It Fl r | -reverse
-Perform a reverse lookup.
+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 EXAMPLES
 .Sh SEE ALSO
 The full documentation for gnunet is maintained as a Texinfo manual.
 If the
@@ -62,16 +73,6 @@ If the
 and gnunet programs are properly installed at your site, the command
 .Pp
 .Dl info gnunet
-.Pp
-should give you access to the complete handbook,
-.Pp
-.Dl info gnunet-c-tutorial
-.Pp
-will give you access to a tutorial for developers.
-.sp
-Depending on your installation, this information is also available in
-.Xr gnunet 7 and
-.Xr gnunet-c-tutorial 7 .
 .\".Sh HISTORY
 .\".Sh AUTHORS
 .Sh BUGS
diff --git a/doc/man/gnunet-testing.1 b/doc/man/gnunet-dht-put.1
similarity index 61%
copy from doc/man/gnunet-testing.1
copy to doc/man/gnunet-dht-put.1
index 7d40152ac..ec6b38c44 100644
--- a/doc/man/gnunet-testing.1
+++ b/doc/man/gnunet-dht-put.1
@@ -1,5 +1,5 @@
 .\" This file is part of GNUnet.
-.\" Copyright (C) 2001-2019 GNUnet e.V.
+.\" 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
@@ -21,52 +21,68 @@
 .\"
 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
 .\"
-.Dd January 4, 2012
-.Dt GNUNET-TESTING 1
+.Dd January 5, 2023
+.Dt GNUNET-DHT-PUT 1
 .Os
 .Sh NAME
-.Nm gnunet-testing
-.Nd command line tool to access the testing library
+.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 | -cfg
 .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
-.Op Fl H | -hostkeys
+.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 | -key
+.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 LOFILE
-.Op Fl n | -number
-.Op Fl t | -template
+.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 access the testing library.
+is a command line tool to issue PUT requests to the DHT.
 .Sh OPTIONS
 .Bl -tag -width indent
-.It Fl C | -cfg
-Create unique configuration files.
 .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
 Use the configuration file
 .Ar FILENAME .
-.It Fl H | -hostkeys
-Host key file.
+.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 | -key
-Create hostkey files from pre-computed hostkey list.
+.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 LOFILE
+.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
 Configure logging to write logs to
 .Ar LOGFILE .
-.It Fl n | -number
-Number of unique configuration files or hostkeys to create.
-.It Fl t | -template
-Configuration template.
+.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.
@@ -75,16 +91,6 @@ If the
 and gnunet programs are properly installed at your site, the command
 .Pp
 .Dl info gnunet
-.Pp
-should give you access to the complete handbook,
-.Pp
-.Dl info gnunet-c-tutorial
-.Pp
-will give you access to a tutorial for developers.
-.sp
-Depending on your installation, this information is also available in
-.Xr gnunet 7 and
-.Xr gnunet-c-tutorial 7 .
 .\".Sh HISTORY
 .\".Sh AUTHORS
 .Sh BUGS
diff --git a/doc/man/gnunet-resolver.1 b/doc/man/gnunet-messenger.1
similarity index 68%
copy from doc/man/gnunet-resolver.1
copy to doc/man/gnunet-messenger.1
index 8dc63ff06..9dfe86227 100644
--- a/doc/man/gnunet-resolver.1
+++ b/doc/man/gnunet-messenger.1
@@ -1,5 +1,5 @@
 .\" This file is part of GNUnet.
-.\" Copyright (C) 2001-2019 GNUnet e.V.
+.\" 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
@@ -21,40 +21,50 @@
 .\"
 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
 .\"
-.Dd January 4, 2012
-.Dt GNUNET-RESOLVER 1
+.Dd January 5, 2023
+.Dt GNUNET-MESSENGER 1
 .Os
 .Sh NAME
-.Nm gnunet-resolver
-.Nd built-in GNUnet stub resolver
+.Nm gnunet-messenger
+.Nd Open and connect to rooms using the MESSENGER service to chat.
 .Sh SYNOPSIS
 .Nm
 .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+.Op Fl d Ar PEERIDENTITY | Fl -door= Ns Ar PEERIDENTITY
+.Op Fl e Ar IDENTITY | Fl -ego= Ns Ar IDENTITY
 .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 r | -reverse
+.Op Fl p | -private
+.Op Fl r Ar ROOMKEY | Fl -room= Ns Ar ROOMKEY
 .Op Fl v | -version
-.Ao Ar hostname Ac
 .Sh DESCRIPTION
 .Nm
-allows you to use the built-in GNUnet stub resolver.
+is a command line tool to connect to rooms using the MESSENGER service to chat.
+.Sh OPTIONS
 .Bl -tag -width indent
 .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
-Use the configuration file FILENAME.
+Use the specified configuration file
+.Ar FILENAME .
+.It Fl d Ar PEERIDENTITY | Fl -did= Ns Ar PEERIDENTITY
+peer identity to entry into the room.
+.It Fl e Ar IDENTITY | Fl -ego= Ns Ar IDENTITY
+identity to use for messaging
 .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 LOGFILE.
-.It Fl r | -reverse
-Perform a reverse lookup.
+Configure logging to write logs to
+.Ar LOGFILE .
+.It Fl p | -private
+flag to enable private mode.
+.It Fl r Ar ROOMKEY | Fl -room= Ns Ar ROOMKEY
+key of the room to connect to.
 .It Fl v | -version
 Print GNUnet version number.
 .El
-.\".Sh EXAMPLES
 .Sh SEE ALSO
 The full documentation for gnunet is maintained as a Texinfo manual.
 If the
@@ -63,15 +73,8 @@ and gnunet programs are properly installed at your site, the 
command
 .Pp
 .Dl info gnunet
 .Pp
-should give you access to the complete handbook,
-.Pp
-.Dl info gnunet-c-tutorial
-.Pp
-will give you access to a tutorial for developers.
+should give you access to the complete handbook.
 .sp
-Depending on your installation, this information is also available in
-.Xr gnunet 7 and
-.Xr gnunet-c-tutorial 7 .
 .\".Sh HISTORY
 .\".Sh AUTHORS
 .Sh BUGS

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]