1ASCIIDOC(1)                                                        ASCIIDOC(1)
2
3
4

NAME

6       asciidoc - converts an AsciiDoc text file to HTML or DocBook
7

SYNOPSIS

9       asciidoc [OPTIONS] FILE
10
11

DESCRIPTION

13       The asciidoc(1) command translates the AsciiDoc text file FILE to a
14       DocBook, HTML or LinuxDoc file. If FILE is - then the standard input is
15       used.
16
17

OPTIONS

19       -a, --attribute=ATTRIBUTE
20           Define or delete document attribute.  ATTRIBUTE is formatted like
21           NAME=VALUE. Command-line attributes take precedence over document
22           and configuration file attributes. Alternate acceptable forms are
23           NAME (the VALUE defaults to an empty string); NAME!  (delete the
24           NAME attribute); NAME@ (do not override document or configuration
25           file attributes). Values containing spaces should be enclosed in
26           double-quote characters. This option may be specified more than
27           once. A special attribute named trace controls the output of
28           diagnostic information.
29
30       -b, --backend=BACKEND
31           Backend output file format: docbook, xhtml11 or html4. Defaults to
32           xhtml11.
33
34       -f, --conf-file=CONF_FILE
35           Use configuration file CONF_FILE.Configuration files processed in
36           command-line order (after implicit configuration files). This
37           option may be specified more than once.
38
39       --doctest
40           Run Python doctests in asciidoc module.
41
42       -d, --doctype=DOCTYPE
43           Document type: article, manpage or book. The book document type is
44           only supported by the docbook backend. Default document type is
45           article.
46
47       -c, --dump-conf
48           Dump configuration to stdout.
49
50       -h, --help[=TOPIC]
51           Print help TOPIC.  --help=topics will print a list of help topics,
52           --help=syntax summarizes AsciiDoc syntax, --help=manpage prints the
53           AsciiDoc manpage.
54
55       -e, --no-conf
56           Exclude implicitly loaded configuration files except for those
57           named like the input file (infile.conf and infile-backend.conf).
58
59       -s, --no-header-footer
60           Suppress document header and footer output.
61
62       -o, --out-file=OUT_FILE
63           Write output to file OUT_FILE. Defaults to the base name of input
64           file with backend extension. If the input is stdin then the outfile
65           defaults to stdout. If OUT_FILE is - then the standard output is
66           used.
67
68       -n, --section-numbers
69           Auto-number HTML article section titles. Synonym for -a numbered.
70
71       --safe
72           Enable safe mode. Safe mode is disabled by default.
73
74       -v, --verbose
75           Verbosely print processing information and configuration file
76           checks to stderr.
77
78       --version
79           Print program version number.
80

EXIT STATUS

82       0
83           Success
84
85       1
86           Failure (syntax or usage error; configuration error; document
87           processing failure; unexpected error).
88

BUGS

90       See the AsciiDoc distribution BUGS file.
91
92

AUTHOR

94       Written by Stuart Rackham, <srackham@gmail.com>
95
96

RESOURCES

98       SourceForge: http://sourceforge.net/projects/asciidoc/
99
100       Main web site: http://www.methods.co.nz/asciidoc/
101
102

COPYING

104       Copyright (C) 2002-2009 Stuart Rackham. Free use of this software is
105       granted under the terms of the GNU General Public License (GPL).
106
107
108
109
110                                  05/26/2009                       ASCIIDOC(1)
Impressum