ssite.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH SSITE "1" "September 2023" "ssite 2.4" "User Commands"
.SH NAME
ssite \- ssite
.SH DESCRIPTION
usage: ssite [\-h] [\-\-version]
.IP
{check,dump,dump_meta,build,serve,show,new,edit,site,meta,shell}
\&...
.PP
Static site generator.
.SS "positional arguments:"
.TP
{check,dump,dump_meta,build,serve,show,new,edit,site,meta,shell}
sub\-command help
.IP
check
dump
dump_meta
build
serve
show
new
edit
site
meta                Edit metadata for a file
shell
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-version\fR, \fB\-V\fR
show program's version number and exit
.SH  CHECK  SUBCOMMAND

usage: ssite check [\-h] [\-v] [\-\-debug] [\-\-theme THEME] [\-\-content CONTENT]
.IP
[\-\-archetypes ARCHETYPES] [\-o OUTPUT] [\-\-draft]
.SH PROJECT
.SS "positional arguments:"
.TP
project
project directory or .py configuration file (default:
the current directory)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-theme\fR THEME
theme directory location. Overrides settings.THEME
.TP
\fB\-\-content\fR CONTENT
content directory location. Overrides settings.CONTENT
.TP
\fB\-\-archetypes\fR ARCHETYPES
archetypes directory location. Override
settings.ARCHETYPES
.TP
\fB\-o\fR OUTPUT, \fB\-\-output\fR OUTPUT
output directory location. Override settings.OUTPUT
.TP
\fB\-\-draft\fR
do not ignore pages with date in the future
.SH  DUMP  SUBCOMMAND

usage: ssite dump [\-h] [\-v] [\-\-debug] [\-\-theme THEME] [\-\-content CONTENT]
.IP
[\-\-archetypes ARCHETYPES] [\-o OUTPUT] [\-\-draft]
(\fB\-\-fstree\fR | \fB\-\-nodes\fR | \fB\-\-changes\fR | \fB\-\-reference\-documentation\fR [destdir])
.SS "positional arguments:"
.TP
project
project directory or .py configuration file (default:
the current directory)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-theme\fR THEME
theme directory location. Overrides settings.THEME
.TP
\fB\-\-content\fR CONTENT
content directory location. Overrides settings.CONTENT
.TP
\fB\-\-archetypes\fR ARCHETYPES
archetypes directory location. Override
settings.ARCHETYPES
.TP
\fB\-o\fR OUTPUT, \fB\-\-output\fR OUTPUT
output directory location. Override settings.OUTPUT
.TP
\fB\-\-draft\fR
do not ignore pages with date in the future
.TP
\fB\-\-fstree\fR
dump information about the scanned directory trees
.TP
\fB\-\-nodes\fR
dump information about the built site layout
.TP
\fB\-\-changes\fR
dump information about pages that changed
.TP
\fB\-\-reference\-documentation\fR [destdir]
regenerate reference documentation
.SH  DUMP_META  SUBCOMMAND

usage: ssite dump_meta [\-h] [\-v] [\-\-debug] [\-\-theme THEME] [\-\-content CONTENT]
.TP
[\-\-archetypes ARCHETYPES] [\-o OUTPUT] [\-\-draft]
[\-f FORMAT] [\-p PAGES [PAGES ...]]
.SS "positional arguments:"
.TP
project
project directory or .py configuration file (default:
the current directory)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-theme\fR THEME
theme directory location. Overrides settings.THEME
.TP
\fB\-\-content\fR CONTENT
content directory location. Overrides settings.CONTENT
.TP
\fB\-\-archetypes\fR ARCHETYPES
archetypes directory location. Override
settings.ARCHETYPES
.TP
\fB\-o\fR OUTPUT, \fB\-\-output\fR OUTPUT
output directory location. Override settings.OUTPUT
.TP
\fB\-\-draft\fR
do not ignore pages with date in the future
.TP
\fB\-f\fR FORMAT, \fB\-\-format\fR FORMAT
format to use for output
.TP
\fB\-p\fR PAGES [PAGES ...], \fB\-\-pages\fR PAGES [PAGES ...]
globs or regexps matching pages to show
.SH  BUILD  SUBCOMMAND

