aboutsummaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2021-07-24 11:09:25 +0000
committerDaniel Eklöf <daniel@ekloef.se>2021-07-24 11:12:10 +0000
commit7c686208a18f93ec1f955c289045251af5ef6056 (patch)
tree5db4a760b5cb5abec55701c4594e62682d06b31b /INSTALL.md
parentMerge branch 'csd-title' (diff)
meson: add -Ddocs=disabled|enabled|auto command line option
When enabled (the default, if scdoc is found), we build and install the man pages, example foot.ini, readme, changelog and license files.
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/INSTALL.md b/INSTALL.md
index d51275f3..1d0366c1 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -64,7 +64,7 @@ In addition to the dev variant of the packages above, you need:
* ninja
* wayland protocols
* ncurses (needed to generate terminfo)
-* scdoc (for man page generation)
+* scdoc (for man page generation, not needed if documentation is disabled)
* llvm (for PGO builds with Clang)
* [tllist](https://codeberg.org/dnkl/tllist) [^1]
@@ -130,11 +130,15 @@ Available compile-time options:
| Option | Type | Default | Description | Extra dependencies |
|-------------------------------|---------|-----------------------|---------------------------------------|--------------------|
+| `-Ddocs` | feature | `auto` | Builds and install documentation | scdoc |
| `-Dime` | bool | `true` | Enables IME support | None |
| `-Dgrapheme-clustering` | feature | `auto` | Enables grapheme clustering | libutf8proc |
| `-Dterminfo` | feature | `auto` | Build terminfo files | `tic` (ncurses) |
| `-Dterminfo-install-location` | string | `${datadir}/terminfo` | Where to install the terminfo files | None |
+Documentation includes the man pages, the example `foot.ini`, readme,
+changelog and license files.
+
The two `terminfo` options are related, but control different aspects
of how the terminfo files are built, installed and used.