A fast, lightweight and minimalistic Wayland terminal emulator
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Daniel Eklöf de6ab6dca0
Merge branch 'update-input-serial-on-each-keypress'
17 hours ago
.builds ci: codespell: ignore ‘doas’ 2 months ago
completions log: add LOG_CLASS_NONE and use as initializer for log_level 4 months ago
doc doc: foot.5: warn user to be careful with single letter key bindings in url mode 2 days ago
icons Add logo, fixes #27 1 year ago
pgo pgo: full-inner: add --override tweak.grapheme-shaping=no 6 days ago
scripts scripts: generate-alt-random: add emoji sequences 4 months ago
subprojects meson: use wrap files for fcft/tllist subprojects 10 months ago
themes add Nordiq theme 4 days ago
.editorconfig editorconfig: adjust max-line-length, down from 80 to 70 3 months ago
.gitignore Revert "gitignore: compile_commands.json + .ccls-cache" 4 months ago
.gitlab-ci.yml ci: codespell: ignore ‘doas’ 2 months ago
.gitmodules fcft/tllist: remove git submodules 2 years ago
.woodpecker.yml ci: run “foot --version” and “footclient --version” after each build 2 weeks ago
CHANGELOG.md input: update serial on each key press/release and mouse button 2 days ago
INSTALL.md pgo: full-inner: add --override tweak.grapheme-shaping=no 6 days ago
LICENSE license: fix bad copy-paste: first commit was in 2019 1 year ago
PKGBUILD pkgbuild: mention that “partial” produces a slower binary than “full” 3 weeks ago
README.md readme: reporting bugs: move “search existing issues” 6 days ago
async.c async: add async_write(), a write primitive to write to a NONBLOCK:ing FD 2 years ago
async.h async: add async_write(), a write primitive to write to a NONBLOCK:ing FD 2 years ago
base64.c debug: rename assert() to xassert(), to avoid clashing with <assert.h> 9 months ago
base64.h base64: implement encode() 2 years ago
box-drawing.c term: only scale using DPI if *all* monitors have a scaling factor or one 4 weeks ago
box-drawing.h box-drawing: make ‘term’ parameter const 10 months ago
client-protocol.h client: send overrides for everything that is publicly visible in the conf 4 months ago
client.c main/client: add no-op "-e" command-line option 1 month ago
commands.c command: scrollback: don’t allow scrolling in URL mode 8 months ago
commands.h scrollback: initial support for mouse scrolling 2 years ago
composed.c composed: insert: require key to be unique 4 months ago
composed.h composed: insert: require key to be unique 4 months ago
config.c config: error out on invalid grapheme-width-method values 17 hours ago
config.h config, render: scrollback indicator: allow configuring scrollback indicator colors 2 weeks ago
csi.c csi: various, minor code/formatting improvements 2 months ago
csi.h performance improvements 2 years ago
dcs.c dcs: only log debug warnings in bsu() and esu() for unhandled params 6 months ago
dcs.h dcs: initial handling of DCS in general 2 years ago
debug.c debug: make use of log_msg() in fatal_error() and bug() functions 8 months ago
debug.h debug: make use of log_msg() in fatal_error() and bug() functions 8 months ago
extract.c composed: store compose chains in a binary search tree 4 months ago
extract.h extract: move ‘strip_trailing_empty’ parameter from extra_finish() to extract_begin() 5 months ago
fdm.c fdm: always check for signals after epoll_pwait(), not only on EINTR 5 months ago
fdm.h fdm: add support for managing signals 8 months ago
foot-features.h features: add feature_graphemes() 4 months ago
foot-server.desktop Add keywords to desktop files 1 year ago
foot.desktop Add keywords to desktop files 1 year ago
foot.info meson: terminfo install location now defaults to $datadir/terminfo 2 months ago
foot.ini foot.ini: add commented out default value of colors.scrollback-indicator 2 weeks ago
generate-version.sh generate-version: handle git repo not having any tags 2 weeks ago
grid.c composed: store compose chains in a binary search tree 4 months ago
grid.h composed: store compose chains in a binary search tree 4 months ago
hsl.c hsl: add our own implementations of rgb-to-hsl and hsl-to-rgb 11 months ago
hsl.h hsl: add our own implementations of rgb-to-hsl and hsl-to-rgb 11 months ago
ime.c term: rename CELL_MULT_COL_SPACER -> CELL_SPACER, and change its definition 5 months ago
ime.h ime: don’t pass ‘term’ to ime_update_cursor_rect() 7 months ago
input.c input: update serial on each key press/release and mouse button 2 days ago
input.h input: implement support for mouse wheel left/right 3 months ago
keymap.h keymap: iso_left_tab: we no longer “consume” shift when matching 5 months ago
log.c log: simplify Boolean logic for setting "colorize" var in log_init() 1 month ago
log.h log: add LOG_CLASS_NONE and use as initializer for log_level 4 months ago
macros.h osc: use STRLEN() macro to make parse_rgb() more self-documenting 2 days ago
main.c main/client: add no-op "-e" command-line option 1 month ago
meson.build osc: use STRLEN() macro to make parse_rgb() more self-documenting 2 days ago
meson_options.txt meson: terminfo install location now defaults to $datadir/terminfo 2 months ago
misc.c config: add ‘[default].word-delimiters’ 1 year ago
misc.h config: add ‘[default].word-delimiters’ 1 year ago
notify.c notify: add the notify-focus-inhibit config option 2 weeks ago
notify.h notify: break out desktop notifications from osc.c 11 months ago
osc.c Merge branch 'parse-rgb-strlen' 2 days ago
osc.h ocs: renamed parameter size -> required_size in osc_ensure_size() 2 years ago
quirks.c wayland: apply CSD/SSD changes in the surface configure event 4 months ago
quirks.h quirk: remove plasma/kwin quirk 5 months ago
reaper.c reaper: monitor SIGCHLD using the FDM instead of via a signalfd 8 months ago
reaper.h reaper: monitor SIGCHLD using the FDM instead of via a signalfd 8 months ago
render.c render: tab -> spaces 2 days ago
render.h urls: initial support for detecting URLs and rendering jump-labels 9 months ago
search.c search: redraw search box after selection has been cancelled 3 months ago
search.h search: reset match state when selection is cancelled 3 months ago
selection.c selection: convert \r -> \n when reading clipboard data 2 days ago
selection.h selection: expose find_word_boundary_{left,right}() 5 months ago
server.c server: no need to clone the config to handle -N,--no-wait 2 months ago
server.h term: don't double fork new terminal windows 1 year ago
shm.c fix crashes when resizing after CSD enabled at runtime with csd.size = 0 2 weeks ago
shm.h shm: refactor: move away from a single, global, buffer list 3 months ago
sixel.c sixel: call decsixel() directly, instead of going through sixel_put() 2 months ago
sixel.h sixel: implement P2=1 - transparent pixels 7 months ago
slave.c slave: log _which_ CWD we failed to change to 2 months ago
slave.h user-notification: 'productify' the user-warning system 1 year ago
spawn.c spawn: don’t error out if we fail to chdir() 2 months ago
spawn.h notify: break out command template expansion to spawn_expand_template() 9 months ago
stride.h box-drawing: add infrastructure for rendering box drawing characters ourselves 10 months ago
terminal.c notify: add the notify-focus-inhibit config option 2 weeks ago
terminal.h osc: use BEL terminator in OSC replies to BEL-terminated OSC queries 2 days ago
tokenize.c tokenize: strdup() each individual argv 4 months ago
tokenize.h tokenize: strdup() each individual argv 4 months ago
uri.c uri: hostname_is_localhost(): don’t crash if hostname == NULL 4 months ago
uri.h uri: add uri_parse() - new function extracts components from an URI 12 months ago
url-mode.c config: add url.uri-characters 2 months ago
url-mode.h input: rewrite of how we match foot’s own key bindings 8 months ago
user-notification.c user-notification: add new function ‘user_notification_add()’ 8 months ago
user-notification.h user-notification: add new function ‘user_notification_add()’ 8 months ago
util.h vt: cache grapheme cluster width in composed struct 4 months ago
vt.c osc: use BEL terminator in OSC replies to BEL-terminated OSC queries 2 days ago
vt.h vt: limit maximum value of params in vt_param_get() 5 months ago
wayland.c term: only scale using DPI if *all* monitors have a scaling factor or one 4 weeks ago
wayland.h input: implement support for mouse wheel left/right 3 months ago
xmalloc.c xmalloc: export xvasprintf() 6 months ago
xmalloc.h xmalloc: export xvasprintf() 6 months ago
xsnprintf.c debug: rename assert() to xassert(), to avoid clashing with <assert.h> 9 months ago
xsnprintf.h Add xsnprintf() and remove some unnecessary strlen(3) calls 9 months ago

