1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY dhfirstname "<firstname>Julien Lemoine</firstname>">
<!ENTITY dhsurname "<surname>SpeedBlue</surname>">
<!ENTITY dhdate "<date>January 3, 2004</date>">
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>speedblue@happycoders.org</email>">
<!ENTITY dhusername "Julien Lemoine">
<!ENTITY dhucpackage "<refentrytitle>orgadoc</refentrytitle>">
<!ENTITY dhpackage "orgadoc">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2004</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Organizes documents from XML descriptions</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option>-h </option></arg>
<arg><option>-v </option></arg>
<arg><option>-V </option></arg>
<arg><option>-c <replaceable>configuration_file</replaceable></option></arg>
<arg><option>-p <replaceable>path</replaceable></option></arg>
<arg><option>-a <replaceable>path</replaceable></option></arg>
<arg><option>-e <replaceable>path</replaceable></option></arg>
<arg><option>-f <replaceable>file</replaceable></option></arg>
<arg><option>-o <replaceable>file</replaceable></option></arg>
<arg><option>-s <replaceable>pattern</replaceable></option></arg>
<arg><option>-i </option></arg>
<arg><option>-w </option></arg>
<arg><option>-r </option></arg>
<arg><option>-t </option></arg>
<arg><option>-d </option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This manual page briefly describes the
<command>&dhpackage;</command> command.</para>
<para><command>&dhpackage;</command> uses XML files to describe
your documents and convert them to a tree of HTML files, a bibtex
file or a latex file. It also includes a search tool to perform
query on these XML files (with regexp support).
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>This program follows the usual GNU command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below. </para>
<variablelist>
<varlistentry>
<term><option>-h</option>
<option>--help</option>
</term>
<listitem>
<para>Show summary of options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option>
<option>--version</option>
</term>
<listitem>
<para>Show version of program.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</option>
<option>--verbose</option>
</term>
<listitem>
<para>Enable verbose mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option>
<option>--conf-file</option>
</term>
<listitem>
<para>Specifies the name of the configuration file. The default is
/etc/orgadoc/orgadoc.conf.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option>
<option>--file</option>
</term>
<listitem>
<para>Name of XML file to convert.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o</option>
<option>--output-file</option>
</term>
<listitem>
<para>File to store output Files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option>
<option>--path</option>
</term>
<listitem>
<para>Path to search XML files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-a</option>
<option>--httpd-path</option>
</term>
<listitem>
<para>Prefix added to href when generates html files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-e</option>
<option>--prefix</option>
</term>
<listitem>
<para>Path to store output files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option>
<option>--search</option>
</term>
<listitem>
<para>Display info about files that match the given pattern</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-i</option>
<option>--case-insensitive</option>
</term>
<listitem>
<para>Ignore case in search.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-w</option>
<option>--with-private</option>
</term>
<listitem>
<para>Activate the generation for private documents.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-r</option>
<option>--recursive</option>
</term>
<listitem>
<para>Recursively read all files under each directory.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option>
<option>--html</option>
</term>
<listitem>
<para>Activate production of HTML files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-b</option>
<option>--bibtex</option>
</term>
<listitem>
<para>Activate production of BibTex file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-l</option>
<option>--latex</option>
</term>
<listitem>
<para>Activate production of LaTex file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option>
<option>--display-ast</option>
</term>
<listitem>
<para>display the Abstract Syntax Tree for each XML file.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>orgadoc_cgi, orgadoc_init_readmes, orgadoc_add_docs</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; <&dhemail;>.
Permission is
granted to copy, distribute and/or modify this document under
the terms of the <acronym>GNU</acronym> Free Documentation
License, Version 1.2 or any later version published by the Free
Software Foundation; with no Invariant Sections, no Front-Cover
Texts and no Back-Cover Texts.</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
|
