[debian] correct debian packages

Signed-off-by: Jean-Baptiste Note <[email protected]>

ChangeLog

@@ -0,0 +1,8 @@
+2006-10-19  Jean-Baptiste Note  <[email protected]>
+
+	Start to fill in the changelog, essentially so that the debian
+	packages do validate agains lintian.
+
+	* doc/man: add the start of a man page for debit
+
+

Makefile.am

@@ -1,4 +1,4 @@
-SUBDIRS = data debian rpm windows altera utils xiledit desktop
+SUBDIRS = data debian doc rpm windows altera utils xiledit desktop
 
 AM_CPPFLAGS	= -DDATADIR=\"$(pkgdatadir)\"
 AM_CFLAGS	= -Wall -Werror -Wunused -O3 -g
@@ -93,7 +93,7 @@ DOCSOURCES=$(shell find ./ -name '*.c' -or -name '*.h')
 DOXYCONFIG=doc/doxygen.cfg
 DOXYDIR=doc
 
-doc: $(DOCSOURCES) $(DOXYCONFIG)
+doxy: $(DOCSOURCES) $(DOXYCONFIG)
 	doxygen $(DOXYCONFIG) #&& make -C $(DOXYDIR)/latex/
 
 DPKG_SOURCE_EXCLUDE=-i'(trash|.git)' -Itrash -I.git

configure.ac

@@ -82,5 +82,6 @@ AC_CONFIG_FILES([Makefile data/Makefile \
 		altera/Makefile \
 		utils/Makefile utils/correlation/Makefile \
 		xiledit/Makefile \
-		desktop/Makefile desktop/artwork/Makefile])
+		desktop/Makefile desktop/artwork/Makefile
+		doc/Makefile doc/man/Makefile])
 AC_OUTPUT

debian/changelog

@@ -1,6 +1,6 @@
 debit (0.1-1) unstable; urgency=low
 
