mirrors/foot
1
0
Fork 0
mirror of https://codeberg.org/dnkl/foot.git synced 2026-02-05 04:06:08 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
A fast, lightweight and minimalistic Wayland terminal emulator
778 commits 40 branches 67 tags 24 MiB
Find a file
Daniel Eklöf a1efd65746
server: implement a --server mode 
In this mode, foot listens on a UNIX socket and creates terminal
windows when clients connect.

A connecting client sends argc/argv to the server, and the server
instantiates a new terminal window.

When the terminal window is closed, the exit code is sent back to the
client.
2019-11-01 20:39:09 +01:00
completions completions: add zsh completions 2019-10-20 11:54:58 +02:00
doc meson: fix version generation from git 2019-10-19 22:09:52 +02:00
scripts generate-alt-random-writes: reduce output size 2019-09-20 22:39:09 +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 scrollback: regression: fix rendering of scrollback diffs less than a screen 2019-10-29 21:09:37 +01:00
commands.h scrollback: initial support for mouse scrolling 2019-07-10 09:15:37 +02:00
config.c config: change default bright5 and bright 6 colors 2019-09-21 12:09:50 +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: ignore invalid scrolling regions 2019-09-29 14:58:02 +02:00
csi.h performance improvements 2019-07-07 16:32:18 +02:00
fdm.c fdm: don't free FD data that may be referenced by epoll return data 2019-11-01 19:51:33 +01:00
fdm.h fdm: don't free FD data that may be referenced by epoll return data 2019-11-01 19:51:33 +01:00
font.c font: glyph_for_wchar(): ensure glyph->valid == false, in *all* error cases 2019-10-18 19:50:48 +02:00
font.h font: load fallback fonts on demand 2019-10-17 17:53:03 +02:00
foot.desktop desktop: clean up, remove unsupported entries 2019-09-29 20:50:27 +02:00
foot.info osc: implement "change color" commands 2019-08-21 17:57:02 +02:00
footrc config: change default bright5 and bright 6 colors 2019-09-21 12:09:50 +02:00
generate-version.sh meson: fix version generation from git 2019-10-19 22:09:52 +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 wayland: move reload_cursor_theme() and update_cursor_surface() to wayland 2019-10-27 19:36:45 +01:00
input.h input: input_repeat() takes a 'struct wayland' pointer 2019-10-27 18:44:58 +01: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 server: implement a --server mode 2019-11-01 20:39:09 +01:00
meson.build server: implement a --server mode 2019-11-01 20:39:09 +01:00
osc.c term: wayland struct is now not a part of the terminal struct 2019-10-27 18:51:14 +01:00
osc.h ocs: renamed parameter size -> required_size in osc_ensure_size() 2019-07-19 09:56:00 +02:00
PKGBUILD PKGBUILD: fix breakage after pacman 5.2 upgrade 2019-10-24 21:21:44 +02:00
README.md README: link to PKGBUILD 2019-10-05 16:41:20 +02:00
render.c render: limit length of title in call to xdg_toplevel_set_title() 2019-11-01 20:25:44 +01:00
render.h wayland: move reload_cursor_theme() and update_cursor_surface() to wayland 2019-10-27 19:36:45 +01:00
search.c wayland: implement wayl_init() 2019-10-27 19:08:48 +01: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 term: wayland struct is now not a part of the terminal struct 2019-10-27 18:51:14 +01:00
selection.h osc: implement copy/paste to/from primary 2019-08-09 21:27:51 +02:00
server.c server: implement a --server mode 2019-11-01 20:39:09 +01:00
server.h server: implement a --server mode 2019-11-01 20:39:09 +01: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 slave: log child's errno, not parents 2019-10-30 20:21:19 +01:00
slave.h term: move client startup to a new function, slave_spawn() 2019-10-30 18:05:03 +01:00
stride.h refactor: break out stride calculation to new function 2019-08-18 17:59:43 +02:00
terminal.c terminal: call user-defined callback when destroying terminal 2019-11-01 20:34:32 +01:00
terminal.h terminal: call user-defined callback when destroying terminal 2019-11-01 20:34:32 +01: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: don't log ignored execute commands 2019-09-28 13:59:11 +02:00
vt.h vt: add vt_to_slave() 2019-07-15 15:42:00 +02:00
wayland.c wayland: wayl_destroy(): destroy any remaining terminals 2019-11-01 20:25:08 +01:00
wayland.h terminal: call user-defined callback when destroying terminal 2019-11-01 20:34:32 +01:00

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
    2. Mouse
  6. Requirements
    1. Running
    2. Building
  7. 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

What does not work?

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

  • Unicode combining characters

    Examples: á, 👪🏼 (may not be displayed correctly in your browser/editor)

  • Reflow text on window resize

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 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 the bundled Arch PKGBUILD file, to see how it builds foot.