2010-11-22 13:19:14 +00:00
=head1 NAME
B<getxcatdocs> - downloads the xCAT documentation and converts to HTML and PDF
=head1 SYNOPSIS
2014-08-21 23:03:46 +00:00
B<getxcatdocs> [B<-?> | B<-h> | B<--help>]
B<getxcatdocs> [B<-v> | B<--verbose>] [I<destination-dir>]
B<getxcatdocs> [B<-v> | B<--verbose>] [B<-d> | B<--doc> I<single_doc>] [I<destination-dir>]
2010-11-22 13:19:14 +00:00
=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
2014-08-21 23:03:46 +00:00
download/convert the entire xCAT wiki - only the "official" xCAT documentation linked from http://sourceforge.net/p/xcat/wiki/XCAT_Documentation.
2010-11-22 13:19:14 +00:00
2014-08-21 23:03:46 +00:00
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).
2010-11-22 13:19:14 +00:00
2014-08-21 23:03:46 +00:00
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
2010-11-22 13:19:14 +00:00
=head2 Limitations:
=over 3
=item *
This command does not run on AIX or Windows.
=back
=head1 OPTIONS
=over 10
2014-08-21 23:03:46 +00:00
=item B<-v|--verbose>
2010-11-22 13:19:14 +00:00
2014-08-21 23:03:46 +00:00
Run the command in verbose mode.
2010-11-22 13:19:14 +00:00
=item B<-?|-h|--help>
Display usage message.
2014-08-21 23:03:46 +00:00
=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.
2010-11-22 13:19:14 +00:00
=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
