sttk_intro(3)

✨ sttk_intro(3) — bestie's guide to the ShapeTools Toolkit Library ✨

okay so sttk_intro is literally the front door to the ShapeTools Toolkit Library, from the ShapeTools Toolkit Library manual, section 3 (library functions, iykyk). pull up a chair, we're doing a tour 🫶

🌸 SYNOPSIS 🌸

#include <config.h>
#include <sttk.h>

char* stVersion (void);

that's the whole vibe up top. the details? below, bestie. 👇

💖 DESCRIPTION 💖

The ShapeTools Toolkit library — going by sttk in the group chat — is a whole set of functions that get used all over the place inside the ShapeTools configuration management toolkit. it's giving shared infrastructure, it's giving "everybody's borrowing your charger". 🔌

little note from the source: you can skip the #include <config.h> if atfs.h is already included. no cap.

And stVersion? she returns a version identification string for the ShapeTools Toolkit library. that's it, that's the function. iconic. 👑

👑 LIST OF FUNCTIONS AND VARIABLES 👑

every single one, fr fr, no skips. the middle column is the page where the full tea lives. 💅

• stAbortThis — sttransaction.3 — abort transaction
• stAskConfirm — stuserio.3 — ask user for confirmation
• stCallCmd — stcall.3 — call command
• stCallCmdErrno — stcall.3 — error code returned by command (variable)
• stCallEditor — stcall.3 — call editor with default contents
• stCatchSigs — stsignal.3 — catch signals
• stCleanup — stsignal.3 — do cleanup (remove temporary files etc.)
• stConvertPattern — ststring.3 — convert sh(1) pattern to regex pattern
• stExit — stsignal.3 — stop program execution
• stFindProgram — stcall.3 — check if file exists and is executable
• stGetFromStdin — stuserio.3 — read text from standard input
• stGetTermWidth — stuserio.3 — get current terminal width in columns
• stInterruptAction — stsignal.3 — address of signal handler for SIGINT (variable)
• stLog — stuserio.3 — print message
• stMessage — stuserio.3 — buffer for constructing messages (variable)
• stMktime — sttime.3 — parse time string
• stParseArgs — stparseargs.3 — parse command line arguments
• stProgramName — stuserio.3 — name how program was called
• stQuietFlag — stuserio.3 — suppress normal messages (no error messages) (variable)
• stQuitAction — stsignal.3 — address of signal handler for SIGQUIT (variable)
• stRegisterFile — sttmpfiles.3 — register file
• stRmRegisteredFiles — sttmpfiles.3 — remove all registered files
• stShortUsage — stparseargs.3 — print usage string
• stShutupFlag — stuserio.3 — suppress all messages (variable)
• stStrEnter — ststring.3 — enter string to string table
• stStrtok — ststring.3 — tokenize string
• stSubstituteString — ststring.3 — replace parts of a string by new string
• stTermAction — stsignal.3 — address of signal handler for SIGTERM (variable)
• stThisTransaction — sttransaction.3 — current transaction (variable)
• stTmpFile — sttmpfiles.3 — return unique name for temporary file
• stUnRegisterFile — sttmpfiles.3 — unregister file
• stVersion — sttkintro.3 — print version identification string
• stWriteTime — sttime.3 — generate time string

🦋 SEE ALSO 🦋

• Andreas Lampen and Axel Mahler (Eds.)
• ShapeTools, Technical Report No. 92-14, Technische Universität Berlin, May 1992

and that's the whole page, bestie, you ate it 🍓✨

signing off from the sttk-1.7 era, dated Thu Jun 24 17:43:28 1993 — yeah she's vintage, she's a classic, she's serving archive-core and we're obsessed 💜🎀