.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "DOCKNOT 1p" .TH DOCKNOT 1p "2022-01-20" "perl v5.32.1" "User Contributed Perl Documentation" .\" 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" docknot \- Static web site and documentation generator .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBdocknot\fR \fB\-h\fR .PP \&\fBdocknot\fR dist [\fB\-d\fR \fIdistdir\fR] [\fB\-m\fR \fImetadata\fR] [\fB\-p\fR \fIpgp-key\fR] .PP \&\fBdocknot\fR generate [\fB\-m\fR \fImetadata\fR] [\fB\-w\fR \fIwidth\fR] \fItemplate\fR [\fIoutput\fR] .PP \&\fBdocknot\fR generate-all [\fB\-m\fR \fImetadata\fR] [\fB\-w\fR \fIwidth\fR] .PP \&\fBdocknot\fR release [\fB\-a\fR \fIarchivedir\fR] [\fB\-d\fR \fIdistdir\fR] [\fB\-m\fR \fImetadata\fR] .PP \&\fBdocknot\fR spin [\fB\-d\fR] [\fB\-e\fR \fIpattern\fR ...] [\fB\-s\fR \fIurl\fR] \fIsource\fR \&\fIoutput\fR .PP \&\fBdocknot\fR spin-rss [\fB\-b\fR \fIbase\fR] \fIfile\fR .PP \&\fBdocknot\fR spin-thread [\fB\-f\fR] [\fB\-s\fR \fIurl\fR] [\fIsource\fR [\fIoutput\fR]] .PP \&\fBdocknot\fR update [\fB\-m\fR \fImetadata\fR] [\fB\-o\fR \fIoutput\fR] .PP \&\fBdocknot\fR update-spin [\fIpath\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBdocknot\fR is a static web site generator with special support for managing the documentation and releases of software packages. Its actions are organized into subcommands. The supported subcommands are: .IP "dist" 4 .IX Item "dist" Build, test, and generate a distribution tarball of the package in the current directory. The exact commands used is determined by the package metadata (see App::DocKnot::Config for format documentation). .Sp After the distribution is built, it will be checked against the source tree and \fBdocknot\fR will report an error and exit with a non-zero status if there are any expected files missing. .IP "generate" 4 .IX Item "generate" Use metadata files and templates to generate human-readable documentation files for a package. See App::DocKnot::Config for documentation on the metadata format, configuration files, and paths. .IP "generate-all" 4 .IX Item "generate-all" Like \f(CW\*(C`generate\*(C'\fR, but generates all of the package documentation for which default output files are configured. This is a quick short-cut to generating all documentation that's shipped with the package. .IP "release" 4 .IX Item "release" Copy a distribution tarball into a release area, archiving old versions, and optionally updating configuration for \f(CW\*(C`spin\*(C'\fR. .IP "spin" 4 .IX Item "spin" Spin a tree of files written in the macro language thread into an \s-1HTML\s0 web site. See App::DocKnot::Spin for documentation on the input format and details of the site generation. .IP "spin-rss" 4 .IX Item "spin-rss" Process a single \fI.rss\fR file with App::DocKnot::Spin::RSS (normally done as part of using \f(CW\*(C`spin\*(C'\fR to process a tree of files). See that module's documentation for more details. .IP "spin-thread" 4 .IX Item "spin-thread" Like \f(CW\*(C`spin\*(C'\fR, but convert a single file written in thread to \s-1HTML.\s0 .IP "update" 4 .IX Item "update" Update the DocKnot package configuration from an older format. .IP "update-spin" 4 .IX Item "update-spin" Update an input tree for \f(CW\*(C`spin\*(C'\fR to the latest expectations. This will, for example, convert old-style \fI*.rpod\fR pointer files to new-style \fI*.spin\fR pointer files. .SH "OPTIONS" .IX Header "OPTIONS" Each \fBdocknot\fR subcommand takes its own options. Many also read global configuration options from DocKnot's configuration. See \&\*(L"Global Configuration\*(R" in App::DocKnot::Config for more details. .SS "Global Options" .IX Subsection "Global Options" .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" Print out usage information and exit. .SS "dist" .IX Subsection "dist" .IP "\fB\-d\fR \fIdistdir\fR, \fB\-\-distdir\fR=\fIdistdir\fR" 4 .IX Item "-d distdir, --distdir=distdir" The directory into which to put the generated distribution tarball. This is also used as a working directory for a temporary copy of the package source. This should point to a trusted directory, not one where an attacker could have written files; see \*(L"\fBmake_distribution()\fR\*(R" in App::DocKnot::Dist for more information. Default: The \f(CW\*(C`destdir\*(C'\fR option in the global DocKnot configuration file. This option is required if there is no configuration file or if this option is not set. .IP "\fB\-m\fR \fImetadata\fR, \fB\-\-metadata\fR=\fImetadata\fR" 4 .IX Item "-m metadata, --metadata=metadata" The path to the metadata file for the package whose distribution tarball is being generated. Default: \fIdocs/docknot.yaml\fR relative to the current directory (which is the recommended metadata path for a project). .IP "\fB\-p\fR \fIpgp-key\fR, \fB\-\-pgp\-key\fR=\fIpgp-key\fR" 4 .IX Item "-p pgp-key, --pgp-key=pgp-key" The name of the \s-1PGP\s0 key to use to sign the generated distribution tarballs. The key can be named in any way that the \fB\-u\fR option of GnuPG understands. The generated signature will be armored and stored in a file named by appending \f(CW\*(C`.asc\*(C'\fR to the name of the tarball. Default: The \f(CW\*(C`pgp_key\*(C'\fR option in the global DocKnot configuration file. .SS "generate" .IX Subsection "generate" .IP "\fB\-m\fR \fImetadata\fR, \fB\-\-metadata\fR=\fImetadata\fR" 4 .IX Item "-m metadata, --metadata=metadata" The path to the metadata file for the package whose documentation is being generated. Default: \fIdocs/docknot.yaml\fR relative to the current directory (which is the recommended metadata path for a project). .IP "\fB\-w\fR \fIwidth\fR, \fB\-\-width\fR=\fIwidth\fR" 4 .IX Item "-w width, --width=width" Column width at which the generated output is wrapped. Default: 74. .IP "\fItemplate\fR" 4 .IX Item "template" The template to use when generating the output file. .IP "\fIoutput\fR" 4 .IX Item "output" The path to the output file to generate. If this argument isn't given, the output file will be chosen based on the template as follows: .Sp .Vb 2 \& readme \-> README \& readme\-md \-> README.md .Ve .Sp If the template isn't listed above, this argument is required. .SS "generate-all" .IX Subsection "generate-all" .IP "\fB\-m\fR \fImetadata\fR, \fB\-\-metadata\fR=\fImetadata\fR" 4 .IX Item "-m metadata, --metadata=metadata" The path to the metadata file for the package whose documentation is being generated. Default: \fIdocs/docknot.yaml\fR relative to the current directory (which is the recommended metadata path for a project). .IP "\fB\-w\fR \fIwidth\fR, \fB\-\-width\fR=\fIwidth\fR" 4 .IX Item "-w width, --width=width" Column width at which the generated output is wrapped. Default: 74. .SS "release" .IX Subsection "release" .IP "\fB\-a\fR \fIarchivedir\fR, \fB\-\-archivedir\fR=\fIarchivedir\fR" 4 .IX Item "-a archivedir, --archivedir=archivedir" The release area into which to put the distribution tarball. The current distribution will be put in a subdirectory named after the \&\f(CW\*(C`distribution.section\*(C'\fR key in the package configuration. Older versions will be moved to the \fI\s-1ARCHIVE\s0\fR subdirectory of \fIarchivedir\fR. Default: The \&\f(CW\*(C`archivedir\*(C'\fR option in the global DocKnot configuration file. This option is required if there is no configuration file or if this option is not set. .IP "\fB\-d\fR \fIdistdir\fR, \fB\-\-distdir\fR=\fIdistdir\fR" 4 .IX Item "-d distdir, --distdir=distdir" The directory from which to get the new distribution tarball, normally generated by \f(CW\*(C`dist\*(C'\fR. The latest version in this directory will be used. Default: The \f(CW\*(C`destdir\*(C'\fR option in the global DocKnot configuration file. This option is required if there is no configuration file or if this option is not set. .IP "\fB\-m\fR \fImetadata\fR, \fB\-\-metadata\fR=\fImetadata\fR" 4 .IX Item "-m metadata, --metadata=metadata" The path to the metadata file for the package whose distribution tarball is being generated. Default: \fIdocs/docknot.yaml\fR relative to the current directory (which is the recommended metadata path for a project). .SS "spin" .IX Subsection "spin" .IP "\fB\-d\fR, \fB\-\-delete\fR" 4 .IX Item "-d, --delete" After populating the \fIoutput\fR tree with the results of converting or copying all the files in the \fIsource\fR tree, delete all files and directories in the \&\fIoutput\fR tree that do not have a corresponding file in the \fIsource\fR tree. .IP "\fB\-e\fR \fIpattern\fR, \fB\-\-exclude\fR=\fIpattern\fR" 4 .IX Item "-e pattern, --exclude=pattern" Exclude files matching the given regular expression \fIpattern\fR from being converted. The pattern is matched only against the file name, not its full path. This flag may be given multiple times. .IP "\fB\-s\fR \fIurl\fR, \fB\-\-style\-url\fR=\fIurl\fR" 4 .IX Item "-s url, --style-url=url" The base \s-1URL\s0 for style sheets. All style sheets specified in \f(CW\*(C`\eheading\*(C'\fR commands will be considered to be relative to this \s-1URL\s0 and this \s-1URL\s0 will be prepended to them. If this option is not given, the name of the style sheet will be used verbatim as its \s-1URL,\s0 except with \f(CW\*(C`.css\*(C'\fR appended. This will also be used as the base \s-1URL\s0 to style sheets for the output of \fBcl2xhtml\fR, \&\fBcvs2xhtml\fR, and \fBfaq2html\fR. .IP "\fIsource\fR" 4 .IX Item "source" The input tree of files to spin into a web site. This must be a directory. .IP "\fIoutput\fR" 4 .IX Item "output" The output location to write the generated web site. If this directory does not exist, it will be created. If it exists, it must be a directory. .SS "spin-rss" .IX Subsection "spin-rss" .IP "\fB\-b\fR \fIbase\fR, \fB\-\-base\fR=\fIbase\fR" 4 .IX Item "-b base, --base=base" By default, output files are relative to the current working directory. If this option is given, output files will be relative to \fIbase\fR instead. Output files specified as absolute paths will not be affected. .IP "\fIfile\fR" 4 .IX Item "file" The \fI.rss\fR file to process. See App::DocKnot::Spin::RSS for the details of the file format. .SS "spin-thread" .IX Subsection "spin-thread" .IP "\fB\-s\fR \fIurl\fR, \fB\-\-style\-url\fR=\fIurl\fR" 4 .IX Item "-s url, --style-url=url" The base \s-1URL\s0 for style sheets. A style sheet specified in a \f(CW\*(C`\eheading\*(C'\fR command will be considered to be relative to this \s-1URL\s0 and this \s-1URL\s0 will be prepended to it. If this option is not given, the name of the style sheet will be used verbatim as its \s-1URL,\s0 except with \f(CW\*(C`.css\*(C'\fR appended. .IP "\fIsource\fR" 4 .IX Item "source" The input file. If not given, standard input will be used. .IP "\fIoutput\fR" 4 .IX Item "output" The output file. If not given, standard output will be used. .SS "update" .IX Subsection "update" .IP "\fB\-m\fR \fImetadata\fR, \fB\-\-metdata\fR=\fImetadata\fR" 4 .IX Item "-m metadata, --metdata=metadata" The path to the \s-1JSON\s0 metadata files for the package that should be converted to the new \s-1YAML\s0 format. This should be a directory containing all the package metadata files required by App::DocKnot. Default: \fIdocs/metadata\fR relative to the current directory. .IP "\fB\-o\fR \fIoutput\fR, \fB\-\-output\fR=\fIoutput\fR" 4 .IX Item "-o output, --output=output" The output file for the updated package configuration. Default: \&\fIdocs/docknot.yaml\fR relative to the current directory (which is the recommended metadata path for a project). .SS "update-spin" .IX Subsection "update-spin" .IP "\fIpath\fR" 4 .IX Item "path" The path to the spin input tree to update. If not given, defaults to the current directory. .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" If \fBdocknot\fR fails with errors, see the underlying module for that subcommand for information about what those errors might mean. Internally, it can also produce the following diagnostics: .ie n .IP "cannot write to %s: %s" 4 .el .IP "cannot write to \f(CW%s:\fR \f(CW%s\fR" 4 .IX Item "cannot write to %s: %s" (F) The output file specified with \fB\-o\fR could not be written to. .ie n .IP "missing required option %s" 4 .el .IP "missing required option \f(CW%s\fR" 4 .IX Item "missing required option %s" (F) One of the required command-line options was not given. .IP "no subcommand given" 4 .IX Item "no subcommand given" (F) No subcommand was given after \fBdocknot\fR on the command line. .ie n .IP "unknown command %s" 4 .el .IP "unknown command \f(CW%s\fR" 4 .IX Item "unknown command %s" (F) The given subcommand was not recognized. .PP In addition, other Getopt::Long error messages may result from invalid command-line options. .SH "AUTHOR" .IX Header "AUTHOR" Russ Allbery .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2016, 2018\-2022 Russ Allbery .PP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \*(L"Software\*(R"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: .PP The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. .PP \&\s-1THE SOFTWARE IS PROVIDED \*(L"AS IS\*(R", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\s0 \s-1IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" App::DocKnot::Config, App::DocKnot::Dist, App::DocKnot::Generate, App::DocKnot::Spin, App::DocKnot::Spin::RSS, App::DocKnot::Spin::Thread, App::DocKnot::Update .PP This program is part of the App-DocKnot distribution. The current version of DocKnot is available from \s-1CPAN,\s0 or directly from its web site at .