usage: ssite build [\-h] [\-v] [\-\-debug] [\-\-theme THEME] [\-\-content CONTENT]
.IP
[\-\-archetypes ARCHETYPES] [\-o OUTPUT] [\-\-draft]
[\-\-type TYPE] [\-\-path PATH] [\-\-fail\-fast] [\-f]
.SS "positional arguments:"
.TP
project
project directory or .py configuration file (default:
the current directory)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-theme\fR THEME
theme directory location. Overrides settings.THEME
.TP
\fB\-\-content\fR CONTENT
content directory location. Overrides settings.CONTENT
.TP
\fB\-\-archetypes\fR ARCHETYPES
archetypes directory location. Override
settings.ARCHETYPES
.TP
\fB\-o\fR OUTPUT, \fB\-\-output\fR OUTPUT
output directory location. Override settings.OUTPUT
.TP
\fB\-\-draft\fR
do not ignore pages with date in the future
.TP
\fB\-\-type\fR TYPE
render only pages of this type
.TP
\fB\-\-path\fR PATH
render only pages under this path
.TP
\fB\-\-fail\-fast\fR
fail the first time a page gives an error in rendering
.TP
\fB\-f\fR, \fB\-\-full\fR
always do a full rebuild
.SH  SERVE  SUBCOMMAND

usage: ssite serve [\-h] [\-v] [\-\-debug] [\-\-theme THEME] [\-\-content CONTENT]
.IP
[\-\-archetypes ARCHETYPES] [\-o OUTPUT] [\-\-draft]
[\-\-port PORT] [\-\-host HOST]
.SS "positional arguments:"
.TP
project
project directory or .py configuration file (default:
the current directory)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-theme\fR THEME
theme directory location. Overrides settings.THEME
.TP
\fB\-\-content\fR CONTENT
content directory location. Overrides settings.CONTENT
.TP
\fB\-\-archetypes\fR ARCHETYPES
archetypes directory location. Override
settings.ARCHETYPES
.TP
\fB\-o\fR OUTPUT, \fB\-\-output\fR OUTPUT
output directory location. Override settings.OUTPUT
.TP
\fB\-\-draft\fR
do not ignore pages with date in the future
.TP
\fB\-\-port\fR PORT, \fB\-p\fR PORT
port to use (default: 8000)
.TP
\fB\-\-host\fR HOST
host to bind to (default: localhost)
.SH  SHOW  SUBCOMMAND

usage: ssite show [\-h] [\-v] [\-\-debug] [\-\-theme THEME] [\-\-draft] [\-\-no\-start]
.IP
[\-\-port PORT] [\-\-host HOST]
.SS "positional arguments:"
.TP
project
project directory or .py configuration file (default:
the current directory)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-theme\fR THEME
theme directory location. Overrides settings.THEME
.TP
\fB\-\-content\fR CONTENT
content directory location. Overrides settings.CONTENT
.TP
\fB\-\-archetypes\fR ARCHETYPES
archetypes directory location. Override
settings.ARCHETYPES
.TP
\fB\-o\fR OUTPUT, \fB\-\-output\fR OUTPUT
output directory location. Override settings.OUTPUT
.TP
\fB\-\-draft\fR
do not ignore pages with date in the future
.TP
\fB\-a\fR ARCHETYPE, \fB\-\-archetype\fR ARCHETYPE
page archetype
.TP
\fB\-t\fR TITLE, \fB\-\-title\fR TITLE
page title
.TP
\fB\-n\fR, \fB\-\-noedit\fR
do not run an editor, only output the file name of the
new post
.TP
\fB\-\-overwrite\fR
if a post already exists, overwrite it instead of
reusing it
.SH  EDIT  SUBCOMMAND

