File: xosd_set_vertical_offset.3

package info (click to toggle)
xosd 2.2.14-2.1
  • links: PTS
  • area: main
  • in suites: bookworm, bullseye, buster, jessie, jessie-kfreebsd, stretch
  • size: 2,320 kB
  • ctags: 409
  • sloc: sh: 10,748; ansic: 3,875; makefile: 77
file content (26 lines) | stat: -rw-r--r-- 819 bytes parent folder | download | duplicates (3)
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
.\" Hey Emacs! This file is -*- nroff -*- source.
.TH xosd_set_vertical_offset 3 "2002-06-25" "X OSD Library"
.SH NAME
xosd_set_vertical_offset \- Change the offset of the XOSD window
.SH SYNOPSIS
.B #include <xosd.h>
.sp
.BI "int xosd_set_vertical_offset (xosd* " osd ", int " offset );
.fi
.SH DESCRIPTION
.B xosd_set_vertical_offset 
changes the number of pixels the XOSD window is offset from the top or
bottom of the screen.
This is normally set to a value such as 48 to avoid desktop-panels,
such as those provided by GNOME or KDE.
.SH ARGUMENTS
.IP \fIosd\fP 1i
The on-screen display object to act on.
.IP \fIoffset\fP 1i
Offset from the top or bottom of the screen, in pixels.
.SH "RETURN VALUE"
On success, a zero is returned.
On error, \-1 is returned.
.SH "SEE ALSO"
.BR xosd_init (3),
.BR xosd_set_pos (3).