diff options
| -rw-r--r-- | Makefile.am | 19 | ||||
| -rw-r--r-- | man/blogc-make.1.ronn | 79 | ||||
| -rw-r--r-- | man/index.txt | 1 |
3 files changed, 99 insertions, 0 deletions
diff --git a/Makefile.am b/Makefile.am index 7650ccc..d1317d9 100644 --- a/Makefile.am +++ b/Makefile.am @@ -287,12 +287,14 @@ endif EXTRA_DIST += \ man/blogc.1.ronn \ man/blogc-git-receiver.1.ronn \ + man/blogc-make.1.ronn \ man/blogc-runserver.1.ronn \ man/blogc-source.7.ronn \ man/blogc-template.7.ronn \ man/blogc-pagination.7.ronn \ man/index.txt \ blogc-git-receiver.1 \ + blogc-make.1 \ blogc-runserver.1 \ $(NULL) @@ -309,6 +311,12 @@ dist_man_MANS += \ $(NULL) endif +if BUILD_MAKE_LIB +dist_man_MANS += \ + blogc-make.1 \ + $(NULL) +endif + if BUILD_RUNSERVER dist_man_MANS += \ blogc-runserver.1 \ @@ -337,6 +345,14 @@ blogc-git-receiver.1: man/blogc-git-receiver.1.ronn --manual "$(PACKAGE_NAME) Manual" \ $(top_srcdir)/man/blogc-git-receiver.1.ronn > blogc-git-receiver.1 +blogc-make.1: man/blogc-make.1.ronn + $(AM_V_GEN)$(RONN) \ + --roff \ + --pipe \ + --organization "Rafael G. Martins" \ + --manual "$(PACKAGE_NAME) Manual" \ + $(top_srcdir)/man/blogc-make.1.ronn > blogc-make.1 + blogc-runserver.1: man/blogc-runserver.1.ronn $(AM_V_GEN)$(RONN) \ --roff \ @@ -377,6 +393,9 @@ blogc.1: blogc-git-receiver.1: $(AM_V_GEN)echo "error: ronn not found. failed to build man page: $@"; exit 1 +blogc-make.1: + $(AM_V_GEN)echo "error: ronn not found. failed to build man page: $@"; exit 1 + blogc-runserver.1: $(AM_V_GEN)echo "error: ronn not found. failed to build man page: $@"; exit 1 diff --git a/man/blogc-make.1.ronn b/man/blogc-make.1.ronn new file mode 100644 index 0000000..10819da --- /dev/null +++ b/man/blogc-make.1.ronn @@ -0,0 +1,79 @@ +blogc-make(1) -- a simple build tool for blogc +============================================== + +## SYNOPSIS + +`blogc-make` [`-V`] [`-f` <FILE>] [<RULE> ...]<br> +`blogc-make` [`-h`|`-v`] + +## DESCRIPTION + +**blogc-make** is a simple build tool for blogc websites. + +EXPAND-ME! + +## OPTIONS + + * `-V`: + Activates verbose mode, that will give more details of commands runs. + + * `-f` <FILE>: + Reads <FILE> as `blogcfile`. + + * `-v`: + Show program name, version and exit. + + * `-h`: + Show help message and exit. + +## RULES + +TODO + +## FILES + +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. + +## ENVIRONMENT + + * `BLOGC`: + Path to `blogc(1)` binary. If not provided, the `blogc` binary in `$PATH` will + be used. + + * `BLOGC_RUNSERVER`: + Path to `blogc-runserver(1)` binary. If not provided, the `blogc-runserver` + binary in `$PATH` will be used, if available. + + * `OUTPUT_DIR`: + Path to the directory where `blogc-make` should write (or instruct blogc(1) to + write) output files. This is usually configured in `blogcfile`, but being able + to override it with an environment variable is useful for automated builds. + +Any other environment variables are inherited by blogc(1) and blogc-runserver(1), +when called by `blogc-make`. + +## EXAMPLES + +Build all files: + + $ blogc-make all + +Clean built files: + + $ blogc-make clean + +## BUGS + +Please report any issues to: <https://github.com/blogc/blogc> + +## AUTHOR + +Rafael G. Martins <<rafael@rafaelmartins.eng.br>> + +## SEE ALSO + +blogc(1), blogc-runserver(1) diff --git a/man/index.txt b/man/index.txt index 4ca6e67..b588121 100644 --- a/man/index.txt +++ b/man/index.txt @@ -1,6 +1,7 @@ # manuals blogc(1) blogc.1.ronn blogc-git-receiver(1) blogc-git-receiver.1.ronn +blogc-make(1) blogc-make.1.ronn blogc-runserver(1) blogc-runserver.1.ronn blogc-source(7) blogc-source.7.ronn blogc-template(7) blogc-template.7.ronn |