Home /Modules/docs/INSTALL.README.md

INSTALL.README.md

docs/archive/INSTALL.README.md · 218 line(s) · markdown

<img align="right" src="../../images/sleela/sleela-medium-profile-permanent-icon-002.jpg" width="45" height="45" alt="SLeeLa">

Installing SLeeLa

This document describes how to install SLeeLa and, in particular, how the installer is built with module-selection options so you decide which standard-library packages are staged — without being prompted interactively at install time.

The installer produces four commands — sleela (runtime), sleelvac (compiler), nordshrift (the .sst → Java/SLeeLa/C transpiler), and sleelactl (the control plane for every module family) — plus the selected standard-library packages, the integrity manifest, docs, and examples.


Quick start

All conventional installation runs through the install/ Makefile:

# User-local install (no sudo). Installs every standard-library package.
make -C install install-local

# System-wide install (uses sudo for system paths only).
make -C install install-system

# Scope-aware entry point (local prefix stays local; system prefix elevates).
make -C install install

# Refresh EVERY standard location in one run
# (user-local layouts + /usr/local + any present extra bindirs).
make -C install install-all

# Show all targets and options.
make -C install install-help

Each variant first offers to (re)generate and verify the base-code SHA-256 integrity manifest. Answer non-interactively with SLEELA_MANIFEST_CONSENT=yes|no|skip.


Module-selection options (built into the installer)

Which standard-library packages get installed is chosen when you run the build, via make variables — not by an interactive prompt. The installer artifact is produced with these options baked in.

OptionMeaning
MODULES=allInstall every lib/ package. This is the default.
MODULES="pkg1 pkg2 …"Install only the named packages (the "individually" selection expressed as data).
EXCLUDE_MODULES="pkgA pkgB"Drop these packages from whatever MODULES selected.
SERVERS=on / SERVERS=offConvenience group for the HTTP/web server trees. on (default) keeps them; off drops them all in one flag. Composes with EXCLUDE_MODULES.

The SERVERS group

SERVERS=off is shorthand for excluding every HTTP/web server package without naming each one. It drops:

http  http-1.0  http-2.0  http-3.0  http-4.0  http-5.0  http-6.0
http-7.0  http-8.0  http-9.0  http-servers  server-edition
web-server-technology  website

SERVERS=on (the default) keeps them. Whatever SERVERS decides is composed with any explicit EXCLUDE_MODULES you also pass.

Note: the HTTP server objects are statically linked into the sleela binary upstream, so SERVERS=off omits the server library source trees — the core binary itself is unchanged.

Examples

# All modules (default) — nothing extra needed.
make -C install install

# Only a chosen subset.
make -C install install MODULES="crypto codecs compression regex"

# Everything except a couple of trees.
make -C install install MODULES=all EXCLUDE_MODULES="ide wifi"

# Everything except the HTTP/web server trees (one flag).
make -C install install SERVERS=off

# Servers off AND also drop the IDE tree (SERVERS composes with EXCLUDE_MODULES).
make -C install install SERVERS=off EXCLUDE_MODULES="ide"

# Works on every install path and for staged (DESTDIR) package builds, e.g.:
make -C install install-local MODULES="crypto regex"
make -C install install-all   MODULES="crypto codecs regex"
make -C install do-install    DESTDIR=/tmp/pkgroot PREFIX=/usr/local \
    MODULES="crypto codecs" EXCLUDE_MODULES="debugger"

Behavior notes

Finding package names

Package names are the top-level directories under lib/:

ls -d lib/*/ | sed 's|lib/||; s|/||'

Install locations

BINDIR, LIBDIR, DATADIR, SYSCONFDIR, and EXTRA_BINDIRS may all be overridden. See make -C install install-help for the full list.


Prerequisites

Building the three core products requires a C/C++ toolchain and the native UI dependencies used by the runtime:

If the compiled products are missing, build them first:

make -C impl all

Uninstalling

# Remove a single tracked install at a prefix.
make -C install uninstall            [PREFIX=/usr/local]

# Remove from every standard location (mirror of install-all).
make -C install uninstall-all

Configuration directories are intentionally preserved; remove them manually if you no longer need them.


Controlling modules after install: sleelactl

Once installed, the sleelactl command controls every module family at runtime — daemons/servers, protocols, the codec/compression/video registries, the compiler/decompiler tools, and the availability of the data systems. Because the families are different kinds of thing, the verbs are chosen per nature and an unsupported verb is refused rather than faked:

NatureLegal verbs
daemonstart stop restart reload status enable disable
registryload unload enable disable list probe can status
datasourceopen close status available
protocolnegotiate grade simulate validate info
toolrun build inspect info
sleelactl list                 # every module and its nature
sleelactl status all           # running status across the board
sleelactl start server-edition # start the server daemon
sleelactl enable antivirus     # enable the antivirus coordinator at boot
sleelactl probe codecs         # run the codec registry reference pipeline
sleelactl available database   # data-source availability
sleelactl validate http-9.0    # validate a protocol spec
sleelactl build decompiler     # build a tool CLI
sleelactl where                # resolved root, registry, runtime, service manager
sleelactl check-registry       # validate the module registry
eval "$(sleelactl completion bash)"   # tab completion (installed copies: <prefix>/share/sleela/completions/)

Full reference: bin/SLEELACTL.md. The module → nature map is the plain-text bin/sleelactl.d/registry.conf (installed to <prefix>/lib/sleela/bin/sleelactl.d/registry.conf); add a module with a one-line append.

See also