[Python-apps-commits] r7423 - in packages/atheist/trunk/debian (atheist.xml.tmpl)

Mon Aug 8 20:16:19 UTC 2011

Date: Monday, August 8, 2011 @ 20:16:16
  Author: davidvilla-guest
Revision: 7423

manpage migrated to reST

Deleted:
  packages/atheist/trunk/debian/atheist.xml.tmpl

Deleted: packages/atheist/trunk/debian/atheist.xml.tmpl
===================================================================

--- packages/atheist/trunk/debian/atheist.xml.tmpl	2011-08-07 23:51:47 UTC (rev 7422)
+++ packages/atheist/trunk/debian/atheist.xml.tmpl	2011-08-08 20:16:16 UTC (rev 7423)
@@ -1,173 +0,0 @@
-<?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/nwalsh/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/nwalsh/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 "Cleto">
-  <!ENTITY dhsurname   "Martin">
-  <!-- dhusername could also be set to "&firstname; &surname;". -->
-  <!ENTITY dhusername  "Cleto Martin Angelina">
-  <!ENTITY dhemail     "cleto.martin at gmail.com">
-  <!-- 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     "atheist User Manual">
-  <!ENTITY dhucpackage "ATHEIST">
-  <!ENTITY dhpackage   "atheist">
-]>
-
-<refentry>
-  <refentryinfo>
-    <title>&dhtitle;</title>
-    <productname>&dhpackage;</productname>
-    <authorgroup>
-      <author>
-       <firstname>&dhfirstname;</firstname> <surname>&dhsurname;</surname>
-       <contrib>Wrote the initial version of this manpage for the Debian system,
-       but now is automatically generated from sources.</contrib>
-        <address>
-          <email>&dhemail;</email>
-        </address>
-      </author>
-    </authorgroup>
-    <copyright>
-      <year>2011</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 3 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-3</filename>.</para>
-    </legalnotice>
-  </refentryinfo>
-  <refmeta>
-    <refentrytitle>&dhucpackage;</refentrytitle>
-    <manvolnum>&dhsection;</manvolnum>
-  </refmeta>
-  <refnamediv>
-    <refname>&dhpackage;</refname>
-    <refpurpose>a general prupose test framework.</refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <cmdsynopsis>
-      <command>&dhpackage;</command>
-      <!-- These are several examples, how syntaxes could look -->
-      <arg choice="opt"><option>options</option></arg>
-      <arg choice="req">
-        <group choice="req">
-          <arg choice="plain"><replaceable>directory</replaceable></arg>
-          <arg choice="plain"><replaceable>file</replaceable></arg>
-        </group>
-      </arg>
-    </cmdsynopsis>
-  </refsynopsisdiv>
-  <refsect1 id="description">
-    <title>DESCRIPTION</title>
-    <para><command>&dhpackage;</command> allows you to specify the
-    behaviour of your tests in a declarative way using many data
-    structures (such us Tasks, Conditions, Daemons, etc.) and provides
-    detailed statistic results. The main idea is that the programmer
-    may describes the test behaviour in a <filename>.test</filename>
-    file and <command>&dhpackage;</command> runs every tests found. It
-    is possible to check and prepare the system by writting setup and
-    teardown files that are executed after and before each
-    test.</para>
-    <para>Each test is represented by Task object which have many
-    configuration attributes such us execution delay, termination
-    signal expected and many others. Tasks have pre and post
-    conditions that are been checked at execution time. You may save
-    the test output and compose Conditions objects to assure concrete
-    states of the system during the tests execution.</para>
-    <para><command>&dhpackage;</command> free all resources used by
-    the user automatically at the end of the execution. See
-    the Atheist manual for more information about data structures
-    and tools provided by the framework.</para>
-
-    <para>This manual page was written for the Debian distribution
-      because the original program does not have a manual page.
-      Instead, it has documentation in the GNU <citerefentry>
-        <refentrytitle>info</refentrytitle>
-        <manvolnum>1</manvolnum>
-      </citerefentry> format; see below.</para>
-  </refsect1>
-  <refsect1 id="options">
-    <title>OPTIONS</title>
-    <variablelist>
-      <!-- Use the variablelist.term.separator and the
-           variablelist.term.break.after parameters to
-           control the term elements. -->
-
-{% for opt in parser.get_all_options() -%}
-{% set short = opt._short_opts %}
-{% set long = opt._long_opts %}
-<varlistentry>
-  {% if short %}
-  <term><option>{{short[0]}}{% if opt.metavar %} <replaceable>{{opt.metavar}}</replaceable>{% endif %}</option>
-  </term>
-  {% endif %}
-  {% if long %}
-  <term><option>{{long[0]}}{% if opt.metavar %}=<replaceable>{{opt.metavar}}</replaceable>{% endif %}</option>
-  </term>
-  {% endif %}
-
-  <listitem>
-	<para>{{opt.help}}</para>
-  </listitem>
-</varlistentry>
-{% endfor %}
-
-</variablelist>
-
-</refsect1>
-</refentry>


