Added a manual page for gallery(1)

This commit is contained in:
Pierre Pronchery 2013-03-02 00:10:07 +01:00
parent c73ae1eb7e
commit c2c3fd25b9
4 changed files with 110 additions and 5 deletions

View File

@ -28,6 +28,7 @@ dist:
$(PACKAGE)-$(VERSION)/doc/Makefile \ $(PACKAGE)-$(VERSION)/doc/Makefile \
$(PACKAGE)-$(VERSION)/doc/docbook.sh \ $(PACKAGE)-$(VERSION)/doc/docbook.sh \
$(PACKAGE)-$(VERSION)/doc/camera.xml \ $(PACKAGE)-$(VERSION)/doc/camera.xml \
$(PACKAGE)-$(VERSION)/doc/gallery.xml \
$(PACKAGE)-$(VERSION)/doc/project.conf \ $(PACKAGE)-$(VERSION)/doc/project.conf \
$(PACKAGE)-$(VERSION)/po/Makefile \ $(PACKAGE)-$(VERSION)/po/Makefile \
$(PACKAGE)-$(VERSION)/po/gettext.sh \ $(PACKAGE)-$(VERSION)/po/gettext.sh \

View File

@ -1,4 +1,4 @@
TARGETS = camera.1 camera.html TARGETS = camera.1 camera.html gallery.1 gallery.html
PREFIX = /usr/local PREFIX = /usr/local
DESTDIR = DESTDIR =
RM = rm -f RM = rm -f
@ -15,9 +15,15 @@ camera.1: camera.xml
camera.html: camera.xml camera.html: camera.xml
./docbook.sh -P "$(PREFIX)" -- "camera.html" ./docbook.sh -P "$(PREFIX)" -- "camera.html"
gallery.1: gallery.xml
./docbook.sh -P "$(PREFIX)" -- "gallery.1"
gallery.html: gallery.xml
./docbook.sh -P "$(PREFIX)" -- "gallery.html"
clean: clean:
$(RM) -- $(camera.1_OBJS) $(camera.html_OBJS) $(RM) -- $(camera.1_OBJS) $(camera.html_OBJS) $(gallery.1_OBJS) $(gallery.html_OBJS)
./docbook.sh -c -P "$(PREFIX)" -- "camera.html" ./docbook.sh -c -P "$(PREFIX)" -- "gallery.html"
distclean: clean distclean: clean
$(RM) -- $(TARGETS) $(RM) -- $(TARGETS)
@ -25,9 +31,13 @@ distclean: clean
install: $(TARGETS) install: $(TARGETS)
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "camera.1" ./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "camera.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "camera.html" ./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "camera.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "gallery.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "gallery.html"
uninstall: uninstall:
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "camera.1" ./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "camera.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "camera.html" ./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "camera.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "gallery.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "gallery.html"
.PHONY: all clean distclean install uninstall .PHONY: all clean distclean install uninstall

82
doc/gallery.xml Normal file
View File

@ -0,0 +1,82 @@
<?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 "Camera User Manual">
<!ENTITY package "DeforaOS Camera">
<!ENTITY name "gallery">
<!ENTITY purpose "Quick access to the picture gallery">
]>
<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>2013</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>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para><command>&name;</command> is a webcam application, with the ability to
take pictures.</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<para>This program does not accept any options from the command line.</para>
</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/3997/Camera"/>.</para>
</refsect1>
<refsect1 id="see_also">
<title>See also</title>
<para>
<citerefentry>
<refentrytitle>browser</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>camera</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->

View File

@ -1,5 +1,5 @@
targets=camera.1,camera.html targets=camera.1,camera.html,gallery.1,gallery.html
dist=Makefile,docbook.sh,camera.xml dist=Makefile,docbook.sh,camera.xml,gallery.xml
[camera.1] [camera.1]
type=script type=script
@ -12,3 +12,15 @@ type=script
script=./docbook.sh script=./docbook.sh
install= install=
depends=camera.xml depends=camera.xml
[gallery.1]
type=script
script=./docbook.sh
install=
depends=gallery.xml
[gallery.html]
type=script
script=./docbook.sh
install=
depends=gallery.xml