Skip to content
german edited this page Aug 21, 2026 · 7 revisions

Usage

Launch

Start the compiled binary:

./bin/superterm

Each visible pane contains a real local or remote terminal process. The application starts with the configured default template/session/window when one is defined.

Four-pane superterm workspace

The screenshot illustrates the pane layout, window borders, status line, and independent PTY-backed shells in one workspace.

Controls

Key Action
F2 Vertical split, side by side
F3 Horizontal split, stacked
Alt-F3 Close the focused pane; exit when one remains
F6 / F7 Next / previous pane
F5 Maximize or restore the focused window
Ctrl-F5 Move or resize the focused window
Alt-F9 Minimize the focused window
Alt-F4 Close the focused window
+ / - Increase or decrease pane width
* / / Increase or decrease pane height
Ctrl-S Save the current session or template selection
Alt-X Exit and save when autosave is enabled
Alt-Q Exit without saving

The same actions are available from the Panels, Size, Templates, Windows, Sessions, Terminals, Session, and Help menus.

Resize Behavior

The parent terminal emulator controls the pixel size of the window. superterm reads the terminal's current rows and columns, updates the FreeVision surface, relayouts every pane, resizes each virtual screen, and sends TIOCSWINSZ to each child PTY. A periodic size check also catches resize changes that are not delivered as a direct application event.

This means a screenshot should be taken after the terminal window has settled. Do not maximize the terminal solely to capture the application; a normal window geometry shows the same adaptive layout more clearly.

Session Wizard

Open Sessions -> Quick session wizard.... In Spanish mode use Sesiones -> Asistente de sesion rapida....

For each of one to four panes, enter a connection command and an optional command to run after it starts:

The session wizard creates a fresh multi-pane workspace

Connection command: ssh -tt alice@prod.example.com
After connecting:   tmux new-session -A -s alice-prod

The wizard is intended for quick workspaces. It does not edit the INI and does not store credentials. Use a window class or a profile for a workspace that must be reproducible across restarts.

The wizard collects all pane entries before replacing the current runtime. If you cancel it, the existing panes remain unchanged. Commands run under the configured login shell and are intentionally not parsed or validated.

Window Classes

A window class is a reusable, named pane definition: a structured SSH target (host, user, port, key, optional password) or a free command, plus an optional command to run once connected. Open Classes -> Manage classes... to create, edit, duplicate, or delete them. Classes are stored in ~/.superterm/superterm.ini and can also be edited by hand.

The window class manager

Profiles

A profile is a named workspace: a set of windows, each with a pane layout whose panes reference window classes. Open Profiles -> Manage profiles... to activate a profile, save the current layout as a new one, rename, or set the default that opens on startup.

The profile manager

Detachable Sessions

Ctrl-Q d (or Sessions -> Detach...) detaches the current workspace under a name; its shells and SSH connections keep running in the background. Reattach with superterm --attach, Ctrl-Q s, or the startup picker when live sessions exist. superterm --list-sessions prints them for scripts.

The session picker listing live detached sessions

The Sessions menu gathers detach, attach/manage, save, and the quick wizard:

The Sessions menu

Options: Language and Palette

The default interface is English. Under Options, Language / Idioma switches between English and Spanish, Color palette chooses the classic color, black-and-white, or monochrome theme, and the autosave/autorestore toggles control session persistence. Every choice is saved in the user configuration.

The Options menu with the color palette submenu

Saving and Restoring

User session state is stored in ~/.superterm/session.ini. Alt-X exits with autosave enabled, while Alt-Q exits without saving. Configure autorestore=1 when the saved session should be restored on startup.

Clone this wiki locally