PIUS-KEYRING-MGR(1)

💖 pius-keyring-mgr — the NAME bit 💖

okay so bestie, meet pius-keyring-mgr — the PIUS (PGP Individual UID Signer) Keyring Manager 🎀. That's the whole name, no cap. It's a General Commands Manual page, section 1, and it's here to help you wrangle keyrings like the main character you are 👑.

🦋 SYNOPSIS 🦋

pius-keyring-mgr <mode> [options]

✨ DESCRIPTION ✨

so pius-keyring-mgr has several modes for managing keyrings 💅. It was originally designed for signing parties, but honestly? It works on any PGP keyring. It's giving versatile.

The one rule: the mode must be the first argument — like, first, bestie, before anything else — and then the options come after, as explained below ⬇️.

💅 OPTIONS 💅

• -d, --debug — turns on debugging output 🔍 so you can see what's actually going on.
• -g PATH, --gpg-path=PATH — where your gpg binary lives 🧚. [default: /usr/bin/gpg2]
• -r KEYRING, --keyring=KEYRING — use this keyring, this one right here 💖.
• -v, --verbose — prints summaries 📝. Yes, it's chatty, we love that for it.

🌈 MODES 🌈

🛠️ build

build mode is the one you'll use pretty much all the time. It can parse a CSV file 📄, automatically go looking for keys 🔎, and email anyone whose key wasn't found 📧. It can also import keys from an mbox file. The options are:

• -b MBOX-FILE, --mbox-file=MBOX-FILE — parses MBOX-FILE and checks every single message for PGP fingerprints or ascii-armored keys 🔑. It decodes messages as needed.
• -c CSV-FILE, --csv-file=CSV-FILE — parses MBOX-FILE and imports keys. (yes bestie, it really says MBOX-FILE right there 🙈 — I'm just the messenger, I don't make the rules.) You will almost certainly also want -D, -E, -F and -N 💅.
• -D DELIMITER, --delimiter=DELIMITER — the field delimiter to use when parsing CSV. Only meaningful with -c. [default: ',']
• -E EMAIL-COLUMN, --email-field=EMAIL-COLUMN — which column number holds the email address in the CSV file 📧. Only meaningful with -c. [default: 3]
• -F FINGERPRINT-COLUMN, --fp-field=FINGERPRINT-COLUMN — which column number holds the GPG fingerprint in the CSV file 🔑. Only meaningful with -c. [default: 4]
• -m FROM-EMAIL, --mail=FROM-EMAIL — emails the people whose keys were not located, using FROM-EMAIL as the sender 📨.
• -M FILE, --mail-text=FILE — uses the text in FILE as the body of the email instead of the default text ✍️. Wanna see the default text? Use --print-default-email. Requires -m.
• -N NAME-COLUMN, --name-field=NAME-COLUMN — which column number holds the name in the CSV file 🏷️. Only meaningful with -c. [default: 2]
• -n TO-EMAIL, --override-email=TO-EMAIL — instead of sending to the actual user, send to this address 👀. Mostly useful for debugging.
• -p PARTY-NAME, --party=PARTY-NAME — the name of the party 🎉. It gets printed in the email that goes out. Only useful with -m.
• -s KEY-SERVER, --keyservers=KEY-SERVER — try this keyserver 🌐. Specify it once for each server you want (-s foo -s bar). [default: pool.sks-keyservers.net, pgp.mit.edu, keys.gnupg.net]
• -t TEMP-DIR, --tmp-dir=TEMP-DIR — the directory to dump temporary stuff in 📁. [default: /tmp/pius_keyring_mgr_tmp]
• -T, --print-default-email — prints the default email 📬.
• --ignore-emails=IGNORE-EMAILS — a comma-separated list of emails to ignore (no spaces!) 🚫.
• --ignore-fingerprints=IGNORE-FINGERPRINTS — a comma-separated list of PGP fingerprints to ignore (again, no spaces) 🙅.

✂️ prune

prune mode opens a keyring and, for each key, asks you whether to remove it 🗑️. Super useful after a party to trim out the people who didn't show up, before you hand the keyring out to the people who did ✨. There are no options. That's it. Simple. Iconic.

🧪 raw

raw mode passes options directly to gpg 🫶. Great for adding keys by hand. Your options get added to the ones needed to safely work on the party keyring — and nope, it does not load your personal keyring 🚫. Your options must be passed after -- so that pius-keyring-manager doesn't try to interpret them as its own 🙈.

🌸 EXAMPLES 🌸

Scan a CSV file and an MBOX for emails, then write to anyone whose key wasn't found, using you@company.com as the sender:

/usr/bin/pius-keyring-mgr build --csv-file /tmp/report --mbox-file /tmp/mbox --mail you@company.com

Download a key and add it to the party keyring:

pius-keyring-mgr raw -r path/to/keyring.gpg -- --recv-key <keyid>

👑 AUTHOR 👑

PIUS was written by Phil Dibowitz <phil@ipom.com> 💜.

This manual page was written by Felix Lechner <felix.lechner@gmail.com> for the Debian project, but may be used by others 🫶. (Sharing is caring, bestie.)

okay that's the whole page!! 🎀✨ this was PIUS-KEYRING-MGR(1) from the General Commands Manual, and the page itself is dated DECEMBER 2016 📅. go forth and manage those keyrings, you absolute legend 👑💖 periodt.