← Back to branch summary

~ubuntu-branches/ubuntu/utopic/asciidoc/utopic

« back to all changes in this revision

Viewing changes to examples/website/manpage.html

  • Committer: Bazaar Package Importer
  • Author(s): Alexander Wirt
  • Date: 2010-11-27 23:19:57 UTC
  • mfrom: (1.1.12 upstream) (3.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20101127231957-jxdmrk7z7lkcqy3l
Tags: 8.6.3-1
http://bugs.debian.org/595324
http://bugs.debian.org/526351
http://bugs.debian.org/571303
http://bugs.debian.org/592423
http://bugs.debian.org/499497
http://bugs.debian.org/564015
* New upstream version (Closes: #595324)
* Support asciidoc API (Closes: #526351)
* Depend on python >= 2.4 (Closes: #571303)
* Do not compress .txt files (Closes: #592423)
* Enhance asciidoc manpage (Closes: #499497)
* Move some of the Recommends (vim-addon-manager, source-highlight) to 
  Suggests (Closes: #564015)
* Bump standards version (No changes)
* Add README.Source file

Show diffs side-by-side

added added

removed removed

Lines of Context:
examples/website/manpage.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2
 
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3
 
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4
 
<head>
5
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6
 
<meta name="generator" content="AsciiDoc 8.5.2" />
7
 
<link rel="stylesheet" href="./xhtml11.css" type="text/css" />
8
 
<link rel="stylesheet" href="./xhtml11-manpage.css" type="text/css" />
9
 
<link rel="stylesheet" href="./xhtml11-quirks.css" type="text/css" />
10
 
<link rel="stylesheet" href="./layout1.css" type="text/css" />
11
 
<script type="text/javascript">
12
 
/*<![CDATA[*/
13
 
window.onload = function(){asciidoc.footnotes();}
14
 
/*]]>*/
15
 
</script>
16
 
<script type="text/javascript" src="./asciidoc-xhtml11.js"></script>
17
 
<title>ASCIIDOC(1)</title>
18
 
</head>
19
 
<body style="max-width:70em">
20
 
<div id="layout-banner">
21
 
  <div id="layout-title">AsciiDoc</div>
22
 
  <div id="layout-description">Text based document generation</div>
23
 
</div>
24
 
<table>
25
 
<tr valign="top">
26
 
<td id="layout-menu">
27
 
  <div>&#187;<a href="index.html">Home</a></div>
28
 
  <div>&#187;<a href="manpage.html">Man&nbsp;Page</a></div>
29
 
  <div>&#187;<a href="userguide.html">User&nbsp;Guide</a></div>
30
 
  <div>&#187;<a href="INSTALL.html">Installation</a></div>
31
 
  <div>&#187;<a href="faq.html">FAQ</a></div>
32
 
  <div>&#187;<a href="a2x.1.html">a2x</a></div>
33
 
  <div>&#187;<a href="asciidocapi.html">API</a></div>
34
 
  <div>&#187;<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
35
 
  <div>&#187;<a href="testasciidoc.html">Tests</a></div>
36
 
  <div>&#187;<a href="CHANGELOG.html">ChangeLog</a></div>
37
 
  <div>&#187;<a href="support.html">Support</a></div>
38
 
  <div id="page-source">&#187;<a href="manpage.txt">Page&nbsp;Source</a></div>
39
 
</td>
40
 
<td>
41
 
<div id="layout-content">
42
 
<div id="header">
43
 
<h1>
44
 
ASCIIDOC(1) Manual Page
45
 
</h1>
46
 
<h2>NAME</h2>
47
 
<div class="sectionbody">
48
 
<p>asciidoc -
49
 
   converts an AsciiDoc text file to HTML or DocBook
50
 
</p>
51
 
</div>
52
 
</div>
53
 
<div id="content">
54
 
<h2 id="_synopsis">SYNOPSIS</h2>
55
 
<div class="sectionbody">
56
 
<div class="paragraph"><p><strong>asciidoc</strong> [<em>OPTIONS</em>] <em>FILE</em></p></div>
57
 
</div>
58
 
<h2 id="_description">DESCRIPTION</h2>
59
 
<div class="sectionbody">
60
 
<div class="paragraph"><p>The <tt>asciidoc(1)</tt> command translates the AsciiDoc text file <em>FILE</em> to a
61
 
DocBook, HTML or LinuxDoc file.  If <em>FILE</em> is <em>-</em> then the standard
62
 
input is used.</p></div>
63
 
</div>
64
 
<h2 id="_options">OPTIONS</h2>
65
 
<div class="sectionbody">
66
 
<div class="dlist"><dl>
67
 
<dt class="hdlist1">
68
 
<strong>-a, --attribute</strong>=<em>ATTRIBUTE</em>
69
 
</dt>
70
 
<dd>
71
 
<p>
72
 
    Define or delete document attribute. <em>ATTRIBUTE</em> is formatted like
73
 
    <em>NAME=VALUE</em>. Command-line attributes take precedence over
74
 
    document and configuration file attributes.  Alternate acceptable
75
 
    forms are <em>NAME</em> (the <em>VALUE</em> defaults to an empty string);
76
 
    <em>NAME!</em> (delete the <em>NAME</em> attribute); <em>NAME@</em> (do not override
77
 
    document or configuration file attributes).  Values containing
78
 
    spaces should be enclosed in double-quote characters. This option
79
 
    may be specified more than once.  A special attribute named
80
 
    <em>trace</em> controls the output of diagnostic information.
81
 
</p>
82
 
</dd>
83
 
<dt class="hdlist1">
84
 
<strong>-b, --backend</strong>=<em>BACKEND</em>
85
 
</dt>
86
 
<dd>
87
 
<p>
88
 
    Backend output file format: <em>docbook</em>, <em>xhtml11</em> or <em>html4</em>.
89
 
    Defaults to <em>xhtml11</em>.
90
 
</p>
91
 
</dd>
92
 
<dt class="hdlist1">
93
 
<strong>-f, --conf-file</strong>=<em>CONF_FILE</em>
94
 
</dt>
95
 
<dd>
96
 
<p>
97
 
    Use configuration file <em>CONF_FILE</em>.Configuration files processed
98
 
    in command-line order (after implicit configuration files).  This
99
 
    option may be specified more than once.
100
 
</p>
101
 
</dd>
102
 
<dt class="hdlist1">
103
 
<strong>--doctest</strong>
104
 
</dt>
105
 
<dd>
106
 
<p>
107
 
    Run Python doctests in <em>asciidoc</em> module.
108
 
</p>
109
 
</dd>
110
 
<dt class="hdlist1">
111
 
<strong>-d, --doctype</strong>=<em>DOCTYPE</em>
112
 
</dt>
113
 
<dd>
114
 
<p>
115
 
    Document type: <em>article</em>, <em>manpage</em> or <em>book</em>. The <em>book</em> document
116
 
    type is only supported by the <em>docbook</em> backend.  Default document
117
 
    type is <em>article</em>.
118
 
</p>
119
 
</dd>
120
 
<dt class="hdlist1">
121
 
<strong>-c, --dump-conf</strong>
122
 
</dt>
123
 
<dd>
124
 
<p>
125
 
    Dump configuration to stdout.
126
 
</p>
127
 
</dd>
128
 
<dt class="hdlist1">
129
 
<strong>-h, --help</strong>[=<em>TOPIC</em>]
130
 
</dt>
131
 
<dd>
132
 
<p>
133
 
    Print help TOPIC. <strong>--help</strong>=<em>topics</em> will print a list of help
134
 
    topics, <strong>--help</strong>=<em>syntax</em> summarizes AsciiDoc syntax,
135
 
    <strong>--help</strong>=<em>manpage</em> prints the AsciiDoc manpage.
136
 
</p>
137
 
</dd>
138
 
<dt class="hdlist1">
139
 
<strong>-e, --no-conf</strong>
140
 
</dt>
141
 
<dd>
142
 
<p>
143
 
    Exclude implicitly loaded configuration files except for those
144
 
    named like the input file (<em>infile.conf</em> and
145
 
    <em>infile-backend.conf</em>).
146
 
</p>
147
 
</dd>
148
 
<dt class="hdlist1">
149
 
<strong>-s, --no-header-footer</strong>
150
 
</dt>
151
 
<dd>
152
 
<p>
153
 
    Suppress document header and footer output.
154
 
</p>
155
 
</dd>
156
 
<dt class="hdlist1">
157
 
<strong>-o, --out-file</strong>=<em>OUT_FILE</em>
158
 
</dt>
159
 
<dd>
160
 
<p>
161
 
    Write output to file <em>OUT_FILE</em>. Defaults to the base name of
162
 
    input file with <em>backend</em> extension. If the input is stdin then
163
 
    the outfile defaults to stdout. If <em>OUT_FILE</em> is <em>-</em> then the
164
 
    standard output is used.
165
 
</p>
166
 
</dd>
167
 
<dt class="hdlist1">
168
 
<strong>-n, --section-numbers</strong>
169
 
</dt>
170
 
<dd>
171
 
<p>
172
 
    Auto-number HTML article section titles.  Synonym for <strong>-a
173
 
    numbered</strong>.
174
 
</p>
175
 
</dd>
176
 
<dt class="hdlist1">
177
 
<strong>--safe</strong>
178
 
</dt>
179
 
<dd>
180
 
<p>
181
 
    Enable safe mode. Safe mode is disabled by default.  AsciiDoc
182
 
    <em>safe mode</em> skips potentially dangerous scripted sections in
183
 
    AsciiDoc source files.
184
 
</p>
185
 
</dd>
186
 
<dt class="hdlist1">
187
 
<strong>-v, --verbose</strong>
188
 
</dt>
189
 
<dd>
190
 
<p>
191
 
    Verbosely print processing information and configuration file
192
 
    checks to stderr.
193
 
</p>
194
 
</dd>
195
 
<dt class="hdlist1">
196
 
<strong>--version</strong>
197
 
</dt>
198
 
<dd>
199
 
<p>
200
 
    Print program version number.
201
 
</p>
202
 
</dd>
203
 
</dl></div>
204
 
</div>
205
 
<h2 id="_exit_status">EXIT STATUS</h2>
206
 
<div class="sectionbody">
207
 
<div class="dlist"><dl>
208
 
<dt class="hdlist1">
209
 
<strong>0</strong>
210
 
</dt>
211
 
<dd>
212
 
<p>
213
 
    Success
214
 
</p>
215
 
</dd>
216
 
<dt class="hdlist1">
217
 
<strong>1</strong>
218
 
</dt>
219
 
<dd>
220
 
<p>
221
 
    Failure (syntax or usage error; configuration error; document
222
 
    processing failure; unexpected error).
223
 
</p>
224
 
</dd>
225
 
</dl></div>
226
 
</div>
227
 
<h2 id="_bugs">BUGS</h2>
228
 
<div class="sectionbody">
229
 
<div class="paragraph"><p>See the AsciiDoc distribution BUGS file.</p></div>
230
 
</div>
231
 
<h2 id="_author">AUTHOR</h2>
232
 
<div class="sectionbody">
233
 
<div class="paragraph"><p>Written by Stuart Rackham, &lt;<a href="mailto:srackham@gmail.com">srackham@gmail.com</a>&gt;</p></div>
234
 
</div>
235
 
<h2 id="_resources">RESOURCES</h2>
236
 
<div class="sectionbody">
237
 
<div class="paragraph"><p>SourceForge: <a href="http://sourceforge.net/projects/asciidoc/">http://sourceforge.net/projects/asciidoc/</a></p></div>
238
 
<div class="paragraph"><p>Main web site: <a href="http://www.methods.co.nz/asciidoc/">http://www.methods.co.nz/asciidoc/</a></p></div>
239
 
</div>
240
 
<h2 id="_copying">COPYING</h2>
241
 
<div class="sectionbody">
242
 
<div class="paragraph"><p>Copyright (C) 2002-2009 Stuart Rackham. Free use of this software is
243
 
granted under the terms of the GNU General Public License (GPL).</p></div>
244
 
</div>
245
 
</div>
246
 
<div id="footnotes"><hr /></div>
247
 
<div id="footer">
248
 
<div id="footer-text">
249
 
Version 8.5.2<br />
250
 
Last updated 2009-12-07 17:24:57 NZDT
251
 
</div>
252
 
<div id="footer-badges">
253
 
<a href="http://validator.w3.org/check?uri=referer">
254
 
  <img style="border:0;width:88px;height:31px"
255
 
    src="http://www.w3.org/Icons/valid-xhtml11-blue"
256
 
    alt="Valid XHTML 1.1" height="31" width="88" />
257
 
</a>
258
 
<a href="http://jigsaw.w3.org/css-validator/">
259
 
  <img style="border:0;width:88px;height:31px"
260
 
    src="http://jigsaw.w3.org/css-validator/images/vcss-blue"
261
 
    alt="Valid CSS!" />
262
 
</a>
263
 
<a href="http://www.mozilla.org/products/firefox/">
264
 
  <img style="border:none; width:110px; height:32px;"
265
 
       src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif"
266
 
       alt="Get Firefox!" />
267
 
</a>
268
 
</div>
269
 
</div>
270
 
</div>
271
 
</td>
272
 
</tr>
273
 
</table>
274
 
</body>
275
 
</html>