From RTSC-Pedia
 | [printable version] [offline version] | offline version generated on 04-Aug-2010 21:08 UTC |  |
Command - xdc.tools.cdoc
Package documentation tool
Contents |
Synopsis
| | xs xdc.tools.cdoc [options ...] |
For a complete description of this tool's options, see its static Cdoc reference page xdc.tools.cdoc. Alternatively, you can always view this reference documentation using the interactive version of this tool (xdc.tools.cdoc.sg) from the command line.
% xs xdc.tools.cdoc.sg xdc.tools.cdoc
Description
In addition to viewing reference documentation interactively as described in Using the CDOC reference help system, you can run a "batch" version of the CDOC tool to generate static HTML files for any collection of packages. After generating static pages, you can leverage popular search tools such as Google Desktop to locate relevant documentation or use a tool like htmldoc to create a single PDF reference manual.
Examples
Suppose for example that you have packages installed in the repositories c:/bios_6_00/packages and c:/codec_engine_1_20/packages. The following command generates configuration documentation for all of these packages and places it into the output directory named ref_html.
xs xdc.tools.cdoc -od:ref_html -Pr c:/bios_6_00/packages c:/codec_engine_1_20/packages
| [printable version] [offline version] | offline version generated on 04-Aug-2010 21:08 UTC | |
