KEYBOXD(1)

🎀 KEYBOXD(1) · User Commands 🎀

✨ NAME ✨

okay so the name is keyboxd - Public key management for GnuPG 🔑💖

🧚 SYNOPSIS 🧚

keyboxd [OPTIONS] [COMMAND]

🌸 DESCRIPTION 🌸

bestie, keyboxd is a public key management service for GnuPG. it handles your public keys so the rest of GnuPG doesn't have to 💅✨

👑 COMMANDS 👑

ngl, commands and options are basically the same thing here. the only real rule is that you can only pass one command at a time 🙈

• --version — prints the program version and licensing info 📜
• --help — prints a usage message with the most useful command-line options 💁‍♀️
• --server — runs in server mode and waits for commands on stdin. by default it'd create a socket and listen there instead. this one is only for testing 🧪
• --daemon — runs as a background daemon and listens for commands on a socket. this is how the other GnuPG components start keyboxd on demand 🦋 if you want to force it to start yourself, the best move is gpgconf --launch keyboxd
• --supervised — runs in the foreground, sends logs to stderr, and listens on file descriptor 3, which has to already be bound to a listening socket 🫶 super useful under systemd or other process supervision setups. not supported on Windows 😭

💜 OPTIONS 💜

not gonna lie, all long options (except --options and --homedir) can also go in the configuration file, you just drop the two leading dashes 🌈

• --options file — reads config from file instead of the default per-user config file. that default is named keyboxd.conf and lives in the home directory 📁
• --homedir dir — sets the home directory to dir. this only works when you pass it on the command line 🙅‍♀️ by default it's the .gnupg directory right under your user's home directory, unless the GNUPGHOME environment variable is set, in which case that value wins. tons of data gets stored in here 💾
• -v, --verbose — prints extra info while things are running 🔍 want even more? stack them, like -vv 📈
• --log-file file — appends all logging output to file. this is seriously helpful for seeing what the agent is actually doing 👀 use socket:// to log to a socket instead
• --debug-level level — picks the debug level for hunting down problems 🐛 level can be a number or a keyword:
  • none — no debugging at all. any value under 1 works instead of the keyword 🙈
  • basic — some basic debug messages. any value from 1 to 2 works instead ✨
  • advanced — more verbose debug messages. any value from 3 to 5 works instead 🔥
  • expert — even more detailed messages. any value from 6 to 8 works instead 🤓
  • guru — literally every debug message you can get 💀 any value greater than 8 works instead. hash tracing files are only created if you use the keyword, not the number

how these levels map to the actual debugging flags isn't specified, and it may change in newer releases. they're carefully picked to help with debugging though, so vibes are good 🫶

• --debug flags — sets debugging flags. this is only useful for debugging, and its behavior may change with a new release, so be careful 🚧 all flags are or-ed together and can be written as C syntax (like 0x0042) or as a comma-separated list of flag names. to see every supported flag, just pass the single word help 🔎
• --debug-all — same as --debug=0xffffffff 💥

📁 FILES 📁

keyboxd uses a configuration file to control how it runs 🎀 by default, all of these live in the current home directory (see: --homedir).

• keyboxd.conf — the standard config file keyboxd reads on startup 💖 it can hold any valid long option. you have to leave off the leading two dashes, and you can't abbreviate the option names. this file also gets re-read after a SIGHUP, but not every option will actually take effect then 😬 this default name can be changed on the command line (see: --options). back this file up 💾
• pubring.db — a database in SQLite format that holds the public key material 🗝️ back this file up too 💾

🐛 BUGS 🐛

found a bug? report it to <https://dev.gnupg.org> 🙏

⚖️ COPYRIGHT ⚖️

Copyright © 2022 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>

this is free software, so you're free to change and redistribute it. there is NO WARRANTY, to the extent permitted by law 🌈

this manpage was generated by NIIBE Yutaka for the Debian distribution (but others may use it too), using the manpage of dirmngr ✨

that's all, bestie!! kbxutil (GnuPG) 2.4.1, March 2022 🦋💅