usage: ssite edit [\-h] [\-v] [\-\-debug] [\-\-theme THEME] [\-\-content CONTENT]
.IP
[\-\-archetypes ARCHETYPES] [\-o OUTPUT] [\-\-draft] [\-n]
[project] [match ...]
.SS "positional arguments:"
.TP
project
project directory or .py configuration file (default:
the current directory)
.TP
match
keywords used to look for the page to edit
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-theme\fR THEME
theme directory location. Overrides settings.THEME
.TP
\fB\-\-content\fR CONTENT
content directory location. Overrides settings.CONTENT
.TP
\fB\-\-archetypes\fR ARCHETYPES
archetypes directory location. Override
settings.ARCHETYPES
.TP
\fB\-o\fR OUTPUT, \fB\-\-output\fR OUTPUT
output directory location. Override settings.OUTPUT
.TP
\fB\-\-draft\fR
do not ignore pages with date in the future
.TP
\fB\-n\fR, \fB\-\-noedit\fR
do not run an editor, only output the file name of the
new post
.SH  SITE  SUBCOMMAND

usage: ssite site [\-h] [\-v] [\-\-debug] [\-\-theme THEME] [\-\-content CONTENT]
.IP
[\-\-archetypes ARCHETYPES] [\-o OUTPUT] [\-\-draft] [\-\-cmd ...]
.SS "positional arguments:"
.TP
project
project directory or .py configuration file (default:
the current directory)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-theme\fR THEME
theme directory location. Overrides settings.THEME
.TP
\fB\-\-content\fR CONTENT
content directory location. Overrides settings.CONTENT
.TP
\fB\-\-archetypes\fR ARCHETYPES
archetypes directory location. Override
settings.ARCHETYPES
.TP
\fB\-o\fR OUTPUT, \fB\-\-output\fR OUTPUT
output directory location. Override settings.OUTPUT
.TP
\fB\-\-draft\fR
do not ignore pages with date in the future
.TP
\fB\-\-cmd\fR ...
site\-specific command (try 'help')
.SH  META  SUBCOMMAND

usage: ssite meta [\-h] [\-v] [\-\-debug] file
.SS "positional arguments:"
.TP
file
edit the metadata of this file
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.SH  SHELL  SUBCOMMAND

usage: ssite shell [\-h] [\-v] [\-\-debug] [\-\-theme THEME] [\-\-content CONTENT]
.IP
[\-\-archetypes ARCHETYPES] [\-o OUTPUT] [\-\-draft]
.SS "positional arguments:"
.TP
project
project directory or .py configuration file (default:
the current directory)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-theme\fR THEME
theme directory location. Overrides settings.THEME
.TP
\fB\-\-content\fR CONTENT
content directory location. Overrides settings.CONTENT
.TP
\fB\-\-archetypes\fR ARCHETYPES
archetypes directory location. Override
settings.ARCHETYPES
.TP
\fB\-o\fR OUTPUT, \fB\-\-output\fR OUTPUT
output directory location. Override settings.OUTPUT
.TP
\fB\-\-draft\fR
do not ignore pages with date in the future
.SH DIR
.SS "positional arguments:"
.TP
dir
directory to show (default: the current directory)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debugging output
.TP
\fB\-\-theme\fR THEME
theme directory location. Overrides settings.THEME
.TP
\fB\-\-draft\fR
do not ignore pages with date in the future
.TP
\fB\-\-no\-start\fR, \fB\-n\fR
do not start a browser automatically, print the URL
instead
.TP
\fB\-\-port\fR PORT, \fB\-p\fR PORT
port to use (default: randomly allocated)
.TP
\fB\-\-host\fR HOST
host to bind to (default: localhost)
.SH  NEW  SUBCOMMAND

usage: ssite new [\-h] [\-v] [\-\-debug] [\-\-theme THEME] [\-\-content CONTENT]
.IP
[\-\-archetypes ARCHETYPES] [\-o OUTPUT] [\-\-draft]
[\-a ARCHETYPE] [\-t TITLE] [\-n] [\-\-overwrite]