Commits

Anonymous committed b98e190

Documentation updates.

Comments (0)

Files changed (3)

doc/asciidoc.1.txt

 
 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.
+The asciidoc(1) command translates the AsciiDoc text file 'FILE' to
+DocBook or HTML.  If 'FILE' is '-' then the standard input is used.
 
 
 OPTIONS
 [[X1]]
 FILTER COMMANDS
 ---------------
-The *--filter* option is used to manage AsciiDoc filters. Filter
-command syntax:
+The *--filter* option is used to install, remove and list AsciiDoc
+filter plugins. Filter commands syntax:
 
   asciidoc --filter install ZIP_FILE [FILTERS_DIR]
   asciidoc --filter remove FILTER_NAME [FILTERS_DIR]
 http://en.wikipedia.org/wiki/Web_colors#HTML_color_names[sixteen HTML
 color names].  Examples:
 
-  [red]#obvious#
-  [big red yellow-background]*very obvious*
+  [red]#Obvious# and [big red yellow-background]*very obvious*.
+
+is rendered as:
+
+[red]#Obvious# and [big red yellow-background]*very obvious*.
 
 [[X52]]
 Constrained and Unconstrained Quotes
 
 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.
+  The asciidoc(1) command translates the AsciiDoc text file FILE to
+  DocBook or HTML.  If FILE is - then the standard input is used.
 
 
 OPTIONS
       Print program version number.
 
 
+FILTER COMMANDS
+
+   The --filter option is used to install, remove and list AsciiDoc filter
+   plugins. Filter commands syntax:
+
+       asciidoc --filter install ZIP_FILE [FILTERS_DIR]
+       asciidoc --filter remove FILTER_NAME [FILTERS_DIR]
+       asciidoc --filter list
+
+   Where:
+
+   FILTER_NAME
+       A unique filter 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.
+
+   FILTERS_DIR
+       The directory containing installed filters. Each filter 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.
+
+   The filter 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.
+
+   remove
+       Delete the FILTER_NAME filter subdirectory and all its contents
+       from the FILTERS_DIR.
+
+   list
+       List the names and locations of all installed filters (including
+       standard filters installed in the global configuration directory).
+
+
 EXIT STATUS
 
   0