view release on metacpan or  search on metacpan

bin/docknot  view on Meta::CPAN

#!perl
#
# Generate human-readable documentation from package metadata.
#
# This is the driver program for the DocKnot documentation generation system.
# As much logic as possible should live in App::DocKnot rather than in this
# script.  It should be a thin wrapper.
#
# SPDX-License-Identifier: MIT

use 5.024;
use autodie;
use warnings;

use App::DocKnot::Command;

# Dispatch everything to the module.
my $docknot = App::DocKnot::Command->new();
$docknot->run();

__END__

=for stopwords
Allbery DocKnot docknot MERCHANTABILITY NONINFRINGEMENT sublicense subcommand
subcommands distdir pgp-key cl2xhtml cvs2xhtml faq2html spin-rss archivedir
XHTML -lu

=head1 NAME

docknot - Static web site and documentation generator

=head1 SYNOPSIS

B<docknot> B<-h>

B<docknot> dist [B<-d> I<distdir>] [B<-m> I<metadata>] [B<-p> I<pgp-key>]

B<docknot> generate [B<-m> I<metadata>] [B<-w> I<width>] I<template> [I<output>]

B<docknot> generate-all [B<-m> I<metadata>] [B<-w> I<width>]

B<docknot> release [B<-a> I<archivedir>] [B<-d> I<distdir>] [B<-m> I<metadata>]

B<docknot> spin [B<-d>] [B<-e> I<pattern> ...] [B<-s> I<url>] I<source>
I<output>

B<docknot> spin-rss [B<-b> I<base>] I<file>

B<docknot> spin-text [B<-lu>] [B<-s> I<url>] [B<-t> I<title>] [I<source>
[I<output>]]

B<docknot> spin-thread [B<-f>] [B<-s> I<url>] [I<source> [I<output>]]

B<docknot> update [B<-m> I<metadata>] [B<-o> I<output>]

B<docknot> update-spin [I<path>]

=head1 DESCRIPTION

B<docknot> 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:

=over 4

=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
L<App::DocKnot::Config> for format documentation).

After the distribution is built, it will be checked against the source tree
and B<docknot> will report an error and exit with a non-zero status if there
are any expected files missing.

=item generate

Use metadata files and templates to generate human-readable documentation
files for a package.  See L<App::DocKnot::Config> for documentation on the
metadata format, configuration files, and paths.

=item generate-all

Like C<generate>, 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.