summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2018-09-24 21:06:12 +0200
committerChristian Duerr <chrisduerr@users.noreply.github.com>2018-09-24 19:06:12 +0000
commitec3a80427b717bb13d56c3031f4195bdae9c011a (patch)
tree85f9119f88c2dfe56d8839150fc136623e14c624 /README.md
parent3d7e88e8a975f40996aaa71d951842db6f2fccbb (diff)
Add standalone terminfo definition
This replaces the current definitions, which depend on the system's 'xterm-256color' terminfo definition with the `alacritty` and `alacritty-direct` definitions. The new definitions are completely standalone. The default `TERM` value has been changed to be dynamically set based on the definitions installed on the system. Alacritty will try to use the `alacritty` definition first and fall back to `xterm-256color` if the `alacritty` definition is not present.
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index d7d299e9..a96ed29c 100644
--- a/README.md
+++ b/README.md
@@ -336,6 +336,27 @@ To install the completions for fish, run
sudo cp alacritty-completions.fish $__fish_datadir/vendor_completions.d/alacritty.fish
```
+## Terminfo
+
+The terminfo database contains entries describing the terminal
+emulator's capabilities. Programs need these in order to function
+properly.
+
+Alacritty should work with the standard `xterm-256color` definition,
+but to allow programs to make best use of alacritty's capabilities,
+use its own terminfo definition instead.
+
+Unless the user has set the `TERM` environment variable in the
+alacritty configuration, the `alacritty` terminfo definition will be
+used if it has been installed. If not, then `xterm-256color` is used
+instead.
+
+To install alacritty's terminfo entry globally:
+
+```sh
+sudo tic -e alacritty,alacritty-direct alacritty.info
+```
+
## Configuration
Although it's possible the default configuration would work on your system,