************
Installation
************

.. highlight:: bash


License
=======

Para is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.

Para is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
:doc:`GNU General Public License <license>` for more details.


Requirements
============

Para should work on almost every Unix-like system. More precisely, it
should work on every system that complies with POSIX.1-2008_, including
the X/Open System Interface and Spawn extensions. It has been tested
on Alpine Linux, Debian, Darwin, FreeBSD, NetBSD, and OpenBSD.

Compiling Para requires:

* A C compiler that supports C99_
  (e.g., GCC_ ≥ v4.3, Clang_ ≥ v1.0, or TinyCC_ ≥ v0.9)
* An assembler and a linker
  (e.g., from `GNU Binutils`_ or a BSD system)
* Make (`GNU Make`_ and BSD makes are known to work)
* The header files of your system's standard library

Para comes with a script that installs
these dependencies if needed.


Debian Package
==============

The package targets Debian ≥ v10 ("buster") and distributions based on
Debian ≥ v10 (e.g., versions of Linux Mint, MX Linux, Pop!_OS, Ubuntu, or
Zorin released since ca. 2020). It likely works on older versions, too.

Add the Codeberg repository key::

    sudo curl -o /etc/apt/trusted.gpg.d/org_codeberg_odkr.asc \
        https://codeberg.org/api/packages/odkr/debian/repository.key

Add my repository::

    sudo tee /etc/apt/sources.list.d/org_codeberg_odkr.list <<EOF
    deb https://codeberg.org/api/packages/odkr/debian bullseye main
    EOF

Update the package index::

    sudo apt-get update

Install SieveManager::

    sudo apt-get install para

.. tip::

    See :doc:`debian/README.rst <debian>` on how to build packages
    for architectures not officially supported by Debian.


Tarball
=======

Preparation
-----------

Import my `PGP key`_, so that you can check whether
the tarball has been tampered with::

    gpg --keyserver keys.openpgp.org --recv-keys 6B06A2E03BE31BE9


Download
--------

Download the tarball and its signature:

.. code-block:: bash
    :substitutions:

    version="|release|"
    baseurl="https://codeberg.org/odkr/para/releases/download/v$version"
    tarball="para-$version.tgz"
    curl --no-clobber -O "$baseurl/$tarball" -O "$baseurl/$tarball.asc"

Check whether the tarball has been tampered with:

.. code-block:: bash
    :substitutions:

    gpg --keyserver keys.openpgp.org --recv-keys 6B06A2E03BE31BE9
    gpg --verify para-|release|.asc

Unpack the tarball:

.. code-block:: bash
    :substitutions:

    tar xzf para-|release|.tgz

Go to the package directory to proceed:

.. code-block:: bash
    :substitutions:

    cd para-|release|

.. tip::
    Subscribe to https://codeberg.org/odkr/para/releases.rss
    to be notified about new releases.


.. include:: ../INSTALL.rst