Newcomen

Description A static content generator.
Newcomen > Perl Manuals > Newcomen::Manual::Newcomen
Source

Index


NAME ^

Newcomen::Manual::Newcomen - Newcomen's main executable script: newcomen.

DESCRIPTION ^

This file is generated automatically from bin/newcomen!

This is the main (executable) script of Newcomen. It should be run from the project's root directory. Currently it only initializes the configuration from the file config/config.pl (relative to the current working directory) and then it starts the processing of the project.

See below for supported command line options.

Note: The directory lib is added to Perl's library path to support project-specific plugins. Do not place any files from untrusted sources in this directory!

OPTIONS ^

-m

$ newcomen -m

If the option -m is specified, after the first processing of the project, the script will monitor the current working directory (and all its subdirectories, recursively) for any changes (creation, deletion and modification of files and directories). As soon as a change is detected, the project is processed again (this includes initializing the configuration again) and the loop starts all over.

Some status output will be printed to STDERR.

Notes: Renaming a file may sometimes not trigger the build process. The -m option has to be the first command line option, else it will not be recognized. Any other command line option will be ignored.

VERSION ^

This is version 2019022601.

AUTHOR ^

Stefan Goebel - newcomen {at} subtype {dot} de

COPYRIGHT AND LICENSE ^

Copyright 2013-2014, 2019 Stefan Goebel.

This file is part of Newcomen.

Newcomen is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the license, or (at your option) any later version.

Newcomen is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Newcomen. If not, see <http://www.gnu.org/licenses/>.