brewery

beer

public

A terminal worth pouring time into

Star0tarball
clone
ssh://git@git.notashelf.dev:33/notashelf/beer.git
doc/beer.1.scd130 lines3.8 KB
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_ on top of the defaults. Repeatable; when
25
	given more than once, later files override keys from earlier ones and
26
	have higher priority than files listed in *BEER_CONFIG* (see
27
	*ENVIRONMENT*). Without any *--config* flags, the default location is
28
	used (see *FILES*).
29
30
*-h*, *--help*
31
	Print usage and exit.
32
33
*-V*, *--version*
34
	Print the version and exit.
35
36
# KEY BINDINGS
37
38
These are the built-in defaults; all are configurable in the *key-bindings*
39
table of _beer.toml_(5).
40
41
[[ *Binding*
42
:< *Action*
43
|  Ctrl+Shift+C
44
:  Copy the selection to the clipboard
45
|  Ctrl+Shift+V
46
:  Paste from the clipboard
47
|  Ctrl+Shift+F
48
:  Start incremental scrollback search
49
|  Shift+Page_Up / Shift+Page_Down
50
:  Scroll the viewport one page
51
|  Ctrl+Shift+Home / Ctrl+Shift+End
52
:  Scroll to the top / bottom of history
53
|  Ctrl+Plus / Ctrl+Equal / Ctrl+Minus
54
:  Increase / decrease the font size
55
|  Ctrl+0
56
:  Reset the font size
57
|  F11
58
:  Toggle fullscreen
59
|  Ctrl+Shift+N
60
:  Open a new window in the shell's current directory
61
|  Ctrl+Shift+Up / Ctrl+Shift+Down
62
:  Jump to the previous / next shell prompt (OSC 133)
63
|  Ctrl+Shift+O
64
:  Enter URL hint mode
65
|  Ctrl+Shift+U
66
:  Enter a Unicode codepoint by hex value
67
68
The *pipe-command-output* action (unbound by default) feeds the last command's
69
output to the configured command; see *shell-integration* in _beer.toml_(5).
70
71
In incremental search, type to refine the query, *Up*/*Return* jumps to the
72
previous match, *Down* to the next, and *Escape* exits.
73
74
In URL hint mode each visible URL is tagged with a label; type the label to open
75
the URL in the configured launcher, or press *Escape* to cancel.
76
77
In Unicode codepoint-input mode, type the hexadecimal value of a codepoint (e.g.
78
_2603_ for a snowman) and press *Return* or *Space* to insert it; *Escape*
79
cancels.
80
81
*beer* implements the kitty keyboard protocol (progressive enhancement via
82
*CSI u*), so applications that request it receive disambiguated keys, key
83
release and repeat events, alternate keys, and associated text.
84
85
# MOUSE
86
87
Left-click and drag selects text; double-click selects a word, triple-click a
88
line, and Ctrl+drag selects a rectangular block. The selection is copied to the
89
primary selection on release; middle-click pastes it. The wheel scrolls
90
history. Holding *Shift* forces local selection even while an application has
91
requested mouse reporting. Clicking an *OSC 8* hyperlink opens it; hovering one
92
underlines it.
93
94
# SHELL INTEGRATION
95
96
With a shell configured to emit them, *beer* tracks the working directory
97
(*OSC 7*, used by new windows) and prompt marks (*OSC 133*) for prompt jumping
98
and piping the last command's output. Applications may raise desktop
99
notifications via *OSC 9*, *OSC 777*, and *OSC 99*.
100
101
# ENVIRONMENT
102
103
*SHELL*
104
	The shell to spawn; defaults to _/bin/sh_.
105
106
*TERM*
107
	Set to the configured terminal name (default _beer_) for the child.
108
109
*BEER_CONFIG*
110
	A colon-separated list of config file paths, like *PATH*. These are
111
	lower priority than paths given via *--config* so explicit flags always
112
	win. Empty elements are ignored.
113
114
*BEER_LOG*
115
	Log filter, in the _tracing_ env-filter syntax (e.g. _debug_).
116
117
# SIGNALS
118
119
*SIGUSR1*
120
	Reload the configuration file and re-apply it without restarting.
121
122
# FILES
123
124
_$XDG_CONFIG_HOME/beer/beer.toml_
125
	The configuration file (falls back to _~/.config/beer/beer.toml_). See
126
	_beer.toml_(5).
127
128
# SEE ALSO
129
130
_beer.toml_(5)