Skip to content

Commit

Permalink
renewed autotools config and added stuff related to the programmer's …
Browse files Browse the repository at this point in the history
…guide
  • Loading branch information
georgesk committed Oct 27, 2013
1 parent 0ee82b1 commit 593bbfd
Show file tree
Hide file tree
Showing 18 changed files with 2,960 additions and 725 deletions.
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ install:
$(DESTDIR)/usr/share/icons/expeyes.png
install -m 644 pixmaps/expeyes-junior-icon.png \
$(DESTDIR)/usr/share/icons
install -m 644 pixmaps/expeyes-progman-jr-doc.png \
$(DESTDIR)/usr/share/icons
install -m 644 pixmaps/nuclear-icon.png \
$(DESTDIR)/usr/share/icons
install -d $(DESTDIR)/usr/share/applications
Expand Down Expand Up @@ -58,6 +60,8 @@ clean:
make -C $$d distclean; \
fi; \
done
# temporary fix for unauthorized symlinks in the source package
rm -f webeyes-1.0/jquery*


.PHONY: all install clean
9 changes: 7 additions & 2 deletions bin/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,18 @@ DESTDIR=
DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/docbook-xsl/manpages/docbook.xsl
XP = xsltproc --nonet --param man.charmap.use.subset "0"

all: expeyes.1 expeyes-junior.1 expeyes-doc.1
all: expeyes.1 expeyes-junior.1 expeyes-doc.1 expeyes-progman-jr-doc.1

expeyes.1: expeyes-man.xml
$(XP) $(DB2MAN) $<

expeyes-junior.1: expeyes-junior-man.xml
$(XP) $(DB2MAN) $<

expeyes-doc.1: expeyes-junior-doc.xml
expeyes-doc.1: expeyes-doc.xml
$(XP) $(DB2MAN) $<

expeyes-progman-jr-doc.1: expeyes-progman-jr-doc.xml
$(XP) $(DB2MAN) $<

clean:
Expand All @@ -22,10 +25,12 @@ install:
gzip -c9 expeyes-junior.1 > $(DESTDIR)/usr/share/man/man1/expeyes-junior.1.gz
gzip -c9 expeyes-doc.1 > $(DESTDIR)/usr/share/man/man1/expeyes-doc.1.gz
ln -s expeyes-doc.1.gz $(DESTDIR)/usr/share/man/man1/expeyes-junior-doc.1.gz
gzip -c9 expeyes-progman-jr-doc.1 > $(DESTDIR)/usr/share/man/man1/expeyes-progman-jr-doc.1.gz
install -d $(DESTDIR)/usr/bin
install -m 755 expeyes $(DESTDIR)/usr/bin
install -m 755 expeyes-junior $(DESTDIR)/usr/bin
install -m 755 expeyes-doc $(DESTDIR)/usr/bin
install -m 755 expeyes-progman-jr-doc $(DESTDIR)/usr/bin
ln -s expeyes-doc $(DESTDIR)/usr/bin/expeyes-junior-doc

.PHONY: all clean install
24 changes: 24 additions & 0 deletions bin/expeyes-progman-jr-doc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#! /usr/bin/python

import sys, os, os.path
from subprocess import call

lang = os.environ.get('LANG')
language = os.environ.get('LANGUAGE')
lc_all = os.environ.get('LC_ALL')

preferred='en'
if language and language[0:2] != preferred:
preferred=language[0:2]
elif lang and lang[0:2] != preferred:
preferred=lang[0:2]
elif lc_all and lc_all[0:2] != preferred:
preferred=lc_all[0:2]
if len(sys.argv)>1:
preferred=sys.argv[1]

pdfTail='eyesj-progman.pdf'
filename=os.path.join('/usr/share/expeyes/doc', preferred+'-'+pdfTail)
if not os.path.exists(filename):
filename=os.path.join('/usr/share/expeyes/doc', 'en-'+pdfTail)
call('evince '+filename, shell=True)
165 changes: 165 additions & 0 deletions bin/expeyes-progman-jr-doc.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!--

