A fast, lightweight and minimalistic Wayland terminal emulator
Find a file
2019-09-20 18:12:58 +02:00
doc man: document keyboard + mouse shortcuts 2019-08-30 20:26:29 +02:00
scripts generate-alt-random-writes: generate streaks of characters 2019-08-30 21:37:51 +02:00
.gitignore initial commit: maps an XDG toplevel window 2019-06-12 20:08:54 +02:00
.gitlab-ci.yml ci: need ncurses (for 'tic' - to generate terminfo) 2019-08-17 12:47:18 +02:00
base64.c base64: implement encode() 2019-07-19 14:19:42 +02:00
base64.h base64: implement encode() 2019-07-19 14:19:42 +02:00
commands.c scrolling: optimize row access by assuming number of rows is a power of 2 2019-08-22 17:33:23 +02:00
commands.h scrollback: initial support for mouse scrolling 2019-07-10 09:15:37 +02:00
config.c config: turn info log message into a debug log message 2019-08-23 20:21:27 +02:00
config.h add config + command line option for setting initial window width/height 2019-08-23 17:26:41 +02:00
csi.c csi: don't ignore the color space identifier in SGRs 2019-09-04 20:28:35 +02:00
csi.h performance improvements 2019-07-07 16:32:18 +02:00
font.c font: tentative support for BGR, V-RGB and V-BGR 2019-08-19 17:45:21 +02:00
font.h font: tentative support for BGR, V-RGB and V-BGR 2019-08-19 17:45:21 +02:00
foot.desktop Add .desktop file 2019-07-15 15:29:17 +02:00
foot.info osc: implement "change color" commands 2019-08-21 17:57:02 +02:00
footrc footrc: add missing newline at end-of-file 2019-09-20 18:12:58 +02:00
grid.c grid: remove commented out code 2019-08-23 20:07:27 +02:00
grid.h search: wip: initial search matching 2019-08-27 19:33:19 +02:00
input.c input: take scale into account when converting mouse coords to row/col 2019-08-30 21:31:14 +02:00
input.h input: mouse events 2019-07-05 10:44:57 +02:00
keymap.h keymap: add meta modifier mappings for keypad keys 2019-08-15 20:07:33 +02:00
LICENSE add license 2019-06-12 20:10:12 +02:00
log.c log: syslog: tag unused function arguments as unused 2019-07-30 21:50:08 +02:00
log.h initial commit: maps an XDG toplevel window 2019-06-12 20:08:54 +02:00
main.c main: use a timer FD to delay render refresh after client data 2019-08-30 17:57:46 +02:00
meson.build meson: install footrc example file to $datadir/foot/footrc 2019-09-20 18:12:58 +02:00
osc.c osc: xparsecolor: parse 'legacy' colors 2019-08-28 17:29:03 +02:00
osc.h ocs: renamed parameter size -> required_size in osc_ensure_size() 2019-07-19 09:56:00 +02:00
PKGBUILD generate-alt-random-writes: generate color, scroll and scroll region sequences 2019-08-22 17:31:13 +02:00
README.md README: combine description for escape and ctrl+g 2019-09-10 18:40:53 +02:00
render.c render: search box: use colors from the color table 2019-08-30 21:01:13 +02:00
render.h search: move render() function to the 'render' module 2019-08-29 20:18:06 +02:00
search.c search: map ctrl+b/f to move cursor single character backward/forward 2019-08-30 20:55:45 +02:00
search.h search: wip: re-direct input while searching, and build a search buffer 2019-08-27 17:23:28 +02:00
selection.c selection: allow selections while searching scrollback 2019-08-27 20:57:58 +02:00
selection.h osc: implement copy/paste to/from primary 2019-08-09 21:27:51 +02:00
shm.c refactor: break out stride calculation to new function 2019-08-18 17:59:43 +02:00
shm.h shm/render: there's no need to have one pixman image per thread 2019-08-16 22:54:05 +02:00
slave.c main: allow user to override shell on the command line 2019-07-17 09:55:36 +02:00
slave.h main: allow user to override shell on the command line 2019-07-17 09:55:36 +02:00
stride.h refactor: break out stride calculation to new function 2019-08-18 17:59:43 +02:00
terminal.c term: add term_reset_view() - make view follow end-of-output again 2019-08-28 17:27:42 +02:00
terminal.h search: make search-direction configurable 2019-08-30 20:15:12 +02:00
tllist.h initial commit: maps an XDG toplevel window 2019-06-12 20:08:54 +02:00
tokenize.c slave: break out command line tokenizer 2019-07-17 09:46:45 +02:00
tokenize.h slave: break out command line tokenizer 2019-07-17 09:46:45 +02:00
vt.c vt: implement 'insert mode' 2019-08-30 22:08:37 +02:00
vt.h vt: add vt_to_slave() 2019-07-15 15:42:00 +02:00

foot

foot is a fast Wayland terminal emulator.

Index

  1. Features
  2. Non-features
  3. Fonts
  4. Shortcuts
    1. Keyboard
    2. Mouse
  5. Requirements
    1. Running
    2. Building
  6. Installing
    1. Arch Linux
    2. Other

Features

  • Fast (TODO insert benchmark results here)
  • Wayland native
  • DE agnostic
  • User configurable font fallback
  • Scrollback search
  • Color emoji support

Non-features

This is a non-exhaustive list of things some people might consider being important features (i.e. "must-haves"), that are unlikely to ever be supported by foot.

  • Tabs
  • Multiple windows

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

At the moment, all shortcuts are hard coded and cannot be changed. It is not possible to define new key bindings.

Keyboard

  • 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

  • ctrl+shift+r

    Start a scrollback search

While doing a scrollback search, the following shortcuts are available:

  • ctrl+r

    Search backward for next match

  • ctrl+s

    Search forward for next match

  • 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. Note that this feature is normally disabled whenever the client has enabled mouse tracking, but can be forced by holding shift.

  • 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

Requirements

Running

  • fontconfig
  • freetype
  • pixman
  • wayland (client and cursor libraries)
  • xkbcommon

Building

In addition to the dev variant of the packages above, you need:

  • meson
  • ninja
  • wayland protocols
  • ncurses
  • scdoc

Installing

Arch Linux

Use makepkg to build the bundled PKGBUILD (just run makepkg in the source root directory)..

Note that it will do a profiling-guided build, and that this requires a running wayland session since it needs to run an intermediate build of foot.

Other

Foot uses meson. If you are unfamiliar with it, the official tutorial might be a good starting point.

I also recommend taking a look at that bundled Arch PKGBUILD file, to see how it builds foot.