Added a manual page to the Surfer project
This commit is contained in:
parent
fc35803b67
commit
12f0918a49
6
Makefile
6
Makefile
@ -1,6 +1,6 @@
|
||||
PACKAGE = Surfer
|
||||
VERSION = 0.2.5
|
||||
SUBDIRS = data po src tools
|
||||
SUBDIRS = data doc po src tools
|
||||
RM ?= rm -f
|
||||
LN ?= ln -f
|
||||
TAR ?= tar -czvf
|
||||
@ -31,6 +31,10 @@ dist:
|
||||
$(PACKAGE)-$(VERSION)/data/24x24/Makefile \
|
||||
$(PACKAGE)-$(VERSION)/data/24x24/surfer-view-html-source.png \
|
||||
$(PACKAGE)-$(VERSION)/data/24x24/project.conf \
|
||||
$(PACKAGE)-$(VERSION)/doc/Makefile \
|
||||
$(PACKAGE)-$(VERSION)/doc/docbook.sh \
|
||||
$(PACKAGE)-$(VERSION)/doc/surfer.xml \
|
||||
$(PACKAGE)-$(VERSION)/doc/project.conf \
|
||||
$(PACKAGE)-$(VERSION)/po/Makefile \
|
||||
$(PACKAGE)-$(VERSION)/po/gettext.sh \
|
||||
$(PACKAGE)-$(VERSION)/po/POTFILES \
|
||||
|
||||
2
doc/.cvsignore
Normal file
2
doc/.cvsignore
Normal file
@ -0,0 +1,2 @@
|
||||
surfer.1
|
||||
surfer.html
|
||||
32
doc/Makefile
Normal file
32
doc/Makefile
Normal file
@ -0,0 +1,32 @@
|
||||
TARGETS = surfer.1 surfer.html
|
||||
PREFIX = /usr/local
|
||||
DESTDIR =
|
||||
RM ?= rm -f
|
||||
LN ?= ln -f
|
||||
MKDIR ?= mkdir -p
|
||||
INSTALL ?= install
|
||||
|
||||
|
||||
all: $(TARGETS)
|
||||
|
||||
surfer.1: surfer.xml
|
||||
./docbook.sh -P "$(PREFIX)" -- "surfer.1"
|
||||
|
||||
surfer.html: surfer.xml
|
||||
./docbook.sh -P "$(PREFIX)" -- "surfer.html"
|
||||
|
||||
clean:
|
||||
$(RM) -- $(surfer.1_OBJS) $(surfer.html_OBJS)
|
||||
|
||||
distclean: clean
|
||||
$(RM) -- $(TARGETS)
|
||||
|
||||
install: $(TARGETS)
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "surfer.1"
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "surfer.html"
|
||||
|
||||
uninstall:
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "surfer.1"
|
||||
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "surfer.html"
|
||||
|
||||
.PHONY: all clean distclean install uninstall
|
||||
130
doc/docbook.sh
Executable file
130
doc/docbook.sh
Executable file
@ -0,0 +1,130 @@
|
||||
#!/bin/sh
|
||||
#$Id$
|
||||
#Copyright (c) 2012 Pierre Pronchery <khorben@defora.org>
|
||||
#
|
||||
#Redistribution and use in source and binary forms, with or without
|
||||
#modification, are permitted provided that the following conditions are met:
|
||||
#
|
||||
# * Redistributions of source code must retain the above copyright notice, this
|
||||
# list of conditions and the following disclaimer.
|
||||
# * Redistributions in binary form must reproduce the above copyright notice,
|
||||
# this list of conditions and the following disclaimer in the documentation
|
||||
# and/or other materials provided with the distribution.
|
||||
#
|
||||
#THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
#AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
#IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
#DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
#FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
#DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
#SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
#CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
#OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
#OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
|
||||
#variables
|
||||
PREFIX="/usr/local"
|
||||
. "../config.sh"
|
||||
DEBUG="_debug"
|
||||
INSTALL="install -m 0644"
|
||||
MKDIR="mkdir -p"
|
||||
RM="rm -f"
|
||||
XSLTPROC="xsltproc --nonet --xinclude"
|
||||
|
||||
|
||||
#functions
|
||||
#debug
|
||||
_debug()
|
||||
{
|
||||
echo $@
|
||||
$@
|
||||
}
|
||||
|
||||
|
||||
#usage
|
||||
_usage()
|
||||
{
|
||||
echo "Usage: docbook.sh [-i|-u][-P prefix] target" 1>&2
|
||||
return 1
|
||||
}
|
||||
|
||||
|
||||
#main
|
||||
install=0
|
||||
uninstall=0
|
||||
while getopts "iuP:" "name"; do
|
||||
case "$name" in
|
||||
i)
|
||||
uninstall=0
|
||||
install=1
|
||||
;;
|
||||
u)
|
||||
install=0
|
||||
uninstall=1
|
||||
;;
|
||||
P)
|
||||
PREFIX="$2"
|
||||
;;
|
||||
?)
|
||||
_usage
|
||||
exit $?
|
||||
;;
|
||||
esac
|
||||
done
|
||||
shift $((OPTIND - 1))
|
||||
if [ $# -eq 0 ]; then
|
||||
_usage
|
||||
exit $?
|
||||
fi
|
||||
|
||||
[ -z "$DATADIR" ] && DATADIR="$PREFIX/share"
|
||||
[ -z "$MANDIR" ] && MANDIR="$DATADIR/man"
|
||||
|
||||
while [ $# -gt 0 ]; do
|
||||
target="$1"
|
||||
source="${target%.*}.xml"
|
||||
shift
|
||||
|
||||
#determine the type
|
||||
ext="${target##*.}"
|
||||
ext="${ext##.}"
|
||||
case "$ext" in
|
||||
html)
|
||||
XSL="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"
|
||||
[ -f "${target%.*}.xsl" ] && XSL="${target%.*}.xsl"
|
||||
instdir="$DATADIR/doc/$ext/$PACKAGE"
|
||||
;;
|
||||
1|2|3|4|5|6|7|8|9)
|
||||
XSL="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
|
||||
instdir="$MANDIR/man$ext"
|
||||
;;
|
||||
*)
|
||||
echo "$0: $target: Unknown type" 1>&2
|
||||
exit 2
|
||||
;;
|
||||
esac
|
||||
|
||||
#uninstall
|
||||
if [ "$uninstall" -eq 1 ]; then
|
||||
$DEBUG $RM -- "$instdir/$target" || exit 2
|
||||
continue
|
||||
fi
|
||||
|
||||
#install
|
||||
if [ "$install" -eq 1 ]; then
|
||||
$DEBUG $MKDIR -- "$instdir" || exit 2
|
||||
$DEBUG $INSTALL -- "$target" "$instdir/$target" || exit 2
|
||||
continue
|
||||
fi
|
||||
|
||||
#create
|
||||
$DEBUG $XSLTPROC -o "$target" "$XSL" "$source"
|
||||
#XXX ignore errors
|
||||
if [ $? -ne 0 ]; then
|
||||
echo "$0: $target: Could not create page" 1>&2
|
||||
$RM -- "$target"
|
||||
break
|
||||
fi
|
||||
done
|
||||
14
doc/project.conf
Normal file
14
doc/project.conf
Normal file
@ -0,0 +1,14 @@
|
||||
targets=surfer.1,surfer.html
|
||||
dist=Makefile,docbook.sh,surfer.xml
|
||||
|
||||
[surfer.1]
|
||||
type=script
|
||||
script=./docbook.sh
|
||||
install=
|
||||
depends=surfer.xml
|
||||
|
||||
[surfer.html]
|
||||
type=script
|
||||
script=./docbook.sh
|
||||
install=
|
||||
depends=surfer.xml
|
||||
79
doc/surfer.xml
Normal file
79
doc/surfer.xml
Normal file
@ -0,0 +1,79 @@
|
||||
<?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 "surfer">
|
||||
<!ENTITY purpose "Web browser">
|
||||
]>
|
||||
<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 rep="repeat"><replaceable>URL</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
<refsect1 id="description">
|
||||
<title>Description</title>
|
||||
<para><command>&name;</command> is a web browser for the desktop.</para>
|
||||
</refsect1>
|
||||
<refsect1 id="options">
|
||||
<title>Options</title>
|
||||
<para>A list of Internet addresses to browse to can 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/340/Surfer"/>.</para>
|
||||
</refsect1>
|
||||
<refsect1 id="see_also">
|
||||
<title>See also</title>
|
||||
<para>
|
||||
<citerefentry>
|
||||
<refentrytitle>download</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->
|
||||
@ -3,4 +3,4 @@ version=0.2.5
|
||||
config=h,sh
|
||||
dist=Makefile,COPYING,config.h,config.sh
|
||||
|
||||
subdirs=data,po,src,tools
|
||||
subdirs=data,doc,po,src,tools
|
||||
|
||||
@ -313,8 +313,8 @@ void on_help_contents(gpointer data)
|
||||
char buf[256];
|
||||
Surfer * s;
|
||||
|
||||
snprintf(buf, sizeof(buf), "%s%s%s%s%s%s", "file://" DATADIR,
|
||||
"/doc/html/", PACKAGE, "/", PACKAGE, ".html");
|
||||
snprintf(buf, sizeof(buf), "%s",
|
||||
"file://" DATADIR "/doc/html/" PACKAGE "/surfer.html");
|
||||
s = surfer_new(buf);
|
||||
}
|
||||
#endif /* !EMBEDDED */
|
||||
|
||||
Loading…
Reference in New Issue
Block a user