← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/asciidoc.1.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:
doc/asciidoc.1.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<meta name="generator" content="AsciiDoc 8.5.2">
6
 
<title>asciidoc</title>
7
 
</head>
8
 
<body>
9
 
<hr>
10
 
<h1>
11
 
    ASCIIDOC(1) Manual Page
12
 
</h1>
13
 
<hr>
14
 
<h2>NAME</h2>
15
 
<p>asciidoc -
16
 
   converts an AsciiDoc text file to HTML or DocBook
17
 
</p>
18
 
<h2><a name="_synopsis"></a>SYNOPSIS</h2>
19
 
<p><strong>asciidoc</strong> [<b>OPTIONS</b>] <b>FILE</b></p>
20
 
<h2><a name="_description"></a>DESCRIPTION</h2>
21
 
<p>The asciidoc(1) command translates the AsciiDoc text file <b>FILE</b> to a
22
 
DocBook, HTML or LinuxDoc file.  If <b>FILE</b> is <b>-</b> then the standard
23
 
input is used.</p>
24
 
<h2><a name="_options"></a>OPTIONS</h2>
25
 
<dl>
26
 
<dt>
27
 
<strong>-a, --attribute</strong>=<b>ATTRIBUTE</b>
28
 
</dt>
29
 
<dd>
30
 
<p>
31
 
    Define or delete document attribute. <b>ATTRIBUTE</b> is formatted like
32
 
    <b>NAME=VALUE</b>. Command-line attributes take precedence over
33
 
    document and configuration file attributes.  Alternate acceptable
34
 
    forms are <b>NAME</b> (the <b>VALUE</b> defaults to an empty string);
35
 
    <b>NAME!</b> (delete the <b>NAME</b> attribute); <b>NAME@</b> (do not override
36
 
    document or configuration file attributes).  Values containing
37
 
    spaces should be enclosed in double-quote characters. This option
38
 
    may be specified more than once.  A special attribute named
39
 
    <b>trace</b> controls the output of diagnostic information.
40
 
</p>
41
 
</dd>
42
 
<dt>
43
 
<strong>-b, --backend</strong>=<b>BACKEND</b>
44
 
</dt>
45
 
<dd>
46
 
<p>
47
 
    Backend output file format: <b>docbook</b>, <b>xhtml11</b> or <b>html4</b>.
48
 
    Defaults to <b>xhtml11</b>.
49
 
</p>
50
 
</dd>
51
 
<dt>
52
 
<strong>-f, --conf-file</strong>=<b>CONF_FILE</b>
53
 
</dt>
54
 
<dd>
55
 
<p>
56
 
    Use configuration file <b>CONF_FILE</b>.Configuration files processed
57
 
    in command-line order (after implicit configuration files).  This
58
 
    option may be specified more than once.
59
 
</p>
60
 
</dd>
61
 
<dt>
62
 
<strong>--doctest</strong>
63
 
</dt>
64
 
<dd>
65
 
<p>
66
 
    Run Python doctests in <b>asciidoc</b> module.
67
 
</p>
68
 
</dd>
69
 
<dt>
70
 
<strong>-d, --doctype</strong>=<b>DOCTYPE</b>
71
 
</dt>
72
 
<dd>
73
 
<p>
74
 
    Document type: <b>article</b>, <b>manpage</b> or <b>book</b>. The <b>book</b> document
75
 
    type is only supported by the <b>docbook</b> backend.  Default document
76
 
    type is <b>article</b>.
77
 
</p>
78
 
</dd>
79
 
<dt>
80
 
<strong>-c, --dump-conf</strong>
81
 
</dt>
82
 
<dd>
83
 
<p>
84
 
    Dump configuration to stdout.
85
 
</p>
86
 
</dd>
87
 
<dt>
88
 
<strong>-h, --help</strong>[=<b>TOPIC</b>]
89
 
</dt>
90
 
<dd>
91
 
<p>
92
 
    Print help TOPIC. <strong>--help</strong>=<b>topics</b> will print a list of help
93
 
    topics, <strong>--help</strong>=<b>syntax</b> summarizes AsciiDoc syntax,
94
 
    <strong>--help</strong>=<b>manpage</b> prints the AsciiDoc manpage.