README.md

Logo: a terminal with a foot shaped prompt foot

The fast, lightweight and minimalistic Wayland terminal emulator.

CI status Pipeline status builds.sr.ht status

Packaging status

Index

  1. Features
  2. Installing
  3. Configuration
  4. Troubleshooting
  5. Why the name 'foot'?
  6. Fonts
  7. Shortcuts
    1. Keyboard
      1. Normal mode
      2. Scrollback search
    2. Mouse
  8. Server (daemon) mode
  9. URLs
  10. Alt/meta
  11. Backspace
  12. Keypad
  13. DPI and font size
  14. Supported OSCs
  15. Programmatically checking if running in foot
  16. Credits
  17. Bugs
  18. Contact
    1. IRC
    2. Mastodon
  19. License

Features

  • Fast (see benchmarks, and performance)

  • Lightweight, in dependencies, on-disk and in-memory

  • Wayland native

  • DE agnostic

  • Server/daemon mode

  • User configurable font fallback

  • On-the-fly font resize

  • On-the-fly DPI font size adjustment

  • Scrollback search

  • Keyboard driven URL detection

  • Color emoji support

  • IME (via text-input-v3)

  • Multi-seat

  • True Color (24bpp)

  • Synchronized Updates support

  • Sixel image support

    wow

Installing

