diff options
author | Stuart Rackham <srackham@methods.co.nz> | 2011-03-22 10:25:28 +1300 |
---|---|---|
committer | Stuart Rackham <srackham@methods.co.nz> | 2011-03-22 10:25:28 +1300 |
commit | 30c8506ab05ea1c4ff08fc4c4fb95c477c329ccd (patch) | |
tree | 644d34e37746c3dce5c38aacfcefb7a0ee175a12 /doc/a2x.1.txt | |
parent | 898dd40cafeb257a5c641da2d362527f04db396e (diff) | |
download | asciidoc-git-30c8506ab05ea1c4ff08fc4c4fb95c477c329ccd.tar.gz |
- a2x: assume resource option is a directory if the name ends with a directory
separator.
- a2x: man page updates.
- a2x: updated 'AsciiDoc EPUB Notes'.
Diffstat (limited to 'doc/a2x.1.txt')
-rw-r--r-- | doc/a2x.1.txt | 55 |
1 files changed, 33 insertions, 22 deletions
diff --git a/doc/a2x.1.txt b/doc/a2x.1.txt index f222289..15c6759 100644 --- a/doc/a2x.1.txt +++ b/doc/a2x.1.txt @@ -83,12 +83,12 @@ OPTIONS *-m, --resource-manifest*='FILE':: 'FILE' contains a list resources (one per line). Manifest 'FILE' - entries are treated just like *--resource* option arguments. + entries are formatted just like *--resource* option arguments. *--stylesheet*='STYLESHEET':: - The file name of the docbook-xsl CSS stylesheet file. Defaults to - 'docbook-xsl.css'. The stylesheet must reside in a valid <<X3, - resource file>> location. + The file name of the CSS stylesheet file that is used to style HTML + output generated by docbook-xsl. Defaults to 'docbook-xsl.css'. The + stylesheet must reside in a valid <<X3, resource file>> location. Applies to HTML formats: 'xhtml', 'epub', 'chunked', 'htmlhelp' formats. @@ -170,20 +170,29 @@ using the *--resource* option. following order: . The 'SOURCE_FILE' directory. -. Resource directories (specified by *--resource* and - *--resource-manifest* options) are searched recursively. -. The 'asciidoc(1)' `images` and `stylesheets` configuration file - directories are searched recursively. +. Resource directories specified by the *--resource* option (searched + recursively). +. Resource directories specified by the *--resource-manifest* option + (searched recursively in the order they appear in the manifest + file). +. The stock `images` and `stylesheets` directories in the + 'asciidoc(1)' configuration files directories (searched + recursively). . The destination directory. -When a resource is found it is copied to the correct relative -destination directory. Destination sub-directories are created +When a resource file is found it is copied to the correct relative +destination directory. Missing destination sub-directories are created automatically. -A resource specifier (*--resource* option 'RESOURCE_SPEC') can specify -a single resource file or a directory to be recursively searched for -resource files. A resource specifier can be either of the following -two formats: +There are two distinct mechanisms for specifying additional resources: + +. A resource directory which will be searched recursively for missing + resource files. +. A resouce file which will be copied to the output destination + directory. + +Resources are defined by the *--resource* option value and can be +either of the following two formats: <resource_dir> <resource_file>[=<destination_file>] @@ -192,28 +201,30 @@ Where: `<resource_dir>`:: Specifies a directory (absolute or relative to the 'SOURCE_FILE') - which is searched recursively for resource files. + which is searched recursively for missing resource files. To + eliminate ambiguity the `<resource_dir>` name should end with a + directory separator character. `<resource_file>`:: Specifies a resource file (absolute or relative to the - 'SOURCE_FILE') which is copied to `<destination_file>`. If + 'SOURCE_FILE') which will be copied to `<destination_file>`. If `<destination_file>` is not specified then it is the same as the `<resource_file>`. `<destination_file>`:: Specifies the destination of the copied source file. The `<destination_file>` path is relative to the destination directory - (absolute paths are not allowed). The destination directory is - format dependent (see the <<X4,*OUTPUT FILES*>> section for - details): + (absolute paths are not allowed). The location of the destination + directory depends on the output 'FORMAT' (see the <<X4,*OUTPUT + FILES*>> section for details): - chunked, htmlhelp;; The chunked directory. + chunked, htmlhelp;; The chunked output directory. epub;; The archived `OEBPS` directory. - xhtml;; The *DESTINATION_DIR*. + xhtml;; The output *DESTINATION_DIR*. Resource specifier examples: - ../images + ../images/ doc/README.txt=README.txt /home/srackham/images/tiger.png=images/tiger.png |