clone
ssh://git@git.notashelf.dev:33/notashelf/beer.git| 1 | beer(1) |
| 2 | |
| 3 | # NAME |
| 4 | |
| 5 | beer - a fast, software-rendered, Wayland-native terminal emulator |
| 6 | |
| 7 | # SYNOPSIS |
| 8 | |
| 9 | *beer* [_options_] |
| 10 | |
| 11 | # DESCRIPTION |
| 12 | |
| 13 | *beer* is a lightweight, CPU-rendered terminal emulator for Wayland. It spawns |
| 14 | the user's login shell in a pseudo-terminal and renders its output into a |
| 15 | server-decorated window, with truecolor, styled text, scrollback, incremental |
| 16 | search, mouse selection, and clipboard integration. |
| 17 | |
| 18 | # OPTIONS |
| 19 | |
| 20 | *--server* |
| 21 | Run as a daemon hosting multiple windows. (Not yet implemented.) |
| 22 | |
| 23 | *--config* _PATH_ |
| 24 | Load configuration from _PATH_ instead of the default location (see |
| 25 | *FILES*). |
| 26 | |
| 27 | *-h*, *--help* |
| 28 | Print usage and exit. |
| 29 | |
| 30 | *-V*, *--version* |
| 31 | Print the version and exit. |
| 32 | |
| 33 | # KEY BINDINGS |
| 34 | |
| 35 | These are the built-in defaults; all are configurable in the *key-bindings* |
| 36 | table of _beer.toml_(5). |
| 37 | |
| 38 | [[ *Binding* |
| 39 | :< *Action* |
| 40 | | Ctrl+Shift+C |
| 41 | : Copy the selection to the clipboard |
| 42 | | Ctrl+Shift+V |
| 43 | : Paste from the clipboard |
| 44 | | Ctrl+Shift+F |
| 45 | : Start incremental scrollback search |
| 46 | | Shift+Page_Up / Shift+Page_Down |
| 47 | : Scroll the viewport one page |
| 48 | | Ctrl+Shift+Home / Ctrl+Shift+End |
| 49 | : Scroll to the top / bottom of history |
| 50 | | Ctrl+Plus / Ctrl+Equal / Ctrl+Minus |
| 51 | : Increase / decrease the font size |
| 52 | | Ctrl+0 |
| 53 | : Reset the font size |
| 54 | | F11 |
| 55 | : Toggle fullscreen |
| 56 | | Ctrl+Shift+N |
| 57 | : Open a new window in the shell's current directory |
| 58 | | Ctrl+Shift+Up / Ctrl+Shift+Down |
| 59 | : Jump to the previous / next shell prompt (OSC 133) |
| 60 | | Ctrl+Shift+O |
| 61 | : Enter URL hint mode |
| 62 | |
| 63 | The *pipe-command-output* action (unbound by default) feeds the last command's |
| 64 | output to the configured command; see *shell-integration* in _beer.toml_(5). |
| 65 | |
| 66 | In incremental search, type to refine the query, *Up*/*Return* jumps to the |
| 67 | previous match, *Down* to the next, and *Escape* exits. |
| 68 | |
| 69 | In URL hint mode each visible URL is tagged with a label; type the label to open |
| 70 | the URL in the configured launcher, or press *Escape* to cancel. |
| 71 | |
| 72 | # MOUSE |
| 73 | |
| 74 | Left-click and drag selects text; double-click selects a word, triple-click a |
| 75 | line, and Ctrl+drag selects a rectangular block. The selection is copied to the |
| 76 | primary selection on release; middle-click pastes it. The wheel scrolls |
| 77 | history. Holding *Shift* forces local selection even while an application has |
| 78 | requested mouse reporting. Clicking an *OSC 8* hyperlink opens it; hovering one |
| 79 | underlines it. |
| 80 | |
| 81 | # SHELL INTEGRATION |
| 82 | |
| 83 | With a shell configured to emit them, *beer* tracks the working directory |
| 84 | (*OSC 7*, used by new windows) and prompt marks (*OSC 133*) for prompt jumping |
| 85 | and piping the last command's output. Applications may raise desktop |
| 86 | notifications via *OSC 9*, *OSC 777*, and *OSC 99*. |
| 87 | |
| 88 | # ENVIRONMENT |
| 89 | |
| 90 | *SHELL* |
| 91 | The shell to spawn; defaults to _/bin/sh_. |
| 92 | |
| 93 | *TERM* |
| 94 | Set to the configured terminal name (default _beer_) for the child. |
| 95 | |
| 96 | *BEER_LOG* |
| 97 | Log filter, in the _tracing_ env-filter syntax (e.g. _debug_). |
| 98 | |
| 99 | # SIGNALS |
| 100 | |
| 101 | *SIGUSR1* |
| 102 | Reload the configuration file and re-apply it without restarting. |
| 103 | |
| 104 | # FILES |
| 105 | |
| 106 | _$XDG_CONFIG_HOME/beer/beer.toml_ |
| 107 | The configuration file (falls back to _~/.config/beer/beer.toml_). See |
| 108 | _beer.toml_(5). |
| 109 | |
| 110 | # SEE ALSO |
| 111 | |
| 112 | _beer.toml_(5) |