XOSD(1)

💖 XOSD — osd_cat 💖

okay bestie, welcome to the X OSD manual, section 1, the General Commands Manual era ✨. This is the page for osd_cat, and no cap, it's about to be your new fave little text-on-your-screen situation. Let's get into it 🫶

---

✨ NAME ✨

osd_cat — the X on-screen file displayer 💅 literally just puts your file up on your X screen. iconic behaviour.

---

🌸 SYNOPSIS 🌸

osd_cat [OPTION] [FILE]...
osd_cat -b percentage|slider [OPTION]

---

🎀 DESCRIPTION 🎀

So basically: it displays FILE, or standard input, on your X screen. That's the whole vibe 🌈

Here's every single option, bestie, don't skip any of them, I'm watching 👀

• -p, --pos=POS — this one tells osd_cat where to display the text. POS can be top, middle, or bottom. The default is top. 📍
• -o, --offset=OFFSET — this specifies the offset from the top or bottom of the screen that the text gets displayed at. The default is 0.
• -A, --align=ALIGN — tells osd_cat where to display the text horizontally, bestie. ALIGN can be left, right or center. The default is left. ⬅️
• -i, --indent=OFFSET — this one specifies the INDENT from the left of the screen that the text is displayed at. The default is 0.
• -f, --font=FONT — this specifies the FONT used for displaying the text. The default is fixed. 🔤
• -c, --color=COLOR — this specifies the COLOR used for displaying the text. The default is red. ❤️ the drama, honestly
• -d, --delay=TIME — this specifies how many seconds the text is displayed. The default is 5 seconds. ⏳
• -l, --lines=LINES — this specifies the number of LINES to scroll the display over. The default is 5.
• -s, --shadow=OFFSET — this specifies the OFFSET of the text shadow. The default is 0, which means no text shadow gets created at all. (sad, but valid)
• -S, --shadowcolour=COLOUR — this specifies the COLOUR of the text shadow. The default is black. 🖤
• -O, --outline=WIDTH — this specifies the WIDTH of the text outline. The default is 0, which is no outline. periodt.
• -u, --outlinecolour=COLOUR — this specifies the COLOUR of the text outline. The default is black. 🖤
• -a, --age[=SCROLL_AGE] — this one affects screen redrawing, so listen up 📢. If SCROLL_AGE seconds pass before a new line is ready (like, say, you're reading from a pipe), all lines get cleared at once instead of being scrolled off as new lines replace old lines. The default is 0. When no SCROLL_AGE is explicitly given, the current value from DELAY is used. ✨
• -w, --wait — this also affects screen redrawing. When there's data ready to be put on screen, this option makes osd_cat wait until the display is clear. It's an alternative to scrolling. 🧘‍♀️
• -b, --barmode=TYPE — lets you display a percentage or slider bar instead of just text, which is lowkey a serve. TYPE may be percentage or slider. In this mode no text is read from any file, but the following options can be used: 👇
• -P, --percentage=PERCENTAGE — this specifies the position of the percentage / slider bar. PERCENTAGE may be in the range from 0 to 100, and the default is 50. 📊
• -T, --text=TEXT — this specifies an optional TEXT which gets displayed above the percentage bar. The default is empty, so no additional text is displayed.
• -h, --help — display help (which is often more up to date) and exit. bestie behaviour fr fr 🙈

🫶 With no FILE, or when FILE is -, read standard input. That's the rule, no exceptions, iykyk.

---

👑 AUTHOR 👑

Martijn van de Streek <martijn@foodfight.org>, with some patching done 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>. the way they built this whole thing… main character energy fr 🧚

---

🦋 SEE ALSO 🦋

More information on the X OSD Library and its author can be found on http://www.ignavus.net/software.html ✨ go look, bestie.

---

💅 COPYRIGHT 💅

It is distributed under the GNU General Public License. 📜

---

and that's the whole page, bestie!! 💖 this was the X OSD cat page, dated January 2001, living under XOSD(1) — go forth and put some text on your screen, you absolute icon 🎀✨🦋💜