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

okay so real talk, this is page shishi_key(3) from the shishi manual, and it's genuinely one of the cutest little functions you'll ever meet. it makes keys. new keys. baby keys. let's get into it 🎀

✨ NAME ✨

shishi_key — it's an API function, bestie. that's the whole name. short, sweet, iconic.

🌸 SYNOPSIS 🌸

#include <shishi.h>

int shishi_key(Shishi * handle, Shishi_key ** key);

literally two arguments and an int return. it's giving low-maintenance. we love that for us 💅

🦋 ARGUMENTS 🦋

  • Shishi * handle — the Shishi library handle, and no you can't just manifest one out of thin air, it gets created by shishi_init(). that's its whole origin story.
  • Shishi_key ** key — a pointer to the structure that's gonna hold the newly created key information. so you're handing it an empty lil spot and it fills it in. it's like passing your friend a cup at a slushie machine. 🍓

💜 DESCRIPTION 💜

okay so here's the tea: shishi_key creates a brand new Key information structure. that's it. that's the vibe. new key, fresh out the box, no notes. ✨

⭐ RETURN VALUE ⭐

it returns SHISHI_OK iff it's successful. and yes, "iff" means if and only if, so if you get SHISHI_OK back you ATE, and if you didn't… well. 🫶

🙈 REPORTING BUGS 🙈

found a bug? first of all, relatable. second of all, report it to <bug-shishi@gnu.org> — they wanna hear it, fr fr.

no cap, if something's broken just tell them. that's how it gets fixed. 💀

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.

like, go off, copy it, remix it, put it in your zine, it's all good — just keep the copyright notice and this notice with it. that's the deal. 🤝

🌈 SEE ALSO 🌈

the full documentation for shishi lives in a Texinfo manual, main character energy honestly. if info and the shishi programs are properly installed at your site, then running this:

info shishi

should give you access to the complete manual. go read it. it's good for you. 🧚

and that's the whole page, bestie!! this was shishi_key(3) from shishi 1.0.3 — shoutout to the source and version, mwah 💋, go make some keys 💖✨🎀

📦 where this page comes from