pft-init man page

pft init — Initialize a PFT Site

Synopsis

pft init [options]

Description

This command initializes a PFT site in the current directory. It generates a configuration file named pft.yaml and it creates the following filesystem structure (see pft(1)).

A generic configuration skeleton is provided by default, and can be modified by editing the pft.yaml configuration file.  Each option explained in this manual page corresponds to an equally named setting in the pft.yaml file.

Configuration Options

--publish-host=HOST

Remote host where to publish (see pft-pub(1)). Defaults to example.org.

--publish-method=NAME

Method used for publishing (see pft-pub(1)). Defaults to rsync+ssh.

--publish-path=PATH

Remote path on publishing host (see pft-pub(1)). Defaults to /home/$USER/public_html, as by tradition.

--publish-port=PORT

Port for connection on publishing host (see pft-pub(1)). Defaults to 22.

--publish-user=USER

User login on publishing host (see pft-pub(1)). Defaults to $USER (environment variable).

--site-author=USER

Global Author, can be overriden by individual entries. Defaults to $USER (environment variable).

--site-encoding=ENC

Charset of the generated web pages. Defaults to what is defined by locale(1).

--site-feed-description=DESC

Description of the channel (<description> in the XML). Defaults to News from a PFT website.

--site-feed-length=N

Number of most recent blog entries to list in the RSS feed. Defaults to 10.

--site-feed-path=PATH

File name of the RSS XML to be published by pft-gen-rss(1). Defaults to feed.rss.

--site-home=PAGE_NAME

First page, where index.html will redirect the browsers. Defaults to Welcome.

--site-template=TEMPLATE

Global HTML template, can be overriden by individual entires. Defaults to default.html.

--site-theme=THEME

Global theme (e.g. light or dark) optionally honored by templates. Specific accepted values depend on the template implementation. Defaults to light.

--site-title=TITLE

Title of the website. Defaults to My PFT website.

--site-url=URL

Base url for the website. Defaults to http://example.org.

--system-browser=BROWSER

Browser to be invoked by pft-show(1). You may specify an executable, or a sh(1) command where “%s” gets replaced with the file name (e.g. “firefox -profile x '%s”'). Defaults to $BROWSER (environment variable), or firefox if not defined.

--system-editor=EDITOR

Editor to be invoked by pft-edit(1). You may specify an executable, or a sh(1) command where “%s” gets replaced with the file name (e.g. “vim +'set filetype=markdown spell' %s”). Defaults to $EDITOR (environment variable), or vi if not defined.

# END AUTOGEN

Environment

The following environment variables are honored as sensible defaults unless some different setting is supplied by command line arguments.

$USER

$BROWSER

$EDITOR

See Also

pft, pft-pub(1)

Referenced By

pft(1), pft-edit(1), pft-gen-rss(1), pft-make(1), pft-pub(1), pft-show(1).

2019-07-25 perl v5.30.0 User Contributed Perl Documentation