-  * Initial release (Closes: #nnnn)  <nnnn is the bug number of your ITP>
+  * Initial release
 
  -- Jean-Baptiste Note <[email protected]>  Wed, 19 Jul 2006 15:36:28 +0200
 

debian/control

@@ -1,5 +1,5 @@
 Source: debit
-Section: unstable
+Section: contrib/electronics
 Priority: optional
 Maintainer: Jean-Baptiste Note <[email protected]>
 Build-Depends: debhelper (>= 5), autotools-dev

debian/copyright

@@ -1,22 +1,11 @@
 This package was debianized by Jean-Baptiste Note <[email protected]> on
 Wed, 19 Jul 2006 15:36:28 +0200.
 
-It was downloaded from <fill in http/ftp site>
+It was downloaded from http://www.ulogic.org/trac
 
-Upstream Author: <put author(s) name and email here>
+Upstream Author: Jean-Baptiste Note <[email protected]>
 
-Copyright: <put the year(s) of the copyright, and the names of the
-            copyright holder(s) here>
+Copyright: 2006, Jean-Baptiste Note
 
-License:
-
-<Put the license of the package here>
-
-
-The Debian packaging is (C) 2006, Jean-Baptiste Note <[email protected]> and
-is licensed under the GPL, see `/usr/share/common-licenses/GPL'.
-
-
-# Please also look if there are files or directories which have a
-# different copyright/license attached and list them here.
+License: GPL, see `/usr/share/common-licenses/GPL'
 

doc/man/Makefile.am

@@ -0,0 +1,7 @@
+dist_man1_MANS = debit.1
+
+EXTRA_DIST = debit.xml
+MAINTAINERCLEANFILES = $(dist_man1_MANS)
+
+%.1: %.xml
+	xmlto man $<

doc/man/debit.xml

@@ -0,0 +1,277 @@
+<?xml version="1.0" encoding="utf-8"?>
+<?xml-stylesheet type="text/xsl"
+   href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+
+    <!ENTITY debit "<command>debit</command>">
+]>
+
+<!-- This is completely copied from xmllint's manpage -->
+
+<refentry>
+
+<refentryinfo>
+	<title>debit Manual</title>
+	<productname>ulogic's debitting tools</productname>
+	<copyright>
+		<year>2006</year>
+	</copyright>
+	<authorgroup>
+		<author>
+			<firstname>Jean-Baptiste</firstname>
+			<surname>Note</surname>
+			<affiliation>
+				<address>
+					<email>[email protected]</email>
+				</address>
+			</affiliation>
+		</author>
+	</authorgroup>
+	<!-- date should be the date of the latest change or the release version -->
+	<date>$Date: 2006/10/19 21:00:00 $</date>
+	<!-- still a bit buggy output, will talk to docbook-xsl upstream to fix this -->
+	<!-- <releaseinfo>This is release 0.1 of the debit Manual.</releaseinfo> -->
+	<!-- <edition>0.0</edition> -->
+</refentryinfo>
+
+<refmeta>
+	<refentrytitle>debit</refentrytitle>
+	<manvolnum>1</manvolnum>
+</refmeta>
+
+<refnamediv>
+	<refname>debit</refname>
+	<refpurpose>command line <acronym>XML</acronym> tool</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+	<cmdsynopsis>
+	<command>debit</command>
+		<group choice="opt">
+			<arg choice="plain"><option>--version</option></arg>
+			<arg choice="plain"><option>--debug</option></arg>
+			<arg choice="plain"><option>--shell</option></arg>
+			<arg choice="plain"><option>--debugent</option></arg>
+			<arg choice="plain"><option>--copy</option></arg>
+			<arg choice="plain"><option>--recover</option></arg>
+			<arg choice="plain"><option>--noent</option></arg>
+			<arg choice="plain"><option>--noout</option></arg>
+			<arg choice="plain"><option>--nonet</option></arg>
+			<arg choice="plain"><option>--path "<replaceable class="option">PATH(S)</replaceable>"</option></arg>
+			<arg choice="plain"><option>--load-trace</option></arg>
+			<arg choice="plain"><option>--htmlout</option></arg>
+			<arg choice="plain"><option>--nowrap</option></arg>
+			<arg choice="plain"><option>--valid</option></arg>
+			<arg choice="plain"><option>--postvalid</option></arg>
+			<arg choice="plain"><option>--dtdvalid <replaceable class="option">URL</replaceable></option></arg>
+			<arg choice="plain"><option>--dtdvalidfpi <replaceable class="option">FPI</replaceable></option></arg>
+			<arg choice="plain"><option>--timing</option></arg>
+			<arg choice="plain"><option>--output <replaceable class="option">FILE</replaceable></option></arg>
+			<arg choice="plain"><option>--repeat</option></arg>
+			<arg choice="plain"><option>--insert</option></arg>
+			<arg choice="plain"><option>--compress</option></arg>
+			<arg choice="plain"><option>--html</option></arg>
+			<arg choice="plain"><option>--xmlout</option></arg>
+			<arg choice="plain"><option>--push</option></arg>
+			<arg choice="plain"><option>--memory</option></arg>
+			<arg choice="plain"><option>--maxmem <replaceable class="option">NBBYTES</replaceable></option></arg>
+			<arg choice="plain"><option>--nowarning</option></arg>
+			<arg choice="plain"><option>--noblanks</option></arg>
+			<arg choice="plain"><option>--nocdata</option></arg>
+			<arg choice="plain"><option>--format</option></arg>
+			<arg choice="plain"><option>--encode <replaceable class="option">ENCODING</replaceable></option></arg>
+			<arg choice="plain"><option>--dropdtd</option></arg>
+			<arg choice="plain"><option>--nsclean</option></arg>
+			<arg choice="plain"><option>--testIO</option></arg>
+			<arg choice="plain"><option>--catalogs</option></arg>
+			<arg choice="plain"><option>--nocatalogs</option></arg>
+			<arg choice="plain"><option>--auto</option></arg>
+			<arg choice="plain"><option>--xinclude</option></arg>
+			<arg choice="plain"><option>--noxincludenode</option></arg>
+			<arg choice="plain"><option>--loaddtd</option></arg>
+			<arg choice="plain"><option>--dtdattr</option></arg>
+			<arg choice="plain"><option>--stream</option></arg>
+			<arg choice="plain"><option>--walker</option></arg>
+			<arg choice="plain"><option>--pattern <replaceable class="option">PATTERNVALUE</replaceable></option></arg>
+			<arg choice="plain"><option>--chkregister</option></arg>
+			<arg choice="plain"><option>--relaxng <replaceable class="option">SCHEMA</replaceable></option></arg>
+			<arg choice="plain"><option>--schema <replaceable class="option">SCHEMA</replaceable></option></arg>
+			<arg choice="plain"><option>--c14n</option></arg>
+		</group>
+		<group choice="req">
+			<arg choice="plain" rep="repeat"><replaceable>XML-FILE(S)</replaceable></arg>
+			<arg choice="plain" rep="norepeat">-</arg>
+		</group>
+	</cmdsynopsis>
+	<cmdsynopsis>
+		<command>debit</command>
+		<arg choice="plain"><option>--help</option></arg>
+	</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id="description">
+	<title>DESCRIPTION</title>
+	<para>
+		The &debit; program parses one or more <acronym>XML</acronym> files,
+		specified on the command line as <replaceable>XML-FILE</replaceable>
+		(or the standard input if the filename provided
+		is <emphasis role="bold">-</emphasis> ). It prints various types of
+		output, depending upon the options selected. It is useful for detecting
+		errors both in <acronym>XML</acronym> code and in
+		the <acronym>XML</acronym> parser itself.
+	</para>
+</refsect1>
+
+<refsect1 id="options">
+	<title>OPTIONS</title>
+	<para>
+		&debit; accepts the following options (in alphabetical order):
+	</para>
+
+	<variablelist>
+
+		<varlistentry>
+	<term><option>--auto</option></term>
+	<listitem>
+		<para>Generate a small document for testing purposes.</para>
+	</listitem>
+		</varlistentry>
+
+		<varlistentry>
+	<term><option>--catalogs</option></term>
+	<listitem>
+		<para>
+			Use the <acronym>SGML</acronym> catalog(s) from <envar>SGML_CATALOG_FILES</envar>.
+			Otherwise <acronym>XML</acronym> catalogs starting
+			from <filename>/etc/xml/catalog</filename> are used by default.
+		</para>
+	</listitem>
+		</varlistentry>
+
+	</variablelist>
+</refsect1>
+
+<refsect1 id="diagnostics">
+	<title>DIAGNOSTICS</title>
+	<para>
+		&debit; return codes provide information that can be used when
+		calling it from scripts.
+	</para>
+	<!-- better use segmentedlist element later,
+	     which is currently only supported in snapshots -->
+	<variablelist>
+
+		<varlistentry>
+	<term><errorcode>0</errorcode></term>
+	<listitem>
+		<para>No error</para>
+	</listitem>
+		</varlistentry>
+
+		<varlistentry>
+	<term><errorcode>1</errorcode></term>
+	<listitem>
+		<para>Unclassified</para>
+	</listitem>
+		</varlistentry>
+
+		<varlistentry>
+	<term><errorcode>2</errorcode></term>
+	<listitem>
+		<para>Error in <acronym>DTD</acronym></para>
+	</listitem>
+		</varlistentry>
+
+		<varlistentry>
+	<term><errorcode>3</errorcode></term>
+	<listitem>
+		<para>Validation error</para>
+	</listitem>
+		</varlistentry>
+
+		<varlistentry>
+	<term><errorcode>4</errorcode></term>
+	<listitem>
+		<para>Validation error</para>
+	</listitem>
+		</varlistentry>
+
+		<varlistentry>
+	<term><errorcode>5</errorcode></term>
+	<listitem>
+		<para>Error in schema compilation</para>
+	</listitem>
+		</varlistentry>
+
+		<varlistentry>
+	<term><errorcode>6</errorcode></term>
+	<listitem>
+		<para>Error writing output</para>
+	</listitem>
+		</varlistentry>
+
+		<varlistentry>
+	<term><errorcode>7</errorcode></term>
+	<listitem>
+		<para>
+			Error in pattern (generated when <option>--pattern</option> option is used)
+		</para>
+	</listitem>
+		</varlistentry>
+
+		<varlistentry>
+	<term><errorcode>8</errorcode></term>
+	<listitem>
+		<para>
+			Error in Reader registration (generated
+			when <option>--chkregister</option> option is used)
+		</para>
+	</listitem>
+		</varlistentry>
+
+		<varlistentry>
+	<term><errorcode>9</errorcode></term>
+	<listitem>
+		<para>Out of memory error</para>
+	</listitem>
+		</varlistentry>
+
+	</variablelist>
+</refsect1>
+
+<refsect1 id="seealso">
+	<title>SEE ALSO</title>
+	<para>
+	<citerefentry>
+	  <refentrytitle>bit2pdf</refentrytitle>
+	  <manvolnum>1</manvolnum>
+	</citerefentry>,
+	<citerefentry>
+	  <refentrytitle>bitisolation</refentrytitle>
+	  <manvolnum>1</manvolnum>
+	</citerefentry>,
+	<citerefentry>
+	  <refentrytitle>debit</refentrytitle>
+	  <manvolnum>1</manvolnum>
+	</citerefentry>,
+	<citerefentry>
+	  <refentrytitle>diff_bin_pos</refentrytitle>
+	  <manvolnum>1</manvolnum>
+	</citerefentry>,
+	<citerefentry>
+	  <refentrytitle>xiledit</refentrytitle>
+	  <manvolnum>1</manvolnum>
+	</citerefentry></para>
+	<para>
+		More information can be found at ulogic's homepage <ulink url="http://www.ulogic.org/trac"/>
+	</para>
+</refsect1>
+
+</refentry>
+
+<!-- W: debit: binary-without-manpage bit2pdf -->
+<!-- W: debit: binary-without-manpage bitisolation -->
+<!-- W: debit: binary-without-manpage debit -->
+<!-- W: debit: binary-without-manpage diff_bin_pos -->
+<!-- W: debit: binary-without-manpage xiledit -->