foot [Options] <command> [COMMAND Options]
All trailing (non-option) arguments are treated as a command, and its arguments, to execute (instead of the default shell).
foot is a Wayland terminal emulator. Running it without arguments will start a new terminal window with your default shell.
You can override the default shell by appending a custom command to the foot command line
foot sh -c "echo hello world && sleep 5"
Path to configuration file. Default: $XDG_CONFIG_HOME/foot/foot.ini.
Verify configuration and then exit with 0 if ok, otherwise exit with 1.
Comma separated list of fonts to use, in fontconfig format (see Font Format).
The first font is the primary font. The remaining fonts are fallback fonts that will be used whenever a glyph cannot be found in the primary font.
The fallback fonts are searched in the order they appear. If a glyph cannot be found in any of the fallback fonts, the dynamic fallback list from fontconfig (for the primary font) is searched.
Set initial window width and height, in pixels. Default: 700x500.
Set initial window width and height, in characters. Default: not set.
Value to set the environment variable TERM to. Default: foot.
Initial window title. Default: foot.
Value to set the app-id property on the Wayland window to. Default: foot.
Start in maximized mode. If both --maximized and --fullscreen are specified, the last one takes precedence.
Start in fullscreen mode. If both --maximized and --fullscreen are specified, the last one takes precedence.
Start a login shell, by prepending a '-' to argv.
Initial working directory for the client application. Default: CWD of foot.
Run as a server. In this mode, a single foot instance hosts multiple terminals (windows). Use footclient(1) to launch new terminals.
This saves some memory since for example fonts and glyph caches can be shared between the terminals.
It also saves upstart time since the config has already been loaded and parsed, and most importantly, fonts have already been loaded (and their glyph caches are likely to already have been populated).
Each terminal will have its own rendering threads, but all Wayland communication, as well as input/output to the shell, is multiplexed in the main thread. Thus, this mode might result in slightly worse performance when multiple terminals are under heavy load.
Also be aware that should one terminal crash, it will take all the others with it.
The default path is $XDG_RUNTIME_DIR/foot-$WAYLAND_DISPLAY.sock.
If $XDG_RUNTIME_DIR is not set, the default path is instead /tmp/foot.sock.
If $XDG_RUNTIME_DIR is set, but $WAYLAND_DISPLAY is not, the default path is $XDG_RUNTIME_DIR/foot.sock.
Note that if you change the default, you will also need to use the --server-socket option in footclient(1) and point it to your custom socket path.
Remain open after child process exits.
Print PID to this file, or FD, when successfully started. The file (or FD) is closed immediately after writing the PID. When a FILE as been specified, the file is unlinked at exit.
This option can only be used in combination with -s,--server.
Log level, used both for log output on stderr as well as syslog. Default: info.
Enables or disables colorization of log output on stderr. Default: auto.
Disables syslog logging. Logging is only done on stderr. This option can only be used in combination with -s,--server.
Show the version number and quit.
The following keyboard shortcuts are available.
Note that these are just the defaults; they can be changed in foot.ini(5).
- shift+page up/page down
Scroll up/down in history
Copy selected text to the clipboard
Paste from clipboard
Paste from the primary selection.
Start a scrollback search
- ctrl++, ctrl+=
Increase font size by 1pt
Decrease font size by 1pt
Reset font size
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.
Search backward for the next match
Search forward for the next match
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.
Same as ctrl+w, except that the only word separating characters are whitespace characters.
- ctrl+v, ctrl+y
Paste from clipboard into the searh buffer.
Paste from primary selection into the search buffer.
- escape, ctrl+g
Cancel the search
Finish the search and copy the current match to the primary selection. The terminal selection is kept, allowing you to press ctrl+shift+c to copy it to the clipboard.
- left, single-click
Drag to select; when released, the selected text is copied to the primary selection. This feature is normally disabled whenever the client has enabled mouse tracking, but can be forced by holding shift.
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
Paste from the primary selection
Extend current selection. Clicking immediately extends the selection, while hold-and-drag allows you to interactively resize the selection.
Scroll up/down in history
The font is specified in FontConfig syntax. That is, a colon-separated list of font name and font options.
- Courier New:size=12
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 foot.ini(5).
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.
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).
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.
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.
Please report bugs to https://codeberg.org/dnkl/foot/issues
The report should contain the following:
- Which Wayland compositor (and version) you are running
- Foot version (foot --version)
- Log output from foot (start foot from another terminal)
- If reporting a crash, please try to provide a bt full backtrace with symbols
- Steps to reproduce. The more details the better
#foot-terminal on chat.freenode.net