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