doc/man/gnunet-namestore.1

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