Reinhard Müller 40f9044019
All checks were successful
the build was successful
Add feature to wake up news *and* events
2019-03-12 01:51:47 +01:00

61 lines
2.8 KiB
Plaintext

Usage:
------------------------------------------------------------------------------
build_main.sh [options] build_into "destination_dir"
Perform the page build. Write output to destination_dir. The source
directory is determined from the build scripts own location.
build_main.sh [options] build_xmlstream "file.xhtml"
Compile an xml stream from the specified file, additional sources will be
determined and included automatically. The stream is suitable for being
passed into xsltproc.
build_main.sh [options] process_file "file.xhtml" [processor.xsl]
Generate output from an xhtml file as if it would be processed during the
build. Output is written to STDOUT and can be redirected as desired.
If a xslt file is not given, it will be choosen automatically.
build_main.sh [options] tree_maker [input_dir] "destination_dir"
Generate a set of make rules to build the website contained in input_dir.
destination_dir should be the www root of a web server.
If input_dir is omitted, it will be the source directory determined from
the build scripts location.
Note: if destination_dir is set via previous options, and only one paramter
is given, then this parameter will be interpreted as input_dir
build_main.sh [options] wakeup [date]
News items that are in the future at the time of their commit are not
considered for the content of dependent files (e.g. news.html, index.html).
This function performs a `touch` on all files which are to be released at
the presented date, thus forcing a subsequent buildrun to rebuild dependent
files even though the input files may not have changed their content.
The same goes for events which start today (have to be moved from future to
current events) or ended yesterday (have to be moved from current to past
events).
The date option defaults to the present date, if given it must adhere to
the form YYYY-MM-DD.
OPTIONS
-------
--source "source_dir"
Force a specific source directory. If not explicitly given source_dir is
determined from the build scripts own location.
Pathes given in .sources files are interpreted as relative to source_dir
making this option useful when building a webpage outside of the build
scripts "regular" tree.
--destination "destination_dir"
The directory into which the website will be built. This option can be used
in conjunction with the tree_maker and build_into commands. It will override
the destination_dir option given after those commands and is therefore
redundant. The option exists to provide backward compatibility to the 2002
build script.
--statusdir "status_dir"
A directory to which messages are written. If no status_dir is provided
information will be written to stdout. The directory will also be used
to store some temporary files, which would otherwise be set up in the
system wide temp directory.