A fast and lightweight 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 751e079196
Merge branch 'releases/1.1'
2 days ago
completions completions: zsh: add empty completions for options with required argument 1 week ago
doc doc: slight change of wording for mouse-drag-to-select 1 week ago
scripts script: generate-alt-random: reduce output size 4 weeks ago
.gitignore fcft/tllist: remove git submodules 6 days ago
.gitlab-ci.yml ci: checkout/clone (doh!) 3 days ago
.gitmodules fcft/tllist: remove git submodules 6 days ago
LICENSE add license 7 months ago
PKGBUILD meson/PKGBUILD: bump version to 1.1.0 2 days ago
README.md README: installation: s/debug/release/ 6 days ago
async.c async: add async_write(), a write primitive to write to a NONBLOCK:ing FD 2 months ago
async.h async: add async_write(), a write primitive to write to a NONBLOCK:ing FD 2 months ago
base64.c base64: implement encode() 6 months ago
base64.h base64: implement encode() 6 months ago
client.c client/server: client sends its CWD to server 3 weeks ago
commands.c commands: scrollback: don't scrollback if mouse tracking is enabled 1 month ago
commands.h scrollback: initial support for mouse scrolling 6 months ago
config.c config: enable user to specify path to configuration file 1 month ago
config.h wayland: optionally use the presentation time protocol to measure input lag 2 weeks ago
csi.c csi: change DA3 reply to "FOOT", in hex 3 weeks ago
csi.h performance improvements 6 months ago
dcs.c term: shorten application_synchronized_updates -> app_sync_updates 6 days ago
dcs.h dcs: initial handling of DCS in general 6 days ago
fdm.c fdm: fix log message 1 week ago
fdm.h fdm: add hook priorities 1 week ago
foot.desktop desktop: clean up, remove unsupported entries 3 months ago
foot.info terminfo: set RGB flag in foot-direct 3 weeks ago
footrc config: change default bright5 and bright 6 colors 3 months ago
generate-version.sh generate-version: redirect *both* stdout and stderr to /dev/null 1 month ago
grid.c grid: remove commented out code 4 months ago
grid.h search: wip: initial search matching 4 months ago
input.c input: reset XKB compose state on keyboard leave 3 days ago
input.h input: input_repeat() takes a 'struct wayland' pointer 2 months ago
keymap.h keymap: remove keymap table 6 days ago
log.c log: caller can control syslog level 1 month ago
log.h log: caller can control syslog level 1 month ago
main.c render: trigger terminal refreshes in an FDM hook 1 week ago
meson.build meson/PKGBUILD: bump version to 1.1.0 2 days ago
misc.c selection: break out isword() to a new file 1 month ago
misc.h selection: break out isword() to a new file 1 month ago
osc.c osc: implement OSC 7 - set PWD 3 weeks ago
osc.h ocs: renamed parameter size -> required_size in osc_ensure_size() 6 months ago
render.c render: resize: TIOCSWINSZ: don't include padding in ws_{x,y}pixel 5 days ago
render.h render: throttle xcursor updates 1 week ago
search.c search: rename render.search_offset -> render.search_glyph_offset 1 week ago
search.h search: wip: re-direct input while searching, and build a search buffer 4 months ago
selection.c Revert "selection: use edge-triggered FDM handlers" 1 week ago
selection.h selection: track selection type; normal or block selection 2 weeks ago
server.c Revert "server: use edge-triggered FDM handler for the client connections" 1 week ago
server.h server: implement a --server mode 2 months ago
shm.c fcft: include <fcft/fcft.h>, and use fcft/stride.h instead of local copy 1 month ago
shm.h shm: automatic buffer purging is now delayed one cycle 2 months ago
slave.c term: term_init: add 'cwd' argument 3 weeks ago
slave.h term: term_init: add 'cwd' argument 3 weeks ago
terminal.c term: shorten application_synchronized_updates -> app_sync_updates 6 days ago
terminal.h term: shorten application_synchronized_updates -> app_sync_updates 6 days ago
tokenize.c slave: break out command line tokenizer 6 months ago
tokenize.h slave: break out command line tokenizer 6 months ago
vt.c dcs: initial handling of DCS in general 6 days ago
vt.h Rename: vt_to_slave() -> term_to_slave() 2 months ago
wayland.c term/wayland: use MONOTONIC timers 1 week ago
wayland.h render: throttle xcursor updates 1 week ago

README.md

foot

foot is a fast Wayland terminal emulator.

Index

  1. Features
  2. Non-features
  3. What does not work?
  4. Fonts
  5. Shortcuts
    1. Keyboard
      1. Normal mode
      2. Scrollback search
    2. Mouse
  6. Server (daemon) mode
  7. Requirements
    1. Running
    2. Building
  8. 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
  • “Server” mode (one master process, many windows)

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
  • Graphical elements (menu, buttons etc)

What does not work?

This is a list of known, but probably not all, issues:

  • Unicode combining characters

    Examples: á (LATIN SMALL LETTER A + COMBINING ACUTE ACCENT)

  • Reflow text on window resize

  • GNOME; might work, but without window decorations.

    Strictly speaking, foot is at fault here; all Wayland applications must be able to draw their own window decorations (but foot is not).

    However, most people want a uniform look and feel on their desktop, including the window decorations. For this reason, a Wayland application can request Server Side Decorations (SSD). GNOME will reply with a “I hear you, but sorry, I wont do that”.

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

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
ctrl+shift+r
Start a scrollback search
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.
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
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. Note that this is nothing like tabs. When first started in server mode, no windows are available.

You open new windows by running footclient. This is a small process that instructs the foot server to open a new terminal window. The client process remains running until the terminal window is closed. The exit value of the client process is that of the shell that was running in the terminal window.

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.

Requirements

Running

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

Building

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

  • meson
  • ninja
  • wayland protocols
  • ncurses
  • scdoc

Installing

foot makes use of a couple of libraries I have developed: tllist and fcft. As such, they will most likely not have been installed already. You can either install them as system libraries, or you can build them as subprojects in foot.

When building foot, they will first be searched for as system libraries. If found, foot will link dynamically against them.

If not found, they will be searched for as subprojects. In this case you need to create the subprojects directory and clone https://codeberg.org/dnkl/fcft.git and https://codeberg.org/dnkl/tllist.git (see Other below).

Arch Linux

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

It requires tllist and fcft to be installed as system libraries. If you do not want this, please edit the PKGBUILD file, or install manually (see Other below).

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 the bundled Arch PKGBUILD file, to see how it builds foot. Especially so if you intend to install a release build of foot, in which case you might be interested in the compiler flags used there.

If you have not installed tllist and fcft as system libraries, clone them into the subprojects directory:

mkdir -p subprojects
pushd subprojects
git clone https://codeberg.org/dnkl/tllist.git
git clone https://codeberg.org/dnkl/fcft.git
popd

To build, first, create a build directory, and switch to it:

mkdir -p bld/release && cd bld/release

Second, configure2 the build (if you intend to install it globally, you might also want --prefix=/usr):

meson --buildtype=release ../..

Three, build it:

ninja

You can now run it directly from the build directory:

./foot

But note that it will default to TERM=foot, and that this terminfo has not been installed yet. However, most things should work with the xterm-256color terminfo:

./foot --term xterm-256color

But, I recommend you install the foot and foot-direct terminfo files. You can either copy them manually (typically to /usr/share/terminfo/f - but this is dependens on the distro), or just install everything:

ninja install

  1. can also be built as subprojects, in which case they are statically linked.

  2. for advanced users: a profile guided build will have significantly better performance; take a look at PKDBUILD to see how this can be done.