docknot

(Generate human-readable documentation from package metadata)

SYNOPSIS

docknot [-h] -m metadata -o output -t template

DESCRIPTION

docknot uses metadata files and templates to generate human-readable documentation files for a package. It is a small driver script around App::DocKnot. See App::DocKnot for documentation on the metadata format, configuration files, and paths.

OPTIONS

-h, --help

Print out usage information and exit.

-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. This option is required.

-o output, --output=output

The path to the output file to generate. This option is required.

-t template, --template=template

The template to use when generating the output file. This option is required.

DIAGNOSTICS

If docknot fails with errors, see App::DocKnot 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.

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 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

App::DocKnot

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/>.

Last spun 2016-11-05 from POD modified 2016-10-27