Wsmake usage

The Wsmake User Manual
Prev |  | Next

# Chapter 2. Wsmake usage

The basic usage of Wsmake is:

`shell$` wsmake `-f` `configfilename`

This runs Wsmake using the configuration file named "configfilename". The defaults for the output are to report the status of pages which have been updated. Typical output might look like:

    shell$ wsmake -f configfilename
    Upd Part   : templates/header.html
    PoU Webpage: html/index.html               [...]
    shell$

The output shows all Pages that are in need of updating. The 3 character state on the left of these lines can be one of the following:

`---`

  This means there was no change since the last run

`Err`

  This means that there was an error in determining the state of the Page. This could be because of:

  - Incorrect Permissions

  - Non-existent directories

  - Database problems

`New`

  This means that the Page was not in the database on the last run, but now is. And it will be updated.

`Frc`

  This means that the Page will be updated, regardless of it's state, by a request from the user, or because a clone's original was updated.

`Upd`

  This means that the source for this Page was modified, so the output will be updated.

`NoO`

  This means that the Page has no "output" file and will be updated.

`NoS`

  This means that the Page has no "source" file

`Old`

  This means that the "output" file is old and will be updated.

`PoU`

  This means that one of the PageOrders that the Page uses has a PagePart whose source has been modified. So the output page will be updated.

`ThU`

  This means that one of the Themes that the Page uses has been been updated. So the output page will be updated.

`Dep`

  This means that one of the files that the Page has been made to depend on has been been updated. So the output page will be updated.

`StU`

  This means that one of the SubTags that the Page uses has been updated. So the output page will be updated.

`SGU`

  This means that one of the SubTagGroups that the Page uses has been updated. So the output page will be updated.

For all cases the page will be updated unless the state is `---`, `Err`, `NoS`, or `Unk`.

The next word indicates the type of page: Part, Webpage, or Clone.

When square brackets appear after a target, it represents the start and stop of the make process for that page. The characters in between can be:

`.`

  A piece of the page.

`i`

  A file was included by one of the pieces.

`X`

  A piece of the page source was missing.

# Options

Wsmake has the following command line options:

    wsmake [-Fshvct] [-m|-e] [-d #] [-f configfile] [target] ...

`-F`,`--force`

  Force files to be updated regardless of their state.

`-s`,`--silent,--quiet`

  Silent. No output.

`-h`,`--help`

  This help.

`-v`,`--version`

  Show version and copyright information.

`-c`,`--clean`

  Clean the website.

`-t`,`--times`

  Sync timestamps between source and output files.

`-m`,`--match`

  Targets match anywhere in web paths.

`-e`,`--end-match`

  Targets match at end of web paths.

`-d #`, `--debug=#`

  Debug output level. (0-3)

  - 0 - No output except for errors

  - 1 - Level 0 and minimal output (default)

  - 2 - Level 1 and verbose output

  - 3 - Level 2 and config file loading info

`-f` `file`, `--file=``file`, `--wsmakefile=``file`

  Configuration filename (looks for `wsmakefile` and files ending with `.ws` if option not given

`targets`

  Specific web paths, matching from front, to make. If not specified, all pages will be made.

"clean" is a special target name. When used, all other targets are ignored and the website is cleaned. To clean only certain groups of files, use the `-c` or `--clean` option with the targets but without the clean target.

Note that updates to the configuration file will not update the website on the next run. Using the `-F` or `--force` option is one solution to this problem. Another is to use a "depend" attribute (discussed in more detail in chapter 3).

Prev | Home | Next
The design |  | Example Usage