diff options
author | Martin Schanzenbach <schanzen@gnunet.org> | 2022-11-21 14:25:32 +0900 |
---|---|---|
committer | Martin Schanzenbach <schanzen@gnunet.org> | 2022-11-21 14:25:32 +0900 |
commit | dcc603a15131602fc0da292b08609383335c1485 (patch) | |
tree | 3a91f42c36424cecaf24cf59b4754c24174b1fef /doc | |
parent | 33f35509877e811e85cae98b94024647db7b7835 (diff) | |
download | gnunet-dcc603a15131602fc0da292b08609383335c1485.tar.gz gnunet-dcc603a15131602fc0da292b08609383335c1485.zip |
-update manpage
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/gnunet-namestore.1 | 76 |
1 files 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 @@ | |||
43 | .Op Fl o | -omit-private | 43 | .Op Fl o | -omit-private |
44 | .Op Fl P | -purge-orphans | 44 | .Op Fl P | -purge-orphans |
45 | .Op Fl p | -public | 45 | .Op Fl p | -public |
46 | .Op Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY | ||
47 | .Op Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE | ||
48 | .Op Fl s | -shadow | 46 | .Op Fl s | -shadow |
49 | .Op Fl S | -from-stdin | 47 | .Op Fl S | -from-stdin |
50 | .Op Fl T | -include-maintenance | 48 | .Op Fl T | -include-maintenance |
@@ -54,6 +52,7 @@ | |||
54 | .Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE | 52 | .Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE |
55 | .Op Fl X | -purge-zone-records | 53 | .Op Fl X | -purge-zone-records |
56 | .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 | ||
57 | .Sh DESCRIPTION | 56 | .Sh DESCRIPTION |
58 | .Nm | 57 | .Nm |
59 | can be used to manipulate records in a GNS zone. | 58 | can be used to manipulate records in a GNS zone. |
@@ -103,29 +102,42 @@ Delete orphaned records from namestore. | |||
103 | .It Fl p | -public | 102 | .It Fl p | -public |
104 | Create a record that is public (shared with other users that know the | 103 | Create a record that is public (shared with other users that know the |
105 | label). | 104 | label). |
106 | .It Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY | 105 | .It Fl r | -recordline |
107 | Determine our GNS name for the given public key (reverse lookup of the | 106 | Changes the output format of zones and records to recordline. |
108 | PKEY) in the given zone. | ||
109 | .It Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE | ||
110 | Sets record set to values given in RECORDLINE. | ||
111 | This option can be specified multiple times to provide multiple | ||
112 | records for the record set. | ||
113 | Existing records under the same label will be deleted. | ||
114 | The format for the RECORDLINE is "TTL TYPE FLAGS VALUE" where TTL is | ||
115 | the time to live in seconds (unit must not be given explicitly, | ||
116 | seconds is always implied), TYPE is the DNS/GNS record type, | ||
117 | FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC". | ||
118 | The VALUE follows the usual human-readable value format(s) of DNS/GNS. | ||
119 | .It Fl s | -shadow | 107 | .It Fl s | -shadow |
120 | Create a record that is a shadow record. | 108 | Create a record that is a shadow record. |
121 | Shadow records are only used once all other records of the same type | 109 | Shadow records are only used once all other records of the same type |
122 | under the same label have expired. | 110 | under the same label have expired. |
123 | .It Fl S | -from-stdin | 111 | .It Fl S | -from-stdin |
124 | This reads commands from stdin until EOF is encountered. | 112 | Read recordlines from stdin until EOF is encountered. |
125 | The commands are formatted like the arguments used for gnunet-namestore. | 113 | The format uses |
126 | Arguments that | 114 | .B recordlines |
127 | .B cannot | 115 | : |
128 | be used for commands in this mode are: -l, -L, -D, -S, -m, -h, -c, -v, -r, -o, -T, -O | 116 | A record in a recordline follows the format |
117 | |||
118 | NAME.EGO: | ||
119 | TYPE EXPIRATION [FLAGS] VALUE | ||
120 | ... | ||
121 | Multiple records may be provided for a name. | ||
122 | |||
123 | EXPIRATION is given in microseconds without a unit (e.g. 3600000000 for 3600 seconds). | ||
124 | |||
125 | FLAGS is a concatenation of record flags. | ||
126 | Possible 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 | |||
134 | TYPE and VALUE are used in the same way as for the "-t" and "-V" options. | ||
135 | Example formats for recordlines can be output using the "-D" flag combined | ||
136 | with "--recordline". | ||
137 | An example record set in recordline format can be found in the examples. | ||
138 | It is possible to specify multiple record sets. | ||
139 | Can only be used in combination with "-a" to add the parsed record sets. | ||
140 | Existing record sets under names will be replaced. | ||
129 | .It Fl T | -include-maintenance | 141 | .It Fl T | -include-maintenance |
130 | Show maintenance records such as TOMBSTONEs. Use in combination with --display. | 142 | Show maintenance records such as TOMBSTONEs. Use in combination with --display. |
131 | .It Fl t Ar TYPE | Fl -type= Ns Ar TYPE | 143 | .It Fl t Ar TYPE | Fl -type= Ns Ar TYPE |
@@ -151,6 +163,9 @@ Base32-encoding using the GNUNET_NAMESTORE_EGO_PRIVATE_KEY environment | |||
151 | variable. The latter is useful to improve performance of tools like | 163 | variable. The latter is useful to improve performance of tools like |
152 | Ascension as it allows the command to skip IPC with the identity | 164 | Ascension as it allows the command to skip IPC with the identity |
153 | management subsystem. | 165 | management subsystem. |
166 | .It Fl Z Ar KEY | Fl -zone-to-name= Ns Ar KEY | ||
167 | Determine our GNS name for the given public key (reverse lookup of the | ||
168 | KEY) in the given zone. | ||
154 | .El | 169 | .El |
155 | .Sh EXAMPLES | 170 | .Sh EXAMPLES |
156 | .Tp | 171 | .Tp |
@@ -165,17 +180,28 @@ management subsystem. | |||
165 | -z example -D | 180 | -z example -D |
166 | .Tp | 181 | .Tp |
167 | .Pp | 182 | .Pp |
168 | .Dl Show all records for ego "example" | 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. | ||
169 | .sp | 191 | .sp |
170 | .Tp | 192 | .Tp |
171 | .Nm | 193 | .Nm |
172 | --from-stdin <<EOF | 194 | --add --from-stdin <<EOF |
173 | -z alice -a -n www -t A -V "1.2.3.4" -e 3600s -p | 195 | www.alice: |
174 | -z bob -a -n www -t A -V "4.3.2.1" -e 24h -p | 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 | ||
175 | EOF | 201 | EOF |
176 | .Tp | 202 | .Tp |
177 | .Pp | 203 | .Pp |
178 | .Dl Read record multiple import commands from stdin. | 204 | .Dl Read record sets in recordline format from stdin. |
179 | .\".Sh FILES | 205 | .\".Sh FILES |
180 | .Sh SEE ALSO | 206 | .Sh SEE ALSO |
181 | .Xr gnunet-gns 1 , | 207 | .Xr gnunet-gns 1 , |