shishi_init(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_init ✨

okay bestie, welcome to shishi_init — section 3 of the shishi manual, and yes it's literally the very first thing you call, the main character of getting set up 💖

🌸 SYNOPSIS 🌸

#include <shishi.h>

int shishi_init(Shishi ** handle);

🎀 ARGUMENTS 🎀

  • Shishi ** handle — a pointer to a Shishi handle, and like… this call is the one that makes it. You're handing it a spot, it fills the spot. So iconic of it 🫶

💅 DESCRIPTION 💅

So here's the tea: shishi_init creates a Shishi library handle (it uses shishi() to do it), and then it goes and reads your system configuration file, your user configuration file, and your user tickets from their default locations. Slay. No arguments needed, it just knows where to look 😌

Where exactly? Okay so:

  • the path to the system configuration file is decided at compile time, and it's $sysconfdir/shishi.conf
  • the user configuration file lives at $HOME/.shishi/config
  • the user ticket file lives at $HOME/.shishi/ticket
okay this next bit is important, bestie, don't scroll past it 👀

The handle is allocated regardless of return value. Yep, even if stuff goes sideways. The single exception is SHISHI_HANDLE_ERROR, which means there was a problem allocating the handle itself. Other error conditions could arise while reading files, and that's just how it is, no cap.

⭐ RETURN VALUE ⭐

Returns SHISHI_OK iff successful. That's the vibe check. Anything else, something happened 💀

🙈 REPORTING BUGS 🙈

Found a bug? Tell the people! Report bugs to <bug-shishi@gnu.org>.

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. (that's the whole thing, verbatim, we don't mess with legal text 💜)

🦋 SEE ALSO 🦋

The full documentation for shishi is maintained as a Texinfo manual. If the info and shishi programs are properly installed at your site, the command

info shishi

should give you access to the complete manual. go read it, it's giving encyclopedia but make it kerberos ✨

shishi version 1.0.3, page shishi_init(3) — mwah, that's the whole page, ily, go init some handles 💖🌸🦋💅

📦 where this page comes from