docs/packs_common_0.html

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>packs_common &mdash; Logtalk APIs v3.91.0-b01 documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d75fae25" />
      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
      <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=0e9007aa" />

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="_static/jquery.js?v=5d32c60e"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
        <script src="_static/documentation_options.js?v=e89a77c9"></script>
        <script src="_static/doctools.js?v=9a2dae69"></script>
        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/js/theme.js"></script>
    <!-- begin favicon -->
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
    <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png" />
    <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png" />
    <link rel="manifest" href="/site.webmanifest" />
    <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5" />
    <meta name="msapplication-TileColor" content="#355b95" />
    <meta name="theme-color" content="#ffffff" />
    <!-- end favicon -->
    
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="packs_messages" href="packs_messages_0.html" />
    <link rel="prev" title="packs" href="packs_0.html" />
   
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          <a href="index.html" class="icon icon-home">
            Logtalk APIs
              <img src="_static/logtalk.gif" class="logo" alt="Logo"/>
          </a>
              <div class="version">
                3.91.0
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
    
              <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="library_index.html">Libraries</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="library_index.html#arbitrary"><span class="xref std std-ref">arbitrary</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#assertions"><span class="xref std std-ref">assertions</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#assignvars"><span class="xref std std-ref">assignvars</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#base64"><span class="xref std std-ref">base64</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#cbor"><span class="xref std std-ref">cbor</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#code-metrics"><span class="xref std std-ref">code_metrics</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#core"><span class="xref std std-ref">core</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#coroutining"><span class="xref std std-ref">coroutining</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#csv"><span class="xref std std-ref">csv</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dates"><span class="xref std std-ref">dates</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dead-code-scanner"><span class="xref std std-ref">dead_code_scanner</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#debug-messages"><span class="xref std std-ref">debug_messages</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#debugger"><span class="xref std std-ref">debugger</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dependents"><span class="xref std std-ref">dependents</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#diagrams"><span class="xref std std-ref">diagrams</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dictionaries"><span class="xref std std-ref">dictionaries</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dif"><span class="xref std std-ref">dif</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#doclet"><span class="xref std std-ref">doclet</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#edcg"><span class="xref std std-ref">edcg</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#events"><span class="xref std std-ref">events</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#expand-library-alias-paths"><span class="xref std std-ref">expand_library_alias_paths</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#expecteds"><span class="xref std std-ref">expecteds</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#fcube"><span class="xref std std-ref">fcube</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#flags"><span class="xref std std-ref">flags</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#format"><span class="xref std std-ref">format</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#genint"><span class="xref std std-ref">genint</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#gensym"><span class="xref std std-ref">gensym</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#git"><span class="xref std std-ref">git</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#grammars"><span class="xref std std-ref">grammars</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#heaps"><span class="xref std std-ref">heaps</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#help"><span class="xref std std-ref">help</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#hierarchies"><span class="xref std std-ref">hierarchies</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#hook-flows"><span class="xref std std-ref">hook_flows</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#hook-objects"><span class="xref std std-ref">hook_objects</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#html"><span class="xref std std-ref">html</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#ids"><span class="xref std std-ref">ids</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#intervals"><span class="xref std std-ref">intervals</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#iso8601"><span class="xref std std-ref">iso8601</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#issue-creator"><span class="xref std std-ref">issue_creator</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#java"><span class="xref std std-ref">java</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#json"><span class="xref std std-ref">json</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#lgtdoc"><span class="xref std std-ref">lgtdoc</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#lgtunit"><span class="xref std std-ref">lgtunit</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#library"><span class="xref std std-ref">library</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#listing"><span class="xref std std-ref">listing</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#logging"><span class="xref std std-ref">logging</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#loops"><span class="xref std std-ref">loops</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#meta"><span class="xref std std-ref">meta</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#meta-compiler"><span class="xref std std-ref">meta_compiler</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#metagol"><span class="xref std std-ref">metagol</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#mutations"><span class="xref std std-ref">mutations</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#nested-dictionaries"><span class="xref std std-ref">nested_dictionaries</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#optionals"><span class="xref std std-ref">optionals</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#options"><span class="xref std std-ref">options</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#os"><span class="xref std std-ref">os</span></a></li>
