-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added man pages for daps-xmlformat and daps-check-deps
Fixes issue #491
- Loading branch information
1 parent
11761df
commit 873b2ad
Showing
3 changed files
with
137 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE refentry PUBLIC | ||
| "-//OASIS//DTD DocBook XML V4.5//EN" | ||
| "http://www.docbook.org/xml/4.5/docbookx.dtd" | ||
| [ | ||
| <!ENTITY daps_check "daps-check-deps"> | ||
| <!ENTITY % entities SYSTEM "entity-decl.ent"> | ||
| %entities; | ||
| ]> | ||
| <refentry lang="en" id="daps_check"> | ||
| <refentryinfo> | ||
| <productname>&dapsacr;</productname> | ||
| <authorgroup> | ||
| <author> | ||
| <contrib>Developer</contrib> | ||
| <firstname>Frank</firstname> | ||
| <surname>Sundermeyer</surname> | ||
| <email>[email protected]</email> | ||
| </author> | ||
| </authorgroup> | ||
| </refentryinfo> | ||
| <refmeta> | ||
| <refentrytitle>&dapsacr;</refentrytitle> | ||
| <manvolnum>1</manvolnum> | ||
| <refmiscinfo class="date"><?dbtimestamp format="Y B d"?></refmiscinfo> | ||
| <refmiscinfo class="version">&dapsversion;</refmiscinfo> | ||
| <refmiscinfo class="manual">&daps;</refmiscinfo> | ||
| </refmeta> | ||
| <refnamediv> | ||
| <refname>&daps_check;</refname> | ||
| <refpurpose> | ||
| Checks the availability of external programs used by &dapsacr;. | ||
| </refpurpose> | ||
| </refnamediv> | ||
| <refsynopsisdiv id="daps_check.synopsis"> | ||
| <title>Synopsis</title> | ||
| <cmdsynopsis> | ||
| <command>&daps_check;</command> | ||
| </cmdsynopsis> | ||
| </refsynopsisdiv> | ||
| <refsect1> | ||
| <title>Description</title> | ||
| <para> | ||
| &dapsacr; depends on a large number of external programs. Without some of | ||
| them, &dapsacr; will not run at all. Other programs are only used for | ||
| certain functions and are not critical. Use this script to check for the | ||
| availability of all external programs used by &dapsacr;. | ||
| </para> | ||
| </refsect1> | ||
| <refsect1 id="daps_check.moreinfo"> | ||
| <title>See Also</title> | ||
| <variablelist> | ||
| <varlistentry> | ||
| <term> | ||
| &dapsurl; | ||
| </term> | ||
| <listitem> | ||
| <para>DAPS project homepage</para> | ||
| </listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
| </refsect1> | ||
| </refentry> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE refentry PUBLIC | ||
| "-//OASIS//DTD DocBook XML V4.5//EN" | ||
| "http://www.docbook.org/xml/4.5/docbookx.dtd" | ||
| [ | ||
| <!ENTITY daps_xmlf "daps-xmlformat"> | ||
| <!ENTITY % entities SYSTEM "entity-decl.ent"> | ||
| %entities; | ||
| ]> | ||
| <refentry lang="en" id="daps_xmlf"> | ||
| <refentryinfo> | ||
| <productname>&dapsacr;</productname> | ||
| <authorgroup> | ||
| <author> | ||
| <contrib>Developer</contrib> | ||
| <firstname>Frank</firstname> | ||
| <surname>Sundermeyer</surname> | ||
| <email>[email protected]</email> | ||
| </author> | ||
| </authorgroup> | ||
| </refentryinfo> | ||
| <refmeta> | ||
| <refentrytitle>&dapsacr;</refentrytitle> | ||
| <manvolnum>1</manvolnum> | ||
| <refmiscinfo class="date"><?dbtimestamp format="Y B d"?></refmiscinfo> | ||
| <refmiscinfo class="version">&dapsversion;</refmiscinfo> | ||
| <refmiscinfo class="manual">&daps;</refmiscinfo> | ||
| </refmeta> | ||
| <refnamediv> | ||
| <refname>&daps_xmlf;</refname> | ||
| <refpurpose> | ||
| A wrapper script for xmlformat.pl/xmlformat.rb that calls a DAPS-specific | ||
| configuration file. | ||
| </refpurpose> | ||
| </refnamediv> | ||
| <refsynopsisdiv id="daps_xmlf.synopsis"> | ||
| <title>Synopsis</title> | ||
| <cmdsynopsis> | ||
| <command>&daps_xmlf;</command> | ||
| <arg choice="opt"><replaceable>OPTIONS</replaceable></arg> | ||
| <arg choice="plain"><replaceable>FILE(S)</replaceable></arg> | ||
| </cmdsynopsis> | ||
| </refsynopsisdiv> | ||
| <refsect1> | ||
| <title>Description</title> | ||
| <para> | ||
| &daps_xmlf; calls xmlformat.pl/xmlformat.rb with a DAPS-specific | ||
| configuration file located at | ||
| <filename>@sysconfdir@/docbook-xmlformat.conf</filename>. Options are the | ||
| same as for xmlformat.pl/xmlformat.rb. See <command>xmlformat.pl | ||
| --help</command> or <command>xmlformat.rb --help</command> for more | ||
| information. | ||
| </para> | ||
| </refsect1> | ||
| <refsect1 id="daps_xmlf.moreinfo"> | ||
| <title>See Also</title> | ||
| <variablelist> | ||
| <varlistentry> | ||
| <term> | ||
| &dapsurl; | ||
| </term> | ||
| <listitem> | ||
| <para>DAPS project homepage</para> | ||
| </listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
| </refsect1> | ||
| </refentry> |