aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-06-14 18:44:16 +0000
committerng0 <ng0@n0.is>2019-06-14 18:44:16 +0000
commit434da3e05f7e7574da4e364a841349de19c5dde8 (patch)
tree2136edb4ed0df594b2b720316ea7320c1ff6d7f4 /doc
parentcebb6b31b858945b1ef091fac50774012cff986e (diff)
downloadgnunet-434da3e05f7e7574da4e364a841349de19c5dde8.tar.gz
gnunet-434da3e05f7e7574da4e364a841349de19c5dde8.zip
gnunet-namestore.1: line-length fix, ignore mdoc linter according to what previous commits established
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-namestore.154
1 files changed, 39 insertions, 15 deletions
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1
index 0fbb6a480..e53bb7d95 100644
--- a/doc/man/gnunet-namestore.1
+++ b/doc/man/gnunet-namestore.1
@@ -60,52 +60,76 @@ Desired operation is adding a record.
60.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME 60.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
61Use the configuration file FILENAME. 61Use the configuration file FILENAME.
62.It Fl d | -delete 62.It Fl d | -delete
63Desired operation is deleting records under the given name that match the specified type (\-t) and value (\-V). 63Desired operation is deleting records under the given name that match
64If 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). 64the specified type (\-t) and value (\-V).
65If type or value are not specified, it means that all types (or
66values) should be assumed to match (and possibly multiple or all
67values under the given label will be deleted).
65Specifying a label (\-n) is mandatory. 68Specifying a label (\-n) is mandatory.
66Note that matching by expiration time or flags is (currently) not supported. 69Note that matching by expiration time or flags is (currently) not
70supported.
67.It Fl D | -display 71.It Fl D | -display
68Desired operation is listing of matching records. 72Desired operation is listing of matching records.
69.It Fl e Ar TIME | Fl -expiration= Ns Ar TIME 73.It Fl e Ar TIME | Fl -expiration= Ns Ar TIME
70Specifies expiration time of record to add; format is relative time, i.e "1 h" or "7 d 30 m". 74Specifies expiration time of record to add; format is relative time,
71Supported units are "ms", "s", "min" or "minutes", "h" (hours), "d" (days) and "a" (years). 75i.e "1 h" or "7 d 30 m".
76Supported units are "ms", "s", "min" or "minutes", "h" (hours), "d"
77(days) and "a" (years).
72.It Fl h | -help 78.It Fl h | -help
73Print short help on options. 79Print short help on options.
74.It Fl i Ar NICKNAME | Fl -nick= Ns Ar NICKNAME 80.It Fl i Ar NICKNAME | Fl -nick= Ns Ar NICKNAME
75Set the desired NICKNAME for the zone. 81Set the desired NICKNAME for the zone.
76The nickname will be included in all (public) records and used as the suggested name for this zone. 82The nickname will be included in all (public) records and used as the
83suggested name for this zone.
77.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL 84.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
78Use LOGLEVEL for logging. 85Use LOGLEVEL for logging.
79Valid values are DEBUG, INFO, WARNING and ERROR. 86Valid values are DEBUG, INFO, WARNING and ERROR.
80.It Fl m | -monitor 87.It Fl m | -monitor
81Monitor changes to the zone on an ongoing basis (in contrast to \-D, which merely displays the current records). 88Monitor changes to the zone on an ongoing basis (in contrast to \-D,
89which merely displays the current records).
82.It Fl n Ar NAME | Fl -name= Ns Ar NAME 90.It Fl n Ar NAME | Fl -name= Ns Ar NAME
83Label or name of the record to add/delete/display. 91Label or name of the record to add/delete/display.
84.It Fl p | -public 92.It Fl p | -public
85Create a record that is public (shared with other users that know the label). 93Create a record that is public (shared with other users that know the
94label).
86.It Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY 95.It Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY
87Determine our GNS name for the given public key (reverse lookup of the PKEY) in the given zone. 96Determine our GNS name for the given public key (reverse lookup of the
97PKEY) in the given zone.
88.It Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE 98.It Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE
89Sets record set to values given in RECORDLINE. 99Sets record set to values given in RECORDLINE.
90This option can be specified multiple times to provide multiple records for the record set. 100This option can be specified multiple times to provide multiple
101records for the record set.
91Existing records under the same label will be deleted. 102Existing records under the same label will be deleted.
92The 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". 103The format for the RECORDLINE is "TTL TYPE FLAGS VALUE" where TTL is
104the time to live in seconds (unit must not be given explicitly,
105seconds is always implied), TYPE is the DNS/GNS record type,
106FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC".
93The VALUE follows the usual human-readable value format(s) of DNS/GNS. 107The VALUE follows the usual human-readable value format(s) of DNS/GNS.
94.It Fl s | -shadow 108.It Fl s | -shadow
95Create a record that is a shadow record. 109Create a record that is a shadow record.
96Shadow records are only used once all other records of the same type under the same label have expired. 110Shadow records are only used once all other records of the same type
111under the same label have expired.
97.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE 112.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
98Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.). 113Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.).
99.It Fl u Ar URI | Fl -uri= Ns Ar URI 114.It Fl u Ar URI | Fl -uri= Ns Ar URI
100Add PKEY record from gnunet://gns/-URI to our zone; the record type is always PKEY, if no expiration is given FOREVER is used 115Add PKEY record from gnunet://gns/-URI to our zone; the record type is
116always PKEY, if no expiration is given FOREVER is used
101.It Fl v | -version 117.It Fl v | -version
102Print GNUnet version number. 118Print GNUnet version number.
103.It Fl V Ar VALUE | Fl -value= Ns Ar VALUE 119.It Fl V Ar VALUE | Fl -value= Ns Ar VALUE
104Value to store or remove from the GNS zone. 120Value to store or remove from the GNS zone.
105Specific format depends on the record type. 121Specific format depends on the record type.
106A 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. 122A records expect a dotted decimal IPv4 address, AAAA records an IPv6
123address, PKEY a public key in GNUnet's printable format, and CNAME and
124NS records should be a domain name.
107.It Fl z Ar EGO | Fl -zone= Ns Ar EGO 125.It Fl z Ar EGO | Fl -zone= Ns Ar EGO
108Specifies the name of the ego controlling the private key for the zone. If not provided, we will attempt to use the default identity set for the "namestore". Alternatively, a private key may be passed in Base32-encoding using the GNUNET_NAMESTORE_EGO_PRIVATE_KEY environment variable. The latter is useful to improve performance of tools like Ascension as it allows the command to skip IPC with the identity management subsystem. 126Specifies the name of the ego controlling the private key for the
127zone. If not provided, we will attempt to use the default identity set
128for the "namestore". Alternatively, a private key may be passed in
129Base32-encoding using the GNUNET_NAMESTORE_EGO_PRIVATE_KEY environment
130variable. The latter is useful to improve performance of tools like
131Ascension as it allows the command to skip IPC with the identity
132management subsystem.
109.El 133.El
110.\".Sh EXAMPLES 134.\".Sh EXAMPLES
111.\".Sh FILES 135.\".Sh FILES