[gnunet] branch master updated: -update manpage

[gnunet]

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

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

The following commit(s) were added to refs/heads/master by this push:
     new dcc603a15 -update manpage
dcc603a15 is described below

commit dcc603a15131602fc0da292b08609383335c1485
Author: Martin Schanzenbach <schanzen@gnunet.org>
AuthorDate: Mon Nov 21 14:25:32 2022 +0900

    -update manpage
---
 doc/man/gnunet-namestore.1 | 76 +++++++++++++++++++++++++++++++---------------
 1 file changed, 51 insertions(+), 25 deletions(-)

diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1
index c70e4499d..6915aed6e 100644
--- a/doc/man/gnunet-namestore.1
+++ b/doc/man/gnunet-namestore.1
@@ -43,8 +43,6 @@
 .Op Fl o | -omit-private
 .Op Fl P | -purge-orphans
 .Op Fl p | -public
-.Op Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY
-.Op Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE
 .Op Fl s | -shadow
 .Op Fl S | -from-stdin
 .Op Fl T | -include-maintenance
@@ -54,6 +52,7 @@
 .Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE
 .Op Fl X | -purge-zone-records
 .Op Fl z Ar EGO | Fl -zone= Ns Ar EGO
+.Op Fl Z Ar KEY | Fl -zone-to-name= Ns Ar KEY
 .Sh DESCRIPTION
 .Nm
 can be used to manipulate records in a GNS zone.
@@ -103,29 +102,42 @@ Delete orphaned records from namestore.
 .It Fl p | -public
 Create a record that is public (shared with other users that know the
 label).
-.It Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY
-Determine our GNS name for the given public key (reverse lookup of the
-PKEY) in the given zone.
-.It Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE
-Sets record set to values given in RECORDLINE.
-This option can be specified multiple times to provide multiple
-records for the record set.
-Existing records under the same label will be deleted.
-The format for the RECORDLINE is "TTL TYPE FLAGS VALUE" where TTL is
-the time to live in seconds (unit must not be given explicitly,
-seconds is always implied), TYPE is the DNS/GNS record type,
-FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC".
-The VALUE follows the usual human-readable value format(s) of DNS/GNS.
+.It Fl r | -recordline
+Changes the output format of zones and records to recordline.
 .It Fl s | -shadow
 Create a record that is a shadow record.
 Shadow records are only used once all other records of the same type
 under the same label have expired.
 .It Fl S | -from-stdin
-This reads commands from stdin until EOF is encountered.
-The commands are formatted like the arguments used for gnunet-namestore.
-Arguments that
-.B cannot
-be used for commands in this mode are: -l, -L, -D, -S, -m, -h, -c, -v, -r, -o, 
-T, -O
+Read recordlines from stdin until EOF is encountered.
+The format uses
+.B recordlines
+:
+A record in a recordline follows the format
+
+NAME.EGO:
+ TYPE EXPIRATION [FLAGS] VALUE
+ ...
+Multiple records may be provided for a name.
+
+EXPIRATION is given in microseconds without a unit (e.g. 3600000000 for 3600 
seconds).
+
+FLAGS is a concatenation of record flags.
+Possible values for flags and their meaning are:
+.Pp
+  p: Public
+  s: Shadow
+  S: Supplemental
+  C: Critical
+  r: Relative expiration
+
+TYPE and VALUE are used in the same way as for the "-t" and "-V" options.
+Example formats for recordlines can be output using the "-D" flag combined
+with "--recordline".
+An example record set in recordline format can be found in the examples.
+It is possible to specify multiple record sets.
+Can only be used in combination with "-a" to add the parsed record sets.
+Existing record sets under names will be replaced.
 .It Fl T | -include-maintenance
 Show maintenance records such as TOMBSTONEs. Use in combination with --display.
 .It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
@@ -151,6 +163,9 @@ Base32-encoding using the GNUNET_NAMESTORE_EGO_PRIVATE_KEY 
environment
 variable. The latter is useful to improve performance of tools like
 Ascension as it allows the command to skip IPC with the identity
 management subsystem.
+.It Fl Z Ar KEY | Fl -zone-to-name= Ns Ar KEY
+Determine our GNS name for the given public key (reverse lookup of the
+KEY) in the given zone.
 .El
 .Sh EXAMPLES
 .Tp
@@ -165,17 +180,28 @@ management subsystem.
 -z example -D
 .Tp
 .Pp
-.Dl Show all records for ego "example"
+.Dl Show all records for ego "example".
+.sp
+.Tp
+.Nm
+-z example -D -r
+.Tp
+.Pp
+.Dl Show all records for ego "example" in recordline format.
 .sp
 .Tp
 .Nm
---from-stdin <<EOF
-  -z alice -a -n www -t A -V "1.2.3.4" -e 3600s -p
-  -z bob -a -n www -t A -V "4.3.2.1" -e 24h -p
+--add --from-stdin <<EOF
+ www.alice:
+  A 3600000000 [pr] 1.2.3.4
+  TXT 3600000001 [pr] Hello World
+
+ www.bob:
+  A 12345679000000 [pr] 4.3.2.1
  EOF
 .Tp
 .Pp
-.Dl Read record multiple import commands from stdin.
+.Dl Read record sets in recordline format from stdin.
 .\".Sh FILES
 .Sh SEE ALSO
 .Xr gnunet-gns 1 ,

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