File: asciidoc.1.txt

package info (click to toggle)
asciidoc 8.6.9-5
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 3,684 kB
  • sloc: python: 6,972; sh: 369; makefile: 144; xml: 77
file content (221 lines) | stat: -rw-r--r-- 6,663 bytes parent folder | download
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
ASCIIDOC(1)
===========
:doctype: manpage


NAME
----
asciidoc - converts an AsciiDoc text file to HTML or DocBook


SYNOPSIS
--------
*asciidoc* ['OPTIONS'] 'FILE'


DESCRIPTION
-----------
The asciidoc(1) command translates the AsciiDoc text file 'FILE' to
DocBook or HTML.  If 'FILE' is '-' then the standard input is used.


OPTIONS
-------
*-a, --attribute*='ATTRIBUTE'::
    Define or delete document attribute. 'ATTRIBUTE' is formatted like
    'NAME=VALUE'. Command-line attributes take precedence over
    document and configuration file attributes.  Alternate acceptable
    forms are 'NAME' (the 'VALUE' defaults to an empty string);
    'NAME!' (delete the 'NAME' attribute); 'NAME=VALUE@' (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
    'trace' controls the output of diagnostic information.

*-b, --backend*='BACKEND'::
    Backend output file format: 'docbook45', 'xhtml11', 'html4',
    'html5', 'slidy', 'wordpress' or 'latex' (the 'latex' backend is
    experimental).  You can also use the backend alias names 'html'
    (aliased to 'xhtml11') or 'docbook' (aliased to 'docbook45').
    Defaults to 'html'.  The *--backend* option is also used to manage
    backend plugins (see <<X1,*PLUGIN COMMANDS*>>).

*-f, --conf-file*='CONF_FILE'::
    Use configuration file 'CONF_FILE'.Configuration files processed
    in command-line order (after implicit configuration files).  This
    option may be specified more than once.

*--doctest*::
    Run Python doctests in 'asciidoc' module.

*-d, --doctype*='DOCTYPE'::
    Document type: 'article', 'manpage' or 'book'. The 'book' document
    type is only supported by the 'docbook' backend.  Default document
    type is 'article'.

*-c, --dump-conf*::
    Dump configuration to stdout.

*--filter*='FILTER'::
    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 *--filter* option is also used to manage filter plugins
    (see <<X1,*PLUGIN COMMANDS*>>).

*-h, --help* ['TOPIC']::
    Print help TOPIC. *--help* 'topics' will print a list of help
    topics, *--help* 'syntax' summarizes AsciiDoc syntax,
    *--help* 'manpage' prints the AsciiDoc manpage.

*-e, --no-conf*::
    Exclude implicitly loaded configuration files except for those
    named like the input file ('infile.conf' and
    'infile-backend.conf').

*-s, --no-header-footer*::
    Suppress document header and footer output.

*-o, --out-file*='OUT_FILE'::
    Write output to file 'OUT_FILE'. Defaults to the base name of
    input file with 'backend' extension. If the input is stdin then
    the outfile defaults to stdout. If 'OUT_FILE' is '-' then the
    standard output is used.

*-n, --section-numbers*::
    Auto-number HTML article section titles.  Synonym for
    *--attribute numbered*.

*--safe*::
    Enable safe mode. Safe mode is disabled by default.  AsciiDoc
    'safe mode' skips potentially dangerous scripted sections in
    AsciiDoc source files.

*--theme*='THEME'::
    Specify a theme name.  Synonym for *--attribute theme*='THEME'.
    The *--theme* option is also used to manage theme plugins (see
    <<X1,*PLUGIN COMMANDS*>>).

*-v, --verbose*::
    Verbosely print processing information and configuration file
    checks to stderr.

*--version*::
    Print program version number.


[[X1]]
PLUGIN COMMANDS
---------------
The asciidoc(1) *--filter*, *--backend* and *--theme* options are used
to install, remove and list AsciiDoc filter, backend and theme
plugins. Syntax:

  asciidoc OPTION install ZIP_FILE [PLUGINS_DIR]
  asciidoc OPTION remove PLUGIN_NAME [PLUGINS_DIR]
  asciidoc OPTION list
  asciidoc OPTION build ZIP_FILE PLUGIN_SOURCE

Where:

*OPTION*::
  asciidoc(1) *--filter*, *--backend* or *--theme* option specifying
  the type of plugin.

*PLUGIN_NAME*::
  A unique plugin name containing only alphanumeric or underscore
  characters.

*ZIP_FILE*::
  A Zip file containing plugin resources, the name must start with the
  plugin name e.g.  `my_filter-1.0.zip` packages filter `my_filter`.

*PLUGINS_DIR*::
  The directory containing installed plugins. Each plugin is contained
  in its own separate subdirectory which has the same name as the
  plugin.
  *PLUGINS_DIR* defaults to the `$HOME/.asciidoc/filters` (for
  filter plugins) or `$HOME/.asciidoc/backends` (for backend plugins) or
  `$HOME/.asciidoc/themes` (for theme plugins).

*PLUGIN_SOURCE*::
  The name of a directory containing the plugin source files or the
  name of a single source file.

The plugin commands perform as follows:

*install*::
  Create a subdirectory in *PLUGINS_DIR* with the same name as the
  plugin then extract the *ZIP_FILE* into it.

*remove*::
  Delete the *PLUGIN_NAME* plugin subdirectory and all its contents
  from the *PLUGINS_DIR*.

*list*::
  List the names and locations of all installed filter or theme
  plugins (including standard plugins installed in the global
  configuration directory).

*build*::
  Create a plugin file named *ZIP_FILE* containing the files and
  subdirectories specified by *PLUGIN_SOURCE*. File and directory
  names starting with a period are skipped.


EXAMPLES
--------
`asciidoc asciidoc_file_name.txt`::
  Simply generate an html file from the asciidoc_file_name.txt that is in
  current directory using asciidoc.

`asciidoc -b html5 asciidoc_file_name.txt`::
  Use the `-b` switch to use one of the proposed backend or another one you
  installed on your computer.

`asciidoc -a data-uri -a icons -a toc -a max-width=55em article.txt`::
  Use the `-a` switch to set attributes from command-line. AsciiDoc generated
  its stand-alone HTML user guide containing embedded CSS, JavaScript and
  images from the AsciiDoc article template with this command.

`asciidoc -b html5 -d manpage asciidoc.1.txt`::
  Generating the asciidoc manpage using the html5 backend.


EXIT STATUS
-----------
*0*::
    Success

*1*::
    Failure (syntax or usage error; configuration error; document
    processing failure; unexpected error).


BUGS
----
See the AsciiDoc distribution BUGS file.


AUTHOR
------
AsciiDoc was originally written by Stuart Rackham. Many people have
contributed to it.


RESOURCES
---------
SourceForge: <http://sourceforge.net/projects/asciidoc/>

Main web site: <http://asciidoc.org/>


SEE ALSO
--------
a2x(1)


COPYING
-------
Copyright \(C) 2002-2011 Stuart Rackham. Free use of this software is
granted under the terms of the GNU General Public License (GPL).