doc/man/5,1: in SEE ALSO mention that the main documentation is maintained in texinfo...
[oweals/gnunet.git] / doc / man / gnunet-namestore.1
1 .TH GNUNET\-NAMESTORE 1 "Apr 15, 2014" "GNUnet"
2
3 .SH NAME
4 gnunet\-namestore \- manipulate GNU Name System (GNS) zone data
5
6 .SH SYNOPSIS
7 .B gnunet\-namestore
8 .RI [ options ] -z ZONEFILE
9 .br
10
11 .SH DESCRIPTION
12 \fBgnunet\-namestore\fP can be used to manipulate records in a GNS zone.
13
14 .SH OPTIONS
15 .B
16 .IP "\-a, \-\-add"
17 Desired operation is adding a record
18 .B
19 .IP "\-c FILENAME,  \-\-config=FILENAME"
20 Use the configuration file FILENAME.
21 .B
22 .IP "\-d, \-\-delete"
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.
29 .B
30 .IP "\-D, \-\-display"
31 Desired operation is listing of matching records
32 .B
33 .IP "\-e TIME, \-\-expiration=TIME"
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).
37 .B
38 .IP "\-h, \-\-help"
39 Print short help on options.
40 .B
41 .IP "\-i NICKNAME, \-\-nick=NICKNAME"
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.
44 .B
45 .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
46 Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and
47 ERROR.
48 .B
49 .IP "\-m, \-\-monitor"
50 Monitor changes to the zone on an ongoing basis (in contrast to \-D,
51 which merely displays the current records)
52 .B
53 .IP "\-n NAME, \-\-name=NAME"
54 Label or name of the record to add/delete/display
55 .B
56 .IP "\-p, \-\-public"
57 Create a record that is public (shared with other users that know the
58 label)
59 .B
60 .IP "\-r PKEY, \-\-reverse=PKEY"
61 Determine our GNS name for the given public key (reverse lookup of the
62 PKEY) in the given zone.
63 .B
64 .IP "\-s, \-\-shadow"
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.
68 .B
69 .IP "\-t TYPE, \-\-type=TYPE"
70 Type of the record to add/delete/display (i.e. "A", "AAAA", "NS",
71 "PKEY", "MX" etc.)
72 .B
73 .IP "\-u URI, \-\-uri=URI"
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
76 .B
77 .IP "\-v, \-\-version"
78 Print GNUnet version number.
79 .B
80 .IP "\-V VALUE, \-\-value=VALUE"
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.
85 .B
86 .IP "\-z EGO, \-\-zone=EGO"
87 Specifies the name of the ego controlling the private key for the zone
88 (mandatory option)
89
90
91 .SH BUGS
92 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
93 .SH "SEE ALSO"
94 \fBgnunet\-gns\fP(1), \fBgnunet\-namestore\-gtk\fP(1)
95 The full documentation for
96 .B gnunet
97 is maintained as a Texinfo manual.  If the
98 .B info
99 and
100 .B gnunet
101 programs are properly installed at your site, the command
102 .IP
103 .B info gnunet
104 .PP
105 should give you access to the complete handbook,
106 .IP
107 .B info gnunet-c-tutorial
108 .PP
109 will give you access to a tutorial for developers.
110 .PP
111 Depending on your installation, this information is also
112 available in
113 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).