Desktop

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id: panel-message.xml,v 1.2 2012/10/12 21:53:12 khorben Exp $ -->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY firstname "Pierre">
<!ENTITY surname "Pronchery">
<!ENTITY username "khorben">
<!ENTITY email "khorben@defora.org">
<!ENTITY section "1">
<!ENTITY title "Panel User Manual">
<!ENTITY package "DeforaOS Panel">
<!ENTITY name "panel-message">
<!ENTITY purpose "Notifier for the panel">
]>
<refentry>
<refentryinfo>
<title>&title;</title>
<productname>&package;</productname>
<authorgroup>
<author>
<firstname>&firstname;</firstname>
<surname>&surname;</surname>
<contrib>Code and documentation.</contrib>
<address>
<email>&email;</email>
</address>
</author>
</authorgroup>
<copyright>
<year>2012</year>
<holder>&firstname; &surname; &lt;&email;&gt;</holder>
</copyright>
<legalnotice>
<para>This manual page was written for the DeforaOS project (and may be
used by others).</para>
<para>Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU General Public License,
Version 3 as published by the Free Software Foundation.</para>
</legalnotice>
</refentryinfo>
<refmeta>
<refentrytitle>&name;</refentrytitle>
<manvolnum>&section;</manvolnum>
</refmeta>
<refnamediv>
<refname>&name;</refname>
<refpurpose>&purpose;</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&name;</command>
<group choice="opt">
<arg choice="plain">-E</arg>
<arg choice="plain">-I</arg>
<arg choice="plain">-Q</arg>
<arg choice="plain">-W</arg>
</group>
<arg choice="opt">-t <replaceable>timeout</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para><command>&name;</command> is a desktop notification program for the
desktop. It can popup a window, centered on the screen, containing different
applets of the panel. It can be set to disappear automatically after a
specific amount of time. It is particularly useful when implementing hotkeys
(system status...).</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<para>&name; expects a text message to be specified as an argument on the
command line.</para>
<para>The following options are available:</para>
<variablelist>
<varlistentry>
<term><option>-E</option></term>
<listitem>
<para>Display an error message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-I</option></term>
<listitem>
<para>Display an information message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-Q</option></term>
<listitem>
<para>Display a question message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-W</option></term>
<listitem>
<para>Display a warning message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option></term>
<listitem>
<para>Time to wait before disappearing (in seconds; 0 means
unlimited).</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="bugs">
<title>Bugs</title>
<para>Issues can be listed and reported at <ulink
url="http://www.defora.org/os/project/bug_list/3262/Panel"/>.</para>
</refsect1>
<refsect1 id="see_also">
<title>See also</title>
<para>
<citerefentry>
<refentrytitle>panel</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>panelctl</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>panel-embed</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>panel-notify</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->