shishi_init_server_with_paths(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_server_with_paths — the NAME section, bestie

okay so like, this is a page from the shishi manual (section 3, the library-call girlies), and it's all about shishi_init_server_with_paths. It's an API function. That's the whole name. Short, sweet, iconic. 💅

✨ SYNOPSIS ✨

like, the whole vibe in one code block:

#include <shishi.h>

int shishi_init_server_with_paths(Shishi ** handle, const char * systemcfgfile);

🎀 ARGUMENTS 🎀

  • Shishi ** handle — a pointer to a Shishi handle, and this call is the one that creates it. She's the main character here. 👑
  • const char * systemcfgfile — the filename of the system configuration, or NULL if you're feeling mysterious and don't wanna specify one. 🙈

🌸 DESCRIPTION 🌸

So the way this works: it creates a Shishi library handle — using shishi_server(), bestie, no cap — and then it reads the system configuration file from the location you specified. The path to that system configuration file? That's not your call, it's decided at compile time, and it is $sysconfdir/shishi.conf. iykyk. ✨

Now here's the part you need to internalize: the handle gets allocated regardless of the return value. Like, no matter what happens, she exists. The single exception to that is SHISHI_HANDLE_ERROR, which is the one that means there was a problem allocating the handle itself. Other error conditions could pop up while reading the file, so stay alert. 👀

not me just casually dropping the most important caveat in the middle of the paragraph. anyway. the handle is allocated regardless of return value. remember it. periodt.

⭐ RETURN VALUE ⭐

Returns SHISHI_OK iff it was successful. That's it, that's the whole section. Slay. 💖

🦋 REPORTING BUGS 🦋

Found a bug? (Rude of the software, honestly.) Report it 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.

🫶 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 ✨ thorough ✨.

okay bestie that's the whole page, mwah 💜 this was shishi version 1.0.3, page shishi_init_server_with_paths(3) — thanks for reading, ily, go allocate a handle 🎀✨

📦 where this page comes from