mirror of
https://codeberg.org/dnkl/foot.git
synced 2026-02-06 04:06:06 -05:00
5717a0dfb0
If the display resolution *is* 800x600, using this size is bad since there will typically be panels and other things on the screen too. Not that 800x600 is something we expect to see in real life, but may happen on virtual displays.
220 lines
5.8 KiB
Markdown
220 lines
5.8 KiB
Markdown
foot(1)
|
|
|
|
# NAME
|
|
foot - Wayland terminal emulator
|
|
|
|
# SYNOPSIS
|
|
*foot* [_OPTIONS_]++
|
|
*foot* [_OPTIONS_] -- <_command_>
|
|
|
|
All trailing (non-option) arguments are treated as a command to
|
|
execute (instead of the shell).
|
|
|
|
# OPTIONS
|
|
|
|
*-c*,*--config*=_PATH_
|
|
Path to configuration file. Default: *XDG_RUNTIME_DIR/footrc*.
|
|
|
|
*-f*,*--font*=_FONT_
|
|
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.
|
|
|
|
Default: _monospace_.
|
|
|
|
*-g*,*--geometry*=_WIDTHxHEIGHT_
|
|
Set initial window width and height. Default: *700x500*.
|
|
|
|
*-t*,*--term*=_TERM_
|
|
Value to set the environment variable *TERM* to. Default: *foot*.
|
|
|
|
*--login-shell*
|
|
Start a login shell, by prepending a '-' to argv[0].
|
|
|
|
*-s*,*--server*[=_PATH_]
|
|
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.
|
|
|
|
You may optionally override the default socket path,
|
|
*XDG\_RUNTIME\_DIR/foot.sock*. If you do so, you will need to use
|
|
the *--server-socket* option in *footclient*(1).
|
|
|
|
*--hold*
|
|
Remain open after child process exits.
|
|
|
|
*-p*,*--print-pid*=_FILE_|_FD_
|
|
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 when yambar exits.
|
|
|
|
This option can only be used in combination with *-s*,*--server*.
|
|
|
|
*-l*,*--log-colorize*=[{*never*,*always*,*auto*}]
|
|
Enables or disables colorization of log output on stderr.
|
|
|
|
*-S*,*--log-no-syslog*
|
|
Disables syslog logging. Logging is only done on stderr. This
|
|
option can only be used in combination with *-s*,*--server*.
|
|
|
|
*-v*,*--version*
|
|
Show the version number and quit.
|
|
|
|
# DESCRIPTION
|
|
|
|
*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. To ensure foot does not touch the shell
|
|
arguments, use *--*:
|
|
|
|
foot -- sh -c "echo hello world && sleep 5"
|
|
|
|
# KEYBOARD SHORTCUTS
|
|
|
|
The following keyboard shortcuts are available. Note that they cannot
|
|
be changed.
|
|
|
|
## 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*+*+*, *ctrl*+*=*
|
|
Increase font size by 1pt
|
|
|
|
*ctrl*+*-*
|
|
Decrease font size by 1pt
|
|
|
|
*ctrl*+*0*
|
|
Reset font size
|
|
|
|
## SCROLLBACK SEARCH
|
|
|
|
*ctrl*+*r*
|
|
Search _backward_ for the next match
|
|
|
|
*ctrl*+*s*
|
|
Search _forward_ for the 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. The terminal selection is kept, allowing you to press
|
|
*ctrl*+*shift*+*c* to copy it to the clipboard.
|
|
|
|
# MOUSE SHORTCUTS
|
|
|
|
*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
|
|
|
|
*middle*
|
|
Paste from the _primary_ selection
|
|
|
|
*wheel*
|
|
Scroll up/down in history
|
|
|
|
# FONT FORMAT
|
|
|
|
The font is specified in FontConfig syntax. That is, a colon-separated
|
|
list of font name and font options.
|
|
|
|
_Examples_:
|
|
- Dina:weight=bold:slant=italic
|
|
- Courier New:size=12
|
|
|
|
# ALT/META CHARACTERS
|
|
|
|
By default, foot prefixes meta characters with *ESC*. This corresponds
|
|
to XTerm's *metaSendsEscape* option set to *true*.
|
|
|
|
This can be disabled programatically 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 programatically 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.
|
|
|
|
# CONFIGURATION
|
|
|
|
See *foot*(5)
|
|
|
|
# SEE ALSO
|
|
|
|
*foot*(5), *footclient*(1)
|