Installation¶

License¶

SieveManager 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.

SieveManager 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 GNU General Public License for more details.

Requirements¶

A Unix-like operating system (e.g., BSD, illumos, Linux, or macOS)
Python ≥ v3.9
When installing from the tarball or the Python Package Index, the Package Installer for Python

Debian Package¶

The Debian package targets Debian ≥ v11 (“bullseye”) and systems based on Debian ≥ v11 (e.g., recent-ish versions of Mint, MX, Pop!_OS, Ubuntu, or Zorin).

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 sievemgr

Python Package Index¶

Install SieveManager:

pip install sievemgr

Note

This package ships without the manual pages for sievemgr and sieve.cf and the shell completion scripts.

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:

curl -O https://codeberg.org/odkr/sievemgr/releases/download/v0.7.4.7/sievemgr-0.7.4.7.tgz

Check whether the tarball has been tampered with:

curl -O https://codeberg.org/odkr/sievemgr/releases/download/v0.7.4.7/sievemgr-0.7.4.7.tgz.asc
gpg --verify sievemgr-0.7.4.7.tgz.asc

Unpack the tarball:

tar xzf sievemgr-0.7.4.7.tgz

Go to the package directory to proceed with the installation:

cd sievemgr-0.7.4.7

Tip

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

Installation¶

Home directory¶

Install SieveManager to your home directory:

make userinstall

The manual for SieveManager are copied to ~/.local/share/man, the Bash completion script to ~/.local/share/bash-completion/completions, and the Zsh completion script to ~/.local/share/zsh-completions.

Virtual environment¶

Create a virtual environment in /opt/odkr/sievemgr and install SieveManager to that environment:

sudo make venvdir=/opt/odkr/sievemgr virtinstall

Tip

Install SieveManager to /foo and its manual and completion scripts to their standard locations in /usr/local:

sudo make venvdir=/foo prefix=/usr/local virtinstall

Manual¶

SieveManager can also be installed by being copied into a directory in your PATH:

install sievemgr.py ~/.local/bin/sievemgr

However, the cryptography module is required to check whether a server’s TLS certificate has been revoked and the dnspython module is required to resolve DNS SRV records. So you should install those modules, too:

pip3 install --user cryptography dnspython

De-installation¶

Uninstall SieveManger:

make uninstall

Note

The cryptography and dnspython Python modules are installed automatically by make userinstall as well as make virtinstall. But they are not uninstalled by make uninstall.

Extras¶

Bash completion¶

The Bash completion script should work automatically if bash-completion is installed.

However, it can also be loaded by adding, for example,

source "$HOME/.local/share/bash-completion/completions/sievemgr.bash"

to your .bashrc.

Zsh completion¶

The Zsh completion script targets Zsh’s modern completion system.

It can be activated by adding, for example,

fpath+=("$HOME/.local/share/zsh-completions")

autoload -Uz compinit
compinit

to your .zshrc.