<li class="toctree-l2 current"><a class="reference internal" href="library_index.html#packs"><span class="xref std std-ref">packs</span></a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="pack_protocol_0.html">pack_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="packs_0.html">packs</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">packs_common</a></li>
<li class="toctree-l3"><a class="reference internal" href="packs_messages_0.html">packs_messages</a></li>
<li class="toctree-l3"><a class="reference internal" href="packs_specs_hook_0.html">packs_specs_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="registries_0.html">registries</a></li>
<li class="toctree-l3"><a class="reference internal" href="registry_loader_hook_0.html">registry_loader_hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="registry_protocol_0.html">registry_protocol</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#pddl-parser"><span class="xref std std-ref">pddl_parser</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#ports-profiler"><span class="xref std std-ref">ports_profiler</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#queues"><span class="xref std std-ref">queues</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#random"><span class="xref std std-ref">random</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#reader"><span class="xref std std-ref">reader</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#recorded-database"><span class="xref std std-ref">recorded_database</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#redis"><span class="xref std std-ref">redis</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#sets"><span class="xref std std-ref">sets</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#statistics"><span class="xref std std-ref">statistics</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#term-io"><span class="xref std std-ref">term_io</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#timeout"><span class="xref std std-ref">timeout</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#toychr"><span class="xref std std-ref">toychr</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#tsv"><span class="xref std std-ref">tsv</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#tutor"><span class="xref std std-ref">tutor</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#types"><span class="xref std std-ref">types</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#ulid"><span class="xref std std-ref">ulid</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#union-find"><span class="xref std std-ref">union_find</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#uuid"><span class="xref std std-ref">uuid</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#verdi-neruda"><span class="xref std std-ref">verdi_neruda</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#wrapper"><span class="xref std std-ref">wrapper</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#xml-parser"><span class="xref std std-ref">xml_parser</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#zippers"><span class="xref std std-ref">zippers</span></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="directory_index.html">Directories</a></li>
<li class="toctree-l1"><a class="reference internal" href="entity_index.html">Entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="predicate_index.html">Predicates</a></li>
</ul>

    <ul>
    <li class="toctree-l1"><a class="reference internal" href="core_inheritance_diagram.svg">Core diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="library_inheritance_diagram.svg">Libraries diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="tools_inheritance_diagram.svg">Tools diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="ports_inheritance_diagram.svg">Ports diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="contributions_inheritance_diagram.svg">Contributions diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
    </ul>
    <p class="caption"><span class="caption-text">External Contents</span></p>
    <ul>
    <li class="toctree-l1"><a class="reference internal" href="../manuals/index.html">Handbook</a></li>
    <li class="toctree-l1"><a class="reference internal" href="https://logtalk.org">Logtalk website</a></li>
    <li class="toctree-l1"><a class="reference internal" href="https://github.com/LogtalkDotOrg/logtalk3">GitHub repo</a></li>
    </ul>
  
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">Logtalk APIs</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="library_index.html">Libraries</a></li>
      <li class="breadcrumb-item active"><code class="docutils literal notranslate"><span class="pre">packs_common</span></code></li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/packs_common_0.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <p class="right" id="packs-common-0"><span id="index-0"></span><strong>category</strong></p>
