NAME

getxcatdocs - downloads the xCAT documentation and converts to HTML and PDF


SYNOPSIS

getxcatdocs [-? | -h | --help | -v | --version] [destination-dir]


DESCRIPTION

The getxcatdocs command downloads the xCAT documentation from the wiki and converts it to both HTML and PDF. This enables reading the documentation when you do not have internet access. Note that this command does not download/convert the entire xCAT wiki - only the ``official'' xCAT documentation linked from https://sourceforge.net/apps/mediawiki/xcat/index.php?title=XCAT_Documentation .

If destination-dir is specified, getxcatdocs will put the converted documentation in that directory, in 2 sub-directories: html, pdf. Otherwise, it will put it in the current directory (in the same two sub-directories).

getxcatdocs uses wget to do the download the documents and xhtml2pdf to convert them to PDF. To install xhtml2pdf, see: https://sourceforge.net/apps/mediawiki/xcat/index.php?title=Editing_xCAT_Documentation_Pages#Converting_Wiki_Pages_to_HTML_and_PDFs .

Limitations:


OPTIONS

-v|--version

Command Version.

-?|-h|--help

Display usage message.


RETURN VALUE

0 The command completed successfully.

1 An error has occurred.


EXAMPLES

  1. To download/convert the documentation and put it in ~/tmp:

     getxcatdocs ~/tmp


FILES

/opt/xcat/bin/getxcatdocs