diff options
| author | Daniel Eklöf <daniel@ekloef.se> | 2021-06-24 07:53:09 +0000 |
|---|---|---|
| committer | Daniel Eklöf <daniel@ekloef.se> | 2021-06-24 07:53:09 +0000 |
| commit | ba26d6382963a10dc9fce9e4277f3b5374e98229 (patch) | |
| tree | 916717ad43af3535a7b671ed7938f207c0755b6c /INSTALL.md | |
| parent | server: make sure ‘overrides’ have been initialized in all error paths (diff) | |
| parent | changelog: -Dterminfo-install-location meson command line option (diff) | |
Merge branch 'custom-terminfo-install-location'
Closes #569
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 32 |
1 files changed, 28 insertions, 4 deletions
@@ -128,10 +128,34 @@ mkdir -p bld/release && cd bld/release Available compile-time options: -| Option | Type | Default | Description | Extra dependencies | -|--------------|---------|---------|---------------------|--------------------| -| `-Dime` | bool | `true` | Enables IME support | None | -| `-Dterminfo` | feature | `auto` | Build terminfo | `tic` (ncurses) | +| Option | Type | Default | Description | Extra dependencies | +|-------------------------------|---------|-----------------------|---------------------------------------|--------------------| +| `-Dime` | bool | `true` | Enables IME support | None | +| `-Dterminfo` | feature | `auto` | Build terminfo files | `tic` (ncurses) | +| `-Dterminfo-install-location` | string | `${datadir}/terminfo` | Where to install the terminfo files | None | + +The two `terminfo` options are related, but control different aspects +of how the terminfo files are built, installed and used. + +`-Dterminfo` controls if the terminfo files should be generated _at +all_. If disabled, foot’s hardcoded default terminfo is +`xterm-256color` instead of `foot`. + +`-Dterminfo-install-location` controls _where_ the terminfo files are +installed, relative to the installation prefix. The default is +`${datadir}/terminfo`. + +It also recognizes the special value `disabled`, that prevents the +terminfo files from being _installed_. They are still _built_, and +foot’s hardcoded default terminfo is still `foot`. It is intended to +be used when the terminfo files are packaged in a separate package +(something I **highly** recommend distros do). + +To build the terminfo files manually, run + +```sh +tic -x -o <output-directory> -e foot,foot-direct foot.info +``` ### Release build |
