From 20503bc1f4e416b97b237996fbcf1d0684674da4 Mon Sep 17 00:00:00 2001
From: Pierre Pronchery <khorben@defora.org>
Date: Wed, 20 Jun 2012 21:59:07 +0000
Subject: [PATCH] Wrote a manual page for desktopctl(1) as well

---
 Makefile           |   1 +
 doc/.cvsignore     |   2 +
 doc/Makefile       |  14 +++-
 doc/desktopctl.xml | 169 +++++++++++++++++++++++++++++++++++++++++++++
 doc/project.conf   |  16 ++++-
 5 files changed, 198 insertions(+), 4 deletions(-)
 create mode 100644 doc/desktopctl.xml

diff --git a/Makefile b/Makefile
index d450144..538a3bc 100644
--- a/Makefile
+++ b/Makefile
@@ -36,6 +36,7 @@ dist:
 		$(PACKAGE)-$(VERSION)/doc/docbook.sh \
 		$(PACKAGE)-$(VERSION)/doc/browser.xml \
 		$(PACKAGE)-$(VERSION)/doc/desktop.xml \
+		$(PACKAGE)-$(VERSION)/doc/desktopctl.xml \
 		$(PACKAGE)-$(VERSION)/doc/project.conf \
 		$(PACKAGE)-$(VERSION)/include/Browser.h \
 		$(PACKAGE)-$(VERSION)/include/Makefile \
diff --git a/doc/.cvsignore b/doc/.cvsignore
index 3d42a16..99abaad 100644
--- a/doc/.cvsignore
+++ b/doc/.cvsignore
@@ -2,3 +2,5 @@ browser.1
 browser.html
 desktop.1
 desktop.html
+desktopctl.1
+desktopctl.html
diff --git a/doc/Makefile b/doc/Makefile
index a2b8a70..c87ad62 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,4 +1,4 @@
-TARGETS	= browser.1 browser.html desktop.1 desktop.html
+TARGETS	= browser.1 browser.html desktop.1 desktop.html desktopctl.1 desktopctl.html
 PREFIX	= /usr/local
 DESTDIR	=
 RM	?= rm -f
@@ -21,8 +21,14 @@ desktop.1: desktop.xml
 desktop.html: desktop.xml
 	./docbook.sh -P "$(PREFIX)" -- "desktop.html"
 
+desktopctl.1: desktopctl.xml
+	./docbook.sh -P "$(PREFIX)" -- "desktopctl.1"
+
+desktopctl.html: desktopctl.xml
+	./docbook.sh -P "$(PREFIX)" -- "desktopctl.html"
+
 clean:
-	$(RM) -- $(browser.1_OBJS) $(browser.html_OBJS) $(desktop.1_OBJS) $(desktop.html_OBJS)
+	$(RM) -- $(browser.1_OBJS) $(browser.html_OBJS) $(desktop.1_OBJS) $(desktop.html_OBJS) $(desktopctl.1_OBJS) $(desktopctl.html_OBJS)
 
 distclean: clean
 	$(RM) -- $(TARGETS)
@@ -32,11 +38,15 @@ install: $(TARGETS)
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "browser.html"
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktop.1"
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktop.html"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktopctl.1"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktopctl.html"
 
 uninstall:
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "browser.1"
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "browser.html"
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "desktop.1"
 	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "desktop.html"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "desktopctl.1"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "desktopctl.html"
 
 .PHONY: all clean distclean install uninstall