`xsltproc -''-nonet \
-''-param man.charmap.use.subset "0" \
-''-param make.year.ranges "1" \
-''-param make.single.year.ranges "1" \
/usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
manpage.xml'

A manual page <package>.<section> will be generated. You may view the
manual page with: nroff -man <package>.<section> | less'. A typical entry
in a Makefile or Makefile.am is:

DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/docbook-xsl/manpages/docbook.xsl
XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0"

manpage.1: manpage.xml
$(XP) $(DB2MAN) $<

The xsltproc binary is found in the xsltproc package. The XSL files are in
docbook-xsl. A description of the parameters you can use can be found in the
docbook-xsl-doc-* packages. Please remember that if you create the nroff
version in one of the debian/rules file targets (such as build), you will need
to include xsltproc and docbook-xsl in your Build-Depends control field.
Alternatively use the xmlto command/package. That will also automatically
pull in xsltproc and docbook-xsl.

Notes for using docbook2x: docbook2x-man does not automatically create the
AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
<refsect1> ... </refsect1>.

To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
found in the docbook-xsl-doc-html package.

Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`

General documentation about man-pages and man-page-formatting:
man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/

-->

<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "Georges">
<!ENTITY dhsurname "Khaznadar">
<!-- dhusername could also be set to "&dhfirstname; &dhsurname;". -->
<!ENTITY dhusername "Georges Khaznadar">
<!ENTITY dhemail "georgesk@ofset.org">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1) and
http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
<!ENTITY dhsection "1">
<!-- TITLE should be something like "User commands" or similar (see
http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
<!ENTITY dhtitle "expEYES Jr Programmer's Manual">
<!ENTITY dhucpackage "EXPEYES-PROGMAN-JR-DOC">
<!ENTITY dhpackage "expeyes-progman-jr-doc">
]>

<refentry>
<refentryinfo>
<title>&dhtitle;</title>
<productname>&dhpackage;</productname>
<authorgroup>
<author>
<firstname>&dhfirstname;</firstname>
<surname>&dhsurname;</surname>
<contrib>Wrote this manpage for the Debian system.</contrib>
<address>
<email>&dhemail;</email>
</address>
</author>
</authorgroup>
<copyright>
<year>2013</year>
<holder>&dhusername;</holder>
</copyright>
<legalnotice>
<para>This manual page was written for the Debian system
(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 2 or (at your option) any later version published by
the Free Software Foundation.</para>
<para>On Debian systems, the complete text of the GNU General Public
License can be found in
<filename>/usr/share/common-licenses/GPL</filename>.</para>
</legalnotice>
</refentryinfo>
<refmeta>
<refentrytitle>&dhucpackage;</refentrytitle>
<manvolnum>&dhsection;</manvolnum>
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>program to display the user manual of expeyes and
expeyes-junior.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg choice="opt">
<replaceable class="option">lang</replaceable>
</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>expeyes-junior-doc</command>
<arg choice="opt">
<replaceable class="option">lang</replaceable>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> launches a viewer for the
programmer's manual of expEYES Jr.</para>
<para> The preferred language is detected automatically.</para>
</refsect1>
<refsect1 id="options">
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option><replaceable>lang</replaceable></option></term>
<listitem>
<para>Enforces the language <replaceable>lang</replaceable> as
preferred. For example, <replaceable>lang</replaceable> may be
'en' or 'fr'.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="environment">
<title>ENVIRONMENT</title>
<variablelist>
<varlistentry>
<term><envar>LANGUAGE</envar></term>
<term><envar>LANG</envar></term>
<term><envar>LC_ALL</envar></term>
<listitem>
<para>If defined, these variables are taken in account to
find automatically the preferred language. These variables are
taken in account only when the optional argument
<replaceable>lang</replaceable> is not given.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="see_also">
<title>SEE ALSO</title>
<!-- In alpabetical order. -->
<para><citerefentry>
<refentrytitle>expeyes</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>expeyes-junior</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>

Loading

0 comments on commit 593bbfd

Please sign in to comment.