/ 
App-PFT-v0.04.2
/ pft

NAME

pft init - Initialize a PFT Site

SYNOPSYS

pft init [<options>]

DESCRIPTION

Initialize a PFT Site.

The command generates the pft.yaml configuration file, creates the filesystem structure for a PFT site, a site Home Page and the site templates.

A test configuration is provided by default, and can be later modified by editing the be modified by editing the pft.yaml configuration file.

The pft init command accepts options which will override the default configuration. The options are listed in this document (see CONFIGURATION OPTIONS)

The pft init command can also be used to override an existing configuration by running it on a site which was already initialized. The existing configuration will be respected, except for the overriden keys.

OPTIONS

--no-home

Skip Home Page generation.

--help | -h

Show this help page.

CONFIGURATION OPTIONS

--author

Specify a Author configuration.

The Author value will be used as default Author for all new content files.

--site-title

Specify a SiteTitle configuration.

The SiteTitle value will be accessible by the template engine, so the title can be shown on all pages.

--site-url

Specify a SiteURL configuration.

SiteURL is the base URL for the site. This will be used as prefix for all internal URLs. You probably want to specify something like http://example.org/path/to/site/. Since pft will not try to guess your protocol scheme, you should put it right.

--home-page

Specify a HomePage configuration.

HomePage declares a Home Page for the site. The page will be generated automatically unless it exists already or the --no-home is used.

--input-enc

Specify a InputEnc configuration.

InputEnc declares the default encoding for content files. The encoding of single content files can be redefined by editing their header.

--output-enc

Specify a OutputEnc configuration.

OutputEnc declares the encoding for output HTML files.

--remote-method

Specify a Remote.Method configuration.

Remote.Method indicates how to upload the compiled content onto a remote machine. Current valid values are:

  • rsync+ssh (default): Use RSync over SSH for sending files.

--remote-host

Specify a Remote.Host configuration.

Remote.Host is optional, and declares the host name (or ip address) of the remote machine hosting the website. The selected remote method (--remote-method option) may require this configuration.

--remote-port

Specify a Remote.Port configuration.

Remote.Port is optional, and declares a port on the remote machine where a file upload service is running. The value may be used as parameter for different transport protocols, depending on the --remote-method in use. Sensible defaults are assumed unless diffrently specified.

For instance, if using --remote-method=rsync+ssh, the Remote.Port configuration will be used to determine the SSH port, and will default to 22.

--remote-user

Specify a Remote.User configuration.

Remote.User is optional, and declares a user on the remote machine where a file upload service is running. The value may be used as parameter for different transport protocols, depending on the --remote-method in use.

For instance, if using --remote-method=rsync+ssh, the Remote.User configuration will be used as user for SSH login.