summaryrefslogtreecommitdiff
path: root/help.conf
diff options
context:
space:
mode:
authorStuart Rackham <srackham@methods.co.nz>2008-07-04 09:47:12 +1200
committerStuart Rackham <srackham@methods.co.nz>2008-07-04 09:47:12 +1200
commitbdf88a2a0c3f5b13762b5691f264c9cb035a12ea (patch)
treeeb00ce6ca04abdf520e50b4b7db2195ba4ffb2d6 /help.conf
parent36bdc2ce174a4ebfce4169e802cbcd356d992a9a (diff)
downloadasciidoc-py3-bdf88a2a0c3f5b13762b5691f264c9cb035a12ea.tar.gz
Documentation updates: help file and minor errata.
Diffstat (limited to 'help.conf')
-rw-r--r--help.conf55
1 files changed, 33 insertions, 22 deletions
diff --git a/help.conf b/help.conf
index da20246..e268805 100644
--- a/help.conf
+++ b/help.conf
@@ -14,6 +14,7 @@ Syntax: asciidoc --help syntax
[manpage]
+
NAME
asciidoc - converts an AsciiDoc text file to DocBook, HTML or LinuxDoc
@@ -25,29 +26,29 @@ SYNOPSIS
DESCRIPTION
The asciidoc(1) command translates the AsciiDoc text file FILE to a
- DocBook, HTML or LinuxDoc file. If FILE is - then the standard input
- is used.
+ DocBook, HTML or LinuxDoc file. 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@ (do not
- override document or configuration file attributes). Values
- containing spaces should be enclosed in double-quote
- characters. Multiple instances allowed.
+ 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@ (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.
-b, --backend=BACKEND
Backend output file format: docbook, xhtml11 or html4. Defaults
to xhtml11.
-f, --conf-file=CONF_FILE
- Use configuration file CONF_FILE. Multiple instances allowed.
- Configuration files processed in command-line order (after
- implicit configuration files).
+ Use configuration file CONF_FILE.Configuration files processed
+ in command-line order (after implicit configuration files). This
+ option may be specified more than once.
-d, --doctype=DOCTYPE
Document type: article, manpage or book. The book document type
@@ -58,14 +59,13 @@ OPTIONS
Dump configuration to stdout.
-h, --help[=TOPIC]
- Print help TOPIC. --help topics will print a list of help
- topics, --help syntax summarises AsciiDoc syntax, --help
- manpage prints the AsciiDoc manpage.
+ 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).
+ named like the input file (infile.conf and infile-backend.conf).
-s, --no-header-footer
Suppress document header and footer output.
@@ -81,8 +81,8 @@ OPTIONS
numbered.
--unsafe
- Disable safe mode. Safe mode is enabled by default, disabling
- it is potentially dangerous.
+ Disable safe mode. Safe mode is enabled by default, disabling it
+ is potentially dangerous.
-v, --verbose
Verbosely print processing information and configuration file
@@ -91,6 +91,15 @@ OPTIONS
--version
Print program version number.
+EXIT STATUS
+
+ 0
+ Success
+
+ 1
+ Failure (syntax or usage error; configuration error; document
+ processing failure; unexpected error).
+
BUGS
See the AsciiDoc distribution BUGS file.
@@ -107,7 +116,7 @@ RESOURCES
COPYING
- Copyright (C) 2002-2007 Stuart Rackham. Free use of this software is
+ Copyright (C) 2002-2008 Stuart Rackham. Free use of this software is
granted under the terms of the GNU General Public License (GPL).
[syntax]
@@ -134,6 +143,8 @@ Document links
URLs
----
+ Use normal URL and email addess syntax or:
+
http:address[caption] (link to web page)
mailto:address[caption] (link to mail recipient)
@@ -174,7 +185,7 @@ Delimiters must begin at left margin.
sidebar block
*******************
- [author, source] (optional)
+ [style, author, cite] (optional)
___________________
quote block
___________________