manpage.sgml.ex 4.6 KB

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