aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMartin Schanzenbach <schanzen@gnunet.org>2022-10-24 20:52:27 +0900
committerMartin Schanzenbach <schanzen@gnunet.org>2022-10-24 20:52:27 +0900
commit8de99f209e9cc3cd5b212c8e5d7da86e90bf64e6 (patch)
treef6469a4a7bf540b5c67c0761e9f421d70ff4cbac /doc
parent73c3d1e1c4bda76d8c7c371988d79eb1b7b4e548 (diff)
downloadgnunet-8de99f209e9cc3cd5b212c8e5d7da86e90bf64e6.tar.gz
gnunet-8de99f209e9cc3cd5b212c8e5d7da86e90bf64e6.zip
-update namestore manpage and add options for orphan management
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-namestore.117
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1
index 73bbe5a5c..9391e21bb 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,14 +39,19 @@
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 46.Op Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY
44.Op Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE 47.Op Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE
45.Op Fl s | -shadow 48.Op Fl s | -shadow
49.Op Fl T | -include-maintenance
46.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE 50.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE
47.Op Fl u Ar URI | Fl -uri= Ns Ar URI 51.Op Fl u Ar URI | Fl -uri= Ns Ar URI
48.Op Fl v | -version 52.Op Fl v | -version
49.Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE 53.Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE
54.Op Fl X | -purge-zone-records
50.Op Fl z Ar EGO | Fl -zone= Ns Ar EGO 55.Op Fl z Ar EGO | Fl -zone= Ns Ar EGO
51.Sh DESCRIPTION 56.Sh DESCRIPTION
52.Nm 57.Nm
@@ -88,6 +93,12 @@ 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).
@@ -108,6 +119,8 @@ The VALUE follows the usual human-readable value format(s) of DNS/GNS.
108Create a record that is a shadow record. 119Create a record that is a shadow record.
109Shadow records are only used once all other records of the same type 120Shadow records are only used once all other records of the same type
110under the same label have expired. 121under the same label have expired.
122.It Fl T | -include-maintenance
123Show maintenance records such as TOMBSTONEs. Use in combination with --display.
111.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE 124.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
112Type of the record to add/delete/display ("A"; "AAAA"; "NS"; "PKEY"; "MX"; etc.). 125Type of the record to add/delete/display ("A"; "AAAA"; "NS"; "PKEY"; "MX"; etc.).
113.It Fl u Ar URI | Fl -uri= Ns Ar URI 126.It Fl u Ar URI | Fl -uri= Ns Ar URI
@@ -121,6 +134,8 @@ Specific format depends on the record type.
121A records expect a dotted decimal IPv4 address, AAAA records an IPv6 134A records expect a dotted decimal IPv4 address, AAAA records an IPv6
122address, PKEY a public key in GNUnet's printable format, and CNAME and 135address, PKEY a public key in GNUnet's printable format, and CNAME and
123NS records should be a domain name. 136NS records should be a domain name.
137.It Fl X | -purge-zone-records
138Delete all records in a zone.
124.It Fl z Ar EGO | Fl -zone= Ns Ar EGO 139.It Fl z Ar EGO | Fl -zone= Ns Ar EGO
125Specifies the name of the ego controlling the private key for the 140Specifies the name of the ego controlling the private key for the
126zone. If not provided, we will attempt to use the default identity set 141zone. If not provided, we will attempt to use the default identity set