forked from NotAShelf/beer
NotAShelf
1ef2efa0a7Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: I9c6df910f57c42f37344b6859a2b58356a6a6964
122 lines
3.4 KiB
Markdown
122 lines
3.4 KiB
Markdown
beer(1)
|
|
|
|
# NAME
|
|
|
|
beer - a fast, software-rendered, Wayland-native terminal emulator
|
|
|
|
# SYNOPSIS
|
|
|
|
*beer* [_options_]
|
|
|
|
# DESCRIPTION
|
|
|
|
*beer* is a lightweight, CPU-rendered terminal emulator for Wayland. It spawns
|
|
the user's login shell in a pseudo-terminal and renders its output into a
|
|
server-decorated window, with truecolor, styled text, scrollback, incremental
|
|
search, mouse selection, and clipboard integration.
|
|
|
|
# OPTIONS
|
|
|
|
*--server*
|
|
Run as a daemon hosting multiple windows. (Not yet implemented.)
|
|
|
|
*--config* _PATH_
|
|
Load configuration from _PATH_ instead of the default location (see
|
|
*FILES*).
|
|
|
|
*-h*, *--help*
|
|
Print usage and exit.
|
|
|
|
*-V*, *--version*
|
|
Print the version and exit.
|
|
|
|
# KEY BINDINGS
|
|
|
|
These are the built-in defaults; all are configurable in the *key-bindings*
|
|
table of _beer.toml_(5).
|
|
|
|
[[ *Binding*
|
|
:< *Action*
|
|
| Ctrl+Shift+C
|
|
: Copy the selection to the clipboard
|
|
| Ctrl+Shift+V
|
|
: Paste from the clipboard
|
|
| Ctrl+Shift+F
|
|
: Start incremental scrollback search
|
|
| Shift+Page_Up / Shift+Page_Down
|
|
: Scroll the viewport one page
|
|
| Ctrl+Shift+Home / Ctrl+Shift+End
|
|
: Scroll to the top / bottom of history
|
|
| Ctrl+Plus / Ctrl+Equal / Ctrl+Minus
|
|
: Increase / decrease the font size
|
|
| Ctrl+0
|
|
: Reset the font size
|
|
| F11
|
|
: Toggle fullscreen
|
|
| Ctrl+Shift+N
|
|
: Open a new window in the shell's current directory
|
|
| Ctrl+Shift+Up / Ctrl+Shift+Down
|
|
: Jump to the previous / next shell prompt (OSC 133)
|
|
| Ctrl+Shift+O
|
|
: Enter URL hint mode
|
|
| Ctrl+Shift+U
|
|
: Enter a Unicode codepoint by hex value
|
|
|
|
The *pipe-command-output* action (unbound by default) feeds the last command's
|
|
output to the configured command; see *shell-integration* in _beer.toml_(5).
|
|
|
|
In incremental search, type to refine the query, *Up*/*Return* jumps to the
|
|
previous match, *Down* to the next, and *Escape* exits.
|
|
|
|
In URL hint mode each visible URL is tagged with a label; type the label to open
|
|
the URL in the configured launcher, or press *Escape* to cancel.
|
|
|
|
In Unicode codepoint-input mode, type the hexadecimal value of a codepoint (e.g.
|
|
_2603_ for a snowman) and press *Return* or *Space* to insert it; *Escape*
|
|
cancels.
|
|
|
|
*beer* implements the kitty keyboard protocol (progressive enhancement via
|
|
*CSI u*), so applications that request it receive disambiguated keys, key
|
|
release and repeat events, alternate keys, and associated text.
|
|
|
|
# MOUSE
|
|
|
|
Left-click and drag selects text; double-click selects a word, triple-click a
|
|
line, and Ctrl+drag selects a rectangular block. The selection is copied to the
|
|
primary selection on release; middle-click pastes it. The wheel scrolls
|
|
history. Holding *Shift* forces local selection even while an application has
|
|
requested mouse reporting. Clicking an *OSC 8* hyperlink opens it; hovering one
|
|
underlines it.
|
|
|
|
# SHELL INTEGRATION
|
|
|
|
With a shell configured to emit them, *beer* tracks the working directory
|
|
(*OSC 7*, used by new windows) and prompt marks (*OSC 133*) for prompt jumping
|
|
and piping the last command's output. Applications may raise desktop
|
|
notifications via *OSC 9*, *OSC 777*, and *OSC 99*.
|
|
|
|
# ENVIRONMENT
|
|
|
|
*SHELL*
|
|
The shell to spawn; defaults to _/bin/sh_.
|
|
|
|
*TERM*
|
|
Set to the configured terminal name (default _beer_) for the child.
|
|
|
|
*BEER_LOG*
|
|
Log filter, in the _tracing_ env-filter syntax (e.g. _debug_).
|
|
|
|
# SIGNALS
|
|
|
|
*SIGUSR1*
|
|
Reload the configuration file and re-apply it without restarting.
|
|
|
|
# FILES
|
|
|
|
_$XDG_CONFIG_HOME/beer/beer.toml_
|
|
The configuration file (falls back to _~/.config/beer/beer.toml_). See
|
|
_beer.toml_(5).
|
|
|
|
# SEE ALSO
|
|
|
|
_beer.toml_(5)
|