From 8b46add27e3ae16267a07e381c621714b9d003a4 Mon Sep 17 00:00:00 2001
From: Pierre Pronchery <khorben@defora.org>
Date: Fri, 12 Oct 2012 21:31:25 +0000
Subject: [PATCH] Documented panel-message

---
 doc/.cvsignore        |   2 +
 doc/Makefile          |  14 +++++-
 doc/panel-embed.xml   |   4 ++
 doc/panel-message.xml | 112 ++++++++++++++++++++++++++++++++++++++++++
 doc/panel-notify.xml  |   4 ++
 doc/panel.xml         |   4 ++
 doc/project.conf      |  14 +++++-
 7 files changed, 151 insertions(+), 3 deletions(-)
 create mode 100644 doc/panel-message.xml

diff --git a/doc/.cvsignore b/doc/.cvsignore
index 97eb969..7ffb51a 100644
--- a/doc/.cvsignore
+++ b/doc/.cvsignore
@@ -4,5 +4,7 @@ panel.1
 panel.html
 panel-embed.1
 panel-embed.html
+panel-message.1
+panel-message.html
 panel-notify.1
 panel-notify.html
diff --git a/doc/Makefile b/doc/Makefile
index 2490c8b..9d66534 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,4 +1,4 @@
-TARGETS	= panel.1 panel.html panelctl.1 panelctl.html panel-embed.1 panel-embed.html panel-notify.1 panel-notify.html
+TARGETS	= panel.1 panel.html panelctl.1 panelctl.html panel-embed.1 panel-embed.html panel-message.1 panel-message.html panel-notify.1 panel-notify.html
 PREFIX	= /usr/local
 DESTDIR	=
 RM	?= rm -f
@@ -27,6 +27,12 @@ panel-embed.1: panel-embed.xml
 panel-embed.html: panel-embed.xml
 	./docbook.sh -P "$(PREFIX)" -- "panel-embed.html"
 
+panel-message.1: panel-message.xml
+	./docbook.sh -P "$(PREFIX)" -- "panel-message.1"
+
+panel-message.html: panel-message.xml
+	./docbook.sh -P "$(PREFIX)" -- "panel-message.html"
+
 panel-notify.1: panel-notify.xml
 	./docbook.sh -P "$(PREFIX)" -- "panel-notify.1"
 
@@ -34,7 +40,7 @@ panel-notify.html: panel-notify.xml
 	./docbook.sh -P "$(PREFIX)" -- "panel-notify.html"
 
 clean:
-	$(RM) -- $(panel.1_OBJS) $(panel.html_OBJS) $(panelctl.1_OBJS) $(panelctl.html_OBJS) $(panel-embed.1_OBJS) $(panel-embed.html_OBJS) $(panel-notify.1_OBJS) $(panel-notify.html_OBJS)
+	$(RM) -- $(panel.1_OBJS) $(panel.html_OBJS) $(panelctl.1_OBJS) $(panelctl.html_OBJS) $(panel-embed.1_OBJS) $(panel-embed.html_OBJS) $(panel-message.1_OBJS) $(panel-message.html_OBJS) $(panel-notify.1_OBJS) $(panel-notify.html_OBJS)
 
 distclean: clean
 	$(RM) -- $(TARGETS)
@@ -46,6 +52,8 @@ install: $(TARGETS)
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panelctl.html"
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panel-embed.1"
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panel-embed.html"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panel-message.1"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panel-message.html"
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panel-notify.1"
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panel-notify.html"
 
@@ -56,6 +64,8 @@ uninstall:
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panelctl.html"
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panel-embed.1"
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panel-embed.html"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panel-message.1"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panel-message.html"
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panel-notify.1"
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panel-notify.html"
 
diff --git a/doc/panel-embed.xml b/doc/panel-embed.xml
index ff80f02..6173f41 100644
--- a/doc/panel-embed.xml
+++ b/doc/panel-embed.xml
@@ -81,6 +81,10 @@
 				<refentrytitle>panelctl</refentrytitle>
 				<manvolnum>1</manvolnum>
 			</citerefentry>,
+			<citerefentry>
+				<refentrytitle>panel-message</refentrytitle>
+				<manvolnum>1</manvolnum>
+			</citerefentry>,
 			<citerefentry>
 				<refentrytitle>panel-notify</refentrytitle>
 				<manvolnum>1</manvolnum>
diff --git a/doc/panel-message.xml b/doc/panel-message.xml
new file mode 100644
index 0000000..af37f22
--- /dev/null
+++ b/doc/panel-message.xml
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Id$ -->
+<!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>
+			<arg choice="opt">-T <replaceable>type</replaceable></arg>
+			<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>-T</option></term>
+				<listitem>
+					<para>Type of message to display.</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: -->
diff --git a/doc/panel-notify.xml b/doc/panel-notify.xml
index 7fa2812..acbdec1 100644
--- a/doc/panel-notify.xml
+++ b/doc/panel-notify.xml
@@ -135,6 +135,10 @@
 			<citerefentry>
 				<refentrytitle>panel-embed</refentrytitle>
 				<manvolnum>1</manvolnum>
+			</citerefentry>,
+			<citerefentry>
+				<refentrytitle>panel-message</refentrytitle>
+				<manvolnum>1</manvolnum>
 			</citerefentry>
 		</para>
 	</refsect1>
diff --git a/doc/panel.xml b/doc/panel.xml
index e2a4f3a..ef0d8de 100644
--- a/doc/panel.xml
+++ b/doc/panel.xml
@@ -109,6 +109,10 @@
 				<refentrytitle>panel-embed</refentrytitle>
 				<manvolnum>1</manvolnum>
 			</citerefentry>,
+			<citerefentry>
+				<refentrytitle>panel-message</refentrytitle>
+				<manvolnum>1</manvolnum>
+			</citerefentry>,
 			<citerefentry>
 				<refentrytitle>panel-notify</refentrytitle>
 				<manvolnum>1</manvolnum>
diff --git a/doc/project.conf b/doc/project.conf
index 06a92ad..da23948 100644
--- a/doc/project.conf
+++ b/doc/project.conf
@@ -1,4 +1,4 @@
-targets=panel.1,panel.html,panelctl.1,panelctl.html,panel-embed.1,panel-embed.html,panel-notify.1,panel-notify.html
+targets=panel.1,panel.html,panelctl.1,panelctl.html,panel-embed.1,panel-embed.html,panel-message.1,panel-message.html,panel-notify.1,panel-notify.html
 dist=Makefile,docbook.sh,panel.xml,panelctl.xml,panel-embed.xml,panel-notify.xml
 
 [panel.1]
@@ -37,6 +37,18 @@ script=./docbook.sh
 install=
 depends=panel-embed.xml
 
+[panel-message.1]
+type=script
+script=./docbook.sh
+install=
+depends=panel-message.xml
+
+[panel-message.html]
+type=script
+script=./docbook.sh
+install=
+depends=panel-message.xml
+
 [panel-notify.1]
 type=script
 script=./docbook.sh