osd_cat(1) [debian man page]
XOSD(1) General Commands Manual XOSD(1) NAME
osd_cat - X on-screen file displayer SYNOPSIS
osd_cat [OPTION] [FILE]... osd_cat -b percentage|slider [OPTION] DESCRIPTION
Display FILE, or standard input, on X screen. -p, --pos=POS This option tells osd_cat where to display the text. POS can be top, middle, or bottom. The default is top. -o, --offset=OFFSET This option specifies the offset from the top or bottom of screen the text is displayed. The default is 0. -A, --align=ALIGN This option tells osd_cat where to display the text. ALIGN can be left, right or center. The default is left. -i, --indent=OFFSET This option specifies the INDENT from the left of screen the text is displayed. The default is 0. -f, --font=FONT This option specifies the FONT to be used for displaying the text. The default is fixed. -c, --color=COLOR This option specifies the COLOR to be used for displaying the text. The default is red. -d, --delay=TIME This option specifies the number of seconds the text is displayed. The default is 5 seconds. -l, --lines=LINES This option specifies the number of LINES to scroll the display over. The default is 5. -s, --shadow=OFFSET This option specifies the OFFSET of the text shadow. The default is 0, which means no text shadow is created. -S, --shadowcolour=COLOUR This option specifies the COLOUR of the text shadow. The default is black. -O, --outline=WIDTH This option specifies the WIDTH of the text outline. The default is 0, which is no outline. -u, --outlinecolour=COLOUR This option specifies the COLOUR of the text outline. The default is black. -a, --age[=SCROLL_AGE] This option affects screen redrawing. If SCROLL_AGE seconds pass before a new line is ready (for example, you're reading from a pipe), all lines are 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 option also affects screen redrawing. When there is data ready to be put on screen, this option will cause osd_cat to wait until the display is clear. An alternative to scrolling. -b, --barmode=TYPE Lets you display a percentage or slider bar instead of just text. 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 option specified the position of the percentage / slider bar. PERCENTAGE may be in the range from 0 to 100, the default is 50. -T, --text=TEXT This option 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 With no FILE, or when FILE is -, read standard input. AUTHOR
Martijn van de Streek <martijn@foodfight.org>, 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> SEE ALSO
More information on the X OSD Library and its author can be found on http://www.ignavus.net/software.html <http://www.ignavus.net/software.html> COPYRIGHT
It is distributed under the GNU General Public License. X OSD cat January 2001 XOSD(1)
Check Out this Related Man Page
XOSD_DISPLAY(3) XOSD_DISPLAY(3) NAME
xosd_display - Display data to an XOSD window SYNOPSIS
#include <xosd.h> int xosd_display (xosd *osd, int line, xosd_command command, ...); DESCRIPTION
xosd_display displays either a string, a percentage bar (like a progress bar) or a slider on an X display. The data is displayed in a bor- derless shaped-window, so it appears to float on top of the other windows, like the on-screen displays found in many televisions. Users cannot interact with the display in any way. The data is displayed until the timeout limit, set by calling xosd_set_timeout(3), is reached, but xosd_display returns immediately. If blocking is required xosd_wait_until_no_display(3) should be called after xosd_display. A window that is displaying data can be hidden by calling xosd_hide(3). The type of data displayed is determined by the command argument. There are two types of data that can be displayed: text or integers. Displaying Textual Data Text is normally displayed by passing XOSD_string as the argument to command, followed by a string in UTF-8 format. If formatted text is desired, pass XOSD_printf as the argument to command, followed by string that has the same format as printf(3), and as many additional ar- guments as is required by the format string. Displaying Integer Values Integer values (which must be within the range 0 to 100) can be displayed in two ways: a percentage-bar or a slider. A percentage bar looks like a volume display on a TV, and is created by passing XOSD_percentage as the argument to command. A slider (see the XOSD plug-in for xmms(1) for an example) is created by passing XOSD_slider as the argument to command. An int between 0 and 100 is expected as the final ar- gument when either XOSD_percentage or XOSD_slider is passed as the argument to command. ARGUMENTS
osd The XOSD window to use as the display. line The line of the display to change. The value of line must be less than number_lines, set in the call to xosd_create(3). command One of XOSD_percentage, XOSD_slider or XOSD_string. If the value of command is XOSD_string, then the next argument should be a string in UTF-8 format. If XOSD_percentage or XOSD_slider is given then an int between 1 and 100 is expected as the next argument. RETURN VALUE
If the command is either XOSD_percentage or XOSD_slider then the integer value of the bar or slider is returned (between 1 and 100). For XOSD_string and XOSD_printf the number of characters written to the display is returned. On error -1 is returned and xosd_error is set to indicate the reason for the error. ENVIRONMENT
char *xosd_error A string describing the error, if one occurred. enum xosd_command The type of information that can be displayed, defined as an enumerated type. There are four values defined: XOSD_percentage, XOSD_string, XOSD_printf, and XOSD_slider. AUTHORS
The XOSD library was originally written by Andre Renaud, and is currently maintained by Tim Wright. This document was written by Michael JasonSmith. BUGS
There are no known bugs with xosd_display. Bug reports can be sent to <xosd@ignavus.net>. SEE ALSO
xosd_create(3), xosd_set_timeout(3), xosd_wait_until_no_display(3), xosd_hide(3), printf(3). XOSD_DISPLAY(3)