build-docs - Fedora Documentation builder script
Main script written by Paul W. Frields <stickster@gmail.com>
Packaged by Patrick Barnes <nman64@n-man.com>

== About ==

The build-docs script is used by the Fedora Documentation Project to
build the latest documents in CVS for viewing by others without a testing
sandbox.  It is intended to build HTML (and potentially other) documents for
presentation on a local web server.

This package also includes a cron job that can run the build process once each
hour.  This requires the crontabs package to be installed.  The cron job is
normally installed but disabled by default.  You can disable it's installation
when building the RPM -- see below.  To enable the cron job after installation,
see the file /etc/build-docs.conf for instructions.

== Installation ==

The recommended method for installing this package is using RPM.

Note that this document demonstrates using 'sudo' to gain root privileges.  You
may need or want to use another method, such as 'su'.

=== Using RPM & yum ===

If you already have an RPM package, you can use yum to install it.

   sudo yum localinstall build-docs-<version>.noarch.rpm

==== Building Your Own RPM ====

If you are working from a source directory or tarball, you can make an RPM
to install easily.  You will need rpmbuild (found in the rpm-build package)
installed on the system.  Note that it is considered poor practice to build
packages as root.  Dag Wieers has an excellent HOWTO for creating a non-root
RPM-building environment: http://dag.wieers.com/howto/bits/rpm-build-user.php

First build an SRPM:

   make srpm

Next, build the RPM from the SRPM:

   rpmbuild --rebuild build-docs-<version>.src.rpm

 Where <version> is replaced by the version of the package you are building.
 * If you do not want to use the cron job, you can disable its installation
   and the dependency on crontabs:

      rpmbuild --rebuild --define "_without_cron 1" build-docs-...

Finally, install the package:

   cd /path/to/your/rpm
   sudo yum localinstall build-docs-<version>.noarch.rpm

 If you don't know where the RPM was built, look at the output from rpmbuild.

=== Using make ===

Installing the package using make is not recommended.  See the
'Using RPM & yum' section above.  To install the package using make:

   make install

 * If you do not want to use the cron job, you can disable its installation:

      make DISABLECRON=1 install

Uninstallation is also available:

   make uninstall

== Usage ==

   build-docs [options...]

Where options can be one or more of:

   -h           : print usage
   -m WORKDIR   : set home directory, default '~'
   -f FDPDIR    : set d/l dir for CVS, default '~/fdpdocs-cvs<datetag>'
   -D TARGETDIR : set target dir for built files,
                    default '/var/www/webtest/docs'
   -a ANONCVS   : set CVS repo location (cvs -d), default
                    ':pserver:anonymous@cvs.fedora.redhat.com:/cvs/docs'
   -r REV       : checkout REV from CVS (global), default 'HEAD'
   -Q           : make CVS checkout less quiet
   -c           : build chunked HTML
   -n           : build HTML nochunks
   -p           : build PDF (not working currently)
   -S		: build SRPM
   -s		: build spec file
   -T		: build source tarball
   -t           : build tarball
   -k           : continue building in face of errors