shisa_cfg(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

✨ shisa_cfg — the shishi library's lil config bestie ✨

okay so bestie, you're reading the manual page for shisa_cfg, which lives in the shishi manual, section 3. it's an API function. it's giving "let me set up your Shisa library real quick." let's go 💅

🌸 NAME 🌸

shisa_cfg — API function. that's it, that's the name. short, sweet, iconic 👑

🦋 SYNOPSIS 🦋

#include <shisa.h>

int shisa_cfg(Shisa * dbh, const char * option);

like... she's simple. two args. no drama. no cap.

🎀 ARGUMENTS 🎀

  • Shisa * dbh — the Shisa library handle. and where does that come from? you guessed it, it's created by shisa(). so make one of those first, bestie, don't come in here empty-handed 🙈
  • const char * option — a string stuffed with options to prime the Shisa library. this is the one that does the talking 💬

✨ DESCRIPTION ✨

so what she actually does: she configures the Shisa library from the specification in option. the way this works is, option has to be a string declaration shaped like either:

"db=VALUE"

or like:

"db VALUE"

and VALUE? it's the exact same declaration that shisa_cfg_db() takes. which means it's shaped like:

"TYPE[ LOCATION[ PARAMETER]]"

okay and here's the little detail that matters: the prefix "db" is mandatory in option. why tho? because that mandatory "db" is what makes shisa_cfg() suited to a syntax that uses key-value pairs in PARAMETER too. iykyk 🧚

⭐ RETURN VALUE ⭐

she returns SHISA_OK if option is valid. that's the vibe check passing. periodt 💖

💀 REPORTING BUGS 💀

found a bug? don't suffer in silence, tell the people. report bugs to bug-shishi@gnu.org.

Copyright © 2002-2022 Simon Josefsson.

and the license tea, fr fr: 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. slay, no royalties, just vibes 🫶

🌈 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, then this command:

info shishi

should give you access to the complete manual. go read the whole thing, it's giving main character energy 📖

and that's the whole page, bestie!! this one came from shishi version 1.0.3, and yeah, it's the shisa_cfg(3) page in all her glory. now go configure something cute and stay hydrated 🍓💜

📦 where this page comes from