NAME
docknot - Generate human-readable documentation from package metadata
SYNOPSIS
docknot -h
docknot generate [-m metadata] [-w width] template [output]
docknot generate-all [-m metadata] [-w width]
DESCRIPTION
docknot can perform various actions related to documenting or releasing software packages, organized into subcommands. The supported subcommands are:
- generate
-
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.
- generate-all
-
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.
OPTIONS
Each docknot subcommand takes its own options.
Global Options
generate
- -m metadata, --metadata=metadata
-
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).
- -w width, --width=width
-
Column width at which the generated output is wrapped. Default: 74.
- template
-
The template to use when generating the output file.
- 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:
readme -> README readme-md -> README.mdIf the template isn't listed above, this argument is required.
generate-all
- -m metadata, --metadata=metadata
-
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).
- -w width, --width=width
-
Column width at which the generated output is wrapped. Default: 74.
DIAGNOSTICS
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:
- cannot write to %s: %s
-
(F) The output file specified with -o could not be written to.
- missing required option %s
-
(F) One of the required command-line options was not given.
- no subcommand given
-
(F) No subcommand was given after docknot on the command line.
- unknown command %s
-
(F) The given subcommand was not recognized.
In addition, other Getopt::Long error messages may result from invalid command-line options.
AUTHOR
Russ Allbery <rra@cpan.org>
COPYRIGHT AND LICENSE
Copyright 2016, 2018 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.
SEE ALSO
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/.