YAPET_CONFIG(5)

🌸 NAME 🌸

yapet_config — bestie, this is the format of a YAPET configuration file 💖 like, the whole layout of the lil text file that tells yapet(1) how to act.

---

✨ DESCRIPTION ✨

okay so first thing: yapet(1) reads the config file $HOME/.yapet — but ONLY if it exists 👀 — unless you point it at a different file with the -r option, go peek at yapet(1) for that. and here's the tea: options you put on the command line override options you put in a configuration file. command line wins, always, no cap. 💅

the configuration file has this syntax, literally just:

option=value

and option can be any of these cuties ⬇️

• colors — (String) set custom colors. 🎨 see yapet_colors(5) for more info, it's giving whole other manpage energy.
• load — (String) the file to load when yapet starts up. same thing as handing it a filename when you invoke yapet. and bestie, a ~ (tilde) as the very first character of the pathname? it gets swapped out for the home directory of whoever's running yapet. 🏠 Default: not set
• locktimeout — (Integer) a positive integer, the seconds of inactivity before the screen locks itself. equivalent to passing the -t option when you invoke yapet. 😴🔒 Default: 600
• pwinputtimeout — (Integer) a positive integer, the seconds of inactivity before the password prompt for unlocking the screen just… vanishes. poof. 🫥 Default: 60
• allowlockquit — (Boolean) true lets the user quit yapet from the locked screen (as long as there's no changes pending). false blocks the user from quitting yapet while the screen is locked. 🚪 Default: true
• checkfsecurity — (Boolean) true turns on verification of the file owner and permissions when loading a file. false turns it off. equivalent to passing the -S option (same as true) or -s (same as false) when invoking yapet. 🕵️ Default: true
• pwgen_pwlen — (Integer) a positive integer greater than zero, the default password length the Password Generator Dialog uses. 🔢 Default: 15
• pwgen_letters — (Boolean) true preselects the Letters check box in the Password Generator Dialog. 🔤 Default: true
• pwgen_digits — (Boolean) true preselects the Digits check box in the Password Generator Dialog. 🔢 Default: true
• pwgen_punct — (Boolean) true preselects the Punctuation check box in the Password Generator Dialog. ❗ Default: true
• pwgen_special — (Boolean) true preselects the Special check box in the Password Generator Dialog. ✨ Default: true
• pwgen_other — (Boolean) true preselects the Other check box in the Password Generator Dialog. 🎁 Default: false
• argon2_memory — (Integer) memory used by the Argon2 hash algorithm, in KB. 🧠 Default: 262144
• argon2_parallelism — (Integer) number of threads used by the Argon2 hash algorithm. 🧵 Default: 16
• argon2_iterations — (Integer) number of iterations performed by the Argon2 hash algorithm. 🔁 Default: 5

so for Boolean values, bestie, these all mean true: 1, yes, true, enable, and enabled. and these all mean false: 0, false, no, disable, disabled. ⚠️ and pls pls pls note: Boolean values are case-sensitive. so True is NOT it. 💀

also, the argon2_* options only do anything when you're creating a new file or changing the master password of an existing file. like, they literally only take effect then. 👑

---

🦋 EXAMPLES 🦋

💖 Example of an yapet configuration file

load=/home/joe/passwords
locktimeout=300
checkfsecurity=0
pwgen_pwlen=8

so in this example, the file /home/joe/passwords gets loaded the moment you invoke yapet. the timeout until the screen locks is set to 300 seconds. and file permissions will not be verified. 🙈

the Password Generator Dialog will have preset the Password Length to 8 characters. cute. 🎀

🌸 Example of an yapet configuration file

locktimeout=150
checkfsecurity=yes
pwgen_other=enable

in this one, no file gets automatically loaded when you invoke yapet. the timeout until the screen locks is set to 150 seconds. file permissions and owner will be verified. ✅

the Password Generator Dialog will have preset the Other check box checked. ☑️

⭐ Example 1 revisited

load=~/passwords.pet
locktimeout=300
checkfsecurity=false
pwgen_pwlen=8

this example has the exact same effect as Example of an yapet configuration file. but instead of writing out the full path to the home directory, the ~ (tilde) sign is used, and it gets expanded to the home directory automatically. ✨ and the .pet suffix can be specified — but if you omit it, it'll be appended automatically. iykyk. 🦋

---

👑 FILES 👑

• $HOME/.yapet — the per-user configuration file. if it exists, options are read from this file, but they can be overridden by the command line options. 🫶 and you can disable processing of this file entirely by invoking yapet with the -i option. periodt.

---

💜 AUTHORS 💜

Rafael Ostertag rafi@guengel.ch. 💅

---

🌈 SEE ALSO 🌈

yapet(1), yapet_colors(5)

---

okay bestie that's literally the whole thing, go configure ur lil heart out 💖 this was YAPET 2.6, dated 2022-03-12, and it's the YAPET_CONFIG(5) page — slay, stay safe, and don't forget those Booleans are case-sensitive fr fr 😭✨🎀