.\" Automatically generated by Pandoc 2.14.0.2
.\"
.TH "XOSD-XFT" "1" "Jun 28 2021" "" "XOSD-XFT General Commands"
.hy
.SH NAME
.PP
osd-echo, osd-cat, osd-demo - Show information in a OSD window
.SH SYNOPSIS
.PP
osd-echo [\f[I]options\f[R]] \f[I]message\f[R]
.PP
osd-cat [\f[I]options\f[R]] [\f[I]file\f[R]]
.PP
osd\[en]demo [\f[I]options\f[R]]
.SH DESCRIPTION
.PP
\f[C]osd-echo\f[R] shows a message in a translucent window on the
screen.
\f[C]osd-echo\f[R] can understand unicode escape sequences in the
message and can also understand glyph names from Nerd fonts.
.PP
\f[C]osd-cat\f[R] shows a given file in a OSD window.
If a file is not given \f[C]osd-cat\f[R] reads from the standard
input.
.PP
\f[C]osd-demo\f[R] is a small program that shows the capabilities of
\f[C]xosd-xft\f[R] library.
.PP
Both \f[C]osd-echo\f[R] and \f[C]osd-cat\f[R] provides various
options to control the colors, font and geometry used to display the
information.
.SH OPTIONS
.TP
-g \f[I]GEOMETRY\f[R], --geometry=\f[I]GEOMETRY\f[R]
Specify the geometry for the window.
The geometry contains the size, offset and alignment specifications.
.IP
.nf
\f[C]
      geometry: <size><offset>*<alignment>
      size: <width>x<height>
        The \[ga]width\[ga] is specified as an integer. It can optionally succeed
        by either \[ga]%\[ga] or \[ga]c\[ga]. \[ga]%\[ga] is used to specify the width as a percentage
        of the screen width. \[ga]c\[ga] is used to specify the width as number of
        characters

      offset: [+-]<xoffset>[+-]<yoffset>
        The \[ga]xoffset\[ga] and \[ga]yoffset\[ga] 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 \[ga]valign\[ga] can be any one of \[ga]top\[ga], \[ga]middle\[ga], or \[ga]bottom\[ga]. The \[ga]halign\[ga] can
        be one of \[ga]left\[ga], \[ga]center\[ga] or \[ga]right\[ga].
\f[R]
.fi
.TP
-t \f[I]ALIGN\f[R], --text-align=\f[I]ALIGN\f[R]
Text alignment within the OSD window
.IP
.nf
\f[C]
    alignment: <halign>/<valign>
      halign: one of left,center,right or none
      valign: one of top,middle,bottom or none
\f[R]
.fi
.TP
-f \f[I]FONT\f[R], --font=*FONT
Font for display.
\f[I]FONT\f[R] is Xft font name.
.TP
-c \f[I]COLOR\f[R], --color=\f[I]COLOR\f[R]
Foreground color for text.
\f[I]COLOR\f[R] is a X11 color name.
.TP
-p \f[I]PADDING\f[R], --padding=\f[I]PADDING\f[R]
Padding for the content
.IP
.nf
\f[C]
    padding: top right bottom left
      All as integers. When later values are absent, the previous values are used
      as in CSS specification.
\f[R]
.fi
.TP
-b \f[I]COLOR\f[R], --bg-color=\f[I]COLOR\f[R]
Color for background (default: black)
.TP
-a \f[I]ALPHA\f[R], --bg-alpha=\f[I]ALPHA\f[R]
Background transparency
.RS
.IP
.nf
\f[C]
ALPHA value should be between 0-100
\f[R]
.fi
.RE
.TP
--no-xinerama
Turn off xinerama support
.TP
--no-xrandr
Turn off xrandr support
.TP
-m \f[I]MONITOR\f[R], --monitor=\f[I]MONITOR\f[R]
Monitor to display message
.IP
.nf
\f[C]
    MONITOR is either a number of the monitor (the numbering starts with 1). You can
    specify either \[ga]active\[ga] or \[ga]primary\[ga] to choose either of the active or primary
    monitors.
\f[R]
.fi
.PP
Besides the above options \f[C]osd-cat\f[R] accepts the following
options:
.TP
-n \f[I]NUMBER\f[R], --number-of-lines=\f[I]NUMBER\f[R]
Number of lines to display
.PP
The \f[C]osd-echo\f[R] command accepts the following additional
options:
.TP
-e \f[I]COMMAND\f[R], --exec=\f[I]COMMAND\f[R]
Executes the command using system(3) before displaying the window
.TP
-l[\f[I]SEARCH\f[R]], --list[=\f[I]SEARCH\f[R]]
List the glyph names known to the command.
If a SEARCH is give, lists glyph names that contains the search pattern.
.SH EXAMPLES
.PP
To display \f[C]/etc/passwd\f[R]:
.IP
.nf
\f[C]
    osd-cat /etc/passwd
\f[R]
.fi
.SH AUTHORS
Dakshinamurthy Karra.