GNUNET-NAMESTORE(1)

πŸ“¦
version 0.27.0 Β· 3 versions
, in alpine 3.24, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0

πŸ’… gnunet-namestore β€” manipulate GNU Name System (GNS) zone data

okay so first things first: this is a page from the General Commands Manual, and it's all about gnunet-namestore, bestie. she manipulates GNS zone data and she does it well. let's get into it πŸŽ€


✨ SYNOPSIS ✨

gnunet-namestore [-a | --add] [-c FILENAME | --config=FILENAME]
                 [-d | --delete] [-D | --display]
                 [-e TIME | --expiration=TIME] [-h | --help]
                 [-i NICKNAME | --nick=NICKNAME]
                 [-L LOGLEVEL | --loglevel=LOGLEVEL] [-m | --monitor]
                 [-n NAME | --name=NAME] [-O | --list-orphans]
                 [-o | --omit-private] [-P | --purge-orphans]
                 [-p | --public] [-s | --shadow] [-S | --from-stdin]
                 [-T | --include-maintenance] [-t TYPE | --type=TYPE]
                 [-u URI | --uri=URI] [-v | --version]
                 [-V VALUE | --value=VALUE] [-X | --purge-zone-records]
                 [-B | --batch-size] [-z EGO | --zone=EGO]
                 [-Z KEY | --zone-to-name=KEY]

no cap, that's a lot of brackets. but honestly? every single one is pulling its weight 🫢


🌸 DESCRIPTION 🌸

gnunet-namestore is literally your little zone-manipulation bestie β€” you use it to work with records in a GNS zone.

the options are as follows (yes, all of them, we're doing this πŸ’…):

  • -a, --add β€” the desired operation is adding a record. slay.
  • -c FILENAME, --config=FILENAME β€” use the configuration file FILENAME. that's it, that's the vibe.
  • -d, --delete β€” the desired operation is deleting records under the given name that match the specified type (-t) and value (-V).
okay so heads up: if type or value are not specified, it means all types (or all values) should be assumed to match β€” and possibly multiple or all values under the given label will get deleted. 😭 so like, be careful.

Specifying a label (-n) is mandatory. also, matching by expiration time or flags is (currently) not supported. periodt.

  • -D, --display β€” the desired operation is listing of matching records. the chill option fr fr.
  • -e TIME, --expiration=TIME β€” specifies the expiration time of the record to add. the format is relative time, i.e. "1 h" or "7 d 30 m". supported units are "ms", "s", "min" or "minutes", "h" (hours), "d" (days) and "a" (years). iconic unit lineup honestly πŸ¦‹
  • -h, --help β€” print short help on options. your safe space.
  • -i NICKNAME, --nick=NICKNAME β€” set the desired NICKNAME for the zone. the nickname will be included in all (public) records and used as the suggested name for this zone. main character energy for real πŸ‘‘
  • -L LOGLEVEL, --loglevel=LOGLEVEL β€” use LOGLEVEL for logging. valid values are DEBUG, INFO, WARNING and ERROR. pick your fighter.
  • -m, --monitor β€” monitor changes to the zone on an ongoing basis. this is in contrast to -D, which merely displays the current records. like, -D is a screenshot and -m is a livestream πŸ“Ή
  • -n NAME, --name=NAME β€” label or name of the record to add/delete/display.
  • -O, --list-orphans β€” list orphaned records. them poor little guys πŸ₯Ί
  • -o, --omit-private β€” filter private records. use in combination with --display.
  • -P, --purge-orphans β€” delete orphaned records from namestore. bye bestie πŸ’€
  • -p, --public β€” create a record that is public (shared with other users that know the label).
  • -r, --recordline β€” changes the output format of zones and records to recordline.
  • -s, --shadow β€” create a record that is a shadow record. shadow records are only used once all other records of the same type under the same label have expired. she waits her turn, quietly, in the wings 🧚
  • -S, --from-stdin β€” read recordlines from stdin until EOF is encountered. the format uses: a record in a recordline follows the format
NAME.EGO:
 TYPE EXPIRATION [FLAGS] VALUE
 ...  Multiple records may be provided for a name.

EXPIRATION is given in microseconds without a unit (e.g. 3600000000 for 3600 seconds).

FLAGS is a concatenation of record flags. possible values for flags and their meaning are:

  • p: Public
  • s: Shadow
  • S: Supplemental
  • C: Critical
  • r: Relative expiration

TYPE and VALUE are used in the same way as for the "-t" and "-V" options. example formats for recordlines can be output using the "-D" flag combined with --recordline. an example record set in recordline format can be found in the examples. it is possible to specify multiple record sets. can only be used in combination with "-a" to add the parsed record sets. existing record sets under names will be replaced β€” so like, no merge, it's a full glow-up swap πŸ”₯

  • -T, --include-maintenance β€” show maintenance records such as TOMBSTONEs. use in combination with --display. spooky but necessary ⭐
  • -t TYPE, --type=TYPE β€” type of the record to add/delete/display ("A"; "AAAA"; "NS"; "PKEY"; "MX"; etc.). etc. really out here carrying the whole list 😭
  • -u URI, --uri=URI β€” add PKEY record from gnunet://gns/-URI to our zone; the record type is always PKEY, and if no expiration is given FOREVER is used. forever forever? forever forever. πŸ’–
  • -v, --version β€” print GNUnet version number.
  • -V VALUE, --value=VALUE β€” value to store or remove from the GNS zone. the specific format depends on the record type: 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. so like, read the room and match the format, bestie πŸ¦‹
  • -X, --purge-zone-records β€” delete all records in a zone. nuclear option. she ate and left no crumbs πŸ’€
  • -B, --batch-size β€” number of records to buffer and send in a batch to the service. for use with --from-stdin.
  • -z EGO, --zone=EGO β€” specifies 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. lowkey a flex ngl ✨
  • -Z KEY, --zone-to-name=KEY β€” determine our GNS name for the given public key (reverse lookup of the KEY) in the given zone. detective mode πŸ”

πŸŽ€ EXAMPLES πŸŽ€

gnunet-namestore -z example -a -n www -t A -V "1.2.3.4" -e 1d -p

Add a public record for ego example with name www containing an IP address.

gnunet-namestore -z example -D

Show all records for ego example.

gnunet-namestore -z example -D -r

Show all records for ego example in recordline format.

gnunet-namestore --add --from-stdin <<EOF
 www.alice:
  A 3600000000 [pr] 1.2.3.4
  TXT 3600000001 [pr] Hello World

 www.bob:
  A 12345679000000 [pr] 4.3.2.1
EOF

Read record sets in recordline format from stdin.


🌈 SEE ALSO 🌈

gnunet-gns(1), gnunet-namestore-gtk(1)

the full documentation for GNUnet is maintained as a Texinfo manual. if the info(1) and gnunet programs are properly installed at your site, the command

info gnunet

should give you access to the complete handbook,

info gnunet-c-tutorial

will give you access to a tutorial for developers.

depending on your installation, this information is also available in gnunet(7) and gnunet-c-tutorial(7). iykyk 🫢


πŸ™ˆ BUGS πŸ™ˆ

report bugs by using https://bugs.gnunet.org or by sending electronic mail to ⟨gnunet-developers@gnu.org⟩. they're lovely, they'll listen πŸ’œ


and that's the whole page, bestie ✨ this one's from the Debian edition of the manual, dated April 15, 2014, filed under GNUNET-NAMESTORE(1). go forth and manipulate those zones πŸ’…πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from