See INSTALL.md.

Configuration

foot can be configured by creating a file $XDG_CONFIG_HOME/foot/foot.ini (defaulting to ~/.config/foot/foot.ini). A template for that can usually be found in /usr/share/foot/foot.ini or here.

Further information can be found in foot's man page foot.ini(5).

Troubleshooting

See the wiki

Why the name 'foot'?

I'm bad at names. Most of my projects usually start out as foo something (for example, yambar was f00bar for a while).

So why foot?

foo terminalfootermfoot

Pretty bad, I know.

As a side note, if you pronounce the foo part of foot the same way you pronounce foobar, then foot sounds a lot like the Swedish word fot, which incidentally means (you guessed it) foot.

Fonts

foot supports all fonts that can be loaded by freetype, including bitmap fonts and color emoji fonts.

Foot uses fontconfig to locate and configure the font(s) to use. Since fontconfig's fallback mechanism is imperfect, especially for monospace fonts (it doesn't prefer monospace fonts even though the requested font is one), foot allows you, the user, to configure the fallback fonts to use.

This also means you can configure each fallback font individually; you want that fallback font to use this size, and you want that other fallback font to be italic? No problem!

If a glyph cannot be found in any of the user configured fallback fonts, then fontconfig's list is used.

Shortcuts

These are the default shortcuts. See man foot.ini and the example foot.ini to see how these can be changed.

Keyboard

Normal mode

shift+page up/page down
Scroll up/down in history
ctrl+shift+c
Copy selected text to the clipboard
ctrl+shift+v
Paste from clipboard
shift+insert
Paste from the primary selection
ctrl+shift+r
Start a scrollback search
ctrl++, ctrl+=
Increase font size by 0,5pt
ctrl+-
Decrease font size by 0,5pt
ctrl+0
Reset font size
ctrl+shift+n
Spawn a new terminal. If the shell has been configured to emit the OSC 7 escape sequence, the new terminal will start in the current working directory.
ctrl+shift+u
Enter URL mode, where all currently visible URLs are tagged with a jump label with a key sequence that will open the URL.
ctrl+r
Search backward for next match
ctrl+s
Search forward for next match
ctrl+w
Extend current selection (and thus the search criteria) to the end of the word, or the next word if currently at a word separating character.
ctrl+shift+w
Same as ctrl+w, except that the only word separating characters are whitespace characters.
ctrl+v
Paste from clipboard into the search buffer.
shift+insert
Paste from primary selection into the search buffer.
escape, ctrl+g
Cancel the search
return
Finish the search and copy the current match to the primary selection

