-
Notifications
You must be signed in to change notification settings - Fork 2
/
averell.1.xml
274 lines (260 loc) · 9.09 KB
/
averell.1.xml
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!--
`xsltproc -''-nonet \
-''-param man.charmap.use.subset "0" \
-''-param make.year.ranges "1" \
-''-param make.single.year.ranges "1" \
/usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
manpage.xml'
A manual page <package>.<section> will be generated. You may view the
manual page with: nroff -man <package>.<section> | less'. A typical entry
in a Makefile or Makefile.am is:
DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/docbook-xsl/manpages/docbook.xsl
XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
manpage.1: manpage.xml
$(XP) $(DB2MAN) $<
The xsltproc binary is found in the xsltproc package. The XSL files are in
docbook-xsl. A description of the parameters you can use can be found in the
docbook-xsl-doc-* packages. Please remember that if you create the nroff
version in one of the debian/rules file targets (such as build), you will need
to include xsltproc and docbook-xsl in your Build-Depends control field.
Alternatively use the xmlto command/package. That will also automatically
pull in xsltproc and docbook-xsl.
Notes for using docbook2x: docbook2x-man does not automatically create the
AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
<refsect1> ... </refsect1>.
To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
found in the docbook-xsl-doc-html package.
Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
General documentation about man-pages and man-page-formatting:
man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "Jean">
<!ENTITY dhsurname "Parpaillon">
<!ENTITY dhusername "&dhfirstname; &dhsurname;">
<!ENTITY dhemail "[email protected]">
<!ENTITY dhsection "1">
<!ENTITY dhtitle "averell User Manual">
<!ENTITY dhucpackage "averell">
<!ENTITY dhpackage "averell">
]>
<refentry>
<refentryinfo>
<title>&dhtitle;</title>
<productname>&dhpackage;</productname>
<authorgroup>
<author>
<firstname>&dhfirstname;</firstname>
<surname>&dhsurname;</surname>
<contrib>Author of averell and this marvellous manpage.</contrib>
<address>
<email>&dhemail;</email>
</address>
</author>
</authorgroup>
<copyright>
<year>2014</year>
<holder>&dhusername;</holder>
</copyright>
<legalnotice>
<para>Permission is granted to copy, distribute and/or modify
this document under the terms of the Apache License Version 2 or
(at your option) any later version published by the Apache
Foundation.</para>
<para>On Debian systems, the complete text of the Apache can be
found in
<filename>/usr/share/common-licenses/Apache-2.0</filename>.</para>
</legalnotice>
</refentryinfo>
<refmeta>
<refentrytitle>&dhucpackage;</refentrytitle>
<manvolnum>&dhsection;</manvolnum>
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>An incredibly stupid (but fast) web server</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg choice="plain">
<group choice="opt">
<arg choice="plain"><option>-h</option></arg>
<arg choice="plain"><option>--help</option></arg>
</group>
</arg>
<arg choice="plain">
<group choice="opt">
<arg choice="plain"><option>-p <replaceable>PORT</replaceable></option></arg>
<arg choice="plain"><option>--port=<replaceable>PORT</replaceable></option></arg>
</group>
</arg>
<arg choice="plain">
<group choice="opt">
<arg choice="plain"><option>-c</option></arg>
<arg choice="plain"><option>--cors</option></arg>
</group>
</arg>
<arg choice="plain">
<group choice="opt">
<arg choice="plain"><option>-v</option></arg>
<arg choice="plain"><option>--verbose</option></arg>
</group>
</arg>
<arg choice="plain">
<group choice="opt">
<arg choice="plain"><option>-d</option></arg>
<arg choice="plain"><option>--debug</option></arg>
</group>
</arg>
<arg choice="plain">
<group choice="opt">
<arg choice="plain"><option>-a</option></arg>
<arg choice="plain"><option>--access</option></arg>
</group>
</arg>
<arg choice="plain">
<group choice="opt">
<arg choice="plain"><option>-I</option></arg>
<arg choice="plain"><option>--no-index</option></arg>
</group>
</arg>
<arg choice="opt"><replaceable>directory</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>DESCRIPTION</title>
<para>
This manual page documents briefly the <command>&dhpackage;</command>.
</para>
<para>
<command>&dhpackage;</command> is an incredibly simple web
server, aiming at serving a single directory, fast.
</para>
</refsect1>
<refsect1 id="options">
<title>OPTIONS</title>
<para>
The program follows the usual GNU command line syntax, with long
options starting with two dashes (`-'). A summary of options is
included below.
</para>
<variablelist>
<!-- Use the variablelist.term.separator and the
variablelist.term.break.after parameters to
control the term elements. -->
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>Show help and exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p <replaceable>PORT</replaceable></option></term>
<term><option>--port=<replaceable>PORT</replaceable></option></term>
<listitem>
<para>Set listening port (default: 8000).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option></term>
<term><option>--cors</option></term>
<listitem>
<para>Enable CORS (allowed origins: *).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
<listitem>
<para>Be more verbose.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<term><option>--debug</option></term>
<listitem>
<para>Debug mode (override verbose mode if any): print
request and response headers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-a</option></term>
<term><option>--access</option></term>
<listitem>
<para>Read .avlaccess for per-directory properties.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-I</option></term>
<term><option>--no-index</option></term>
<listitem>
<para>Do not serve index.html file automatically (can be
overridden by .avlaccess).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>directory</term>
<listitem>
<para>Directory to server (default: current dir).</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="avlaccess">
<title><filename>.avlaccess</filename> FILE FORMAT</title>
<para>
This section describes the <filename>.avlaccess</filename> file format.
</para>
<para>
<filename>.avlaccess</filename> files can be placed anywhere in
a directory served by &dhpackage;. It contains properties
applicable to this directory. Properties are inherited from
parent directories.
</para>
<refsect2>
<title>SYNTAX</title>
<para>
File is parsed using the <varname>file:consult/1</varname>
function of erlang/OTP (see <ulink
url="http://www.erlang.org/doc/man/file.html#consult-1">erlang/OTP
documentation</ulink>). Parser is strict, be careful with
ending dot, comma between tuples and no comma after last
tuple.
</para>
<para>
Example of such file is given below:
<programlisting>
[
{option1, value1},
{option2, value2}
].
</programlisting>
</para>
</refsect2>
<refsect2>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>{index, <<"index.html">>}</term>
<listitem>
<para>When requesting a directory path, look for the given
filename and serves it if it exists. 403 otherwise.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>{index, noindex}</term>
<listitem>
<para>Do not server any index file when requesting a
directory path. Such requests will return 403.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
</refentry>