ONAK(1)

πŸ’– ONAK(1) πŸ’–

ok so bestie, welcome to onak β€” an OpenPGP compatible keyserver. it lives in the General Commands Manual (section 1, obviously) and it's literally here to hold everybody's PGP keys for you. no cap.


✨ SYNOPSIS ✨

onak [ options ] command [ parameters ]

like, you give it some options, you tell it which command you want, and sometimes you hand it parameters too. that's the whole vibe.


🌸 DESCRIPTION 🌸

bestie. it does various keyserver actions. that's it, that's the description. it's giving mysterious, it's giving minimal, and honestly? we respect it.

πŸŽ€ Options

these are the lil flags that change how onak behaves. learn them, love them.

  • -b β€” treat the keys coming in on stdin as binary instead of ASCII armoured. so if it's raw bytes and not cute -----BEGIN PGP... text, this is your girl.
  • -c _FILE_ β€” use _FILE_ as the config file instead of the default one. your config, your rules, periodt.
  • -f β€” display fingerprints when listing keys. so you can see exactly whose key is whose, iykyk.
  • -u β€” update keys, and output the changes on stdout. changes go bye-bye to stdout, not into the void.
  • -v β€” verbose! crank that loglevel up. stack it if you want, the more the louder. πŸ”₯

πŸ¦‹ Commands

the main character options, fr fr. pick one.

  • add β€” read OpenPGP keys from stdin and add them to the keyserver database. welcome to the party, keys. 🫢
  • clean β€” read OpenPGP keys from stdin, run the key cleaning routines against them, and dump the result to stdout. glow-up in, glow-up out. ✨
  • dumpconfig β€” dump the running config in the new .ini format to stdout, or to the file you provided. it's literally here to help you migrate from the old style configuration files β€” onak can read and parse the old style file, and this command will output the equivalent new style configuration. the way that it's just doing your homework for you πŸ’…
  • delete β€” delete a given key from the keyserver. bye bestie, we won't miss you 😭
  • dump β€” dump all the keys from the keyserver. every single one. no survivors.
  • get β€” retrieves the requested key from the keyserver.
  • getphoto β€” retrieves the first photoid on the requested key and dumps it to stdout. yeah, keys have selfies. iconic behavior honestly. πŸ“Έ
  • index β€” search for a key and list it.
  • vindex β€” search for a key and list it and its signatures. extra detail, extra slay.

🌈 EXAMPLES 🌈

ok here's how you actually use it, bestie:

onak index noodles

list all keys in the keyserver that contain the word noodles. yes really. go find noodles. 🍜

onak clean < dirty.key > clean.key

clean up one or more PGP keys. currently this will just dedupe UIDs β€” that's the whole glow-up, don't expect more.

gpg --export | onak -b add

export all keys on your gnupg keyring and import them into the keyserver. look at you, migrating like a pro. πŸ‘‘


πŸ“ FILES πŸ“

  • /etc/onak.ini β€” the default configuration file. that's where it lives, that's its home. 🏠

πŸ’€ NOTES πŸ’€

this man page could probably do with some more details.

not me reading that and going 😭 β€” the man page is self-aware. it's honest. it's humble. we love it for that.


πŸ‘‘ AUTHOR πŸ‘‘

onak was written by Jonathan McDowell <noodles@earth.li>. it can be found at http://www.earth.li/projectpurple/progs/onak.html


ok that's the whole page, bestie!! this one's from the General Commands Manual, section 1 β€” that's the <rainbow>ONAK(1)</rainbow> energy right there. go forth and keyserver responsibly. mwah. πŸ’–βœ¨πŸŽ€