XOSD-XFT(1)

🎀 XOSD-XFT(1) 🎀

okay so welcome to the XOSD-XFT General Commands page, bestie! This is the whole vibe for showing info in an OSD window, and yes it's giving very main character energy. 💅

🌸 NAME 🌸

• osd-echo, osd-cat, osd-demo — show information in a OSD window. 💖

✨ SYNOPSIS ✨

osd-echo [options] message

osd-cat [options] [file]

osd–demo [options]

💖 DESCRIPTION 💖

osd-echo shows a message in a translucent window on the screen. It can understand unicode escape sequences in the message, and it can also understand glyph names from Nerd fonts. slay ✨

osd-cat shows a given file in a OSD window. If a file is not given, osd-cat reads from the standard input. 🫶

osd-demo is a small program that shows the capabilities of xosd-xft library. It's the little demo bestie that shows off what the library can do. 🦋

Both osd-echo and osd-cat provides various options to control the colors, font and geometry used to display the information. So yes, you get to customize the whole look. 👑

🔥 OPTIONS 🔥

• -g GEOMETRY, --geometry=GEOMETRY — specify the geometry for the window. The geometry contains the size, offset and alignment specifications. this is the layout blueprint, bestie 🎀

      geometry: <size><offset>*<alignment>
      size: <width>x<height>
        The `width` is specified as an integer. It can optionally succeed
        by either `%` or `c`. `%` is used to specify the width as a percentage
        of the screen width. `c` is used to specify the width as number of
        characters

      offset: [+-]<xoffset>[+-]<yoffset>
        The `xoffset` and `yoffset` follows the standard X geometry definition
        when alignment is not provided. When alignment is provided the offsets
        are used to adjust the alignmennt positions

      alignment: <valign>/<halign>
        The `valign` can be any one of `top`, `middle`, or `bottom`. The `halign` can
        be one of `left`, `center` or `right`.

• -t ALIGN, --text-align=ALIGN — text alignment within the OSD window. get that text sitting exactly where you want it 💅

      alignment: <halign>/<valign>
        halign: one of left,center,right or none
        valign: one of top,middle,bottom or none

• -f FONT, --font=*FONT — font for display. FONT is Xft font name. 🔥
• -c COLOR, --color=COLOR — foreground color for text. COLOR is a X11 color name. 🌈
• -p PADDING, --padding=PADDING — padding for the content. personal space, but for your OSD 🎀

      padding: top right bottom left
        All as integers. When later values are absent, the previous values are used
        as in CSS specification.

• -b COLOR, --bg-color=COLOR — color for background (default: black). 🖤
• -a ALPHA, --bg-alpha=ALPHA — background transparency. translucent era ✨

      ALPHA value should be between 0-100

• --no-xinerama — turn off xinerama support. 🚫
• --no-xrandr — turn off xrandr support. 🚫
• -m MONITOR, --monitor=MONITOR — monitor to display message. choose your screen, bestie 🖥️

      MONITOR is either a number of the monitor (the numbering starts with 1). You can
      specify either `active` or `primary` to choose either of the active or primary
      monitors.

Besides the above options, osd-cat accepts the following options:

• -n NUMBER, --number-of-lines=NUMBER — number of lines to display. 📄

The osd-echo command accepts the following additional options:

• -e COMMAND, --exec=COMMAND — executes the command using system(3) before displaying the window. ⚡
• -l[SEARCH], --list[=SEARCH] — list the glyph names known to the command. If a SEARCH is give, lists glyph names that contains the search pattern. 🔍

🎀 EXAMPLES 🎀

To display /etc/passwd:

osd-cat /etc/passwd

👑 AUTHORS 👑

Dakshinamurthy Karra. 💖

---

💖 That's the XOSD-XFT(1) manual, dated Jun 28 2021 — mwah, bestie! 🫶