Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Glossary

Terminal

Active pane

The pane that receives your keystrokes. A new pane and a pane you click become the active pane, and the other panes are tinted (see Inactive panes).

Alternate screen

A second screen that full-screen programs such as vim and less draw on. It has no scrollback, and the primary screen comes back unchanged when the program exits.

Chord

A key pressed together with zero or more modifiers, such as Alt+h or Cmd+Plus. A direct chord runs an action by itself, and a leader binding is the leader followed by one more key (see Chord syntax).

Leader

A key that starts a two-key shortcut, written <Leader> in the configuration. By default it is a tap of Cmd on macOS and of Alt on Windows and Linux (see The leader key).

Pane

A part of the window that runs its own shell. The panes of a tab share the window below the tab bar (see Panes and Tabs).

Primary screen

The screen a shell prints to. Lines that scroll off its top go into the scrollback.

Scrollback

The lines that have scrolled off the top of the primary screen. orzma keeps the latest 10,000 lines of each pane. Scroll back with the mouse wheel or in vi mode.

Tab

One layout of panes, shown in the tab bar at the top of the window and labelled with its name or its active pane’s title. The shells in the tabs that are not on screen keep running (see Tabs).

Vi mode

A mode that moves a cursor over the screen and the scrollback with vi keys, to select and copy text (see Vi Mode).

Webview apps

These terms appear in Building Webview Apps and the Webview Protocol.

Bridge

The window.orzma object orzma adds to a page, through which the page calls its program and exchanges events with it (see The window.orzma bridge).

Control socket

The local socket a program talks to orzma over. orzma gives each pane the socket’s path in ORZMA_SOCK and a token in ORZMA_TOKEN (see The control socket).

Forward keys

Key chords that a program asks orzma to send to its pane instead of to its focused page, so that the program keeps keys such as its own quit key (see Forward keys).

Handle

The opaque ID orzma returns when a program registers content. It names the registration.

Host

orzma’s side of the protocol: it keeps each program’s registrations and draws their pages.

Instance

The ID of one placement. A program mounts, unmounts, focuses, and navigates placements by their instance IDs (see Instance semantics).

Mount

To show a placement in a rectangle of terminal cells, with the APC mount sequence or the socket mount op. Unmounting removes it again (see APC webview verbs).

Page

The web page a placement shows: the registered HTML, file, or URL, loaded in its own webview.

Placement

One place where a registration’s page appears in a pane. A registration can have several placements, each with its own instance ID and its own page.

Program

The terminal app that runs in a pane, registers content, and mounts it. The Rust SDK ratatui_orzma implements the program’s side of the protocol.

Registration

Content a program has registered with orzma: inline HTML, a directory of files, or a URL. It is named by its handle.

Webview

The embedded browser that draws a page inside the terminal.