NAME¶
webgen - a template based static website generator
SYNOPSIS¶
webgen [
global options]
command [
command
arguments] [command [command arguments] ...] [args]
DESCRIPTION¶
webgen is used to generate web pages from page and template files. You create
one template file in which you define the layout of your pages and where the
content should go. After that you create page files in which you only define
the content. webgen merges the page's content into the template and generates
the final HTML output.
GLOBAL OPTIONS¶
- -d, --directory DIR
- Set the website directectory. if none specified, the
current directory is used.
- -V, --verbosity level
- Set verbosity to the given level.
- -h, --help
- Show generic help.
- -v, --version
- Show the version of the program and exit.
COMMANDS¶
- check
- Executes check command by default.
- check config
- Checks validity of configuration file.
- check libs
- Checks presence of optional libraries.
- create
- Creates the basic directories and files for webgen. This
includes the source and output directories, the log and the plugin
directory. Also, a basic template plus a CSS and an index file are
created. Takes the directory to create the webgen structure in as
an argument.
- help
- Provides help for the individual commands.
- run
- Runs webgen which will result in the generation of the HTML
data in the output directory from the files in the source directory. This
command is used as the default command when no command was issued.
- show
- Shows all available plugins or their configuration items.
Takes either config or plugins as an argument.
- use
- Changes configured gallery style, sipttra or website style.
Takes either gallery_style, sipttra_style or
website_style as an argument plus the gallery, sipttra or website
style name you want to configure.
- version
- Shows the version of the program and exit.
SEE ALSO¶
The webgen website,
http://webgen.rubyforge.org/ for more information.
AUTHOR¶
webgen was written by Thomas Leitner <t_leitner@gmx.at>
This manual page was written by Paul van Tilburg <paulvt@debian.org> for
the Debian project (but may be used by others). This manual page was update to
reflect webgen 0.4 change by Arnaud Cornet <arnaud.cornet@gmail.com>.
This manual page was updated to reflect webgen 0.4.2 changes by Thomas Leitner
<t_leitner@gmx.at>.