docknot - Generate human-readable documentation from package metadata
docknot -h
docknot dist [-m metadata] -d distdir
docknot generate [-m metadata] [-w width] template [output]
docknot generate-all [-m metadata] [-w width]
docknot can perform various actions related to documenting or releasing software packages, organized into subcommands. The supported subcommands are:
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::Generate for format documentation).
Use metadata files and templates to generate human-readable documentation files for a package. See App::DocKnot::Generate for documentation on the metadata format, configuration files, and paths.
Like 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.
generate
Each docknot subcommand takes its own options.
Print out usage information and exit.
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. Required.
The path to the metadata files for the package whose distribution tarball is being generated. This should be a directory containing all the package metadata files required by App::DocKnot. Default: docs/metadata relative to the current directory (which is the recommended metadata path for a project).
The path to the metadata files for the package whose documentation is being generated. This should be a directory containing all the package metadata files required by App::DocKnot. Default: docs/metadata relative to the current directory (which is the recommended metadata path for a project).
Column width at which the generated output is wrapped. Default: 74.
The template to use when generating the output file.
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:
readme -> README readme-md -> README.md
If the template isn't listed above, this argument is required.
If docknot 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:
(F) The output file specified with -o could not be written to.
(F) One of the required command-line options was not given.
(F) No subcommand was given after docknot on the command line.
(F) The given subcommand was not recognized.
In addition, other Getopt::Long error messages may result from invalid command-line options.
Russ Allbery <rra@cpan.org>
Copyright 2016, 2018-2019 Russ Allbery <rra@cpan.org>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), 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:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN 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.
App::DocKnot::Generate
This program is part of the DocKnot distribution. DocKnot is available from CPAN as App::DocKnot, or directly from its web site at https://www.eyrie.org/~eagle/software/docknot/.
To install App::DocKnot, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::DocKnot
CPAN shell
perl -MCPAN -e shell install App::DocKnot
For more information on module installation, please visit the detailed CPAN module installation guide.