KWALLETCLI_GETPIN(1)

💖 KWALLETCLI_GETPIN 💖

okay bestie, so this one's from the General Commands Manual section, and it's literally called kwalletcli_getpin — say that three times fast, I dare you. 🎀

---

✨ NAME ✨

kwalletcli_getpin — a command line interface to pinentry, no cap 🫶

---

🌸 SYNOPSIS 🌸

kwalletcli_getpin [-q] [-b | -m | -p prompt] [-E | -e errortext]
                  [-N NoText] [-t desctext] [-Y YesText]

---

🦋 DESCRIPTION 🦋

so kwalletcli_getpin is a lil shell wrapper that talks to pinentry using the Assuan protocol, which is giving very much backstage-pass energy ngl. it asks the user for a passphrase and then prints it to standard output — without any trailing newline, okay, that part matters, don't come for me. 💅

and it's not just passphrases, bestie. there are options for asking a boolean question or just displaying a message. versatile icon behaviour, honestly. 👑

now here's the tea ☕ — if PINENTRY is not empty but points to a non-existing or failing program, then pinentry is not called. instead:

• xmessage(1) gets used for boolean queries and messages, but only if DISPLAY is set
• otherwise kwalletcli_getpin falls back to simple terminal I/O on GPG_TTY, using stty(1) to turn off echo of terminal input for passphrase queries 🔇

The options are as follows:

---

💅 OPTIONS 💅

• -b — ask for a confirmation (boolean) instead of a passphrase. yes/no vibes only. 🍓
• -E — unset a previously set error text. bye bye error text 👋
• -E errtxt — set the error text to errtxt, and it pops a dialogue box with a red X icon indicating that this is a retry question. dramatic? yes. necessary? also yes. 😭
• -m — display a message (one-button query) instead of asking. just a lil announcement, main character energy 📢
• -N NoText — use NoText instead of Cancel for the text of the abort button, if any.
• -p prompt — set the small descriptive text shown in front of the input field (aka “the Prompt”) to prompt. ✍️
• -q — be more quiet. shhh 🤫
• -t desctxt — set the descriptive text (the input challenge) to desctxt.
• -Y YesText — use YesText instead of OK for the text of the confirm button.

All input and output is assumed to be in UTF-8. periodt. 💖

---

🌈 RETURN VALUES 🌈

kwalletcli_getpin exits 0 on success, 1 if the passphrase input was cancelled by the user, or >1 if an error occurred.

Confirmation (boolean) error codes are 0 for Yes, 1 for No, or >1 if an error occurred. Messages return >0 if an error occurred, 0 otherwise.

A summary of the error codes follows:

• 0 — Read password successfully. Boolean question returned Yes/OK. 🎉
• 1 — Boolean question returned No/Cancel. 🙈
• 2 — Wrong command line syntax. bestie what did you type 💀
• 3 — The process reading user input unexpectedly terminated or errored out. 😭
• 4 — Unexpected result reading from pinentry. 🤨
• 5 — Unable to determine controlling tty, caller must set GPG_TTY. 📵
• 6 — Caught SIGHUP, SIGINT, SIGQUIT, SIGTRAP, SIGPIPE, or SIGTERM. 🛑

---

🧚 ENVIRONMENT 🧚

• DISPLAY — If not set, pass current terminal information to pinentry.
• GPG_TERM — Terminal type of the current tty. Defaults to the value of the environment variable TERM, or “vt100” if unset.
• GPG_TTY — The current terminal, determined by tty(1) if unset.
• LC_CTYPE — Passed to pinentry. Default: “en_US.UTF-8”
• LC_MESSAGES — Passed to pinentry. Unset by default.
• PINENTRY — The pinentry program to use. Default: “pinentry”

---

👀 SEE ALSO 👀

gpg-agent(1), kwalletcli(1), pinentry(1), stty(1), tset(1), tty(1)

---

🫶 AUTHORS 🫶

kwalletcli_getpin was written by mirabilos <m@mirbsd.org> mostly for tarent solutions GmbH. iconic collaboration fr fr 💜

---

⚠️ CAVEATS ⚠️

Some newer pinentry features, such as three-button operation or setting the window title, are not supported yet. it's giving "coming soon to a terminal near you", but for now, no. 🙅♀️

---

💀 BUGS 💀

• Some pinentry programs may not support messages correctly and display them as boolean queries instead. messy. 😭
• Some implementations display labels with the wrong charset. 🈚

Neither of these two problems is an issue in kwalletcli_getpin but a bug of the backend implementation. so like… not our fault, bestie, don't @ us. 💅

---

okay and that's the whole page!! 🎀 this version shipped in Debian, dated November 19, 2020 — so when you're reading this in the group chat at 2am, just know it's the real, official, vintage-certified manual page. slay, stay safe, and always set your GPG_TTY. 🦋✨💖