Added a manual page for "desktop" as well
This commit is contained in:
parent
f8b0d1ac39
commit
cf48930667
1
Makefile
1
Makefile
|
|
@ -35,6 +35,7 @@ dist:
|
|||
$(PACKAGE)-$(VERSION)/doc/Makefile \
|
||||
$(PACKAGE)-$(VERSION)/doc/docbook.sh \
|
||||
$(PACKAGE)-$(VERSION)/doc/browser.xml \
|
||||
$(PACKAGE)-$(VERSION)/doc/desktop.xml \
|
||||
$(PACKAGE)-$(VERSION)/doc/project.conf \
|
||||
$(PACKAGE)-$(VERSION)/include/Browser.h \
|
||||
$(PACKAGE)-$(VERSION)/include/Makefile \
|
||||
|
|
|
|||
14
doc/Makefile
14
doc/Makefile
|
|
@ -1,4 +1,4 @@
|
|||
TARGETS = browser.1 browser.html
|
||||
TARGETS = browser.1 browser.html desktop.1 desktop.html
|
||||
PREFIX = /usr/local
|
||||
DESTDIR =
|
||||
RM ?= rm -f
|
||||
|
|
@ -15,8 +15,14 @@ browser.1: browser.xml
|
|||
browser.html: browser.xml
|
||||
./docbook.sh -P "$(PREFIX)" -- "browser.html"
|
||||
|
||||
desktop.1: desktop.xml
|
||||
./docbook.sh -P "$(PREFIX)" -- "desktop.1"
|
||||
|
||||
desktop.html: desktop.xml
|
||||
./docbook.sh -P "$(PREFIX)" -- "desktop.html"
|
||||
|
||||
clean:
|
||||
$(RM) -- $(browser.1_OBJS) $(browser.html_OBJS)
|
||||
$(RM) -- $(browser.1_OBJS) $(browser.html_OBJS) $(desktop.1_OBJS) $(desktop.html_OBJS)
|
||||
|
||||
distclean: clean
|
||||
$(RM) -- $(TARGETS)
|
||||
|
|
@ -24,9 +30,13 @@ distclean: clean
|
|||
install: $(TARGETS)
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "browser.1"
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "browser.html"
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktop.1"
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "desktop.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"
|
||||
|
||||
.PHONY: all clean distclean install uninstall
|
||||
|
|
|
|||
|
|
@ -69,10 +69,24 @@
|
|||
</refsect1>
|
||||
<refsect1 id="see_also">
|
||||
<title>See also</title>
|
||||
<para><citerefentry>
|
||||
<para>
|
||||
<citerefentry>
|
||||
<refentrytitle>copy</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</citerefentry>,
|
||||
<citerefentry>
|
||||
<refentrytitle>delete</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</citerefentry>,
|
||||
<citerefentry>
|
||||
<refentrytitle>desktop</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</citerefentry></para>
|
||||
</citerefentry>,
|
||||
<citerefentry>
|
||||
<refentrytitle>move</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->
|
||||
|
|
|
|||
142
doc/desktop.xml
Normal file
142
doc/desktop.xml
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
<?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 "desktop">
|
||||
<!ENTITY purpose "File manager and image viewer">
|
||||
]>
|
||||
<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"><option>-H</option>
|
||||
| <option>-V</option></arg>
|
||||
<arg choice="opt"><option>-a</option>
|
||||
| <option>-c</option>
|
||||
| <option>-f</option>
|
||||
| <option>-h</option>
|
||||
| <option>-n</option></arg>
|
||||
<arg choice="opt"><option>-m</option>
|
||||
<replaceable>monitor</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
<refsect1 id="description">
|
||||
<title>Description</title>
|
||||
<para><command>&name;</command> is a desktop manager. It can set the
|
||||
background picture and handle icons on the desktop.</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>-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. This is the default
|
||||
behavior.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-h</option></term>
|
||||
<listitem>
|
||||
<para>Display the homescreen.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-m</option></term>
|
||||
<listitem>
|
||||
<para>Monitor where to display the desktop.</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>desktopctl</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
targets=browser.1,browser.html
|
||||
dist=Makefile,docbook.sh,browser.xml
|
||||
targets=browser.1,browser.html,desktop.1,desktop.html
|
||||
dist=Makefile,docbook.sh,browser.xml,desktop.xml
|
||||
|
||||
[browser.1]
|
||||
type=script
|
||||
|
|
@ -12,3 +12,15 @@ type=script
|
|||
script=./docbook.sh
|
||||
install=
|
||||
depends=browser.xml
|
||||
|
||||
[desktop.1]
|
||||
type=script
|
||||
script=./docbook.sh
|
||||
install=
|
||||
depends=desktop.xml
|
||||
|
||||
[desktop.html]
|
||||
type=script
|
||||
script=./docbook.sh
|
||||
install=
|
||||
depends=desktop.xml
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user