Added two manual pages
This commit is contained in:
parent
c997a342cb
commit
cbdd00b607
2
Makefile
2
Makefile
|
|
@ -59,6 +59,8 @@ dist:
|
||||||
$(PACKAGE)-$(VERSION)/doc/Makefile \
|
$(PACKAGE)-$(VERSION)/doc/Makefile \
|
||||||
$(PACKAGE)-$(VERSION)/doc/docbook.sh \
|
$(PACKAGE)-$(VERSION)/doc/docbook.sh \
|
||||||
$(PACKAGE)-$(VERSION)/doc/panel.xml \
|
$(PACKAGE)-$(VERSION)/doc/panel.xml \
|
||||||
|
$(PACKAGE)-$(VERSION)/doc/panelctl.xml \
|
||||||
|
$(PACKAGE)-$(VERSION)/doc/panel-notify.xml \
|
||||||
$(PACKAGE)-$(VERSION)/doc/project.conf \
|
$(PACKAGE)-$(VERSION)/doc/project.conf \
|
||||||
$(PACKAGE)-$(VERSION)/include/Panel.h \
|
$(PACKAGE)-$(VERSION)/include/Panel.h \
|
||||||
$(PACKAGE)-$(VERSION)/include/Makefile \
|
$(PACKAGE)-$(VERSION)/include/Makefile \
|
||||||
|
|
|
||||||
24
doc/Makefile
24
doc/Makefile
|
|
@ -1,4 +1,4 @@
|
||||||
TARGETS = panel.1 panel.html
|
TARGETS = panel.1 panel.html panelctl.1 panelctl.html panel-notify.1 panel-notify.html
|
||||||
PREFIX = /usr/local
|
PREFIX = /usr/local
|
||||||
DESTDIR =
|
DESTDIR =
|
||||||
RM ?= rm -f
|
RM ?= rm -f
|
||||||
|
|
@ -15,8 +15,20 @@ panel.1: panel.xml
|
||||||
panel.html: panel.xml
|
panel.html: panel.xml
|
||||||
./docbook.sh -P "$(PREFIX)" -- "panel.html"
|
./docbook.sh -P "$(PREFIX)" -- "panel.html"
|
||||||
|
|
||||||
|
panelctl.1: panelctl.xml
|
||||||
|
./docbook.sh -P "$(PREFIX)" -- "panelctl.1"
|
||||||
|
|
||||||
|
panelctl.html: panelctl.xml
|
||||||
|
./docbook.sh -P "$(PREFIX)" -- "panelctl.html"
|
||||||
|
|
||||||
|
panel-notify.1: panel-notify.xml
|
||||||
|
./docbook.sh -P "$(PREFIX)" -- "panel-notify.1"
|
||||||
|
|
||||||
|
panel-notify.html: panel-notify.xml
|
||||||
|
./docbook.sh -P "$(PREFIX)" -- "panel-notify.html"
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
$(RM) -- $(panel.1_OBJS) $(panel.html_OBJS)
|
$(RM) -- $(panel.1_OBJS) $(panel.html_OBJS) $(panelctl.1_OBJS) $(panelctl.html_OBJS) $(panel-notify.1_OBJS) $(panel-notify.html_OBJS)
|
||||||
|
|
||||||
distclean: clean
|
distclean: clean
|
||||||
$(RM) -- $(TARGETS)
|
$(RM) -- $(TARGETS)
|
||||||
|
|
@ -24,9 +36,17 @@ distclean: clean
|
||||||
install: $(TARGETS)
|
install: $(TARGETS)
|
||||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panel.1"
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panel.1"
|
||||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panel.html"
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panel.html"
|
||||||
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panelctl.1"
|
||||||
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panelctl.html"
|
||||||
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panel-notify.1"
|
||||||
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "panel-notify.html"
|
||||||
|
|
||||||
uninstall:
|
uninstall:
|
||||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panel.1"
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panel.1"
|
||||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panel.html"
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panel.html"
|
||||||
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panelctl.1"
|
||||||
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panelctl.html"
|
||||||
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panel-notify.1"
|
||||||
|
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "panel-notify.html"
|
||||||
|
|
||||||
.PHONY: all clean distclean install uninstall
|
.PHONY: all clean distclean install uninstall
|
||||||
|
|
|
||||||
122
doc/panel-notify.xml
Normal file
122
doc/panel-notify.xml
Normal file
|
|
@ -0,0 +1,122 @@
|
||||||
|
<?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-notify">
|
||||||
|
<!ENTITY purpose "Notifier for the desktop">
|
||||||
|
]>
|
||||||
|
<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; <&email;></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>§ion;</manvolnum>
|
||||||
|
</refmeta>
|
||||||
|
<refnamediv>
|
||||||
|
<refname>&name;</refname>
|
||||||
|
<refpurpose>&purpose;</refpurpose>
|
||||||
|
</refnamediv>
|
||||||
|
<refsynopsisdiv>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>&name;</command>
|
||||||
|
<arg choice="opt">-s</arg>
|
||||||
|
<arg choice="opt">-x</arg>
|
||||||
|
<arg choice="opt">-t <replaceable>timeout</replaceable></arg>
|
||||||
|
<arg choice="plain" rep="repeat"><replaceable>applet</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>&name;</command>
|
||||||
|
<arg choice="plain">-l</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 an arbitrary number of panel applets to be specified as
|
||||||
|
arguments on the command line.</para>
|
||||||
|
<para>The following options are available:</para>
|
||||||
|
<variablelist>
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-s</option></term>
|
||||||
|
<listitem>
|
||||||
|
<para>Use icons the size of a small toolbar.</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-x</option></term>
|
||||||
|
<listitem>
|
||||||
|
<para>Use icons the size of menus.</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-t</option></term>
|
||||||
|
<listitem>
|
||||||
|
<para>Time to wait before disappearing (in seconds; 0 means
|
||||||
|
unlimited).</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-l</option></term>
|
||||||
|
<listitem>
|
||||||
|
<para>Lists the plug-ins available.</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>
|
||||||
|
</para>
|
||||||
|
</refsect1>
|
||||||
|
</refentry>
|
||||||
|
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->
|
||||||
|
|
@ -102,6 +102,10 @@
|
||||||
<citerefentry>
|
<citerefentry>
|
||||||
<refentrytitle>panelctl</refentrytitle>
|
<refentrytitle>panelctl</refentrytitle>
|
||||||
<manvolnum>1</manvolnum>
|
<manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>,
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>panel-notify</refentrytitle>
|
||||||
|
<manvolnum>1</manvolnum>
|
||||||
</citerefentry>
|
</citerefentry>
|
||||||
</para>
|
</para>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
|
|
||||||
122
doc/panelctl.xml
Normal file
122
doc/panelctl.xml
Normal file
|
|
@ -0,0 +1,122 @@
|
||||||
|
<?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 "panelctl">
|
||||||
|
<!ENTITY purpose "Control interface for the desktop 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; <&email;></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>§ion;</manvolnum>
|
||||||
|
</refmeta>
|
||||||
|
<refnamediv>
|
||||||
|
<refname>&name;</refname>
|
||||||
|
<refpurpose>&purpose;</refpurpose>
|
||||||
|
</refnamediv>
|
||||||
|
<refsynopsisdiv>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>&name;</command>
|
||||||
|
<group choice="plain">
|
||||||
|
<arg choice="plain">-B</arg>
|
||||||
|
<arg choice="plain">-S</arg>
|
||||||
|
<arg choice="plain">-T</arg>
|
||||||
|
<arg choice="plain">-b</arg>
|
||||||
|
<arg choice="plain">-t</arg>
|
||||||
|
</group>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</refsynopsisdiv>
|
||||||
|
<refsect1 id="description">
|
||||||
|
<title>Description</title>
|
||||||
|
<para><command>&name;</command> is a control interface for the desktop panel.
|
||||||
|
It can hide and show different elements of the panel individually, including
|
||||||
|
the preferences window.</para>
|
||||||
|
</refsect1>
|
||||||
|
<refsect1 id="options">
|
||||||
|
<title>Options</title>
|
||||||
|
<para>The following options are available:</para>
|
||||||
|
<variablelist>
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-B</option></term>
|
||||||
|
<listitem>
|
||||||
|
<para>Show the bottom panel.</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-S</option></term>
|
||||||
|
<listitem>
|
||||||
|
<para>Display the preferences window.</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-T</option></term>
|
||||||
|
<listitem>
|
||||||
|
<para>Show the top panel.</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-b</option></term>
|
||||||
|
<listitem>
|
||||||
|
<para>Hide the bottom panel.</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-t</option></term>
|
||||||
|
<listitem>
|
||||||
|
<para>Hide the top panel.</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>panel-notify</refentrytitle>
|
||||||
|
<manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>
|
||||||
|
</para>
|
||||||
|
</refsect1>
|
||||||
|
</refentry>
|
||||||
|
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
targets=panel.1,panel.html
|
targets=panel.1,panel.html,panelctl.1,panelctl.html,panel-notify.1,panel-notify.html
|
||||||
dist=Makefile,docbook.sh,panel.xml
|
dist=Makefile,docbook.sh,panel.xml,panelctl.xml,panel-notify.xml
|
||||||
|
|
||||||
[panel.1]
|
[panel.1]
|
||||||
type=script
|
type=script
|
||||||
|
|
@ -12,3 +12,27 @@ type=script
|
||||||
script=./docbook.sh
|
script=./docbook.sh
|
||||||
install=
|
install=
|
||||||
depends=panel.xml
|
depends=panel.xml
|
||||||
|
|
||||||
|
[panelctl.1]
|
||||||
|
type=script
|
||||||
|
script=./docbook.sh
|
||||||
|
install=
|
||||||
|
depends=panelctl.xml
|
||||||
|
|
||||||
|
[panelctl.html]
|
||||||
|
type=script
|
||||||
|
script=./docbook.sh
|
||||||
|
install=
|
||||||
|
depends=panelctl.xml
|
||||||
|
|
||||||
|
[panel-notify.1]
|
||||||
|
type=script
|
||||||
|
script=./docbook.sh
|
||||||
|
install=
|
||||||
|
depends=panel-notify.xml
|
||||||
|
|
||||||
|
[panel-notify.html]
|
||||||
|
type=script
|
||||||
|
script=./docbook.sh
|
||||||
|
install=
|
||||||
|
depends=panel-notify.xml
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user