Added a manual page for view(1)

This commit is contained in:
Pierre Pronchery 2012-06-25 01:16:58 +00:00
parent 921a6878bb
commit e132e19ced
10 changed files with 145 additions and 4 deletions

View File

@ -39,6 +39,7 @@ dist:
$(PACKAGE)-$(VERSION)/doc/desktopctl.xml \
$(PACKAGE)-$(VERSION)/doc/open.xml \
$(PACKAGE)-$(VERSION)/doc/properties.xml \
$(PACKAGE)-$(VERSION)/doc/view.xml \
$(PACKAGE)-$(VERSION)/doc/project.conf \
$(PACKAGE)-$(VERSION)/include/Browser.h \
$(PACKAGE)-$(VERSION)/include/Makefile \

View File

@ -8,3 +8,5 @@ open.1
open.html
properties.1
properties.html
view.1
view.html

View File

@ -1,4 +1,4 @@
TARGETS = browser.1 browser.html desktop.1 desktop.html desktopctl.1 desktopctl.html open.1 open.html properties.1 properties.html
TARGETS = browser.1 browser.html desktop.1 desktop.html desktopctl.1 desktopctl.html open.1 open.html properties.1 properties.html view.1 view.html
PREFIX = /usr/local
DESTDIR =
RM ?= rm -f
@ -39,8 +39,14 @@ properties.1: properties.xml
properties.html: properties.xml
./docbook.sh -P "$(PREFIX)" -- "properties.html"
view.1: view.xml
./docbook.sh -P "$(PREFIX)" -- "view.1"
view.html: view.xml
./docbook.sh -P "$(PREFIX)" -- "view.html"
clean:
$(RM) -- $(browser.1_OBJS) $(browser.html_OBJS) $(desktop.1_OBJS) $(desktop.html_OBJS) $(desktopctl.1_OBJS) $(desktopctl.html_OBJS) $(open.1_OBJS) $(open.html_OBJS) $(properties.1_OBJS) $(properties.html_OBJS)
$(RM) -- $(browser.1_OBJS) $(browser.html_OBJS) $(desktop.1_OBJS) $(desktop.html_OBJS) $(desktopctl.1_OBJS) $(desktopctl.html_OBJS) $(open.1_OBJS) $(open.html_OBJS) $(properties.1_OBJS) $(properties.html_OBJS) $(view.1_OBJS) $(view.html_OBJS)
distclean: clean
$(RM) -- $(TARGETS)
@ -56,6 +62,8 @@ install: $(TARGETS)
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "open.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "properties.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "properties.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "view.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "view.html"
uninstall:
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "browser.1"
@ -68,5 +76,7 @@ uninstall:
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "open.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "properties.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "properties.html"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "view.1"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "view.html"
.PHONY: all clean distclean install uninstall

View File

@ -97,6 +97,10 @@
<citerefentry>
<refentrytitle>properties</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>view</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>

View File

@ -143,6 +143,10 @@
<citerefentry>
<refentrytitle>properties</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>view</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>

View File

@ -172,6 +172,10 @@
<citerefentry>
<refentrytitle>properties</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>view</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>

View File

@ -102,6 +102,10 @@
<citerefentry>
<refentrytitle>properties</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>view</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>

View File

@ -1,5 +1,5 @@
targets=browser.1,browser.html,desktop.1,desktop.html,desktopctl.1,desktopctl.html,open.1,open.html,properties.1,properties.html
dist=Makefile,docbook.sh,browser.xml,desktop.xml,desktopctl.xml,open.xml,properties.xml
targets=browser.1,browser.html,desktop.1,desktop.html,desktopctl.1,desktopctl.html,open.1,open.html,properties.1,properties.html,view.1,view.html
dist=Makefile,docbook.sh,browser.xml,desktop.xml,desktopctl.xml,open.xml,properties.xml,view.xml
[browser.1]
type=script
@ -60,3 +60,15 @@ type=script
script=./docbook.sh
install=
depends=properties.xml
[view.1]
type=script
script=./docbook.sh
install=
depends=view.xml
[view.html]
type=script
script=./docbook.sh
install=
depends=view.xml

View File

@ -91,6 +91,10 @@
<citerefentry>
<refentrytitle>open</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>view</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>

96
doc/view.xml Normal file
View File

@ -0,0 +1,96 @@
<?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 "view">
<!ENTITY purpose "Generic document 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; &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="plain" rep="repeat"><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para><command>&name;</command> displays a simple preview of documents when it
can.</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<para>A list of documents to visualize must be provided directly on 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/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>,
<citerefentry>
<refentrytitle>desktopctl</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>open</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>properties</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->