manpage.sgml.ex 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  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>April 28, 2002</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>geraint@users.sf.net</email>">
  22. <!ENTITY dhusername "Geraint">
  23. <!ENTITY dhucpackage "<refentrytitle>MTT</refentrytitle>">
  24. <!ENTITY dhpackage "mtt">
  25. <!ENTITY debian "<productname>Debian</productname>">
  26. <!ENTITY gnu "<acronym>GNU</acronym>">
  27. ]>
  28. <refentry>
  29. <refentryinfo>
  30. <address>
  31. &dhemail;
  32. </address>
  33. <author>
  34. &dhfirstname;
  35. &dhsurname;
  36. </author>
  37. <copyright>
  38. <year>2001</year>
  39. <holder>&dhusername;</holder>
  40. </copyright>
  41. &dhdate;
  42. </refentryinfo>
  43. <refmeta>
  44. &dhucpackage;
  45. &dhsection;
  46. </refmeta>
  47. <refnamediv>
  48. <refname>&dhpackage;</refname>
  49. <refpurpose>program to do something</refpurpose>
  50. </refnamediv>
  51. <refsynopsisdiv>
  52. <cmdsynopsis>
  53. <command>&dhpackage;</command>
  54. <arg><option>-e <replaceable>this</replaceable></option></arg>
  55. <arg><option>--example <replaceable>that</replaceable></option></arg>
  56. </cmdsynopsis>
  57. </refsynopsisdiv>
  58. <refsect1>
  59. <title>DESCRIPTION</title>
  60. <para>This manual page documents briefly the
  61. <command>&dhpackage;</command> and <command>bar</command>
  62. commands.</para>
  63. <para>This manual page was written for the &debian; distribution
  64. because the original program does not have a manual page.
  65. Instead, it has documentation in the &gnu;
  66. <application>Info</application> format; see below.</para>
  67. <para><command>&dhpackage;</command> is a program that...</para>
  68. </refsect1>
  69. <refsect1>
  70. <title>OPTIONS</title>
  71. <para>These programs follow the usual GNU command line syntax,
  72. with long options starting with two dashes (`-'). A summary of
  73. options is included below. For a complete description, see the
  74. <application>Info</application> files.</para>
  75. <variablelist>
  76. <varlistentry>
  77. <term><option>-h</option>
  78. <option>--help</option>
  79. </term>
  80. <listitem>
  81. <para>Show summary of options.</para>
  82. </listitem>
  83. </varlistentry>
  84. <varlistentry>
  85. <term><option>-v</option>
  86. <option>--version</option>
  87. </term>
  88. <listitem>
  89. <para>Show version of program.</para>
  90. </listitem>
  91. </varlistentry>
  92. </variablelist>
  93. </refsect1>
  94. <refsect1>
  95. <title>SEE ALSO</title>
  96. <para>bar (1), baz (1).</para>
  97. <para>The programs are documented fully by <citetitle>The Rise and
  98. Fall of a Fooish Bar</citetitle> available via the
  99. <application>Info</application> system.</para>
  100. </refsect1>
  101. <refsect1>
  102. <title>AUTHOR</title>
  103. <para>This manual page was written by &dhusername; &dhemail; for
  104. the &debian; system (but may be used by others). Permission is
  105. granted to copy, distribute and/or modify this document under
  106. the terms of the <acronym>GNU</acronym> Free Documentation
  107. License, Version 1.1 or any later version published by the Free
  108. Software Foundation; with no Invariant Sections, no Front-Cover
  109. Texts and no Back-Cover Texts.</para>
  110. </refsect1>
  111. </refentry>
  112. <!-- Keep this comment at the end of the file
  113. Local variables:
  114. mode: sgml
  115. sgml-omittag:t
  116. sgml-shorttag:t
  117. sgml-minimize-attributes:nil
  118. sgml-always-quote-attributes:t
  119. sgml-indent-step:2
  120. sgml-indent-data:t
  121. sgml-parent-document:nil
  122. sgml-default-dtd-file:nil
  123. sgml-exposed-tags:nil
  124. sgml-local-catalogs:nil
  125. sgml-local-ecat-files:nil
  126. End:
  127. -->