.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH PELICAN "1" "January 2021" "pelican 4.0.1" "User Commands"
.SH NAME
pelican \- manages pelican plugins
.SH DESCRIPTION
usage: pelican [\-h] [\-t THEME] [\-o OUTPUT] [\-s SETTINGS] [\-d] [\-v] [\-q] [\-D]
.IP
[\-\-version] [\-r]
[\-\-print\-settings [SETTING_NAME [SETTING_NAME ...]]]
[\-\-relative\-urls] [\-\-cache\-path CACHE_PATH] [\-\-ignore\-cache]
[\-w SELECTED_PATHS] [\-\-fatal errors|warnings]
[\-\-logs\-dedup\-min\-level {DEBUG,INFO,WARNING,ERROR}] [\-l]
[\-p PORT] [\-b BIND]
[path]
.PP
A tool to generate a static blog, with restructured text input files.
.SS "positional arguments:"
.TP
path
Path where to find the content files. (default: None)
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-t\fR THEME, \fB\-\-theme\-path\fR THEME
Path where to find the theme templates. If not
specified, it will use the default one included with
pelican. (default: None)
.TP
\fB\-o\fR OUTPUT, \fB\-\-output\fR OUTPUT
Where to output the generated files. If not specified,
a directory will be created, named "output" in the
current path. (default: None)
.TP
\fB\-s\fR SETTINGS, \fB\-\-settings\fR SETTINGS
The settings of the application, this is automatically
set to pelicanconf.py if a file exists with this name.
(default: None)
.TP
\fB\-d\fR, \fB\-\-delete\-output\-directory\fR
Delete the output directory. (default: None)
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Show all messages. (default: None)
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Show only critical errors. (default: None)
.TP
\fB\-D\fR, \fB\-\-debug\fR
Show all messages, including debug messages. (default:
None)
.TP
\fB\-\-version\fR
Print the pelican version and exit.
.TP
\fB\-r\fR, \fB\-\-autoreload\fR
Relaunch pelican each time a modification occurs on
the content files. (default: False)
.TP
\fB\-\-print\-settings\fR [SETTING_NAME [SETTING_NAME ...]]
Print current configuration settings and exit. Append
one or more setting name arguments to see the values
for specific settings only. (default: None)
.TP
\fB\-\-relative\-urls\fR
Use relative urls in output, useful for site
development (default: False)
.TP
\fB\-\-cache\-path\fR CACHE_PATH
Directory in which to store cache files. If not
specified, defaults to "cache". (default: None)
.TP
\fB\-\-ignore\-cache\fR
Ignore content cache from previous runs by not loading
cache files. (default: False)
.TP
\fB\-w\fR SELECTED_PATHS, \fB\-\-write\-selected\fR SELECTED_PATHS
Comma separated list of selected paths to write
(default: None)
.TP
\fB\-\-fatal\fR errors|warnings
Exit the program with non\-zero status if any
errors/warnings encountered. (default: )
.TP
\fB\-\-logs\-dedup\-min\-level\fR {DEBUG,INFO,WARNING,ERROR}
Only enable log de\-duplication for levels equal to or
above the specified value (default: WARNING)
.TP
\fB\-l\fR, \fB\-\-listen\fR
Serve content files via HTTP and port 8000. (default:
False)
.TP
\fB\-p\fR PORT, \fB\-\-port\fR PORT
Port to serve HTTP files at. (default: 8000) (default:
None)
.TP
\fB\-b\fR BIND, \fB\-\-bind\fR BIND
IP to bind to when serving files via HTTP (default:
127.0.0.1) (default: None)
.SH "SEE ALSO"
The full documentation for
.B pelican
is maintained as a Texinfo manual.  If the
.B info
and
.B pelican
programs are properly installed at your site, the command
.IP
.B info pelican
.PP
should give you access to the complete manual.