XOSD(3)

XOSD(3) — the X on-screen display library 💖

okay so bestie, this is a page from the Library Functions Manual, and it's literally the whole vibe of "hey what if your X display had TV-style pop-up text on it". Buckle up, we're going in 🦋

---

✨ NAME ✨

xosd — X on-screen display library 👑

---

✨ SYNOPSIS ✨

#include <xosd.h>

xosd* xosd_create(int number_lines);

int xosd_uninit (xosd* osd);

int xosd_display (xosd* osd, int line,
                  xosd_command command, ...);

int xosd_is_onscreen(xosd* osd);

int xosd_wait_until_no_display(xosd* osd);

int xosd_hide (xosd* osd);

int xosd_show (xosd* osd);

int xosd_set_pos (xosd* osd, xosd_pos pos);

int xosd_set_vertical_offset (xosd* osd, int offset);

int xosd_set_horizontal_offset (xosd* osd, int offset);

int xosd_set_align (xosd* osd, xosd_align align)

int xosd_set_shadow_offset (xosd* osd, int shadow_offset);

int xosd_set_timeout (xosd* osd, int timeout);

int xosd_set_font (xosd* osd, char* font);

int xosd_set_colour (xosd* osd, char* colour);

int xosd_get_colour (xosd* osd,
                     int* red, int* green, int* blue);

int xosd_scroll (xosd* osd, int lines);

int xosd_get_number_lines (xosd* osd);

int screen_count(xosd *osd);

xosd* xosd_clone(xosd *osd2);

int xosd_monitor(xosd *osd, int monitor);

int xosd_set_shadow_direction(xosd *osd, int shadow_direction);

int display_info();

and yes, xosd_set_align is out here with no semicolon, living its truth. I copied it exactly, no edits, no cap 🙈

---

✨ DESCRIPTION ✨

xosd is a library for displaying an on-screen display (like the one on many TVs) on your X display. it's giving very "channel 3 in 2004" energy and honestly? iconic 💅

each function should have its own manpage. periodt — this one's just the group photo 📸

the latest version can be found on http://www.ignavus.net/software.html 🫶

it is distributed under the GNU General Public License. free software bestie, we love to see it 💖

---

✨ BUGS ✨

no known bugs at the moment 👑 there are probably functions that aren't listed here though (classic, the manpage is lowkey missing a few of its friends 😭).

bug reports can be sent to tnw13@cosc.canterbury.ac.nz 📮

---

✨ EXAMPLE ✨

here's the whole thing in action, no notes, it ate 🔥

#include <xosd.h>

int main (int argc, char *argv[])
{
     xosd *osd;

     osd = xosd_create (1);

     xosd_set_font(osd, "fixed");
     xosd_set_colour(osd, "LawnGreen");
     xosd_set_timeout(osd, 3);
     xosd_set_shadow_offset(osd, 1);

     xosd_display (osd, 0, XOSD_string, "Example XOSD output");

     xosd_wait_until_no_display(osd);

     xosd_uninit (osd);

     return EXIT_SUCCESS;
}

---

✨ AUTHOR ✨

Martijn van de Streek <martijn@foodfight.org>, some patching by Malcolm Valentine <farkit@iprimus.com.au> and Tim Wright <tim@ignavus.net> 🌸

xosd was written by Andre Renaud <andre@ignavus.net> and is maintained by Tim Wright <tim@ignavus.net> 👑

---

✨ SEE ALSO ✨

more information on the X OSD Library and its author can be found on http://www.ignavus.net/software.html 🦋

each function has its own manpage — see there for more information, iykyk 💜

---

and that's the whole page bestie, from the X OSD Library, dated December 2000, and it signs off as XOSD(3). go forth and make your screen go bling ✨💖🎀