diff --git a/doc/desktopctl.xml b/doc/desktopctl.xml
new file mode 100644
index 0000000..945208c
--- /dev/null
+++ b/doc/desktopctl.xml
@@ -0,0 +1,169 @@
+<?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     "Browser User Manual">
+	<!ENTITY package   "DeforaOS Browser">
+	<!ENTITY name      "desktopctl">
+	<!ENTITY purpose   "Control interface for the desktop manager">
+]>
+<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"><option>-H</option>
+				| <option>-L</option>
+				| <option>-P</option>
+				| <option>-R</option>
+				| <option>-S</option>
+				| <option>-T</option>
+				| <option>-V</option>
+				| <option>-a</option>
+				| <option>-c</option>
+				| <option>-f</option>
+				| <option>-h</option>
+				| <option>-n</option></arg>
+		</cmdsynopsis>
+	</refsynopsisdiv>
+	<refsect1 id="description">
+		<title>Description</title>
+		<para><command>&name;</command> is a control interface for the desktop
+			manager. It can trigger events and modify the behavior of the desktop manager
+			with a command line interface, while running.</para>
+	</refsect1>
+	<refsect1 id="options">
+		<title>Options</title>
+		<para>The following options are available:</para>
+		<variablelist>
+			<varlistentry>
+				<term><option>-H</option></term>
+				<listitem>
+					<para>Place icons horizontally.</para>
+				</listitem>
+			</varlistentry>
+			<varlistentry>
+				<term><option>-L</option></term>
+				<listitem>
+					<para>Rotate screen to landscape mode.</para>
+				</listitem>
+			</varlistentry>
+			<varlistentry>
+				<term><option>-P</option></term>
+				<listitem>
+					<para>Rotate screen to portrait mode.</para>
+				</listitem>
+			</varlistentry>
+			<varlistentry>
+				<term><option>-R</option></term>
+				<listitem>
+					<para>Rotate screen.</para>
+				</listitem>
+			</varlistentry>
+			<varlistentry>
+				<term><option>-S</option></term>
+				<listitem>
+					<para>Display or change settings.</para>
+				</listitem>
+			</varlistentry>
+			<varlistentry>
+				<term><option>-T</option></term>
+				<listitem>
+					<para>Toggle screen rotation.</para>
+				</listitem>
+			</varlistentry>
+			<varlistentry>
+				<term><option>-V</option></term>
+				<listitem>
+					<para>Place icons vertically.</para>
+				</listitem>
+			</varlistentry>
+			<varlistentry>
+				<term><option>-a</option></term>
+				<listitem>
+					<para>Display the applications registered.</para>
+				</listitem>
+			</varlistentry>
+			<varlistentry>
+				<term><option>-c</option></term>
+				<listitem>
+					<para>Sort the applications registered by category.</para>
+				</listitem>
+			</varlistentry>
+			<varlistentry>
+				<term><option>-f</option></term>
+				<listitem>
+					<para>Display contents of the desktop folder.</para>
+				</listitem>
+			</varlistentry>
+			<varlistentry>
+				<term><option>-h</option></term>
+				<listitem>
+					<para>Display the homescreen.</para>
+				</listitem>
+			</varlistentry>
+			<varlistentry>
+				<term><option>-n</option></term>
+				<listitem>
+					<para>Do not display icons on the desktop.</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/230/Browser"/>.</para>
+	</refsect1>
+	<refsect1 id="see_also">
+		<title>See also</title>
+		<para>
+			<citerefentry>
+				<refentrytitle>browser</refentrytitle>
+				<manvolnum>1</manvolnum>
+			</citerefentry>,
+			<citerefentry>
+				<refentrytitle>desktop</refentrytitle>
+				<manvolnum>1</manvolnum>
+			</citerefentry>
+		</para>
+	</refsect1>
+</refentry>
+<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->
diff --git a/doc/project.conf b/doc/project.conf
index d238815..ec7a5d6 100644
--- a/doc/project.conf
+++ b/doc/project.conf
@@ -1,5 +1,5 @@
-targets=browser.1,browser.html,desktop.1,desktop.html
-dist=Makefile,docbook.sh,browser.xml,desktop.xml
+targets=browser.1,browser.html,desktop.1,desktop.html,desktopctl.1,desktopctl.html
+dist=Makefile,docbook.sh,browser.xml,desktop.xml,desktopctl.xml
 
 [browser.1]
 type=script
@@ -24,3 +24,15 @@ type=script
 script=./docbook.sh
 install=
 depends=desktop.xml
+
+[desktopctl.1]
+type=script
+script=./docbook.sh
+install=
+depends=desktopctl.xml
+
+[desktopctl.html]
+type=script
+script=./docbook.sh
+install=
+depends=desktopctl.xml