1PFT-INIT(1)           User Contributed Perl Documentation          PFT-INIT(1)
2
3
4

NAME

6       pft init - Initialize a PFT Site
7

SYNOPSIS

9       pft init [options]
10

DESCRIPTION

12       This command initializes a PFT site in the current directory. It
13       generates a configuration file named "pft.yaml" and it creates the
14       following filesystem structure (see pft(1)).
15
16       A generic configuration skeleton is provided by default, and can be
17       modified by editing the "pft.yaml" configuration file.  Each option
18       explained in this manual page corresponds to an equally named setting
19       in the "pft.yaml" file.
20

CONFIGURATION OPTIONS

22       --publish-host=HOST
23           Remote host where to publish (see pft-pub(1)).  Defaults to
24           "example.org".
25
26       --publish-method=NAME
27           Method used for publishing (see pft-pub(1)).  Defaults to
28           "rsync+ssh".
29
30       --publish-path=PATH
31           Remote path on publishing host (see pft-pub(1)).  Defaults to
32           "/home/$USER/public_html", as by tradition.
33
34       --publish-port=PORT
35           Port for connection on publishing host (see pft-pub(1)).  Defaults
36           to 22.
37
38       --publish-user=USER
39           User login on publishing host (see pft-pub(1)).  Defaults to $USER
40           (environment variable).
41
42       --site-author=USER
43           Global Author, can be overriden by individual entries.  Defaults to
44           $USER (environment variable).
45
46       --site-encoding=ENC
47           Charset of the generated web pages.  Defaults to what is defined by
48           locale(1).
49
50       --site-feed-description=DESC
51           Description of the channel ("<description>" in the XML).  Defaults
52           to "News from a PFT website".
53
54       --site-feed-length=N
55           Number of most recent blog entries to list in the RSS feed.
56           Defaults to 10.
57
58       --site-feed-path=PATH
59           File name of the RSS XML to be published by pft-gen-rss(1).
60           Defaults to "feed.rss".
61
62       --site-home=PAGE_NAME
63           First page, where "index.html" will redirect the browsers.
64           Defaults to "Welcome".
65
66       --site-template=TEMPLATE
67           Global HTML template, can be overriden by individual entires.
68           Defaults to "default.html".
69
70       --site-theme=THEME
71           Global theme (e.g. "light" or "dark") optionally honored by
72           templates. Specific accepted values depend on the template
73           implementation.  Defaults to "light".
74
75       --site-title=TITLE
76           Title of the website.  Defaults to "My PFT website".
77
78       --site-url=URL
79           Base url for the website.  Defaults to "http://example.org".
80
81       --system-browser=BROWSER
82           Browser to be invoked by pft-show(1). You may specify an
83           executable, or a sh(1) command where "%s" gets replaced with the
84           file name (e.g. "firefox -profile x '%s'").  Defaults to $BROWSER
85           (environment variable), or "firefox" if not defined.
86
87       --system-editor=EDITOR
88           Editor to be invoked by pft-edit(1). You may specify an executable,
89           or a sh(1) command where "%s" gets replaced with the file name
90           (e.g. "vim +'set filetype=markdown spell' %s").  Defaults to
91           $EDITOR (environment variable), or "vi" if not defined.
92
93       # END AUTOGEN
94

ENVIRONMENT

96       The following environment variables are honored as sensible defaults
97       unless some different setting is supplied by command line arguments.
98
99       $USER
100       $BROWSER
101       $EDITOR
102

SEE ALSO

104       pft, pft-pub(1)
105
106
107
108perl v5.34.0                      2021-07-22                       PFT-INIT(1)
Impressum