App-DocKnot

 view release on metacpan or  search on metacpan

t/data/spin/output/software/docknot/api/app-docknot.html  view on Meta::CPAN

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>App::DocKnot</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <link rel="stylesheet" href="/~eagle/styles/pod.css" type="text/css" />
  <link rel="next" href="app-docknot-command.html"
        title="App::DocKnot::Command" />
  <link rel="up" href="../" title="DocKnot" />
  <link rel="top" href="../../../" />
</head>

<!-- Spun from DocKnot.pm by DocKnot %VERSION% on %DATE% -->

<body>
<table class="navbar"><tr>
  <td class="navleft"></td>
  <td>
    <a href="../../../">Russ Allbery</a>
    &gt; <a href="../../">Software</a>
    &gt; <a href="../">DocKnot</a>
  </td>
  <td class="navright"><a href="app-docknot-command.html">App::DocKnot::Command</a>&nbsp;&gt;</td>
</tr></table>

<h1>App::DocKnot</h1>

<p class="subhead">(Documentation and software release management)</p>

<p class="navbar">
  <a href="#S1">Requirements</a>
  | <a href="#S2">Description</a>
  | <a href="#S3">Instance Methods</a>
  | <a href="#S4">Author</a>
<br />
  <a href="#S5">Copyright and License</a>
  | <a href="#S6">See Also</a>
</p>

<h2 id="S1"><a name="S1">REQUIREMENTS</a></h2>

<p>
Perl 5.24 or later and the modules File::BaseDir, File::ShareDir, Kwalify,
Path::Tiny, and YAML::XS, all of which are available from CPAN.
</p>

<h2 id="S2"><a name="S2">DESCRIPTION</a></h2>

<p>
DocKnot is a system for documentation and software release management.  Its
functionality is provided by various submodules, often invoked via the
<b>docknot</b> command-line program.  For more information, see docknot(1).
</p>

<p>
This module only provides helper functions to load configuration and metadata
that are used by its various submodules.
</p>

<h2 id="S3"><a name="S3">INSTANCE METHODS</a></h2>

<dl>
<dt>appdata_path(PATH[, ...])</dt>
<dd><p>
Return the path of a file from the application data.  The file is specified as



( run in 2.644 seconds using v1.01-cache-2.11-cpan-39bf76dae61 )