aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-07-26 10:40:00 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-07-26 10:40:00 +0000
commit82d7cfdfe4e53a5c8b104195ead8f8994304748d (patch)
treebfc5a85fa5265446aca63afd03293393d74253c7 /README.md
parentrender: scrollback indicator: add top margin (diff)
parentdoc: benchmark: update 'laptop' results after foot-1.4.0 (diff)
Merge branch 'master' into scrollback-position-indicator
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index de0f5b7a..233703d1 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,7 @@ The fast, lightweight and minimalistic Wayland terminal emulator.
## Index
1. [Features](#features)
+1. [Configuration](#configuration)
1. [Troubleshooting](#troubleshooting)
1. [Why the name 'foot'?](#why-the-name-foot)
1. [Fonts](#fonts)
@@ -34,7 +35,6 @@ The fast, lightweight and minimalistic Wayland terminal emulator.
1. [Bugs](#bugs)
1. [Mastodon](#mastodon)
-
## Features
* Fast (see [benchmarks](doc/benchmark.md))
@@ -53,6 +53,14 @@ The fast, lightweight and minimalistic Wayland terminal emulator.
![wow](doc/sixel-wow.png "Sixel screenshot")
+## Configuration
+
+**foot** can be configured by creating a file `$XDG_CONFIG_HOME/footrc` (defaulting to `~/.config/footrc`).
+A template for that can usually be found in `/usr/share/foot/footrc` or
+[here](https://codeberg.org/dnkl/foot/src/branch/master/footrc).
+
+Further information can be found in foot's manpage `foot(5)`.
+
## Troubleshooting
@@ -223,14 +231,14 @@ want to launch a new terminal.
By default, foot prefixes _Meta characters_ with ESC. This corresponds
to XTerm's `metaSendsEscape` option set to `true`.
-This can be disabled programatically with `\E[?1036l` (and enabled
+This can be disabled programmatically with `\E[?1036l` (and enabled
again with `\E[?1036h`).
When disabled, foot will instead set the 8:th bit of meta character
and then UTF-8 encode it. This corresponds to XTerm's `eightBitMeta`
option set to `true`.
-This can also be disabled programatically with `rmm` (_reset meta
+This can also be disabled programmatically with `rmm` (_reset meta
mode_, `\E[?1034l`), and enabled again with `smm` (_set meta mode_,
`\E[?1034h`).