view release on metacpan or  search on metacpan

bin/docknot  view on Meta::CPAN

=back

=head2 spin-text

=over 4

=item B<-m>, B<--modified>

Add a last modified subheading to the converted document based on the last
modification timestamp of the source file.  This is only done if no RCS/CVS Id
string is found in the file.  If there is one, it is used in preference.  This
option is ignored if the input is not a file.

=item B<-s> I<style>, B<--style>=I<style>

Use I<style> as the URL of a style sheet for the generated web page.  Unless
this argument is given, no style sheet will be referred to in the generated
web page.

=item B<-t> I<title>, B<--title>=I<title>

Use I<title> as the page title rather than whatever may be determined from
looking at the input file.

=back

=head2 spin-thread

=over 4

=item B<-s> I<url>, B<--style-url>=I<url>

The base URL for style sheets.  A style sheet specified in a C<\heading>
command will be considered to be relative to this URL and this URL will be
prepended to it.  If this option is not given, the name of the style sheet
will be used verbatim as its URL, except with C<.css> appended.

=item I<source>

The input file.  If not given, standard input will be used.

=item I<output>

The output file.  If not given, standard output will be used.

=back

=head2 update

=over 4

=item B<-m> I<metadata>, B<--metdata>=I<metadata>

The path to the JSON metadata files for the package that should be converted
to the new YAML format.  This should be a directory containing all the package
metadata files required by App::DocKnot.  Default: F<docs/metadata> relative
to the current directory.

=item B<-o> I<output>, B<--output>=I<output>

The output file for the updated package configuration.  Default:
F<docs/docknot.yaml> relative to the current directory (which is the
recommended metadata path for a project).

=back

=head2 update-spin

=over 4

=item I<path>

The path to the spin input tree to update.  If not given, defaults to the
current directory.

=back

=head1 DIAGNOSTICS

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

=over 4

=item cannot write to %s: %s

(F) The output file specified with B<-o> could not be written to.

=item missing required option %s

(F) One of the required command-line options was not given.

=item no subcommand given

(F) No subcommand was given after B<docknot> on the command line.

=item unknown command %s

(F) The given subcommand was not recognized.

=back

In addition, other L<Getopt::Long> error messages may result from invalid
command-line options.

=head1 AUTHOR

Russ Allbery <rra@cpan.org>

=head1 COPYRIGHT AND LICENSE

Copyright 2016, 2018-2022 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: