KUTIL_OPENLOG(3)

✨ KUTIL_OPENLOG(3) ✨

okay so bestie, this one is from the Library Functions Manual (that's the manual name, keep it in your notes 📓) and it's all about libkcgi — the library literally called “libkcgi”. let's get into it 💅

---

🌸 NAME 🌸

kutil_openlog — configure log message sink 🫶

🎀 LIBRARY 🎀

library “libkcgi” ✨

🦋 SYNOPSIS 🦋

#include <sys/types.h>
#include <stdarg.h>
#include <stdint.h>
#include <kcgi.h>

int
kutil_openlog(const char *file);

💖 DESCRIPTION 💖

so the kutil_openlog() function configures output for the kutil_log(3) family of functions. like, it sets up where your logs go, no cap 🎯

by default, these functions log to stderr and inherit the initial output buffering behaviour (see setvbuf(3)). default vibes = stderr, standard buffering, nothing fancy.

if file is not NULL, kutil_openlog() first redirects stderr to file. then, regardless of whether file is NULL, the output buffering of the stream is set to line buffered. so either way you get line buffering — periodt 💅

CGI scripts invoking long-running child processes via fork(2) should use this function with a valid file as the web server might wait for all file descriptors to close before closing the request connection. 👀 like, this is the main character use case, fr fr.

🔥 RETURN VALUES 🔥

the kutil_openlog() function returns zero on failure (system error) and non-zero on success. ✨

if kutil_openlog() fails to re-open stderr, the output stream may no longer be operable: the caller should exit. 😭 like, that's not a suggestion, bestie.

👑 AUTHORS 👑

the kutil_openlog() function was written by Kristaps Dzonsons <kristaps@bsd.lv>. 🫶

🌈 CAVEATS 🌈

in most situations, file is configured in the default log directory, which is not writable to the CGI process. thus, file must be pre-created and be writable to the CGI process. otherwise, kutil_openlog() will fail to create the file and exit with failure. 💀

so yeah — pre-create that file and make sure the CGI process can write to it, or it's game over. 🙈

---

and that's the whole page, bestie! 🎀 this one's from Debian, version $Mdocdate$, and it's the KUTIL_OPENLOG(3) page — slay, go configure those logs 💜✨