169 lines
No EOL
7.1 KiB
HTML
169 lines
No EOL
7.1 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<title>Installation — snap-pac documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Configuration" href="configuration.html" />
|
||
<link rel="prev" title="snap-pac" href="index.html" />
|
||
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||
|
||
</head><body>
|
||
<div class="document">
|
||
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<h1 class="logo"><a href="index.html">snap-pac</a></h1>
|
||
|
||
|
||
|
||
<p class="blurb">pacman hooks that use snapper to create pre/post btrfs snapshots</p>
|
||
|
||
|
||
|
||
|
||
<p>
|
||
<iframe src="https://ghbtns.com/github-btn.html?user=wesbarnett&repo=snap-pac&type=star&count=true&size=large&v=2"
|
||
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
|
||
</p>
|
||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="configuration.html#environment-variables">Environment Variables</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Example</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
|
||
</ul>
|
||
|
||
<div class="relations">
|
||
<h3>Related Topics</h3>
|
||
<ul>
|
||
<li><a href="index.html">Documentation overview</a><ul>
|
||
<li>Previous: <a href="index.html" title="previous chapter">snap-pac</a></li>
|
||
<li>Next: <a href="configuration.html" title="next chapter">Configuration</a></li>
|
||
</ul></li>
|
||
</ul>
|
||
</div>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>$('#searchbox').show(0);</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
|
||
|
||
<div class="body" role="main">
|
||
|
||
<section id="installation">
|
||
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
|
||
<p>Install the <code class="docutils literal notranslate"><span class="pre">snap-pac</span></code> package using pacman:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pacman -S snap-pac
|
||
</pre></div>
|
||
</div>
|
||
<p>Alternatively download the <a class="reference external" href="https://github.com/wesbarnett/snap-pac/releases">latest release and signature</a>. Then, verify the download:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>gpg --verify snap-pac-<version>.tar.gz.sig
|
||
</pre></div>
|
||
</div>
|
||
<p>where <code class="docutils literal notranslate"><span class="pre"><version></span></code> is the version number you downloaded.</p>
|
||
<p>Finally, run:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make install
|
||
</pre></div>
|
||
</div>
|
||
<p>I have signed the release tarball and commits with my PGP key. Starting with release
|
||
2.2, the tarballs are signed with my key with fingerprint
|
||
<code class="docutils literal notranslate"><span class="pre">F7B28C61944FE30DABEEB0B01070BCC98C18BD66</span></code>.</p>
|
||
<p>For previous releases, the key’s fingerprint was
|
||
<code class="docutils literal notranslate"><span class="pre">8535CEF3F3C38EE69555BF67E4B5E45AA3B8C5C3</span></code>.</p>
|
||
<section id="dependencies">
|
||
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
|
||
<p><code class="docutils literal notranslate"><span class="pre">python</span></code>, <code class="docutils literal notranslate"><span class="pre">pacman</span></code>, and <code class="docutils literal notranslate"><span class="pre">snapper</span></code> are all required.</p>
|
||
</section>
|
||
<section id="testing">
|
||
<h2>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h2>
|
||
<p>For testing, <code class="docutils literal notranslate"><span class="pre">pytest</span></code> is required. To run the tests do:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make <span class="nb">test</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="documentation">
|
||
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
|
||
<p>Typically, you will not need to build the documentation on your own and can simply
|
||
access it by visiting the <a class="reference external" href="https://wesbarnett.github.io/snap-pac/">online documentation</a> or by accessing the manpage:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>man <span class="m">8</span> snap-pac
|
||
</pre></div>
|
||
</div>
|
||
<p>To build the documentation, <code class="docutils literal notranslate"><span class="pre">sphinx</span></code> is required. To build the documentation you can
|
||
do:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make docs
|
||
</pre></div>
|
||
</div>
|
||
<p>The resulting html documentation will then be located at <code class="docutils literal notranslate"><span class="pre">docs/build/index.html</span></code>.
|
||
Additionally, this generates the manpage which will be located under <code class="docutils literal notranslate"><span class="pre">man8</span></code>.</p>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2021, Wes Barnett, PhD.
|
||
|
||
|
|
||
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.1</a>
|
||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||
|
||
|
|
||
<a href="_sources/installation.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
<a href="https://github.com/wesbarnett/snap-pac" class="github">
|
||
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
|
||
</a>
|
||
|
||
|
||
|
||
</body>
|
||
</html> |