.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH OSDSH 1 "August 31, 2003"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
osdsh \- Overlays your screen with various system informations
.SH SYNOPSIS
.B osdsh
.RI [ options ]
.SH DESCRIPTION
.B osdsh 
is a a little program that overlays system information using
the XOSD library. OSDsh was originally based on osdd but got some
features added, like:
.br
  * It is able to display a clock.
  * Shows the volume levels of the soundcard whenever they change.
  * Tells you if you are on- or off-line, and the time you were connected.
  * Shows the battery status and
  * shows any message you want it to.
.br
.br
.B osdsh
forks to the background when started and should be started in the user's
session scripts (like ~/.xsession)

.SH OPTIONS
.TP
.B \-h 
Show summary of options.
.TP
.B \-m mixer
Set mixer device.
.SM (Default: /dev/mixer)
.TP
.B \-f font
Set font
.SM (Default: -*-lucidatypewriter-bold-*-*-*-*-240-*-*-*-*-*-*)
.TP
.B \-c color
Set color
.SM (Default: green)
.TP
.B \-d int
Set OSD delay
.SM (Default: 5)
.TP
.B \-o int
Set shadow offset
.SM (Default: 1)
.TP
.B \-p <0|1>
Position of the osd: 0 for top, 1 for bottom.
.SM (Default: 1 (bottom))
.TP
.B \-a <0|1|2>
align of the osd: left, center or right
.TP
.B \-n number
set the nice number so osdsh won't eat your cpu

.SH SEE ALSO
.BR osdctl (1),
.BR osdshconfig (1).
.SH AUTHOR
This manual page was written by Joachim Breitner <nomeata@debian.org>,
for the Debian project (but may be used by others).