Mouse

left - single-click
Drag to select; when released, the selected text is copied to the primary selection. This feature is disabled when client has enabled mouse tracking.
Holding shift enables selection in mouse tracking enabled clients.
Holding ctrl will create a block selection.
left - double-click
Selects the word (separated by spaces, period, comma, parenthesis etc) under the pointer. Hold ctrl to select everything under the pointer up to, and until, the next space characters.
left - triple-click
Selects the entire row
middle
Paste from primary selection
right
Extend current selection. Clicking immediately extends the selection, while hold-and-drag allows you to interactively resize the selection.
wheel
Scroll up/down in history

Server (daemon) mode

When run normally, foot is a single-window application; if you want another window, start another foot process.

However, foot can also be run in a server mode. In this mode, one process hosts multiple windows. All Wayland communication, VT parsing and rendering is done in the server process.

New windows are opened by running footclient, which remains running until the terminal window is closed, at which point it exits with the exit value of the client process (typically the shell).

The point of this mode is a) reduced memory footprint - all terminal windows will share fonts and glyph cache, and b) reduced startup time - loading fonts and populating the glyph cache takes time, but in server mode it only happens once.

The downside is a performance penalty; all windows' input and output are multiplexed in the same thread (but each window will have its own set of rendering threads). This means that if one window is very busy with, for example, producing output, then other windows will suffer.

And of course, should the server process crash, all windows will be gone.

Typical usage would be to start the server process (foot --server) when starting your Wayland compositor (i.e. logging in to your desktop), and then run footclient instead of foot whenever you want to launch a new terminal.

URLs

Foot supports URL detection. But, unlike many other terminal emulators, where URLs are highlighted when they are hovered and opened by clicking on them, foot uses a keyboard driven approach.

Pressing ctrl+shift+u enters “URL mode”, where all currently visible URLs are underlined, and is associated with a “jump-label”. The jump-label indicates the key sequence (e.g. ”AF”) to use to activate the URL.

The key binding can, of course, be customized, like all other key bindings in foot. See show-urls-launch and show-urls-copy in the foot.ini man page.

show-urls-launch by default opens the URL with xdg-open. This can be changed with the url-launch option.

show-urls-copy is an alternative to show-urls-launch, that changes what activating an URL does; instead of opening it, it copies it to the clipboard. It is unbound by default.

Jump label colors, the URL underline color, and the letters used in the jump label key sequences can be configured.

Alt/meta

