blogc-make - a simple build tool for blogc
blogc-make [-V] [-f FILE] [RULE ...]
blogc-make [-h|-v]
blogc-make is a simple build tool for blogc websites. It reads a blogcfile(5) and generates the output files using blogc(1) and some predefined rules, that are useful enough for most common use cases.
See blogcfile(5) for details on the file format.
-DBuilds for development environment. This option is useful to load local,
non-optimized assets for development purposes. It adds two global
variables to all blogc(1) calls: MAKE_ENV_DEV=1 and MAKE_ENV=dev.
-VActivates verbose mode, that will give more details of commands runs.
-f FILEReads FILE as blogcfile.
-vShow program name, version and exit.
-hShow help message and exit.
Run all build rules. This is the default rule.
Clean built files and empty directories in output directory.
Run blogc-runserver(1) (if available) pointing to output directory, watching
for changes in the source files and rebuilding as needed. This rule accepts
some arguments, in the following format:
runserver:host=127.0.0.1,port=8080,threads=20
The values in the example are the default values. Rebuilds are done by running
blogc-make all internally.
Watch for changes in the source files, rebuilding as needed.
Rebuilds are done by running blogc-make all internally.
Dump default Atom feed template based on current blogcfile(5) settings.
The template is dumped to the standard output, and can be used as base for customized Atom feed templates.
Build website index from posts.
The rule passes the following helper variables to blogc(1):
MAKE_RULEindexMAKE_TYPEpostBuild main atom feed from posts.
The rule passes the following helper variables to blogc(1):
MAKE_RULEatomMAKE_TYPEatomBuild atom feeds for each tag from posts.
The rule passes the following helper variables to blogc(1):
MAKE_RULEatom_tagsMAKE_TYPEatomBuild pagination pages from posts. This rule is disabled if posts_per_page
value in blogcfile(5) is negative or 0.
The rule passes the following helper variables to blogc(1):
MAKE_RULEpaginationMAKE_TYPEpostBuild pagination pages for each tag from posts. This rule is disabled if
posts_per_page value in blogcfile(5) is negative or 0.
The rule passes the following helper variables to blogc(1):
MAKE_RULEpagination_tagsMAKE_TYPEpostBuild individual pages for each post.
The rule passes the following helper variables to blogc(1):
MAKE_RULEpostsMAKE_TYPEpostMAKE_SLUGBuild post listings for each tag from posts.
The rule passes the following helper variables to blogc(1):
MAKE_RULEtagsMAKE_TYPEpostBuild individual pages for each page.
The rule passes the following helper variables to blogc(1):
MAKE_RULEpagesMAKE_TYPEpageMAKE_SLUGCopy static files from source directory to output directory.
The blogc-make command expects a settings file, called blogcfile by default,
or any other file passed to -f option. blogcfile must have valid UTF-8 content.
The blogc-make command will read any files listed on blogcfile, and may write
files to the configured output directory.
BLOGCPath to blogc(1) binary. If not provided, the blogc binary in $PATH will
be used.
BLOGC_RUNSERVERPath to blogc-runserver(1) binary. If not provided, the blogc-runserver
binary in $PATH will be used, if available.
OUTPUT_DIRPath to the directory where blogc-make should write (or instruct blogc(1) to
write) output files.
Any other environment variables are inherited by blogc(1) and blogc-runserver(1),
when called by blogc-make.
Build all files:
$ blogc-make
or
$ blogc-make all
Clean built files:
$ blogc-make clean
Please report any issues to: https://github.com/blogc/blogc
Rafael G. Martins <rafael@rafaelmartins.eng.br>
blogc(1), blogc-runserver(1), blogcfile(5)