shishi_cfg_default_userfile(3)

📦
version 1.0.3 · 2 versions
  • 1.0.3 · debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 1.0.2 · ubuntu jammy
, in debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 shishi_cfg_default_userfile — the shishi manual, section 3 💖

okay bestie, sit down, hydrate, because we're about to talk about a function that tells you where your config file lives. it's giving "small but mighty" and honestly? obsessed. 🎀

✨ NAME ✨

shishi_cfg_default_userfile — it's an API function, bestie. that's the whole name. no cap.

🌸 SYNOPSIS 🌸

#include <shishi.h>

const char * shishi_cfg_default_userfile(Shishi * handle);

look at that signature. clean. iconic. she returns a const char * and she takes exactly one thing. periodt. 💅

🦋 ARGUMENTS 🦋

  • Shishi * handle — the Shishi library handle, and you gotta make it with shishi_init(), okay? that's where she comes from. no handle, no vibes. 🙈

🌈 DESCRIPTION 🌈

so like, what does she actually do? she reports the absolute filename of the default user configuration file. absolute, meaning the whole entire path, not some vague little relative thing. she's not being mysterious, she's being precise. 💜

typically it's this:

"$HOME/.shishi/shishi.conf"

and here's the tea 🍓: if you've set $SHISHI_HOME, that will change the directory part of it. exactly as stated regarding shishi_cfg_default_userdirectory(). so like, go read that one too if you want the full lore. iykyk.

⭐ RETURN VALUE ⭐

she returns the user's configuration filename. that's it. that's the gift. 🫶

💀 REPORTING BUGS 💀

found a bug? not me manifesting one, but if you did, report it to <bug-shishi@gnu.org>. like actually, tell them, don't just tweet about it. 😭

Copyright © 2002-2022 Simon Josefsson.

Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved.

(translation: you can copy and share this file, modified or not, in any medium, no royalty needed — just keep the copyright notice and this notice. that's the whole deal. slay.) ✨

🔥 SEE ALSO 🔥

the full documentation for shishi is maintained as a Texinfo manual. so if the info and shishi programs are properly installed at your site, this command:

info shishi

should give you access to the complete manual. go forth and read, main character. 📚

lowkey reminder: every detail here is load-bearing, bestie. don't skip the $SHISHI_HOME bit. 💅

and that's the page!! this was shishi version 1.0.3, dated with all the love, and the page you just read is shishi_cfg_default_userfile(3). mwah. take care of your config files, they're doing their best. 💖🦋🌸

📦 where this page comes from