xosd(3) [debian man page]

XOSD(3) 						     Library Functions Manual							   XOSD(3)

NAME

       xosd - X on-screen display library

SYNOPSIS

       #include <xosd.h>

       xosd* xosd_create(int number_lines);

       int xosd_uninit (xosd* osd);

       int xosd_display (xosd* osd, int line,
			 xosd_command command, ...);

       int xosd_is_onscreen(xosd* osd);

       int xosd_wait_until_no_display(xosd* osd);

       int xosd_hide (xosd* osd);

       int xosd_show (xosd* osd);

       int xosd_set_pos (xosd* osd, xosd_pos pos);

       int xosd_set_vertical_offset (xosd* osd, int offset);

       int xosd_set_horizontal_offset (xosd* osd, int offset);

       int xosd_set_align (xosd* osd, xosd_align align)

       int xosd_set_shadow_offset (xosd* osd, int shadow_offset);

       int xosd_set_timeout (xosd* osd, int timeout);

       int xosd_set_font (xosd* osd, char* font);

       int xosd_set_colour (xosd* osd, char* colour);

       int xosd_get_colour (xosd* osd,
			    int* red, int* green, int* blue);

       int xosd_scroll (xosd* osd, int lines);

       int xosd_get_number_lines ( xosd* osd);

DESCRIPTION

       xosd is a library for displaying an on-screen display (like the one on many TVs) on your X display. Each function should have it's own man-
       page.

       The latest version can be found on http://www.ignavus.net/software.html

       It is distributed under the GNU General Public License.

BUGS

       No known bugs at the moment. There are probably functions that aren't listed here.

       Bug reports can be sent to tnw13@cosc.canterbury.ac.nz

EXAMPLE

       #include <xosd.h>

       int main (int argc, char *argv[])
       {
	    xosd *osd;

	    osd = xosd_create (1);

	    xosd_set_font(osd, "fixed");
	    xosd_set_colour(osd, "LawnGreen");
	    xosd_set_timeout(osd, 3);
	    xosd_set_shadow_offset(osd, 1);

	    xosd_display (osd, 0, XOSD_string, "Example XOSD output");

	    xosd_wait_until_no_display(osd);

	    xosd_uninit (osd);

	    return EXIT_SUCCESS;
       }

AUTHOR

       Martijn van de Streek <martijn@foodfight.org>, Some patching 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. Each function has its  own  man-
       page.  See there for more information.

X OSD Library							   December 2000							   XOSD(3)

XOSD(1xosd)															       XOSD(1xosd)

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.

       -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(1xosd)