manpage.xml.ex 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. <?xml version='1.0' encoding='ISO-8859-1'?>
  2. <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
  4. <!--
  5. Process this file with an XSLT processor: `xsltproc \
  6. -''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
  7. manpages/docbook.xsl manpage.dbk'. A manual page
  8. <package>.<section> will be generated. You may view the
  9. manual page with: nroff -man <package>.<section> | less'. A
  10. typical entry in a Makefile or Makefile.am is:
  11. DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
  12. manpages/docbook.xsl
  13. XP=xsltproc -''-nonet
  14. manpage.1: manpage.dbk
  15. $(XP) $(DB2MAN) $<
  16. The xsltproc binary is found in the xsltproc package. The
  17. XSL files are in docbook-xsl. Please remember that if you
  18. create the nroff version in one of the debian/rules file
  19. targets (such as build), you will need to include xsltproc
  20. and docbook-xsl in your Build-Depends control field.
  21. -->
  22. <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  23. <!ENTITY dhfirstname "<firstname>FIRSTNAME</firstname>">
  24. <!ENTITY dhsurname "<surname>SURNAME</surname>">
  25. <!-- Please adjust the date whenever revising the manpage. -->
  26. <!ENTITY dhdate "<date>April 30, 2010</date>">
  27. <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  28. allowed: see man(7), man(1). -->
  29. <!ENTITY dhsection "<manvolnum>SECTION</manvolnum>">
  30. <!ENTITY dhemail "<email>@hybridemail@</email>">
  31. <!ENTITY dhusername "@hybridauthor@">
  32. <!ENTITY dhucpackage "<refentrytitle>@HYBRIDAPP@</refentrytitle>">
  33. <!ENTITY dhpackage "@hybridapp@">
  34. <!ENTITY debian "<productname>Debian</productname>">
  35. <!ENTITY gnu "<acronym>GNU</acronym>">
  36. <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
  37. ]>
  38. <refentry>
  39. <refentryinfo>
  40. <address>
  41. &dhemail;
  42. </address>
  43. <author>
  44. &dhfirstname;
  45. &dhsurname;
  46. </author>
  47. <copyright>
  48. <year>2003</year>
  49. <holder>&dhusername;</holder>
  50. </copyright>
  51. &dhdate;
  52. </refentryinfo>
  53. <refmeta>
  54. &dhucpackage;
  55. &dhsection;
  56. </refmeta>
  57. <refnamediv>
  58. <refname>&dhpackage;</refname>
  59. <refpurpose>program to do something</refpurpose>
  60. </refnamediv>
  61. <refsynopsisdiv>
  62. <cmdsynopsis>
  63. <command>&dhpackage;</command>
  64. <arg><option>-e <replaceable>this</replaceable></option></arg>
  65. <arg><option>--example <replaceable>that</replaceable></option></arg>
  66. </cmdsynopsis>
  67. </refsynopsisdiv>
  68. <refsect1>
  69. <title>DESCRIPTION</title>
  70. <para>This manual page documents briefly the
  71. <command>&dhpackage;</command> and <command>bar</command>
  72. commands.</para>
  73. <para>This manual page was written for the &debian; distribution
  74. because the original program does not have a manual page.
  75. Instead, it has documentation in the &gnu;
  76. <application>Info</application> format; see below.</para>
  77. <para><command>&dhpackage;</command> is a program that...</para>
  78. </refsect1>
  79. <refsect1>
  80. <title>OPTIONS</title>
  81. <para>These programs follow the usual &gnu; command line syntax,
  82. with long options starting with two dashes (`-'). A summary of
  83. options is included below. For a complete description, see the
  84. <application>Info</application> files.</para>
  85. <variablelist>
  86. <varlistentry>
  87. <term><option>-h</option>
  88. <option>--help</option>
  89. </term>
  90. <listitem>
  91. <para>Show summary of options.</para>
  92. </listitem>
  93. </varlistentry>
  94. <varlistentry>
  95. <term><option>-v</option>
  96. <option>--version</option>
  97. </term>
  98. <listitem>
  99. <para>Show version of program.</para>
  100. </listitem>
  101. </varlistentry>
  102. </variablelist>
  103. </refsect1>
  104. <refsect1>
  105. <title>SEE ALSO</title>
  106. <para>bar (1), baz (1).</para>
  107. <para>The programs are documented fully by <citetitle>The Rise and
  108. Fall of a Fooish Bar</citetitle> available via the
  109. <application>Info</application> system.</para>
  110. </refsect1>
  111. <refsect1>
  112. <title>AUTHOR</title>
  113. <para>This manual page was written by &dhusername; &dhemail; for
  114. the &debian; system (but may be used by others). Permission is
  115. granted to copy, distribute and/or modify this document under
  116. the terms of the &gnu; General Public License, Version 2 any
  117. later version published by the Free Software Foundation.
  118. </para>
  119. <para>
  120. On Debian systems, the complete text of the GNU General Public
  121. License can be found in /usr/share/common-licenses/GPL.
  122. </para>
  123. </refsect1>
  124. </refentry>