atfstk_intro(3)

💖 atfstk_intro — AtFS Toolkit Library 💖

okay bestie, sit DOWN because this is the intro page for AtFStk, aka the AtFS (Attribute Filesystem) Toolkit Library, and it's the manual page atfstk_intro(3). this is your little map to the whole toolkit, so buckle up 🎀

✨ NAME ✨

AtFSTK — introduction to the AtFS (Attribute Filesystem) Toolkit Library 🦋

✨ SYNOPSIS ✨

#include <atfs.h>
#include <atfstk.h>

char* atVersion (void);

void atError (int code; char *msg);
int atErrno;
char *atErrMsg;

int atBindError;
char atBindErrorMsg[];

✨ DESCRIPTION ✨

so, the AtFS Toolkit library (that's AtFStk, for the girlies keeping track 💅) is a whole library of functions built on top of the Attribute Filesystem (AtFS). its whole purpose? making it easier to actually build AtFS application programs. it's giving "we did the hard part so you don't have to" ✨

atVersion — returns a version identification string for the AtFS Toolkit library. you want to know what you're working with? boom, there it is. 💖

atError — assigns the given error code and the error message msg to the global variables atErrno and atErrMsg. heads up though, this is the important bit: the given error message string (msg) is not copied. atError just assigns its address to atErrMsg. so it's on you, the application, to care about the persistence of the message buffer assigned to atErrMsg. don't be out here letting your buffer vanish into the void, bestie 😭

atBindError — a flag that says something went wrong while a function from the version binding subsystem was running (go peek at atbind(3) and atbindrule(3) for that whole saga). when atBindError is set TRUE, atBindErrorMsg holds an explaining error message. the tea ☕: the atBindError flag gets cleared upon successful calls, but the message buffer stays unchanged. so the flag resets, the message is like "i'm still here 💀"

✨ LIST OF FUNCTIONS AND VARIABLES ✨

here's the whole squad, with the page each one lives on and what they do 👑

• atAttrName — atattribute.3 — return name part of attribute
• atAttrValue — atattribute.3 — return value part of attribute
• atBindAddRule — atbindrule.3 — add version binding rule to internal database
• atBindCache — atbind.3 — perform version binding on object cache
• atBindDelRule — atbindrule.3 — delete version binding rule from internal database
• atBindDisplayErrors — atbindrule.3 — report errors while parsing version binding rules (variable)
• atBindError — atfstkintro.3 — Version binding error flag (variable)
• atBindErrorMsg — atfstkintro.3 — Version binding error message (variable)
• atBindExpandMacro — atbind.3 — external function for macro expansion (variable)
• atBindListRules — atbindrule.3 — list names of all known version binding rules
• atBindModeOption — atbind.3 — version binding mode (variable)
• atBindNoMsg — atbind.3 — suppress output from version binding rules (variable)
• atBindOptions — atbind.3 — parse version binding options from command line
• atBindRuleFile — atbindrule.3 — evaluate file containing version binding rules
• atBindSet — atbind.3 — perform nonunique version binding
• atBindSetArgv — atbind.3 — perprocess command line with version binding
• atBindShowRules — atbindrule.3 — dump internal database of version binding rules
• atBindTestRule — atbindrule.3 — test existence of version binding rule
• atBindTrace — atbind.3 — trace version binding (variable)
• atBindUsage — atbind.3 — print usage for version binding options
• atBindVersion — atbind.3 — perform unique version binding
• atCacheKey — atcache.3 — return unique key attribute
• atDelVersAlias — atversion.3 — delete version alias name
• atErrno — atfstkintro.3 — AtFStk error code (variable)
• atError — atfstkintro.3 — set AtFStk error code and message
• atErrMsg — atfstkintro.3 — AtFStk error message (variable)
• atExpand — atexpand.3 — switch attribute expansion on/off (variable)
• atExpandAttrs — atexpand.3 — expand attribue citations in string
• atFileClassExt — atclass.3 — return file class symbol
• atFreeAttr — atattribute.3 — recycle memory of attribute string
• atGen — atversion.3 — get generation number from compact representation
• atIsDerived — atclass.3 — check if object is from a derived object cache
• atLocalPath — atnetwork.3 — map network path to local path
• atMatchAttr — atattribute.3 — check if attribute value matches given pattern
• atNetworkPath — atnetwork.3 — generate network wide path
• atRev — atversion.3 — get revision number from compact representation
• atRetAttr — atattribute.3 — return attribute value
• atSaveCache — atcache.3 — save object to derived object cache and attach key
• atScanBinding — atbind.3 — scan version bind directive
• atScanStatus — atprint.3 — scan status string
• atScanUser — atuser.3 — scan user name
• atSetAttr — atattribute.3 — set or modify attribute
• atSetAttrFile — atattribute.3 — set or modify attributes with input from file
• atSetComment — atlog.3 — set description, intent or log text
• atSetVersAlias — atversion.3 — set version alias name
• atUnlock — atlog.3 — unlock attributed software object
• atUserName — atuser.3 — get user name from user name
• atUserUid — atuser.3 — get user id from user structure
• atUserValid — atuser.3 — test if user structure is valid
• atVersion — atfstkintro.3 — return AtFStk version identification string
• atVno — atversion.3 — generate compact version number representation
• atWriteDate — atprint.3 — generate string representation of date attribute
• atWriteMode — atprint.3 — generate string representation of mode attribute
• atWriteName — atprint.3 — write name and path attribute
• atWriteStatus — atprint.3 — generate string representation of status attribute

✨ SEE ALSO ✨

• afintro(3)

go read that one too, it's the sibling page 🫶

✨ AUTHOR ✨

Andreas.Lampen@cs.tu-berlin.de — legend behavior honestly 👑

and that's the whole page, bestie!! 🌈 this gorgeous thing is from AtFStk-1.12, dated Fri Jun 25 16:39:27 1993, which is giving vintage icon energy fr fr 🕰️✨ you're welcome, go slay your AtFS app 💖🎀🦋