GFS_ACL_TO_ANY_TEXT(3)

✨ GFS_ACL_TO_ANY_TEXT(3) ✨

okay so bestie, welcome to section 3 of the Gfarm manual 💖 this one is gfs_acl_to_any_text, and it's literally the glow-up station where a Gfarm ACL gets turned into cute lil text. no cap.

🌸 NAME 🌸

gfs_acl_to_any_text — convert a Gfarm ACL to text

🎀 SYNOPSIS 🎀

#include <gfarm/gfarm.h>

gfarm_error_t gfs_acl_to_any_text(gfarm_acl_t acl, const char *prefix,
                                  char separator, int options,
                                  char **str_p);

🦋 INPUT ARGUMENTS 🦋

• acl — an ACL structure type. that's the thing getting converted, she's the main character here 👑
• prefix — if the argument prefix is not NULL, then every single entry gets to have this character string. not NULL? boom, prefix for everyone. it's giving matching outfits ✨
• separator — the ACL entries are separated by this separator character. pick your divider, bestie 💅
• options — bitwise combinations of the stuff in the OPTIONS section down below 👇 go crazy
• str_p — a pointer to the long text form string of the ACL. this is where the finished text lands 🫶

💅 OPTIONS 💅

• GFARM_ACL_TEXT_ABBREVIATE — instead of spelling out the full tag type keywords, you get single letter abbreviations. short queen energy, we love efficiency 😌
• GFARM_ACL_TEXT_SOME_EFFECTIVE — drops a comment containing the effective permissions in some ACL entries.
• GFARM_ACL_TEXT_ALL_EFFECTIVE — same vibe but all the ACL entries get that comment containing the effective permissions. everyone eats 🔥
• GFARM_ACL_TEXT_SMART_INDENT — if you use this one together with the GFARM_ACL_TEXT_SOME_EFFECTIVE or GFARM_ACL_TEXT_ALL_EFFECTIVE option, the effective comment gets aligned to column 40. so satisfying, honestly, the alignment is immaculate ✨

🍓 RETURN VALUES 🍓

• GFARM_ERR_NO_ERROR — the function terminated successfully. slay! everything worked 🎉
• GFARM_ERR_NO_MEMORY — insufficient memory was available. girl is starving, there was just not enough memory to go around 😭
• Others — an error except the above occurred. the reason is shown by gfarm_error_string(3). so if you get a mystery error, that's your detective 🕵️

👑 SEE ALSO 👑

• gfs_acl_free(3)
• gfs_acl_to_text(3)
• gfs_acl_from_text(3)

ok that's the whole page fr fr. every flag, every argument, every error code — all accounted for, nothing skipped, periodt 💖

mwah 💋 this page came from the Gfarm crew, dated 14 Feb 2011 — yeah, a Valentine's Day manpage, iconic behavior 🌈