Skip to content

Installation

german edited this page Aug 21, 2026 · 9 revisions

Installation

Requirements

Build requirements:

  • Free Pascal Compiler 3.2.2 or a compatible Free Pascal 3.x release.
  • Free Pascal FV, FCL, and DB units.
  • GNU make.
  • GNU/Linux with /proc and POSIX PTY support.

Test requirements:

  • Python 3.
  • Python package pyte.

Remote terminal requirements:

  • openssh-client for SSH connections.
  • sshpass only when password authentication is explicitly configured.

Prebuilt packages

Prebuilt v2.1 packages are attached to the release page: https://github.com/garacil/superterm/releases/tag/v2.1. Every package installs /usr/bin/superterm plus documentation and examples; the only runtime dependency is glibc.

Arch and derivatives (superterm-2.1-1-x86_64.pkg.tar.zst):

sudo pacman -U superterm-2.1-1-x86_64.pkg.tar.zst

Debian/Ubuntu (superterm_2.1_amd64.deb):

sudo apt install ./superterm_2.1_amd64.deb   # or: sudo dpkg -i superterm_2.1_amd64.deb

Fedora/RHEL/openSUSE (superterm-2.1-1.x86_64.rpm):

sudo dnf install ./superterm-2.1-1.x86_64.rpm   # or: sudo rpm -i superterm-2.1-1.x86_64.rpm

Generic tarball (superterm-2.1-gnu-x86_64.tar.gz, verify with the companion .sha256):

sha256sum -c superterm-2.1-gnu-x86_64.tar.gz.sha256
tar xzf superterm-2.1-gnu-x86_64.tar.gz
./superterm-2.1/superterm

Configure and Build

The project includes a self-contained POSIX configure script (not generated by GNU Autoconf). It builds from a clean checkout on any architecture that has a native Free Pascal compiler.

./configure
make release

The release binary is bin/superterm. A debug build is available with:

make debug

The debug binary is bin/superterm-debug.

Useful overrides:

./configure --with-fpc=/usr/local/bin/fpc
./configure --with-python=/usr/bin/python3
./configure --prefix="$HOME/.local" \
  --sysconfdir="$HOME/.config/superterm"

Inspect the selected paths with:

make info

The compatibility wrapper remains available:

./compile.sh
./compile.sh -B

Run

./bin/superterm

Optional runtime diagnostics:

SUPERTERM_DEBUG=/tmp/superterm-debug.log ./bin/superterm

Test

Build the release binary and run the complete PTY/UI regression suite:

make test

The tests launch isolated PTYs and do not attach to, restart, or modify a user's tmux server.

Install System-Wide

System installation normally requires root:

./configure --prefix=/usr/local --sysconfdir=/etc
make release
sudo make install

For a user-local installation:

./configure --prefix="$HOME/.local" \
  --sysconfdir="$HOME/.config/superterm"
make install

Ensure $HOME/.local/bin is in PATH after a user-local installation.

Clone this wiki locally