.TH AOSD "1" "November 2007" "aosd_cat" "User Commands"
.SH NAME
aosd_cat - displays text on the screen
.SH SYNOPSIS
.B aosd_cat [\fIOPTION\fB...]
.SH DESCRIPTION
Displays UTF-8 text in a transparent OSD frame.
.PP
For parameters marked with asterisk (*) valid range is 0-255.
Those, which are marked with double asterisk (**), accept negative values.
Coloring parameters are specified in either #RGB format or from rgb.txt.
Timing parameters are specified in milliseconds.
Scrollback limits are cancelled with 0 parameter.
Age is in seconds.
.TP
Geometry Options:
.TP
\fB\-p\fR, \fB\-\-position\fR
Sets the OSD window position. Or to be more precise, selects the point of the
screen which is told to be the beginning of the coordinates (the 0,0 point)
AND selects the point of the OSD window to collocate with it. Valid range is
0-8, where 0 is top-left corner and 8 is bottom-right corner.
Default value is \fB6\fR.
.TP
\fB\-x\fR, \fB\-\-x\-offset\fR **
Sets the x-axis window offset from the (0,0) point. Default value is \fB50\fR.
.TP
\fB\-y\fR, \fB\-\-y\-offset\fR **
Sets the y-axis window offset from the (0,0) point. Default value is \fB-50\fR.
.TP
\fB\-e\fR, \fB\-\-shadow\-offset\fR **
Sets the shadow offset. Default value is \fB2\fR.
.TP
\fB\-d\fR, \fB\-\-padding\fR *
Sets the margin from the edge to the contents. Default value is \fB0\fR.
.TP
Appearance Options:
.TP
\fB\-t\fR, \fB\-\-transparency\fR
Sets the transparency mode. 0=none, 1=fake, 2=composite. Default value is \fB2\fR.
.TP
\fB\-n\fR, \fB\-\-font\fR
Sets the OSD font. No default value.
.TP
\fB\-w\fR, \fB\-\-width\fR
Sets the OSD wrapping width in pixels. If set to zero, text will be
wrapped on screen width or will not be wrapped at all if other
parameters make it impossible to layout correctly. Default value is \fB0\fR.
.TP
Coloring Options:
.TP
\fB\-B\fR, \fB\-\-back\-color\fR
Sets the background color. No default value.
.TP
\fB\-S\fR, \fB\-\-shadow\-color\fR
Sets the shadow color. Default value is \fBblack\fR.
.TP
\fB\-R\fR, \fB\-\-fore\-color\fR
Sets the foreground color. Default value is \fBgreen\fR.
.TP
Opacity Options:
.TP
\fB\-b\fR, \fB\-\-back\-opacity\fR *
Sets the background opacity. Default value is \fB0\fR.
.TP
\fB\-s\fR, \fB\-\-shadow\-opacity\fR *
Sets the shadow opacity. Default value is \fB192\fR.
.TP
\fB\-r\fR, \fB\-\-fore\-opacity\fR *
Sets the foreground opacity. Default value is \fB255\fR.
.TP
Timing Options:
.TP
\fB\-f,\fR \fB\-\-fade\-in\fR
Sets the fade in time. Default value is \fB300\fR.
.TP
\fB\-u,\fR \fB\-\-fade\-full\fR
Sets the time to show with full opacity. Default value is \fB3000\fR.
.TP
\fB\-o,\fR \fB\-\-fade\-out\fR
Sets the fade out time. Default value is \fB300\fR.
.TP
Scrollback Options:
.TP
\fB\-a,\fR \fB\-\-age\fR
Sets the line age removal limit. Default value is \fB0\fR.
.TP
\fB\-l,\fR \fB\-\-lines\fR
Sets the line amount removal limit. Default value is \fB1\fR.
.TP
Application Options:
.TP
\fB\-i,\fR \fB\-\-input\fR
Sets the input text source. Default value is \fB-\fR.
.SH BUGS
This manpage may be out of date. Use \-\-help to get the latest options.

Thank you for using libaosd!
Please send bug reports to: http://jira.atheme.org/