view release on metacpan or  search on metacpan

docs/README.html  view on Meta::CPAN

    <code class="block">
      $ curl -s -o ledgersmb-installer -L https://get.ledgersmb.org/ledgersmb-installer <br />
      $ chmod +x ledgersmb-installer
    </code>
    <p>Or, download the content of https://get.ledgersmb.org/ledgersmb-installer using your
      favorite browser.</p>


    <h2 id="commands">Commands</h2>
    <dl>
      <dt><code>ledgersmb-installer install [options] &lt;version&gt;</code></dt>
      <dd>Installs the indicated LedgerSMB version, or the latest release if no
        version was specified, building on the host
        operating system provided packages -- when on a supported platforms.</dd>

      <dt><code>ledgersmb-installer help</code></dt>
      <dd>Shows a short help message and the installer version.</dd>

      <dt><code>ledgersmb-installer compute [options] &lt;version&gt; &lt;outfile&gt;</code></dt>
      <dd>Computes the mapping of Perl module dependencies to their
        distribution package equivalents for the version specified
        and stores the result in 'outfile'.</dd>

<!--      <dt>download</dt>
      <dd>Downloads the indicated LedgerSMB tarball and signature, verifying
        the signature after download.</dd>-->

      <dt><code>ledgersmb-installer system-id [options]</code></dt>
      <dd>Prints the identifier of the system. This identifier is used to name
        the file containing the mapping of the Perl modules to the system packages.</dd>

    </dl>


    <h2 id="options">Options</h2>


    <h3>General</h3>
    <p>Options applicable to all commands.</p>
    <dl>
      <dt><code>--log-level=&lt;level&gt;</code></dt>
      <dd>Default value: <code>info</code><br />
        Available values (in increasing verbosity): <code>fatal</code>,
        <code>error</code>, <code>warning</code>, <code>info</code>,
        <code>debug</code> and <code>trace</code></dd>

      <dt><code>--[no-]prepare-env</code></dt>
      <dd>Default value: (ask)<br />
        Enables installation of system tools required for installation of Perl packages,
        such as <code>make</code> and <code>gcc</code>. Additional dependencies may
        apply based on <code>--compute-packages</code>. Installed dependencies are removed
        after installation. This may be prevented using <code>--no-uninstall-env</code></dd>

      <dt><code>--target=&lt;path&gt;</code></dt>
      <dd>Default value: <code>./ledgersmb/</code><br />
        The path to use to unpack the release tarball; used with the
        <code>install</code> <em>and</em> <code>compute</code> commands</dd>

      <dt><code>--[no-]verify-sig</code></dt>
      <dd>Default value: <code>--no-verify-sig</code><br />
        Use <code>gpg</code> to verify the release signature of the downloaded tarball</dd>

      <dt><code>--[no-]uninstall-env</code></dt>
      <dd>Default value: <code>--uninstall-env</code><br />
        Uninstalls packages that were installed to prepare the environment for computation
        of the "Perl distribution to system package" mapping and the installation of
        Perl distributions from CPAN.</dd>

      <dt><code>--yes</code></dt>
      <dd>Automatically answer &quot;yes&quot; to installer questions, allowing
        non-interactive use. (Shorthand: <code>-y</code>)</dd>
    </dl>


    <h3 id="compute-options">compute</h3>
    <p>There are no options specific to this command.</p>


    <h3 id="install-options">install</h3>
    <dl>
      <dt><code>--yes</code></dt>
      <dd>Automatically answers 'yes' to any yes/no questions the installer may ask the user.
        Especially practical for automation purposes.</dd>

      <dt class="todo"><code>--[no-]compute-packages</code></dt>
      <dd>Default value: <code>--compute-packages</code><br />
        Enables computing the mapping of Perl dependencies to system packages, if no
        mapping could be downloaded from the precomputed repository. This behaviour is
        only supported when a supported package manager could be detected.</dd>

      <dt><code>--local-lib=&lt;path&gt;</code></dt>
      <dd>Default value: <code>local</code><br />
        The location to install modules from CPAN;
        relative values are expanded relative to the <code>target</code> path.</dd>

      <dt><code>--[no-]system-packages</code></dt>
      <dd>Default value: <code>--system-packages</code> if running as a user with package
        installation rights (usually <code>root</code>).</dd>

      <dt>
    </dl>


    <h3 id="system-id-options">system-id</h3>
    <p>There are no options specific to this command.</p>


    <h2 id="bugs">Bugs and general discussion</h2>
    <p>The project is hosted on GitHub, as part of the <a href="https://github.com/ledgersmb">
        LedgerSMB organization</a>. Please file any bugs you run into <a href="https://github.com/ledgersmb/ledgersmb-installer/issues/new?template=bug_report.md">
        using the provided template</a>.
    </p>
    <p>For improvement ideas, general questions and other conversations, please use
      <a href="https://github.com/ledgersmb/ledgersmb-installer/discussions">GitHub Discussions</a>.</p>


    <h2 id="contributing">Contributing</h2>
    <p>Contributions take many forms: reporting bugs, helping other users with their installation problems,
      describing enhancement ideas and finally, submitting code changes. All of these contributions are
      equally valued.
    </p>