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