aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-namestore.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-namestore.1')
-rw-r--r--doc/man/gnunet-namestore.1105
1 files changed, 88 insertions, 17 deletions
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1
index 73bbe5a5c..6915aed6e 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,15 +39,20 @@
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
44.Op Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE
45.Op Fl s | -shadow 46.Op Fl s | -shadow
47.Op Fl S | -from-stdin
48.Op Fl T | -include-maintenance
46.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE 49.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE
47.Op Fl u Ar URI | Fl -uri= Ns Ar URI 50.Op Fl u Ar URI | Fl -uri= Ns Ar URI
48.Op Fl v | -version 51.Op Fl v | -version
49.Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE 52.Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE
53.Op Fl X | -purge-zone-records
50.Op Fl z Ar EGO | Fl -zone= Ns Ar EGO 54.Op Fl z Ar EGO | Fl -zone= Ns Ar EGO
55.Op Fl Z Ar KEY | Fl -zone-to-name= Ns Ar KEY
51.Sh DESCRIPTION 56.Sh DESCRIPTION
52.Nm 57.Nm
53can be used to manipulate records in a GNS zone. 58can be used to manipulate records in a GNS zone.
@@ -88,26 +93,53 @@ 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).
94.It Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY 105.It Fl r | -recordline
95Determine our GNS name for the given public key (reverse lookup of the 106Changes the output format of zones and records to recordline.
96PKEY) in the given zone.
97.It Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE
98Sets record set to values given in RECORDLINE.
99This option can be specified multiple times to provide multiple
100records for the record set.
101Existing records under the same label will be deleted.
102The format for the RECORDLINE is "TTL TYPE FLAGS VALUE" where TTL is
103the time to live in seconds (unit must not be given explicitly,
104seconds is always implied), TYPE is the DNS/GNS record type,
105FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC".
106The VALUE follows the usual human-readable value format(s) of DNS/GNS.
107.It Fl s | -shadow 107.It Fl s | -shadow
108Create a record that is a shadow record. 108Create a record that is a shadow record.
109Shadow records are only used once all other records of the same type 109Shadow records are only used once all other records of the same type
110under the same label have expired. 110under the same label have expired.
111.It Fl S | -from-stdin
112Read recordlines from stdin until EOF is encountered.
113The format uses
114.B recordlines
115:
116A record in a recordline follows the format
117
118NAME.EGO:
119 TYPE EXPIRATION [FLAGS] VALUE
120 ...
121Multiple records may be provided for a name.
122
123EXPIRATION is given in microseconds without a unit (e.g. 3600000000 for 3600 seconds).
124
125FLAGS is a concatenation of record flags.
126Possible values for flags and their meaning are:
127.Pp
128 p: Public
129 s: Shadow
130 S: Supplemental
131 C: Critical
132 r: Relative expiration
133
134TYPE and VALUE are used in the same way as for the "-t" and "-V" options.
135Example formats for recordlines can be output using the "-D" flag combined
136with "--recordline".
137An example record set in recordline format can be found in the examples.
138It is possible to specify multiple record sets.
139Can only be used in combination with "-a" to add the parsed record sets.
140Existing record sets under names will be replaced.
141.It Fl T | -include-maintenance
142Show maintenance records such as TOMBSTONEs. Use in combination with --display.
111.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE 143.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
112Type of the record to add/delete/display ("A"; "AAAA"; "NS"; "PKEY"; "MX"; etc.). 144Type of the record to add/delete/display ("A"; "AAAA"; "NS"; "PKEY"; "MX"; etc.).
113.It Fl u Ar URI | Fl -uri= Ns Ar URI 145.It Fl u Ar URI | Fl -uri= Ns Ar URI
@@ -121,6 +153,8 @@ Specific format depends on the record type.
121A records expect a dotted decimal IPv4 address, AAAA records an IPv6 153A records expect a dotted decimal IPv4 address, AAAA records an IPv6
122address, PKEY a public key in GNUnet's printable format, and CNAME and 154address, PKEY a public key in GNUnet's printable format, and CNAME and
123NS records should be a domain name. 155NS records should be a domain name.
156.It Fl X | -purge-zone-records
157Delete all records in a zone.
124.It Fl z Ar EGO | Fl -zone= Ns Ar EGO 158.It Fl z Ar EGO | Fl -zone= Ns Ar EGO
125Specifies the name of the ego controlling the private key for the 159Specifies the name of the ego controlling the private key for the
126zone. If not provided, we will attempt to use the default identity set 160zone. If not provided, we will attempt to use the default identity set
@@ -129,8 +163,45 @@ Base32-encoding using the GNUNET_NAMESTORE_EGO_PRIVATE_KEY environment
129variable. The latter is useful to improve performance of tools like 163variable. The latter is useful to improve performance of tools like
130Ascension as it allows the command to skip IPC with the identity 164Ascension as it allows the command to skip IPC with the identity
131management subsystem. 165management subsystem.
166.It Fl Z Ar KEY | Fl -zone-to-name= Ns Ar KEY
167Determine our GNS name for the given public key (reverse lookup of the
168KEY) in the given zone.
132.El 169.El
133.\".Sh EXAMPLES 170.Sh EXAMPLES
171.Tp
172.Nm
173-z example -a -n www -t A -V "1.2.3.4" -e 1d -p
174.Tp
175.Pp
176.Dl Add a public record for ego "example" with name "www" containing an IP address.
177.sp
178.Tp
179.Nm
180-z example -D
181.Tp
182.Pp
183.Dl Show all records for ego "example".
184.sp
185.Tp
186.Nm
187-z example -D -r
188.Tp
189.Pp
190.Dl Show all records for ego "example" in recordline format.
191.sp
192.Tp
193.Nm
194--add --from-stdin <<EOF
195 www.alice:
196 A 3600000000 [pr] 1.2.3.4
197 TXT 3600000001 [pr] Hello World
198
199 www.bob:
200 A 12345679000000 [pr] 4.3.2.1
201 EOF
202.Tp
203.Pp
204.Dl Read record sets in recordline format from stdin.
134.\".Sh FILES 205.\".Sh FILES
135.Sh SEE ALSO 206.Sh SEE ALSO
136.Xr gnunet-gns 1 , 207.Xr gnunet-gns 1 ,