diff options
Diffstat (limited to 'doc/man/gnunet-namestore.1')
-rw-r--r-- | doc/man/gnunet-namestore.1 | 232 |
1 files changed, 133 insertions, 99 deletions
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1 index 6a824cc47..6a399c360 100644 --- a/doc/man/gnunet-namestore.1 +++ b/doc/man/gnunet-namestore.1 | |||
@@ -1,104 +1,138 @@ | |||
1 | .TH GNUNET\-NAMESTORE 1 "April 15, 2014" "GNUnet" | 1 | .\" This file is part of GNUnet. |
2 | 2 | .\" Copyright (C) 2001-2019 GNUnet e.V. | |
3 | .SH NAME | 3 | .\" |
4 | gnunet\-namestore \- manipulate GNU Name System (GNS) zone data | 4 | .\" Permission is granted to copy, distribute and/or modify this document |
5 | 5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or | |
6 | .SH SYNOPSIS | 6 | .\" any later version published by the Free Software Foundation; with no |
7 | .B gnunet\-namestore | 7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A |
8 | .RI [ options ] -z ZONEFILE | 8 | .\" copy of the license is included in the file |
9 | .br | 9 | .\" ``FDL-1.3''. |
10 | 10 | .\" | |
11 | .SH DESCRIPTION | 11 | .\" A copy of the license is also available from the Free Software |
12 | \fBgnunet\-namestore\fP can be used to manipulate records in a GNS zone. | 12 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}. |
13 | 13 | .\" | |
14 | .SH OPTIONS | 14 | .\" Alternately, this document is also available under the General |
15 | .IP "\-a, \-\-add" | 15 | .\" Public License, version 3 or later, as published by the Free Software |
16 | Desired operation is adding a record | 16 | .\" Foundation. A copy of the license is included in the file |
17 | .IP "\-c FILENAME, \-\-config=FILENAME" | 17 | .\" ``GPL3''. |
18 | .\" | ||
19 | .\" A copy of the license is also available from the Free Software | ||
20 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}. | ||
21 | .\" | ||
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
23 | .\" | ||
24 | .Dd April 15, 2014 | ||
25 | .Dt GNUNET-NAMESTORE 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-namestore | ||
29 | .Nd | ||
30 | manipulate GNU Name System (GNS) zone data | ||
31 | .Sh SYNOPSIS | ||
32 | .Nm | ||
33 | .Op Fl a | \-add | ||
34 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
35 | .Op Fl d | \-delete | ||
36 | .Op Fl D | \-display | ||
37 | .Op Fl e Ar TIME | Fl \-expiration= Ns Ar TIME | ||
38 | .Op Fl h | \-help | ||
39 | .Op Fl i Ar NICKNAME | Fl \-nick= Ns Ar NICKNAME | ||
40 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | ||
41 | .Op Fl m | \-monitor | ||
42 | .Op Fl n Ar NAME | Fl \-name= Ns Ar NAME | ||
43 | .Op Fl p | \-public | ||
44 | .Op Fl r Ar PKEY | Fl \-reverse= Ns Ar PKEY | ||
45 | .Op Fl R Ar RECORDLINE | Fl \-replace= Ns Ar RECORDLINE | ||
46 | .Op Fl s | \-shadow | ||
47 | .Op Fl t Ar TYPE | Fl \-type= Ns Ar TYPE | ||
48 | .Op Fl u Ar URI | Fl \-uri= Ns Ar URI | ||
49 | .Op Fl v | \-version | ||
50 | .Op Fl V Ar VALUE | Fl \-value= Ns Ar VALUE | ||
51 | .Op Fl z Ar EGO | Fl \-zone= Ns Ar EGO | ||
52 | .Sh DESCRIPTION | ||
53 | .Nm | ||
54 | can be used to manipulate records in a GNS zone. | ||
55 | .Pp | ||
56 | The options are as follows: | ||
57 | .Bl -tag -width Ds | ||
58 | .It Fl a | \-add | ||
59 | Desired operation is adding a record. | ||
60 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
18 | Use the configuration file FILENAME. | 61 | Use the configuration file FILENAME. |
19 | .IP "\-d, \-\-delete" | 62 | .It Fl d | \-delete |
20 | Desired operation is deleting records under the given name that match | 63 | Desired operation is deleting records under the given name that match the specified type (\-t) and value (\-V). |
21 | the specified type (\-t) and value (\-V). If type or value are not | 64 | 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). |
22 | specified, it means that all types (or values) should be assumed to | 65 | Specifying a label (\-n) is mandatory. |
23 | match (and possibly multiple or all values under the given label will | 66 | Note that matching by expiration time or flags is (currently) not supported. |
24 | be deleted). Specifying a label (\-n) is mandatory. Note that | 67 | .It Fl D | \-display |
25 | matching by expiration time or flags is (currently) not supported. | 68 | Desired operation is listing of matching records. |
26 | .IP "\-D, \-\-display" | 69 | .It Fl e Ar TIME | Fl \-expiration= Ns Ar TIME |
27 | Desired operation is listing of matching records | 70 | Specifies expiration time of record to add; format is relative time, i.e "1 h" or "7 d 30 m". |
28 | .IP "\-e TIME, \-\-expiration=TIME" | 71 | Supported units are "ms", "s", "min" or "minutes", "h" (hours), "d" (days) and "a" (years). |
29 | Specifies expiration time of record to add; format is relative time, | 72 | .It Fl h | \-help |
30 | i.e "1 h" or "7 d 30 m". Supported units are "ms", "s", "min" or | ||
31 | "minutes", "h" (hours), "d" (days) and "a" (years). | ||
32 | .IP "\-h, \-\-help" | ||
33 | Print short help on options. | 73 | Print short help on options. |
34 | .IP "\-i NICKNAME, \-\-nick=NICKNAME" | 74 | .It Fl i Ar NICKNAME | Fl \-nick= Ns Ar NICKNAME |
35 | Set the desired NICKNAME for the zone. The nickname will be included | 75 | Set the desired NICKNAME for the zone. |
36 | in all (public) records and used as the suggested name for this zone. | 76 | The nickname will be included in all (public) records and used as the suggested name for this zone. |
37 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 77 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
38 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and | 78 | Use LOGLEVEL for logging. |
39 | ERROR. | 79 | Valid values are DEBUG, INFO, WARNING and ERROR. |
40 | .IP "\-m, \-\-monitor" | 80 | .It Fl m | \-monitor |
41 | Monitor changes to the zone on an ongoing basis (in contrast to \-D, | 81 | Monitor changes to the zone on an ongoing basis (in contrast to \-D, which merely displays the current records). |
42 | which merely displays the current records) | 82 | .It Fl n Ar NAME | Fl \-name= Ns Ar NAME |
43 | .IP "\-n NAME, \-\-name=NAME" | 83 | Label or name of the record to add/delete/display. |
44 | Label or name of the record to add/delete/display | 84 | .It Fl p | \-public |
45 | .IP "\-p, \-\-public" | 85 | Create a record that is public (shared with other users that know the label). |
46 | Create a record that is public (shared with other users that know the | 86 | .It Fl r Ar PKEY | Fl \-reverse= Ns Ar PKEY |
47 | label) | 87 | Determine our GNS name for the given public key (reverse lookup of the PKEY) in the given zone. |
48 | .IP "\-r PKEY, \-\-reverse=PKEY" | 88 | .It Fl R Ar RECORDLINE | Fl \-replace= Ns Ar RECORDLINE |
49 | Determine our GNS name for the given public key (reverse lookup of the | 89 | Sets record set to values given in RECORDLINE. |
50 | PKEY) in the given zone. | 90 | This option can be specified multiple times to provide multiple records for the record set. |
51 | .IP "\-R RECORDLINE, \-\-replace=RECORDLINE" | 91 | Existing records under the same label will be deleted. |
52 | Sets record set to values given in RECORDLINE. This option can be specified multiple | 92 | 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". |
53 | times to provide multiple records for the record set. Existing records under the | 93 | The VALUE follows the usual human-readable value format(s) of DNS/GNS. |
54 | same label will be deleted. The format for the RECORDLINE is | 94 | .It Fl s | \-shadow |
55 | "TTL TYPE FLAGS VALUE" where TTL is the time to live in seconds (unit must not | 95 | Create a record that is a shadow record. |
56 | be given explicitly, seconds is always implied), TYPE is the | 96 | Shadow records are only used once all other records of the same type under the same label have expired. |
57 | DNS/GNS record type, FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC". The VALUE | 97 | .It Fl t Ar TYPE | Fl \-type= Ns Ar TYPE |
58 | follows the usual human-readable value format(s) of DNS/GNS. | 98 | Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.). |
59 | .IP "\-s, \-\-shadow" | 99 | .It Fl u Ar URI | Fl \-uri= Ns Ar URI |
60 | Create a record that is a shadow record. Shadow records are only used | 100 | Add PKEY record from gnunet://gns/-URI to our zone; the record type is always PKEY, if no expiration is given FOREVER is used |
61 | once all other records of the same type under the same label have | 101 | .It Fl v | \-version |
62 | expired. | ||
63 | .IP "\-t TYPE, \-\-type=TYPE" | ||
64 | Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", | ||
65 | "PKEY", "MX" etc.) | ||
66 | .IP "\-u URI, \-\-uri=URI" | ||
67 | Add PKEY record from gnunet://gns/-URI to our zone; the record type is | ||
68 | always PKEY, if no expiration is given FOREVER is used | ||
69 | .IP "\-v, \-\-version" | ||
70 | Print GNUnet version number. | 102 | Print GNUnet version number. |
71 | .IP "\-V VALUE, \-\-value=VALUE" | 103 | .It Fl V Ar VALUE | Fl \-value= Ns Ar VALUE |
72 | Value to store or remove from the GNS zone. Specific format depends | 104 | Value to store or remove from the GNS zone. |
73 | on the record type. A records expect a dotted decimal IPv4 address, | 105 | Specific format depends on the record type. |
74 | AAAA records an IPv6 address, PKEY a public key in GNUnet's printable | 106 | 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. |
75 | format, and CNAME and NS records should be a domain name. | 107 | .It Fl z Ar EGO | Fl \-zone= Ns Ar EGO |
76 | .IP "\-z EGO, \-\-zone=EGO" | 108 | Specifies the name of the ego controlling the private key for the zone (mandatory option). |
77 | Specifies the name of the ego controlling the private key for the zone | 109 | .El |
78 | (mandatory option) | 110 | .\".Sh EXAMPLES |
79 | 111 | .\".Sh FILES | |
80 | 112 | .Sh SEE ALSO | |
81 | .SH BUGS | 113 | .Xr gnunet-gns 1 , |
82 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 114 | .Xr gnunet-namestore-gtk 1 |
83 | electronic mail to <gnunet\-developers@gnu.org> | 115 | .sp |
84 | .SH SEE ALSO | 116 | The full documentation for gnunet is maintained as a Texinfo manual. |
85 | \fBgnunet\-gns\fP(1), \fBgnunet\-namestore\-gtk\fP(1) | 117 | If the |
86 | The full documentation for | 118 | .Xr info 1 |
87 | .B gnunet | 119 | and gnunet programs are properly installed at your site, the command |
88 | is maintained as a Texinfo manual. If the | 120 | .Pp |
89 | .B info | 121 | .Dl info gnunet |
90 | and | 122 | .Pp |
91 | .B gnunet | ||
92 | programs are properly installed at your site, the command | ||
93 | .IP | ||
94 | .B info gnunet | ||
95 | .PP | ||
96 | should give you access to the complete handbook, | 123 | should give you access to the complete handbook, |
97 | .IP | 124 | .Pp |
98 | .B info gnunet-c-tutorial | 125 | .Dl info gnunet-c-tutorial |
99 | .PP | 126 | .Pp |
100 | will give you access to a tutorial for developers. | 127 | will give you access to a tutorial for developers. |
101 | .PP | 128 | .sp |
102 | Depending on your installation, this information is also | 129 | Depending on your installation, this information is also available in |
103 | available in | 130 | .Xr gnunet 7 and |
104 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 131 | .Xr gnunet-c-tutorial 7 . |
132 | .\".Sh HISTORY | ||
133 | .\".Sh AUTHORS | ||
134 | .Sh BUGS | ||
135 | Report bugs by using | ||
136 | .Lk https://bugs.gnunet.org | ||
137 | or by sending electronic mail to | ||
138 | .Aq Mt gnunet-developers@gnu.org . | ||