shishi_keys_to_file(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_keys_to_file — the shishi manual, page 3 ✨

okay bestie, sit down, hydrate, and let's talk about shishi_keys_to_file(3) 🫶 this one lives in the shishi manual section 3, and it's literally the "write ur keys somewhere" function. no cap.

🌸 SYNOPSIS 🌸

#include <shishi.h>

int shishi_keys_to_file(Shishi * handle, const char * filename,
       Shishi_keys * keys);

that's it. that's the whole vibe. three little args and a dream 💅

🎀 ARGUMENTS 🎀

  • Shishi * handle — the shishi handle, and it has to be one that was allocated by shishi_init(). like, it's giving "you gotta have a handle first" energy, bestie.
  • const char * filename — the filename to append the key to. yes, append. we'll get to that 👀
  • Shishi_keys * keys — the set of keys to print. the whole lil squad of keys, not just one.

🦋 DESCRIPTION 🦋

so basically: this function prints an ASCII representation of a key structure to a file — and it does that for each key in the key set. every single one. no skipping. we love a thorough queen ✨

and here's the important part, the one you cannot miss: the file is appended to if it exists. it does not overwrite. it does not start fresh. it adds. so if you run this twice, congrats, you now have double the keys in there. periodt.

wanna know what the output actually looks like? go check shishi_key_print() — that's the format reference, iykyk. this function is basically that, but landed in a file 🎀

⭐ RETURN VALUE ⭐

returns SHISHI_OK iff successful. and yes, "iff" means if and only if — so anything that isn't SHISHI_OK means it did not go successfully. read the room 😭

💀 REPORTING BUGS 💀

found a bug? don't be shy, tell the devs, they wanna know 🫶

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. (yes bestie, that's the whole permission slip, keep it attached, it's iconic)

🌈 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 ✨educated✨

and that's the page!! this was shishi_keys_to_file(3) from shishi version 1.0.3 — mwah, take care of ur keys, bye bestie 🎀💖

📦 where this page comes from