xcat-core/xCAT-client/pods/man1/getxcatdocs.1.pod

=head1 NAME

B<getxcatdocs> - downloads the xCAT documentation and converts to HTML and PDF

=head1 SYNOPSIS

B<getxcatdocs> [B<-?> | B<-h> | B<--help>]
B<getxcatdocs> [B<-v> | B<--verbose>] [I<destination-dir>]
B<getxcatdocs> [B<-v> | B<--verbose>] [B<-c> | B<--continue>] [B<-d> | B<--doc> I<single_doc>] [I<destination-dir>]

=head1 DESCRIPTION

The B<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 http://sourceforge.net/p/xcat/wiki/XCAT_Documentation.

If I<destination-dir> is specified, B<getxcatdocs> will put the converted documentation in that directory, in 3 sub-directories: html, pdf, images.
Otherwise, it will put it in the current directory (in the same three sub-directories).

If B<--doc> I<single_doc> is specified, only that one wiki page will be downloaded and converted.  

B<getxcatdocs> uses curl to run the Allura wiki API to download the document markdown text, and Pandoc with LaTex them to PDF.  You must have all of these functions installed to run B<getxcatdocs>.  See:
http://sourceforge.net/p/xcat/wiki/Editing_and_Downloading_xCAT_Documentation/#converting-wiki-pages-to-html-and-pdfs 

=head2 Limitations:

=over 3

=item *

This command does not run on AIX or Windows.

=back

=head1 OPTIONS

=over 10

=item B<-?|-h|--help>

Display usage message.

=item B<-v|--verbose>

Run the command in verbose mode.

=item B<-c|--continue>

If a previous run of this command failed (which often happens if you lose your network connection), continue processing using files already downloaded to your markdown directory.

=item B<-d|--doc> I<single_doc>

Run this command for a single document only.  If you get errors about Official-xcat-doc.png not found, either download this image directly from http://sourceforge.net/p/xcat/wiki/XCAT_Documentation/attachment/Official-xcat-doc.png or run B<getxcatdocs -d XCAT_Documentation> first.

=back

=head1 RETURN VALUE

0  The command completed successfully.

1  An error has occurred.

=head1 EXAMPLES

=over 3

=item 1.

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

 getxcatdocs ~/tmp

=back

=head1 FILES

/opt/xcat/bin/getxcatdocs