.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "NANOC 1"
.TH NANOC 1 "2023-06-13" "" ""
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
nanoc \- Nanoc, a static site compiler written in Ruby
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBnanoc\fR \fIcommand\fR [\fIoptions\fR] [\fIarguments\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBNanoc\fR is a static site generator, fit for building anything from a small
personal blog to a large corporate web site. It can transform content
from one format (e.g. Haml or Markdown) into another (usually \s-1HTML\s0) and
lay out pages so that the site's look and feel is consistent across all
pages.
.SH "COMMANDS"
.IX Header "COMMANDS"
.IP "\fBcheck\fR" 4
.IX Item "check"
run issue checks
.IP "\fBcompile\fR" 4
.IX Item "compile"
compile items of this site
.IP "\fBcreate-site\fR" 4
.IX Item "create-site"
create a site
.IP "\fBdeploy\fR" 4
.IX Item "deploy"
deploy the compiled site
.IP "\fBhelp\fR" 4
.IX Item "help"
show help
.IP "\fBprune\fR" 4
.IX Item "prune"
remove files not managed by Nanoc from the output directory
.IP "\fBshell\fR" 4
.IX Item "shell"
open a shell on the Nanoc environment
.IP "\fBshow-data\fR" 4
.IX Item "show-data"
show data in this site
.IP "\fBshow-plugins\fR" 4
.IX Item "show-plugins"
show all available plugins
.IP "\fBshow-rules\fR" 4
.IX Item "show-rules"
describe the rules for each item
.IP "\fBview\fR" 4
.IX Item "view"
start the web server that serves static files
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-C\fR, \fB\-\-no\-color\fR" 4
.IX Item "-C, --no-color"
disable color
.IP "\fB\-V\fR, \fB\-\-verbose\fR" 4
.IX Item "-V, --verbose"
make nanoc output more detailed
.IP "\fB\-d\fR, \fB\-\-debug\fR" 4
.IX Item "-d, --debug"
enable debugging
.IP "<\-e>, \fB\-\-env\fR=\fIvalue\fR" 4
.IX Item "<-e>, --env=value"
set environment
.IP "\fB\-h\fR, \fB\-\-help\fR" 4
.IX Item "-h, --help"
show the help message and quit
.IP "\fB\-l\fR, \fB\-\-color\fR" 4
.IX Item "-l, --color"
enable color
.IP "\fB\-v\fR, \fB\-\-version\fR" 4
.IX Item "-v, --version"
show version information and quit
.IP "\fB\-w\fR, \fB\-\-warn\fR" 4
.IX Item "-w, --warn"
enable warnings
.SH "AUTHORS"
.IX Header "AUTHORS"
\&\fBNanoc\fR has been developed by Denis Defreyne <denis.defreyne@stoneship.org>.