By default, foot prefixes Meta characters with ESC. This corresponds to XTerm's metaSendsEscape option set to true.

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 programmatically with rmm (reset meta mode, \E[?1034l), and enabled again with smm (set meta mode, \E[?1034h).

Backspace

Foot transmits DEL (^?) on backspace. This corresponds to XTerm's backarrowKey option set to false, and to DECBKM being reset.

To instead transmit BS (^H), press ctrl+backspace.

Note that foot does not implement DECBKM, and that the behavior described above cannot be changed.

Finally, pressing alt will prefix the transmitted byte with ESC.

Keypad

By default, Num Lock overrides the run-time configuration keypad mode; when active, the keypad is always considered to be in numerical mode. This corresponds to XTerm's numLock option set to true.

In this mode, the keypad keys always sends either numbers (Num Lock is active) or cursor movement keys (Up, Down, Left, Right, Page Up, Page Down etc).

This can be disabled programmatically with \E[?1035l (and enabled again with \E[?1035h).

When disabled, the keypad sends custom escape sequences instead of numbers, when in application mode.

DPI and font size

Font sizes are apparently a complex thing. Many applications use a fixed DPI of 96. They may also multiply it with the monitor's scale factor.

This results in fonts with different physical sizes (i.e. if measured by a ruler) when rendered on screens with different DPI values. Even if the configured font size is the same.

This is not how it is meant to be. Fonts are measured in point sizes for a reason; a given point size should have the same height on all mediums, be it printers or monitors, regardless of their DPI.

Foot’s default behavior is to use the monitor’s DPI to size fonts when output scaling has been disabled on all monitors. If at least one monitor has output scaling enabled, fonts will instead by sized using the scaling factor.

This can be changed to either always use the monitor’s DPI (regardless of scaling factor), or to never use it, with the dpi-aware option in foot.ini. See the man page, foot.ini(5) for more information.

When fonts are sized using the monitor’s DPI, glyphs should always have the same physical height, regardless of monitor.

Furthermore, foot will re-size the fonts on-the-fly when the window is moved between screens with different DPIs values. If the window covers multiple screens, with different DPIs, the highest DPI will be used.

Note: if you configure pixelsize, rather than size, then DPI changes will not change the font size. Pixels are always pixels.

Supported OSCs

OSC, Operating System Command, are escape sequences that interacts with the terminal emulator itself. Foot implements the following OSCs:

  • OSC 0 - change window icon + title (but only title is actually supported)
  • OSC 2 - change window title
  • OSC 4 - change color palette
  • OSC 7 - report CWD
  • OSC 8 - hyperlink
  • OSC 9 - desktop notification
  • OSC 10 - change (default) foreground color
  • OSC 11 - change (default) background color
  • OSC 12 - change cursor color
  • OSC 17 - change highlight (selection) background color
  • OSC 19 - change highlight (selection) foreground color
  • OSC 52 - copy/paste clipboard data
  • OSC 104 - reset color palette
  • OSC 110 - reset default foreground color
  • OSC 111 - reset default background color
  • OSC 112 - reset cursor color
  • OSC 117 - reset highlight background color
  • OSC 119 - reset highlight foreground color
  • OSC 555 - flash screen (foot specific)
  • OSC 777 - desktop notification (only the ;notify sub-command of OSC 777 is supported.)

Programmatically checking if running in foot

Foot does not set any environment variables that can be used to identify foot (reading TERM is not reliable since the user may have chosen to use a different terminfo).

You can instead use the escape sequences to read the Secondary and Tertiary Device Attributes (secondary/tertiary DA, for short).

The tertiary DA response is always \EP!|464f4f54\E\\, where 464f4f54 is FOOT in hex.

The secondary DA response is \E[>1;XXYYZZ;0c, where XXYYZZ is foot's major, minor and patch version numbers, in decimal, using two digits for each number. For example, foot-1.4.2 would respond with \E[>1;010402;0c.

Note: not all terminal emulators implement tertiary DA. Most implement secondary DA, but not all. All should however implement Primary DA.

Thus, a safe way to query the terminal is to request the tertiary, secondary and primary DA all at once, in that order. All terminals should ignore escape sequences they do not recognize. You will have to parse the response (which in foot will consist of all three DA responses, all at once) to determine which requests the terminal emulator actually responded to.

Starting with version 1.7.0, foot also implements XTVERSION, to which it will reply with \EP>|foot(version)\E\\. Version is e.g. “1.8.2” for a regular release, or “1.8.2-36-g7db8e06f” for a git build.

Credits

Bugs

Please report bugs to https://codeberg.org/dnkl/foot/issues

Before you open a new issue, please search existing bug reports, both open and closed ones. Chances are someone else has already reported the same issue.

The report should contain the following:

  • Foot version (foot --version).
  • Log output from foot (start foot from another terminal).
  • Which Wayland compositor (and version) you are running.
  • If reporting a crash, please try to provide a bt full backtrace with symbols.
  • Steps to reproduce. The more details the better.

Contact

IRC

Ask questions, hang out, sing praise or just say hi in the #foot channel on irc.libera.chat. Logs are available at https://libera.irclog.whitequark.org/foot.

Mastodon

Every now and then I post foot related updates on @dnkl@linuxrocks.online

License

Foot is released under the MIT license.