ASCIIDOC(1) Manual Page
NAME
asciidoc - converts an AsciiDoc text file to DocBook, HTML or LinuxDoc
SYNOPSIS
asciidoc -b backend [ -d doctype ] [ -a attribute ] [ -e ] [-n] [ -s ] [ -f configfile ] [ -o outfile ] [ —help | -h ] [ —version ] [ -v ] [ -c ] infile
DESCRIPTION
The asciidoc(1) command translates the AsciiDoc text file infile to the backend formatted file outfile. If infile is - then the standard input is used.
OPTIONS
- —help, -h
- Print this documentation.
- -a attribute
- Define document attribute. attribute is formatted like name=value. Alternate acceptable forms are name (the value defaults to an empty string) and ^name (delete the name attribute).
- -b backend
- Backend output file format: docbook, docbook-sgml, xhtml, html. css, css-embedded, linuxdoc. docbook generates DocBook XML; xhtml generates XHTML; html generates HTML 4.
- -c
- Dump configuration to stdout.
- -e
- Exclude implicitly loaded configuration files except for those named like the input file (infile.conf and infile-backend.conf).
- -d doctype
- Document type: article, manpage or book. The book document type is only supported by the docbook backend and the manpage document type is not supported by the linuxdoc backend.
- -f configfile
- Use configuration file configfile.
- -n
- Auto-number HTML article section titles. Synonym for -a section-numbers.
- -o outfile
- Write output to file outfile. Defaults to the base name of input file with backend extension. If the input is stdin then the outfile defaults to stdout. If outfile is - then the standard output is used.
- -s
- Suppress document header and footer output.
- -v
- Verbosely print processing information and configuration file checks to stderr.
- —version
- Print program version number.
BUGS
See the AsciiDoc distribution BUGS file.
AUTHOR
Written by Stuart Rackham, <srackham@methods.co.nz>
RESOURCES
SourceForge: http://sourceforge.net/projects/asciidoc/
Main web site: http://www.methods.co.nz/asciidoc/
COPYING
Copyright © 2002,2005 Stuart Rackham. Free use of this software is granted under the terms of the GNU General Public License (GPL).