shishi_key_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_key_to_file — the manual page bestie 💖

okay so this is the shishi_key_to_file(3) page from the shishi manual (version 1.0.3, if you're keeping receipts). it's an API function, it's lowkey iconic, and it does exactly one thing: it writes your key out to a file. let's get into it 🫶

🌸 SYNOPSIS 🌸

#include <shishi.h>

int shishi_key_to_file(Shishi * handle, const char * filename,
       Shishi_key * key);

that's it, that's the whole vibe check 💅

🎀 ARGUMENTS 🎀

  • Shishi * handle — the Shishi handle, and it's gotta be one you got from shishi_init(). like, you can't just show up with a random handle, bestie, it has to come from the right place ✨
  • const char * filename — the name of the file, and this is the file the key text gets appended to. appended, not replaced. noted 📝
  • Shishi_key * key — the key you wanna print. that's the whole point, babes 🔑

🦋 DESCRIPTION 🦋

so what it does is: it prints an ASCII representation of a key structure, key, into the file named filename. and the way that it handles an existing file?? it appends the text if the file already exists, it does not overwrite, periodt 💖

if you wanna see what the output text actually looks like, go peek at shishi_key_print() — that one shows you an example 👀

⭐ RETURN VALUE ⭐

it returns SHISHI_OK if everything went great, slay 🎉

if it fails? it's because of I/O issues, or because of allocation. that's it, those are the two culprits. no cap 😭

💀 REPORTING BUGS 💀

found a bug? don't gatekeep it, tell the people 🫶

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 means you can copy it, you just have to keep the notice. iconic behaviour from the licensing tbh 💜)

🌈 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 running this:

info shishi

should give you access to the complete manual. iykyk 📖✨

and that's the page!! mwah 💋 this whole thing lives in the shishi manual, version 1.0.3, and it's the shishi_key_to_file(3) page — go forth and append your keys responsibly, bestie 🎀🦋💖

📦 where this page comes from