asciidoc/doc/asciidoc.1.txt in mizuho-0.9.10 vs asciidoc/doc/asciidoc.1.txt in mizuho-0.9.11
- old
+ new
@@ -32,14 +32,15 @@
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',
- 'wordpress' or 'latex' (the 'latex' backend is experimental).
- You can also the backend alias names 'html' (aliased to 'xhtml11')
- or 'docbook' (aliased to 'docbook45').
- Defaults to 'html'.
+ '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.
@@ -53,12 +54,15 @@
type is 'article'.
*-c, --dump-conf*::
Dump configuration to stdout.
-*--filter*::
- Manage asciidoc(1) filters (see <<X1,*FILTER COMMANDS*>>).
+*--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.
@@ -76,65 +80,87 @@
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 *-a
- numbered*.
+ 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]]
-FILTER COMMANDS
+PLUGIN COMMANDS
---------------
-The *--filter* option is used to install, remove and list AsciiDoc
-filter plugins. Filter commands syntax:
+The asciidoc(1) *--filter*, *--backend* and *--theme* options are used
+to install, remove and list AsciiDoc filter, backend and theme
+plugins. Syntax:
- asciidoc --filter install ZIP_FILE [FILTERS_DIR]
- asciidoc --filter remove FILTER_NAME [FILTERS_DIR]
- asciidoc --filter list
+ 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:
-*FILTER_NAME*::
- A unique filter name containing only alphanumeric or underscore
+*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 filter resources, the name must start with the
- filter name e.g. `my_filter-1.0.zip` packages filter `my_filter`.
+ 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`.
-*FILTERS_DIR*::
- The directory containing installed filters. Each filter is contained
+*PLUGINS_DIR*::
+ The directory containing installed plugins. Each plugin is contained
in its own separate subdirectory which has the same name as the
- filter.
- *FILTERS_DIR* defaults to the `.asciidoc/filters` directory in the
- user's home directory.
+ 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).
-The filter commands perform as follows:
+*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 *FILTERS_DIR* with the same name as the
- filter then extract the *ZIP_FILE* into it.
+ Create a subdirectory in *PLUGINS_DIR* with the same name as the
+ plugin then extract the *ZIP_FILE* into it.
*remove*::
- Delete the *FILTER_NAME* filter subdirectory and all its contents from
- the *FILTERS_DIR*.
+ Delete the *PLUGIN_NAME* plugin subdirectory and all its contents
+ from the *PLUGINS_DIR*.
*list*::
- List the names and locations of all installed filters (including
- standard filters installed in the global configuration directory).
+ 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.
EXIT STATUS
-----------
*0*::