1 | '\" t |
---|
2 | .\" Title: asciidoc |
---|
3 | .\" Author: [see the "AUTHOR" section] |
---|
4 | .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> |
---|
5 | .\" Date: 17 July 2012 |
---|
6 | .\" Manual: \ \& |
---|
7 | .\" Source: \ \& 8.6.8 |
---|
8 | .\" Language: English |
---|
9 | .\" |
---|
10 | .TH "ASCIIDOC" "1" "17 July 2012" "\ \& 8\&.6\&.8" "\ \&" |
---|
11 | .\" ----------------------------------------------------------------- |
---|
12 | .\" * Define some portability stuff |
---|
13 | .\" ----------------------------------------------------------------- |
---|
14 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
15 | .\" http://bugs.debian.org/507673 |
---|
16 | .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
---|
17 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
18 | .ie \n(.g .ds Aq \(aq |
---|
19 | .el .ds Aq ' |
---|
20 | .\" ----------------------------------------------------------------- |
---|
21 | .\" * set default formatting |
---|
22 | .\" ----------------------------------------------------------------- |
---|
23 | .\" disable hyphenation |
---|
24 | .nh |
---|
25 | .\" disable justification (adjust text to left margin only) |
---|
26 | .ad l |
---|
27 | .\" ----------------------------------------------------------------- |
---|
28 | .\" * MAIN CONTENT STARTS HERE * |
---|
29 | .\" ----------------------------------------------------------------- |
---|
30 | .SH "NAME" |
---|
31 | asciidoc \- converts an AsciiDoc text file to HTML or DocBook |
---|
32 | .SH "SYNOPSIS" |
---|
33 | .sp |
---|
34 | \fBasciidoc\fR [\fIOPTIONS\fR] \fIFILE\fR |
---|
35 | .SH "DESCRIPTION" |
---|
36 | .sp |
---|
37 | The asciidoc(1) command translates the AsciiDoc text file \fIFILE\fR to DocBook or HTML\&. If \fIFILE\fR is \fI\-\fR then the standard input is used\&. |
---|
38 | .SH "OPTIONS" |
---|
39 | .PP |
---|
40 | \fB\-a, \-\-attribute\fR=\fIATTRIBUTE\fR |
---|
41 | .RS 4 |
---|
42 | Define or delete document attribute\&. |
---|
43 | \fIATTRIBUTE\fR |
---|
44 | is formatted like |
---|
45 | \fINAME=VALUE\fR\&. Command\-line attributes take precedence over document and configuration file attributes\&. Alternate acceptable forms are |
---|
46 | \fINAME\fR |
---|
47 | (the |
---|
48 | \fIVALUE\fR |
---|
49 | defaults to an empty string); |
---|
50 | \fINAME!\fR |
---|
51 | (delete the |
---|
52 | \fINAME\fR |
---|
53 | attribute); |
---|
54 | \fINAME=VALUE@\fR |
---|
55 | (do not override document or configuration file attributes)\&. Values containing spaces should be enclosed in double\-quote characters\&. This option may be specified more than once\&. A special attribute named |
---|
56 | \fItrace\fR |
---|
57 | controls the output of diagnostic information\&. |
---|
58 | .RE |
---|
59 | .PP |
---|
60 | \fB\-b, \-\-backend\fR=\fIBACKEND\fR |
---|
61 | .RS 4 |
---|
62 | Backend output file format: |
---|
63 | \fIdocbook45\fR, |
---|
64 | \fIxhtml11\fR, |
---|
65 | \fIhtml4\fR, |
---|
66 | \fIhtml5\fR, |
---|
67 | \fIslidy\fR, |
---|
68 | \fIwordpress\fR |
---|
69 | or |
---|
70 | \fIlatex\fR |
---|
71 | (the |
---|
72 | \fIlatex\fR |
---|
73 | backend is experimental)\&. You can also use the backend alias names |
---|
74 | \fIhtml\fR |
---|
75 | (aliased to |
---|
76 | \fIxhtml11\fR) or |
---|
77 | \fIdocbook\fR |
---|
78 | (aliased to |
---|
79 | \fIdocbook45\fR)\&. Defaults to |
---|
80 | \fIhtml\fR\&. The |
---|
81 | \fB\-\-backend\fR |
---|
82 | option is also used to manage backend plugins (see |
---|
83 | \fBPLUGIN COMMANDS\fR)\&. |
---|
84 | .RE |
---|
85 | .PP |
---|
86 | \fB\-f, \-\-conf\-file\fR=\fICONF_FILE\fR |
---|
87 | .RS 4 |
---|
88 | Use configuration file |
---|
89 | \fICONF_FILE\fR\&.Configuration files processed in command\-line order (after implicit configuration files)\&. This option may be specified more than once\&. |
---|
90 | .RE |
---|
91 | .PP |
---|
92 | \fB\-\-doctest\fR |
---|
93 | .RS 4 |
---|
94 | Run Python doctests in |
---|
95 | \fIasciidoc\fR |
---|
96 | module\&. |
---|
97 | .RE |
---|
98 | .PP |
---|
99 | \fB\-d, \-\-doctype\fR=\fIDOCTYPE\fR |
---|
100 | .RS 4 |
---|
101 | Document type: |
---|
102 | \fIarticle\fR, |
---|
103 | \fImanpage\fR |
---|
104 | or |
---|
105 | \fIbook\fR\&. The |
---|
106 | \fIbook\fR |
---|
107 | document type is only supported by the |
---|
108 | \fIdocbook\fR |
---|
109 | backend\&. Default document type is |
---|
110 | \fIarticle\fR\&. |
---|
111 | .RE |
---|
112 | .PP |
---|
113 | \fB\-c, \-\-dump\-conf\fR |
---|
114 | .RS 4 |
---|
115 | Dump configuration to stdout\&. |
---|
116 | .RE |
---|
117 | .PP |
---|
118 | \fB\-\-filter\fR=\fIFILTER\fR |
---|
119 | .RS 4 |
---|
120 | Specify the name of a filter to be loaded (used to load filters that are not auto\-loaded)\&. This option may be specified more than once\&. The |
---|
121 | \fB\-\-filter\fR |
---|
122 | option is also used to manage filter plugins (see |
---|
123 | \fBPLUGIN COMMANDS\fR)\&. |
---|
124 | .RE |
---|
125 | .PP |
---|
126 | \fB\-h, \-\-help\fR [\fITOPIC\fR] |
---|
127 | .RS 4 |
---|
128 | Print help TOPIC\&. |
---|
129 | \fB\-\-help\fR |
---|
130 | \fItopics\fR |
---|
131 | will print a list of help topics, |
---|
132 | \fB\-\-help\fR |
---|
133 | \fIsyntax\fR |
---|
134 | summarizes AsciiDoc syntax, |
---|
135 | \fB\-\-help\fR |
---|
136 | \fImanpage\fR |
---|
137 | prints the AsciiDoc manpage\&. |
---|
138 | .RE |
---|
139 | .PP |
---|
140 | \fB\-e, \-\-no\-conf\fR |
---|
141 | .RS 4 |
---|
142 | Exclude implicitly loaded configuration files except for those named like the input file (\fIinfile\&.conf\fR |
---|
143 | and |
---|
144 | \fIinfile\-backend\&.conf\fR)\&. |
---|
145 | .RE |
---|
146 | .PP |
---|
147 | \fB\-s, \-\-no\-header\-footer\fR |
---|
148 | .RS 4 |
---|
149 | Suppress document header and footer output\&. |
---|
150 | .RE |
---|
151 | .PP |
---|
152 | \fB\-o, \-\-out\-file\fR=\fIOUT_FILE\fR |
---|
153 | .RS 4 |
---|
154 | Write output to file |
---|
155 | \fIOUT_FILE\fR\&. Defaults to the base name of input file with |
---|
156 | \fIbackend\fR |
---|
157 | extension\&. If the input is stdin then the outfile defaults to stdout\&. If |
---|
158 | \fIOUT_FILE\fR |
---|
159 | is |
---|
160 | \fI\-\fR |
---|
161 | then the standard output is used\&. |
---|
162 | .RE |
---|
163 | .PP |
---|
164 | \fB\-n, \-\-section\-numbers\fR |
---|
165 | .RS 4 |
---|
166 | Auto\-number HTML article section titles\&. Synonym for |
---|
167 | \fB\-\-attribute numbered\fR\&. |
---|
168 | .RE |
---|
169 | .PP |
---|
170 | \fB\-\-safe\fR |
---|
171 | .RS 4 |
---|
172 | Enable safe mode\&. Safe mode is disabled by default\&. AsciiDoc |
---|
173 | \fIsafe mode\fR |
---|
174 | skips potentially dangerous scripted sections in AsciiDoc source files\&. |
---|
175 | .RE |
---|
176 | .PP |
---|
177 | \fB\-\-theme\fR=\fITHEME\fR |
---|
178 | .RS 4 |
---|
179 | Specify a theme name\&. Synonym for |
---|
180 | \fB\-\-attribute theme\fR=\fITHEME\fR\&. The |
---|
181 | \fB\-\-theme\fR |
---|
182 | option is also used to manage theme plugins (see |
---|
183 | \fBPLUGIN COMMANDS\fR)\&. |
---|
184 | .RE |
---|
185 | .PP |
---|
186 | \fB\-v, \-\-verbose\fR |
---|
187 | .RS 4 |
---|
188 | Verbosely print processing information and configuration file checks to stderr\&. |
---|
189 | .RE |
---|
190 | .PP |
---|
191 | \fB\-\-version\fR |
---|
192 | .RS 4 |
---|
193 | Print program version number\&. |
---|
194 | .RE |
---|
195 | .SH "PLUGIN COMMANDS" |
---|
196 | .sp |
---|
197 | The asciidoc(1) \fB\-\-filter\fR, \fB\-\-backend\fR and \fB\-\-theme\fR options are used to install, remove and list AsciiDoc filter, backend and theme plugins\&. Syntax: |
---|
198 | .sp |
---|
199 | .if n \{\ |
---|
200 | .RS 4 |
---|
201 | .\} |
---|
202 | .nf |
---|
203 | asciidoc OPTION install ZIP_FILE [PLUGINS_DIR] |
---|
204 | asciidoc OPTION remove PLUGIN_NAME [PLUGINS_DIR] |
---|
205 | asciidoc OPTION list |
---|
206 | asciidoc OPTION build ZIP_FILE PLUGIN_SOURCE |
---|
207 | .fi |
---|
208 | .if n \{\ |
---|
209 | .RE |
---|
210 | .\} |
---|
211 | .sp |
---|
212 | Where: |
---|
213 | .PP |
---|
214 | \fBOPTION\fR |
---|
215 | .RS 4 |
---|
216 | asciidoc(1) |
---|
217 | \fB\-\-filter\fR, |
---|
218 | \fB\-\-backend\fR |
---|
219 | or |
---|
220 | \fB\-\-theme\fR |
---|
221 | option specifying the type of plugin\&. |
---|
222 | .RE |
---|
223 | .PP |
---|
224 | \fBPLUGIN_NAME\fR |
---|
225 | .RS 4 |
---|
226 | A unique plugin name containing only alphanumeric or underscore characters\&. |
---|
227 | .RE |
---|
228 | .PP |
---|
229 | \fBZIP_FILE\fR |
---|
230 | .RS 4 |
---|
231 | A Zip file containing plugin resources, the name must start with the plugin name e\&.g\&. |
---|
232 | my_filter\-1\&.0\&.zip |
---|
233 | packages filter |
---|
234 | my_filter\&. |
---|
235 | .RE |
---|
236 | .PP |
---|
237 | \fBPLUGINS_DIR\fR |
---|
238 | .RS 4 |
---|
239 | The directory containing installed plugins\&. Each plugin is contained in its own separate subdirectory which has the same name as the plugin\&. |
---|
240 | \fBPLUGINS_DIR\fR |
---|
241 | defaults to the |
---|
242 | $HOME/\&.asciidoc/filters |
---|
243 | (for filter plugins) or |
---|
244 | $HOME/\&.asciidoc/backends |
---|
245 | (for backend plugins) or |
---|
246 | $HOME/\&.asciidoc/themes |
---|
247 | (for theme plugins)\&. |
---|
248 | .RE |
---|
249 | .PP |
---|
250 | \fBPLUGIN_SOURCE\fR |
---|
251 | .RS 4 |
---|
252 | The name of a directory containing the plugin source files or the name of a single source file\&. |
---|
253 | .RE |
---|
254 | .sp |
---|
255 | The plugin commands perform as follows: |
---|
256 | .PP |
---|
257 | \fBinstall\fR |
---|
258 | .RS 4 |
---|
259 | Create a subdirectory in |
---|
260 | \fBPLUGINS_DIR\fR |
---|
261 | with the same name as the plugin then extract the |
---|
262 | \fBZIP_FILE\fR |
---|
263 | into it\&. |
---|
264 | .RE |
---|
265 | .PP |
---|
266 | \fBremove\fR |
---|
267 | .RS 4 |
---|
268 | Delete the |
---|
269 | \fBPLUGIN_NAME\fR |
---|
270 | plugin subdirectory and all its contents from the |
---|
271 | \fBPLUGINS_DIR\fR\&. |
---|
272 | .RE |
---|
273 | .PP |
---|
274 | \fBlist\fR |
---|
275 | .RS 4 |
---|
276 | List the names and locations of all installed filter or theme plugins (including standard plugins installed in the global configuration directory)\&. |
---|
277 | .RE |
---|
278 | .PP |
---|
279 | \fBbuild\fR |
---|
280 | .RS 4 |
---|
281 | Create a plugin file named |
---|
282 | \fBZIP_FILE\fR |
---|
283 | containing the files and subdirectories specified by |
---|
284 | \fBPLUGIN_SOURCE\fR\&. File and directory names starting with a period are skipped\&. |
---|
285 | .RE |
---|
286 | .SH "EXIT STATUS" |
---|
287 | .PP |
---|
288 | \fB0\fR |
---|
289 | .RS 4 |
---|
290 | Success |
---|
291 | .RE |
---|
292 | .PP |
---|
293 | \fB1\fR |
---|
294 | .RS 4 |
---|
295 | Failure (syntax or usage error; configuration error; document processing failure; unexpected error)\&. |
---|
296 | .RE |
---|
297 | .SH "BUGS" |
---|
298 | .sp |
---|
299 | See the AsciiDoc distribution BUGS file\&. |
---|
300 | .SH "AUTHOR" |
---|
301 | .sp |
---|
302 | AsciiDoc was originally written by Stuart Rackham\&. Many people have contributed to it\&. |
---|
303 | .SH "RESOURCES" |
---|
304 | .sp |
---|
305 | SourceForge: http://sourceforge\&.net/projects/asciidoc/ |
---|
306 | .sp |
---|
307 | Main web site: http://www\&.methods\&.co\&.nz/asciidoc/ |
---|
308 | .SH "COPYING" |
---|
309 | .sp |
---|
310 | Copyright (C) 2002\-2011 Stuart Rackham\&. Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. |
---|