PS_HYPHENATE(3)

🌸 NAME 🌸

PS_hyphenate — hyphenates a word. 💅 This page is PS_HYPHENATE(3) from the Library Functions Manual, and it's lowkey iconic for a tiny function. Hiiii bestie, let's get into it. ✨

✨ SYNOPSIS ✨

#include <pslib.h>

int PS_hyphenate(PSDoc *psdoc, const char *text, char **hyphens)

🦋 DESCRIPTION 🦋

Okay so PS_hyphenate() takes the word you hand it and figures out where it can be broken with hyphens. The text you pass should not contain any non alpha characters — like, letters only, bestie. No non-alpha characters crashing the vibe. 🙈

The possible positions for breaks are returned in hyphens. So that's where you go looking for the "break it here" spots. 💖

This function requires the locale category LC_CTYPE to be set propperly. (Yes, "propperly" — that's the original spelling, and we're keeping it, no cap. 📝) PS_boot() usually does it by using the enviroment variables. (Another original spelling: "enviroment." We keep. 💀)

PS_hyphenate() evaluates the value 'hyphenminchars' and the parameter hyphendict. hyphendict must be set before calling this function. So set that up first, okay? It's giving prerequisite, periodt. 👑

🎀 RETURN VALUE 🎀

• -1 — returned in case of an error. Sad girl hours. 😭
• 0 — returned otherwise. Slay. ✨

🌈 SEE ALSO 🌈

• PS_boot(3)
• PS_show_boxed(3)
• locale(1)

💜 AUTHOR 💜

This manual page was written by Uwe Steinmann <uwe@steinmann.cx>. Give them their flowers, bestie. 💐

That's the whole page — PS_HYPHENATE(3) from the Library Functions Manual. The footer didn't have a date/version stamp, just the page name again, so this is your cute sign-off. 🫶💖