File: xosd.3

package info (click to toggle)
xosd 2.2.14-2.1
  • links: PTS
  • area: main
  • in suites: bullseye, buster, jessie, jessie-kfreebsd, sid, stretch
  • size: 2,320 kB
  • ctags: 409
  • sloc: sh: 10,748; ansic: 3,875; makefile: 77
file content (94 lines) | stat: -rw-r--r-- 2,573 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
.\" Emacs, -*- nroff -*- please
.TH XOSD 3 "December 2000" "X OSD Library"
.SH NAME
xosd - X on-screen display library
.SH SYNOPSIS
.nf
.B #include <xosd.h>
.sp
.BI "xosd* xosd_create(int " number_lines ); 
.sp
.BI "int xosd_uninit (xosd* " osd );
.sp
.BI "int xosd_display (xosd* " osd ", int " line ,
.BI "                  xosd_command " command ", " ... );
.sp
.BI "int xosd_is_onscreen(xosd* " osd );
.sp
.BI "int xosd_wait_until_no_display(xosd* " osd );
.sp
.BI "int xosd_hide (xosd* " osd );
.sp
.BI "int xosd_show (xosd* " osd );
.sp
.BI "int xosd_set_pos (xosd* " osd ", xosd_pos " pos );
.sp
.BI "int xosd_set_vertical_offset (xosd* " osd ", int " offset );
.sp
.BI "int xosd_set_horizontal_offset (xosd* " osd ", int " offset );
.sp
.BI "int xosd_set_align (xosd* " osd ", xosd_align " align)
.sp
.BI "int xosd_set_shadow_offset (xosd* " osd ", int " shadow_offset );
.sp
.BI "int xosd_set_timeout (xosd* " osd ", int " timeout );
.sp
.BI "int xosd_set_font (xosd* " osd ", char* " font );
.sp
.BI "int xosd_set_colour (xosd* " osd ", char* " colour );
.sp
.BI "int xosd_get_colour (xosd* " osd ,
.BI "                     int* " red ", int* " green ", int* " blue );
.sp
.BI "int xosd_scroll (xosd* "osd ", int " lines );
.sp
.BI "int xosd_get_number_lines ( xosd* "osd "); "
.fi

.SH 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 manpage.
.sp
The latest version can be found on
http://www.ignavus.net/software.html
.PP
It is distributed under the GNU General Public License.

.SH BUGS
No known bugs at the moment. There are probably functions that aren't listed here.
.sp
Bug reports can be sent to tnw13@cosc.canterbury.ac.nz

.SH EXAMPLE
.nf
#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;
}
.fi

.SH AUTHOR
Martijn van de Streek <martijn@foodfight.org>, Some patching by Malcolm Valentine <farkit@iprimus.com.au> and Tim Wright <tim@ignavus.net>.
.PP
xosd was written by Andre Renaud <andre@ignavus.net> and is maintained by Tim Wright <tim@ignavus.net>.
.SH 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.