mirrors/foot
1
0
Fork 0
mirror of https://codeberg.org/dnkl/foot.git synced 2026-04-28 06:46:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'master' of https://codeberg.org/dnkl/foot

Browse source
This commit is contained in:
lbia.xyz 2023-04-13 17:09:46 +02:00
commit 8445da4853
No known key found for this signature in database
GPG key ID: 6774C7B38E986DF1
103 changed files with 1655 additions and 579 deletions
Download patch file Download diff file Expand all files Collapse all files

22
doc/foot-ctlseqs.7.scd
View file

@ -22,7 +22,7 @@ This document describes all the control sequences supported by foot.
[[ *Sequence*
:[ *Name*
:[ *Description*
:< *Description*
| \\a
: BEL
: Depends on what *bell* in *foot.ini*(5) is set to.
@ -60,7 +60,7 @@ equivalent to 8-bit C1 controls.
[[ *Sequence*
:[ *Name*
:[ *Origin*
:[ *Description*
:< *Description*
| \\E 7
: DECSC
: VT100
@ -140,7 +140,7 @@ single CSI sequence by separating them with semicolons: *\\E[ 1;2;3
m*.
[[ *Parameter*
:[ *Description*
:< *Description*
| 0
: Reset all attributes
| 1
@ -223,7 +223,7 @@ following 4 escape sequences:
[[ *Sequence*
:[ *Name*
:[ *Description*
:< *Description*
| \\E[ ? _Pm_ h
: DECSET
: Enable private mode
@ -243,7 +243,7 @@ that corresponds to one of the following modes:
[[ *Parameter*
:[ *Origin*
:[ *Description*
:< *Description*
| 1
: VT100
: Cursor keys mode (DECCKM)
@ -344,7 +344,7 @@ manipulation sequences. The generic format is:
[[ *Parameter 1*
:[ *Parameter 2*
:[ *Description*
:< *Description*
| 11
: -
: Report if window is iconified. Foot always reports *1* - not iconified.
@ -394,7 +394,7 @@ manipulation sequences. The generic format is:
[[ *Parameter*
:[ *Name*
:[ *Origin*
:[ *Description*
:< *Description*
| \\E[ _Ps_ c
: DA
: VT100
@ -504,7 +504,7 @@ manipulation sequences. The generic format is:
| \\E[ = _Ps_ c
: DA3
: VT510
: send tertiary device attributes. Foot responds with "FOOT", in
: Send tertiary device attributes. Foot responds with "FOOT", in
hexadecimal.
| \\E[ _Pm_ d
: VPA
@ -595,7 +595,7 @@ All _OSC_ sequences begin with *\\E]*, sometimes abbreviated _OSC_.
[[ *Sequence*
:[ *Origin*
:[ *Description*
:< *Description*
| \\E] 0 ; _Pt_ \\E\\
: xterm
: Set window icon and title to _Pt_ (foot does not support setting the
@ -693,7 +693,7 @@ All _DCS_ sequences begin with *\\EP* (sometimes abbreviated _DCS_),
and are terminated by *\\E\\* (ST).
[[ *Sequence*
:[ *Description*
:< *Description*
| \\EP q <sixel data> \\E\\
: Emit a sixel image at the current cursor position
| \\P $ q <query> \\E\\
@ -703,7 +703,7 @@ and are terminated by *\\E\\* (ST).
: Begin (_C_=*1*) or end (_C_=*2*) application synchronized updates.
This sequence is supported for compatibility reasons, but it's
recommended to use private mode 2026 (see above) instead.
| \\EP + q <hex encoded capability name> \\E\\
| \\EP + q <hex encoded capability name> \\E\\
: Query builtin terminfo database (XTGETTCAP)

18
doc/foot.1.scd
View file

@ -142,7 +142,7 @@ the foot command line
*-d*,*--log-level*={*info*,*warning*,*error*,*none*}
Log level, used both for log output on stderr as well as
syslog. Default: _info_.
syslog. Default: _warning_.
*-l*,*--log-colorize*=[{*never*,*always*,*auto*}]
Enables or disables colorization of log output on stderr. Default:
@ -543,10 +543,24 @@ In all other cases, the exit code is that of the client application
set according to either the *--term* command-line option or the
*term* config option in *foot.ini*(5).
*PWD*
Current working directory (at the time of launching foot)
*COLORTERM*
This variable is set to *truecolor*, to indicate to client
applications that 24-bit RGB colors are supported.
*TERM_PROGRAM*
Always set to *foot*. This can be used by client applications to
check which terminal is in use, but with the caveat that it may
have been inherited from a parent process in other terminals that
aren't known to set the variable.
*TERM_PROGRAM_VERSION*
Set to the foot version string, in the format _major_*.*_minor_*.*_patch_
or _major_*.*_minor_*.*_patch_*-*_revision_*-\g*_commit_ for inter-release
builds. The same caveat as for *TERM_PROGRAM* applies.
In addition to the variables listed above, custom environment
variables may be defined in *foot.ini*(5).
@ -561,7 +575,7 @@ the same issue.
The report should contain the following:
- Foot version (*foot --version*).
- Log output from foot (start foot from another terminal).
- Log output from foot (run *foot -d info* from another terminal).
- Which Wayland compositor (and version) you are running.
- If reporting a crash, please try to provide a *bt full* backtrace
with symbols.

61
doc/foot.ini.5.scd
View file

@ -22,6 +22,15 @@ in this order:
An example configuration file containing all options with their default value
commented out will usually be installed to */etc/xdg/foot/foot.ini*.
Options are set using KEY=VALUE pairs:
*\[colors\]*++
*background=000000*++
*foreground=ffffff*
Empty values (*KEY=*) are not supported. String options do allow the
empty string to be set, but it must be quoted: *KEY=""*)
# SECTION: main
*shell*
@ -71,6 +80,19 @@ commented out will usually be installed to */etc/xdg/foot/foot.ini*.
Default: _monospace:size=8_ (*font*), _not set_ (*font-bold*,
*font-italic*, *font-bold-italic*).
*font-size-adjustment*
Amount, in _points_, _pixels_ or _percent_, to increment/decrement
the font size when zooming in our out.
Examples:
```
font-size-adjustment=0.5 # Adjust by 0.5 points
font-size-adjustment=10xp # Adjust by 10 pixels
font-size-adjustment=7.5% # Adjust by 7.5 percent
```
Default: _0.5_
*include*
Absolute path to configuration file to import.
@ -213,15 +235,19 @@ commented out will usually be installed to */etc/xdg/foot/foot.ini*.
Default: _0x0_.
*resize-delay-ms*
Time, in milliseconds, of "idle time" before foot sends the new
window dimensions to the client application while doing an
interactive resize of a foot window. Idle time in this context is
a period of time where the window size is not changing.
Time, in milliseconds, of "idle time" before foot performs text
reflow, and sends the new window dimensions to the client
application while doing an interactive resize of a foot
window. Idle time in this context is a period of time where the
window size is not changing.
In other words, while you are fiddling with the window size, foot
does not send the updated dimensions to the client. Only when you
pause the fiddling for *resize-delay-ms* milliseconds is the
client updated.
does not send the updated dimensions to the client. It also does a
fast "truncating" resize of the grid, instead of actually
reflowing the contents. Only when you pause the fiddling for
*resize-delay-ms* milliseconds is the client updated, and the
contents properly reflowed.
Emphasis is on _while_ here; as soon as the interactive resize
ends (i.e. when you let go of the window border), the final
@ -339,7 +365,7 @@ Note: do not set *TERM* here; use the *term* option in the main
*urgent*
When set to _yes_, foot will signal urgency to the compositor
through the XDG activation protocol whenever *BEL* is received,
and the window does NOT have keyboard foccus.
and the window does NOT have keyboard focus.
If the compositor does not implement this protocol, the margins
will be painted in red instead.
@ -448,14 +474,13 @@ applications can change these at runtime.
by applications. Default: _no_.
*color*
Two RRGGBB values (i.e. plain old 6-digit hex values, without
prefix) specifying the foreground (text) and background (cursor)
colors for the cursor.
Two space separated RRGGBB values (i.e. plain old 6-digit hex
values, without prefix) specifying the foreground (text) and
background (cursor) colors for the cursor.
Default: _inverse foreground/background colors_.
Note that this value only applies to the block cursor. The other
cursor styles are always rendered with the foreground color.
Example: *ff0000 00ff00* (green cursor, red text)
Default: the regular foreground and background colors, reversed.
*beam-thickness*
Thickness (width) of the beam styled cursor. The value is in
@ -551,7 +576,7 @@ can configure the background transparency with the _alpha_ option.
options are unconfigured). 24-bit RGB colors will typically fall
into this category.
Note that applications can change the *regularN* and *brighN*
Note that applications can change the *regularN* and *brightN*
colors at runtime. However, they have no way of changing the
*dimN* colors. If an application has changed the *regularN*
colors, foot will still use the corresponding *dimN* color, as
@ -939,7 +964,7 @@ Be careful; do not use single-letter keys that are also used in
original text.
But with e.g. OSC-8 URLs (the terminal version of HTML anchors,
i.e. "links"), the text on the screen can be something completey
i.e. "links"), the text on the screen can be something completely
different than the URL.
This action toggles between showing and hiding the URL on the jump
@ -1235,7 +1260,7 @@ any of these options.
*max* uses the width of the largest codepoint in the cluster.
Default: _wcswidth_
Default: _double-width_
*font-monospace-warn*
Boolean. When enabled, foot will use heuristics to try to verify

15
doc/footclient.1.scd
View file

@ -75,7 +75,7 @@ terminal has terminated.
*-d*,*--log-level*={*info*,*warning*,*error*,*none*}
Log level, used both for log output on stderr as well as
syslog. Default: _info_.
syslog. Default: _warning_.
*-l*,*--log-colorize*=[{*never*,*always*,*auto*}]
Enables or disables colorization of log output on stderr.
@ -89,7 +89,7 @@ terminal has terminated.
# EXIT STATUS
Footlient will exit with code 220 if there is a failure in footclient
Footclient will exit with code 220 if there is a failure in footclient
itself (for example, the server socket does not exist).
If *-N*,*--no-wait* is used, footclient exits with code 0 as soon as
@ -158,6 +158,17 @@ terminfo entries manually, by copying *foot* and *foot-direct* to
This variable is set to *truecolor*, to indicate to client
applications that 24-bit RGB colors are supported.
*TERM_PROGRAM*
Always set to *foot*. This can be used by client applications to
check which terminal is in use, but with the caveat that it may
have been inherited from a parent process in other terminals that
aren't known to set the variable.
*TERM_PROGRAM_VERSION*
Set to the foot version string, in the format _major_*.*_minor_*.*_patch_
or _major_*.*_minor_*.*_patch_*-*_revision_*-\g*_commit_ for inter-release
builds. The same caveat as for *TERM_PROGRAM* applies.
In addition to the variables listed above, custom environment
variables may be defined in *foot.ini*(5).