Write a manual page for htmlapp(1)

This commit is contained in:
Pierre Pronchery 2015-04-18 16:13:39 +02:00
parent 1bd3d393aa
commit c827ccd9c2
3 changed files with 126 additions and 2 deletions

7
doc/htmlapp.css.xml Normal file
View File

@ -0,0 +1,7 @@
<?xml version="1.0"?>
<!-- $Id$ -->
<!DOCTYPE style [
<!ENTITY manual "manual.css.xml">
]>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="&manual;"/>
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->

105
doc/htmlapp.xml Normal file
View File

@ -0,0 +1,105 @@
<?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 "Surfer User Manual">
<!ENTITY package "DeforaOS Surfer">
<!ENTITY name "htmlapp">
<!ENTITY purpose "HTML application 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>2015</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>-J</option></arg>
<arg choice="opt"><option>-j</option></arg>
<arg>command</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para><command>&name;</command> is an HTML application viewer for the
desktop.</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<para>The path to a remote or local HTML application can be specified on the
command line.</para>
<para>The following options are available:</para>
<variablelist>
<varlistentry>
<term><option>-J</option></term>
<listitem>
<para>Disable Javascript support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-j</option></term>
<listitem>
<para>Enable Javascript support (default).</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/340/Surfer"/>.</para>
</refsect1>
<refsect1 id="see_also">
<title>See also</title>
<para>
<citerefentry>
<refentrytitle>download</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>helper</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>surfer</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=download.1,download.html,helper.1,helper.html,surfer.1,surfer.html
dist=Makefile,docbook.sh,download.css.xml,download.xml,helper.css.xml,helper.xml,manual.css.xml,surfer.css.xml,surfer.xml
targets=download.1,download.html,helper.1,helper.html,htmlapp.1,htmlapp.html,surfer.1,surfer.html
dist=Makefile,docbook.sh,download.css.xml,download.xml,helper.css.xml,helper.xml,htmlapp.css.xml,htmlapp.xml,manual.css.xml,surfer.css.xml,surfer.xml
[download.1]
type=script
@ -25,6 +25,18 @@ script=./docbook.sh
install=
depends=helper.css.xml,helper.xml,manual.css.xml
[htmlapp.1]
type=script
script=./docbook.sh
install=
depends=htmlapp.xml
[htmlapp.html]
type=script
script=./docbook.sh
install=
depends=htmlapp.css.xml,htmlapp.xml,manual.css.xml
[surfer.1]
type=script
script=./docbook.sh