shishi(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(3) — the shishi manual, bestie edition 💖

okay so this is the man page for shishi, section 3 (that's the library-functions section, iykyk). It's part of the shishi manual, and we're vibing with version 1.0.3 the whole way through. Let's get into it ✨

🌸 NAME 🌸

shishi — it's an API function, bestie. That's the whole name. Short, iconic, no notes. 💅

🎀 SYNOPSIS 🎀

here's the tea, copy it exactly:

#include <shishi.h>

Shishi * shishi();

yeah that's it. include the header, call the function. slay. 🦋

✨ DESCRIPTION ✨

So what does shishi() actually do? It initializes the Shishi library, and it also primes logging so that any future warnings and informational messages get printed on stderr. Like, it's setting the whole vibe up for you ahead of time. 🫶

And real talk — if this function fails, it may send its own diagnostic errors to stderr too. So it's not gonna ghost you about what went wrong, it'll just tell you. 😭

👑 RETURN VALUE 👑

  • On success it hands you back a Shishi library handle. your little key to everything. 🔑
  • On error it returns NULL. which is the "no handle for you" outcome. 💀

🐛 REPORTING BUGS 🐛

Found a bug? Don't suffer in silence, tell the people:

fr fr, they wanna hear from you.

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. 🎀 (basically: go off, just keep the receipts.)

🌈 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. like, that's the whole entire lore drop. 📚✨

and that's the page, bestie 🫶 this was shishi version 1.0.3, living in section shishi(3). go forth and initialize something. 🌟

📦 where this page comes from