diff options
Diffstat (limited to 'doc/man/gnunet-namestore.1')
-rw-r--r-- | doc/man/gnunet-namestore.1 | 44 |
1 files changed, 32 insertions, 12 deletions
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1 index 1811031ad..006c8593b 100644 --- a/doc/man/gnunet-namestore.1 +++ b/doc/man/gnunet-namestore.1 | |||
@@ -20,52 +20,72 @@ Desired operation is adding a record | |||
20 | Use the configuration file FILENAME. | 20 | Use the configuration file FILENAME. |
21 | .B | 21 | .B |
22 | .IP "\-d, \-\-delete" | 22 | .IP "\-d, \-\-delete" |
23 | Desired operation is deleting records under the given name that match the specified type (\-t) and value (\-V). If type or value are not specified, it means that all types (or values) should be assumed to match (and possibly multiple or all values under the given label will be deleted). Specifying a label (\-n) is mandatory. Note that matching by expiration time or flags is (currently) not supported. | 23 | Desired operation is deleting records under the given name that match |
24 | the specified type (\-t) and value (\-V). If type or value are not | ||
25 | specified, it means that all types (or values) should be assumed to | ||
26 | match (and possibly multiple or all values under the given label will | ||
27 | be deleted). Specifying a label (\-n) is mandatory. Note that | ||
28 | matching by expiration time or flags is (currently) not supported. | ||
24 | .B | 29 | .B |
25 | .IP "\-D, \-\-display" | 30 | .IP "\-D, \-\-display" |
26 | Desired operation is listing of matching records | 31 | Desired operation is listing of matching records |
27 | .B | 32 | .B |
28 | .IP "\-e TIME, \-\-expiration=TIME" | 33 | .IP "\-e TIME, \-\-expiration=TIME" |
29 | Specifies expiration time of record to add; format is relative time, i.e "1 h" or "7 d 30 m". Supported units are "ms", "s", "min" or "minutes", "h" (hours), "d" (days) and "a" (years). | 34 | Specifies expiration time of record to add; format is relative time, |
35 | i.e "1 h" or "7 d 30 m". Supported units are "ms", "s", "min" or | ||
36 | "minutes", "h" (hours), "d" (days) and "a" (years). | ||
30 | .B | 37 | .B |
31 | .IP "\-h, \-\-help" | 38 | .IP "\-h, \-\-help" |
32 | Print short help on options. | 39 | Print short help on options. |
33 | .B | 40 | .B |
34 | .IP "\-i NICKNAME, \-\-nick=NICKNAME" | 41 | .IP "\-i NICKNAME, \-\-nick=NICKNAME" |
35 | Set the desired NICKNAME for the zone. The nickname will be included in all (public) records and used as the suggested name for this zone. | 42 | Set the desired NICKNAME for the zone. The nickname will be included |
43 | in all (public) records and used as the suggested name for this zone. | ||
36 | .B | 44 | .B |
37 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 45 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
38 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 46 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and |
47 | ERROR. | ||
39 | .B | 48 | .B |
40 | .IP "\-m, \-\-monitor" | 49 | .IP "\-m, \-\-monitor" |
41 | Monitor changes to the zone on an ongoing basis (in contrast to \-D, which merely displays the current records) | 50 | Monitor changes to the zone on an ongoing basis (in contrast to \-D, |
51 | which merely displays the current records) | ||
42 | .B | 52 | .B |
43 | .IP "\-n NAME, \-\-name=NAME" | 53 | .IP "\-n NAME, \-\-name=NAME" |
44 | Label or name of the record to add/delete/display | 54 | Label or name of the record to add/delete/display |
45 | .B | 55 | .B |
46 | .IP "\-p, \-\-public" | 56 | .IP "\-p, \-\-public" |
47 | Create a record that is public (shared with other users that know the label) | 57 | Create a record that is public (shared with other users that know the |
58 | label) | ||
48 | .B | 59 | .B |
49 | .IP "\-r PKEY, \-\-reverse=PKEY" | 60 | .IP "\-r PKEY, \-\-reverse=PKEY" |
50 | Determine our GNS name for the given public key (reverse lookup of the PKEY) in the given zone. | 61 | Determine our GNS name for the given public key (reverse lookup of the |
62 | PKEY) in the given zone. | ||
51 | .B | 63 | .B |
52 | .IP "\-s, \-\-shadow" | 64 | .IP "\-s, \-\-shadow" |
53 | 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. | 65 | Create a record that is a shadow record. Shadow records are only used |
66 | once all other records of the same type under the same label have | ||
67 | expired. | ||
54 | .B | 68 | .B |
55 | .IP "\-t TYPE, \-\-type=TYPE" | 69 | .IP "\-t TYPE, \-\-type=TYPE" |
56 | Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.) | 70 | Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", |
71 | "PKEY", "MX" etc.) | ||
57 | .B | 72 | .B |
58 | .IP "\-u URI, \-\-uri=URI" | 73 | .IP "\-u URI, \-\-uri=URI" |
59 | Add PKEY record from gnunet://gns/-URI to our zone; the record type is always PKEY, if no expiration is given FOREVER is used | 74 | Add PKEY record from gnunet://gns/-URI to our zone; the record type is |
75 | always PKEY, if no expiration is given FOREVER is used | ||
60 | .B | 76 | .B |
61 | .IP "\-v, \-\-version" | 77 | .IP "\-v, \-\-version" |
62 | Print GNUnet version number. | 78 | Print GNUnet version number. |
63 | .B | 79 | .B |
64 | .IP "\-V VALUE, \-\-value=VALUE" | 80 | .IP "\-V VALUE, \-\-value=VALUE" |
65 | Value to store or remove from the GNS zone. Specific format depends on the record type. A records expect a dotted decimal IPv4 address, AAAA records an IPv6 address, PKEY a public key in GNUnet's printable format, and CNAME and NS records should be a domain name. | 81 | Value to store or remove from the GNS zone. Specific format depends |
82 | on the record type. A records expect a dotted decimal IPv4 address, | ||
83 | AAAA records an IPv6 address, PKEY a public key in GNUnet's printable | ||
84 | format, and CNAME and NS records should be a domain name. | ||
66 | .B | 85 | .B |
67 | .IP "\-z EGO, \-\-zone=EGO" | 86 | .IP "\-z EGO, \-\-zone=EGO" |
68 | Specifies the name of the ego controlling the private key for the zone (mandatory option) | 87 | Specifies the name of the ego controlling the private key for the zone |
88 | (mandatory option) | ||
69 | 89 | ||
70 | 90 | ||
71 | .SH BUGS | 91 | .SH BUGS |