95
 
</p>
96
 
</dd>
97
 
<dt>
98
 
<strong>-e, --no-conf</strong>
99
 
</dt>
100
 
<dd>
101
 
<p>
102
 
    Exclude implicitly loaded configuration files except for those
103
 
    named like the input file (<b>infile.conf</b> and
104
 
    <b>infile-backend.conf</b>).
105
 
</p>
106
 
</dd>
107
 
<dt>
108
 
<strong>-s, --no-header-footer</strong>
109
 
</dt>
110
 
<dd>
111
 
<p>
112
 
    Suppress document header and footer output.
113
 
</p>
114
 
</dd>
115
 
<dt>
116
 
<strong>-o, --out-file</strong>=<b>OUT_FILE</b>
117
 
</dt>
118
 
<dd>
119
 
<p>
120
 
    Write output to file <b>OUT_FILE</b>. Defaults to the base name of
121
 
    input file with <b>backend</b> extension. If the input is stdin then
122
 
    the outfile defaults to stdout. If <b>OUT_FILE</b> is <b>-</b> then the
123
 
    standard output is used.
124
 
</p>
125
 
</dd>
126
 
<dt>
127
 
<strong>-n, --section-numbers</strong>
128
 
</dt>
129
 
<dd>
130
 
<p>
131
 
    Auto-number HTML article section titles.  Synonym for <strong>-a
132
 
    numbered</strong>.
133
 
</p>
134
 
</dd>
135
 
<dt>
136
 
<strong>--safe</strong>
137
 
</dt>
138
 
<dd>
139
 
<p>
140
 
    Enable safe mode. Safe mode is disabled by default.  AsciiDoc
141
 
    <b>safe mode</b> skips potentially dangerous scripted sections in
142
 
    AsciiDoc source files.
143
 
</p>
144
 
</dd>
145
 
<dt>
146
 
<strong>-v, --verbose</strong>
147
 
</dt>
148
 
<dd>
149
 
<p>
150
 
    Verbosely print processing information and configuration file
151
 
    checks to stderr.
152
 
</p>
153
 
</dd>
154
 
<dt>
155
 
<strong>--version</strong>
156
 
</dt>
157
 
<dd>
158
 
<p>
159
 
    Print program version number.
160
 
</p>
161
 
</dd>
162
 
</dl>
163
 
<h2><a name="_exit_status"></a>EXIT STATUS</h2>
164
 
<dl>
165
 
<dt>
166
 
<strong>0</strong>
167
 
</dt>
168
 
<dd>
169
 
<p>
170
 
    Success
171
 
</p>
172
 
</dd>
173
 
<dt>
174
 
<strong>1</strong>
175
 
</dt>
176
 
<dd>
177
 
<p>
178
 
    Failure (syntax or usage error; configuration error; document
179
 
    processing failure; unexpected error).
180
 
</p>
181
 
</dd>
182
 
</dl>
183
 
<h2><a name="_bugs"></a>BUGS</h2>
184
 
<p>See the AsciiDoc distribution BUGS file.</p>
185
 
<h2><a name="_author"></a>AUTHOR</h2>
186
 
<p>Written by Stuart Rackham, &lt;<a href="mailto:srackham@gmail.com">srackham@gmail.com</a>&gt;</p>
187
 
<h2><a name="_resources"></a>RESOURCES</h2>
188
 
<p>SourceForge: <a href="http://sourceforge.net/projects/asciidoc/">http://sourceforge.net/projects/asciidoc/</a></p>
189
 
<p>Main web site: <a href="http://www.methods.co.nz/asciidoc/">http://www.methods.co.nz/asciidoc/</a></p>
190
 
<h2><a name="_copying"></a>COPYING</h2>
191
 
<p>Copyright (C) 2002-2009 Stuart Rackham. Free use of this software is
192
 
granted under the terms of the GNU General Public License (GPL).</p>
193
 
<p></p>
194
 
<p></p>
195
 
<hr><p><small>
196
 
Version 8.5.2<br>
197
 
Last updated 2009-11-18 13:43:26 NZDT
198
 
</small></p>
199
 
</body>
200
 
</html>