AOSD(1)

πŸ¦‹ AOSD(1) πŸ¦‹ β€” the aosd_cat manual, but make it bestie πŸ’–

✨ NAME ✨

okay so aosd_cat is the one that displays text on the screen 🫢 it's literally an OSD (on-screen display) tool that puts your words over whatever you're doing πŸ’…

🌸 SYNOPSIS 🌸

aosd_cat [OPTION...]

πŸŽ€ DESCRIPTION πŸŽ€

okay bestie, so this thing shows UTF-8 text inside a see-through OSD frame ✨ it's giving floating-over-your-desktop energy and I'm obsessed 😭

heads up on the numbers πŸ”’ parameters marked with an asterisk (*) take a valid range of 0-255. the ones with a double asterisk (**) are chill and accept negative values too πŸ™ˆ colors can be written as #RGB or pulled by name from rgb.txt 🌈 timing stuff is in milliseconds ⏱️ scrollback limits get cancelled if you pass 0 🚫 and age is measured in seconds πŸ•°οΈ

πŸ—ΊοΈ Geometry Options πŸ—ΊοΈ

  • -p, --position β€” this sets where the OSD window sits. more precisely, it picks the spot on the screen that counts as the start of the coordinates (the 0,0 point) AND picks the spot on the OSD window that lines up with it 🎯 valid range is 0-8, where 0 is the top-left corner and 8 is the bottom-right corner πŸ’œ the default is 6.
  • -x, --x-offset ** β€” sets the x-axis offset of the window from the (0,0) point ➑️ default is 50.
  • -y, --y-offset ** β€” sets the y-axis offset of the window from the (0,0) point ⬇️ default is -50.
  • -e, --shadow-offset ** β€” sets the shadow offset πŸŒ‘ default is 2.
  • -d, --padding * β€” sets the margin between the edge and the contents 🧸 default is 0.

πŸ’… Appearance Options πŸ’…

  • -t, --transparency β€” sets the transparency mode: 0 = none, 1 = fake, 2 = composite ✨ default is 2.
  • -n, --font β€” sets the OSD font πŸ”€ there's no default value, so you pick one.
  • -w, --width β€” sets the OSD wrapping width in pixels πŸ“ if you set it to 0, the text wraps on the screen width, or doesn't wrap at all if other parameters make correct layout impossible πŸ™ƒ default is 0.

🌈 Coloring Options 🌈

  • -B, --back-color β€” sets the background color 🎨 no default value.
  • -S, --shadow-color β€” sets the shadow color πŸ–€ default is black.
  • -R, --fore-color β€” sets the foreground color πŸ’š default is green.

🫧 Opacity Options 🫧

  • -b, --back-opacity * β€” sets the background opacity πŸ‘» default is 0.
  • -s, --shadow-opacity * β€” sets the shadow opacity 🌘 default is 192.
  • -r, --fore-opacity * β€” sets the foreground opacity πŸ’« default is 255.

⏰ Timing Options ⏰

  • -f, --fade-in β€” sets the fade-in time ✨ default is 300.
  • -u, --fade-full β€” sets how long it stays at full opacity πŸ’– default is 3000.
  • -o, --fade-out β€” sets the fade-out time πŸ‘‹ default is 300.

πŸ“œ Scrollback Options πŸ“œ

  • -a, --age β€” sets the line age removal limit πŸ•°οΈ default is 0.
  • -l, --lines β€” sets the line amount removal limit πŸ“‰ default is 1.

πŸ¦„ Application Options πŸ¦„

  • -i, --input β€” sets the input text source πŸ“₯ default is -.

πŸ™ˆ BUGS πŸ™ˆ

⚠️ bestie, this manpage may be out of date! run --help to get the latest options πŸ‘€

Thank you for using libaosd! 🫢 please send bug reports to: http://jira.atheme.org/


ok that's the whole tea β˜• aosd_cat Β· November 2007 Β· AOSD(1) Β· stay iconic and keep your OSD slay πŸ’…βœ¨πŸ¦‹