<section id="packs-common">
<h1><code class="docutils literal notranslate"><span class="pre">packs_common</span></code><a class="headerlink" href="#packs-common" title="Link to this heading"></a></h1>
<p>Common predicates for the packs tool objects.</p>
<div class="line-block">
<div class="line"><strong>Availability:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">logtalk_load(packs(loader))</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Author:</strong> Paulo Moura</div>
<div class="line"><strong>Version:</strong> 0:33:0</div>
<div class="line"><strong>Date:</strong> 2025-01-23</div>
</div>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Provides:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="type_0.html#type-0-type-1"><span class="std std-ref">type::type/1</span></a></div>
<div class="line"><a class="reference internal" href="type_0.html#type-0-check-2"><span class="std std-ref">type::check/2</span></a></div>
</div>
<div class="line"><strong>Uses:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="list_0.html#list-0"><span class="std std-ref">list</span></a></div>
<div class="line"><a class="reference internal" href="logtalk_0.html#logtalk-0"><span class="std std-ref">logtalk</span></a></div>
<div class="line"><a class="reference internal" href="os_0.html#os-0"><span class="std std-ref">os</span></a></div>
<div class="line"><a class="reference internal" href="type_0.html#type-0"><span class="std std-ref">type</span></a></div>
<div class="line"><a class="reference internal" href="user_0.html#user-0"><span class="std std-ref">user</span></a></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Remarks:</strong></div>
<div class="line-block">
<div class="line">(none)</div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Inherited public predicates:</strong></div>
<div class="line-block">
<div class="line">(none)</div>
</div>
</div>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#public-predicates" id="id1">Public predicates</a></p>
<ul>
<li><p><a class="reference internal" href="#setup-0" id="id2"><code class="docutils literal notranslate"><span class="pre">setup/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#reset-0" id="id3"><code class="docutils literal notranslate"><span class="pre">reset/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#verify-commands-availability-0" id="id4"><code class="docutils literal notranslate"><span class="pre">verify_commands_availability/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#help-0" id="id5"><code class="docutils literal notranslate"><span class="pre">help/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#pin-1" id="id6"><code class="docutils literal notranslate"><span class="pre">pin/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#pin-0" id="id7"><code class="docutils literal notranslate"><span class="pre">pin/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#unpin-1" id="id8"><code class="docutils literal notranslate"><span class="pre">unpin/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#unpin-0" id="id9"><code class="docutils literal notranslate"><span class="pre">unpin/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#pinned-1" id="id10"><code class="docutils literal notranslate"><span class="pre">pinned/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#directory-2" id="id11"><code class="docutils literal notranslate"><span class="pre">directory/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#directory-1" id="id12"><code class="docutils literal notranslate"><span class="pre">directory/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#readme-2" id="id13"><code class="docutils literal notranslate"><span class="pre">readme/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#readme-1" id="id14"><code class="docutils literal notranslate"><span class="pre">readme/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#logtalk-packs-1" id="id15"><code class="docutils literal notranslate"><span class="pre">logtalk_packs/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#logtalk-packs-0" id="id16"><code class="docutils literal notranslate"><span class="pre">logtalk_packs/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#prefix-1" id="id17"><code class="docutils literal notranslate"><span class="pre">prefix/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#prefix-0" id="id18"><code class="docutils literal notranslate"><span class="pre">prefix/0</span></code></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#protected-predicates" id="id19">Protected predicates</a></p>
<ul>
<li><p><a class="reference internal" href="#readme-file-path-2" id="id20"><code class="docutils literal notranslate"><span class="pre">readme_file_path/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#print-readme-file-path-1" id="id21"><code class="docutils literal notranslate"><span class="pre">print_readme_file_path/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#command-2" id="id22"><code class="docutils literal notranslate"><span class="pre">command/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#load-registry-1" id="id23"><code class="docutils literal notranslate"><span class="pre">load_registry/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#sha256sum-command-1" id="id24"><code class="docutils literal notranslate"><span class="pre">sha256sum_command/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#tar-command-1" id="id25"><code class="docutils literal notranslate"><span class="pre">tar_command/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#supported-archive-1" id="id26"><code class="docutils literal notranslate"><span class="pre">supported_archive/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#supported-url-archive-1" id="id27"><code class="docutils literal notranslate"><span class="pre">supported_url_archive/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#decode-url-spaces-2" id="id28"><code class="docutils literal notranslate"><span class="pre">decode_url_spaces/2</span></code></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#private-predicates" id="id29">Private predicates</a></p></li>
<li><p><a class="reference internal" href="#operators" id="id30">Operators</a></p></li>
</ul>
</nav>
<section id="public-predicates">
<h2><a class="toc-backref" href="#contents" role="doc-backlink">Public predicates</a><a class="headerlink" href="#public-predicates" title="Link to this heading"></a></h2>
<section id="setup-0">
<span id="packs-common-0-setup-0"></span><span id="index-1"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">setup/0</span></code></a><a class="headerlink" href="#setup-0" title="Link to this heading"></a></h3>
<p>Ensures that registries and packs directory structure exists. Preserves any defined registries and installed packs.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">setup</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="reset-0">
<span id="packs-common-0-reset-0"></span><span id="index-2"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">reset/0</span></code></a><a class="headerlink" href="#reset-0" title="Link to this heading"></a></h3>
<p>Resets registries and packs directory structure. Deletes any defined registries and installed packs.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">reset</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="verify-commands-availability-0">
<span id="packs-common-0-verify-commands-availability-0"></span><span id="index-3"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">verify_commands_availability/0</span></code></a><a class="headerlink" href="#verify-commands-availability-0" title="Link to this heading"></a></h3>
<p>Verifies required shell commands availability. Fails printing an error message if a command is missing.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">verify_commands_availability</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="help-0">
<span id="packs-common-0-help-0"></span><span id="index-4"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">help/0</span></code></a><a class="headerlink" href="#help-0" title="Link to this heading"></a></h3>
<p>Provides help about the main predicates.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">help</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="pin-1">
<span id="packs-common-0-pin-1"></span><span id="index-5"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">pin/1</span></code></a><a class="headerlink" href="#pin-1" title="Link to this heading"></a></h3>
<p>Pins a resource (pack or registry) preventing it from being updated, uninstalled, or deleted. Fails if the resource is not found.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">pin(Resource)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">pin(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Exceptions:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">Resource</span></code> is a variable:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">instantiation_error</span></code></div>
</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">Resource</span></code> is neither a variable nor an atom:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">type_error(atom,Resource)</span></code></div>
</div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="pin-0">
<span id="packs-common-0-pin-0"></span><span id="index-6"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">pin/0</span></code></a><a class="headerlink" href="#pin-0" title="Link to this heading"></a></h3>
<p>Pins all resource (packs or registries) preventing them from being updated, uninstalled, or deleted. Note that resources added after calling this predicate will not be pinned.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">pin</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="unpin-1">
<span id="packs-common-0-unpin-1"></span><span id="index-7"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">unpin/1</span></code></a><a class="headerlink" href="#unpin-1" title="Link to this heading"></a></h3>
<p>Unpins a resource (pack or registry), allowing it to be updated, uninstalled, or deleted. Fails if the resource is not found.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">unpin(Resource)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">unpin(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Exceptions:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">Resource</span></code> is a variable:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">instantiation_error</span></code></div>
</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">Resource</span></code> is neither a variable nor an atom:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">type_error(atom,Resource)</span></code></div>
</div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="unpin-0">
<span id="packs-common-0-unpin-0"></span><span id="index-8"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">unpin/0</span></code></a><a class="headerlink" href="#unpin-0" title="Link to this heading"></a></h3>
<p>Unpins all resources (packs or registries), allowing them to be updated, uninstalled, or deleted.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">unpin</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="pinned-1">
<span id="packs-common-0-pinned-1"></span><span id="index-9"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">pinned/1</span></code></a><a class="headerlink" href="#pinned-1" title="Link to this heading"></a></h3>
<p>True iff the resource (pack or registry) is defined or installed and if it is pinned.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">pinned(Resource)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">pinned(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Exceptions:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">Resource</span></code> is a variable:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">instantiation_error</span></code></div>
</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">Resource</span></code> is neither a variable nor an atom:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">type_error(atom,Resource)</span></code></div>
</div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="directory-2">
<span id="packs-common-0-directory-2"></span><span id="index-10"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">directory/2</span></code></a><a class="headerlink" href="#directory-2" title="Link to this heading"></a></h3>
<p>Enumerates by backtracking all packs or registries and respective installation or definition directories (using the internal backend format).</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directory(Resource,Directory)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directory(?atom,?atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Exceptions:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">Resource</span></code> is neither a variable nor an atom:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">type_error(atom,Resource)</span></code></div>
</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">Directory</span></code> is neither a variable nor an atom:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">type_error(atom,Directory)</span></code></div>
</div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="directory-1">
<span id="packs-common-0-directory-1"></span><span id="index-11"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">directory/1</span></code></a><a class="headerlink" href="#directory-1" title="Link to this heading"></a></h3>
<p>Prints the directory where the registry or the pack is installed (using the native operating-system format).</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directory(Resource)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directory(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Exceptions:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">Resource</span></code> is a variable:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">instantiation_error</span></code></div>
</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">Resource</span></code> is neither a variable nor an atom:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">type_error(atom,Resource)</span></code></div>
</div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="readme-2">
<span id="packs-common-0-readme-2"></span><span id="index-12"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">readme/2</span></code></a><a class="headerlink" href="#readme-2" title="Link to this heading"></a></h3>
<p>Returns the path to the resource (pack or registry) readme file (using the internal backend format). Fails if the resource is not defined or installed or if no readme file is found for it.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">readme(Resource,ReadMeFile)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">readme(+atom,-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Exceptions:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">Resource</span></code> is a variable:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">instantiation_error</span></code></div>
</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">Resource</span></code> is neither a variable nor an atom:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">type_error(atom,Resource)</span></code></div>
</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">ReadMeFile</span></code> is neither a variable nor an atom:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">type_error(atom,ReadMeFile)</span></code></div>
</div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="readme-1">
<span id="packs-common-0-readme-1"></span><span id="index-13"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">readme/1</span></code></a><a class="headerlink" href="#readme-1" title="Link to this heading"></a></h3>
<p>Prints the path to the resource (pack or registry) readme file (using the native operating-system format). Fails if the resource is not defined or installed or if no readme file is found for it.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">readme(Resource)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">readme(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Exceptions:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">Resource</span></code> is a variable:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">instantiation_error</span></code></div>
</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">Resource</span></code> is neither a variable nor an atom:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">type_error(atom,Resource)</span></code></div>
</div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="logtalk-packs-1">
<span id="packs-common-0-logtalk-packs-1"></span><span id="index-14"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">logtalk_packs/1</span></code></a><a class="headerlink" href="#logtalk-packs-1" title="Link to this heading"></a></h3>
<p>Returns the directory prefix (using the internal backend format) where the registries, packs, and archives are installed.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">logtalk_packs(LogtalkPacks)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">logtalk_packs(-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Exceptions:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">LogtalkPacks</span></code> is neither a variable nor an atom:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">type_error(atom,LogtalkPacks)</span></code></div>
</div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="logtalk-packs-0">
<span id="packs-common-0-logtalk-packs-0"></span><span id="index-15"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">logtalk_packs/0</span></code></a><a class="headerlink" href="#logtalk-packs-0" title="Link to this heading"></a></h3>
<p>Prints the directory prefix (using the native operating-system format) where the registries, packs, and archives are installed.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">logtalk_packs</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="prefix-1">
<span id="packs-common-0-prefix-1"></span><span id="index-16"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">prefix/1</span></code></a><a class="headerlink" href="#prefix-1" title="Link to this heading"></a></h3>
<p>Returns the directory prefix (using the internal backend format) where the registries or packs are installed.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">prefix(Prefix)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">prefix(-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Exceptions:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">Prefix</span></code> is neither a variable nor an atom:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">type_error(atom,Prefix)</span></code></div>
</div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="prefix-0">
<span id="packs-common-0-prefix-0"></span><span id="index-17"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">prefix/0</span></code></a><a class="headerlink" href="#prefix-0" title="Link to this heading"></a></h3>
<p>Prints the directory prefix (using the native operating-system format) where the registries or packs are installed.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">prefix</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
</section>
</section>
<hr class="docutils" />
<section id="protected-predicates">
<h2><a class="toc-backref" href="#contents" role="doc-backlink">Protected predicates</a><a class="headerlink" href="#protected-predicates" title="Link to this heading"></a></h2>
<section id="readme-file-path-2">
<span id="packs-common-0-readme-file-path-2"></span><span id="index-18"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">readme_file_path/2</span></code></a><a class="headerlink" href="#readme-file-path-2" title="Link to this heading"></a></h3>
<p>Returns the absolute path for the given directory readme file if it exists.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">readme_file_path(Directory,ReadMeFile)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">readme_file_path(+atom,-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Remarks:</strong></div>
</div>
<blockquote>
<div><ul class="simple">
<li><p>Valid file names: Case variations of <code class="docutils literal notranslate"><span class="pre">README</span></code> and <code class="docutils literal notranslate"><span class="pre">NOTES</span></code> with or without a <code class="docutils literal notranslate"><span class="pre">.md</span></code> or <code class="docutils literal notranslate"><span class="pre">.txt</span></code> extension. The recommended file name is <code class="docutils literal notranslate"><span class="pre">README.md</span></code>.</p></li>
</ul>
</div></blockquote>
<hr class="docutils" />
</section>
<section id="print-readme-file-path-1">
<span id="packs-common-0-print-readme-file-path-1"></span><span id="index-19"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">print_readme_file_path/1</span></code></a><a class="headerlink" href="#print-readme-file-path-1" title="Link to this heading"></a></h3>
<p>Prints the absolute path for the given directory readme file if it exists. Succeeds otherwise.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">print_readme_file_path(Directory)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">print_readme_file_path(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="command-2">
<span id="packs-common-0-command-2"></span><span id="index-20"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">command/2</span></code></a><a class="headerlink" href="#command-2" title="Link to this heading"></a></h3>
<p>Executes a shell command. Prints an error message and fails if the command fails.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">command(Command,FailureMessage)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">command(+atom,&#64;nonvar)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="load-registry-1">
<span id="packs-common-0-load-registry-1"></span><span id="index-21"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">load_registry/1</span></code></a><a class="headerlink" href="#load-registry-1" title="Link to this heading"></a></h3>
<p>Loads all registry files from the given directory.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">load_registry(Directory)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">load_registry(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="sha256sum-command-1">
<span id="packs-common-0-sha256sum-command-1"></span><span id="index-22"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">sha256sum_command/1</span></code></a><a class="headerlink" href="#sha256sum-command-1" title="Link to this heading"></a></h3>
<p>Returns the name of the sha256sum command to be used on POSIX systems. Fails if neither gsha256sum or sha256sum commands are found.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">sha256sum_command(Command)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">sha256sum_command(-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="tar-command-1">
<span id="packs-common-0-tar-command-1"></span><span id="index-23"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">tar_command/1</span></code></a><a class="headerlink" href="#tar-command-1" title="Link to this heading"></a></h3>
<p>Returns the name of the tar command to be used depending on the operating-system.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">tar_command(Command)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">tar_command(-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="supported-archive-1">
<span id="packs-common-0-supported-archive-1"></span><span id="index-24"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">supported_archive/1</span></code></a><a class="headerlink" href="#supported-archive-1" title="Link to this heading"></a></h3>
<p>True iff the archive format is supported.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">supported_archive(Extension)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">supported_archive(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="supported-url-archive-1">
<span id="packs-common-0-supported-url-archive-1"></span><span id="index-25"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">supported_url_archive/1</span></code></a><a class="headerlink" href="#supported-url-archive-1" title="Link to this heading"></a></h3>
<p>True iff the URL archive is supported.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">supported_url_archive(URL)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">supported_url_archive(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="decode-url-spaces-2">
<span id="packs-common-0-decode-url-spaces-2"></span><span id="index-26"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">decode_url_spaces/2</span></code></a><a class="headerlink" href="#decode-url-spaces-2" title="Link to this heading"></a></h3>
<p>Decodes encoded spaces (%20) in URLs to spaces.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">decode_url_spaces(URL,Decoded)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">decode_url_spaces(+atom,-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
</section>
</section>
<hr class="docutils" />
<section id="private-predicates">
<h2><a class="toc-backref" href="#contents" role="doc-backlink">Private predicates</a><a class="headerlink" href="#private-predicates" title="Link to this heading"></a></h2>
<p>(no local declarations; see entity ancestors if any)</p>
</section>
<section id="operators">
<h2><a class="toc-backref" href="#contents" role="doc-backlink">Operators</a><a class="headerlink" href="#operators" title="Link to this heading"></a></h2>
<p>(none)</p>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="packs_0.html" class="btn btn-neutral float-left" title="packs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="packs_messages_0.html" class="btn btn-neutral float-right" title="packs_messages" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 1998-2025, Paulo Moura.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>