Merge CHANGELOG.md

This commit is contained in:
Max Gautier 2023-07-21 06:01:28 +02:00
commit dd647203fb
No known key found for this signature in database
52 changed files with 2907 additions and 1116 deletions

View file

@ -65,7 +65,7 @@ the foot command line
*-a*,*--app-id*=_ID_
Value to set the *app-id* property on the Wayland window
to. Default: _foot_.
to. Default: _foot_ (normal mode), or _footclient_ (server mode).
*-m*,*--maximized*
Start in maximized mode. If both *--maximized* and *--fullscreen*
@ -202,9 +202,12 @@ default) available; see *foot.ini*(5).
_OSC 7_ escape sequence, the new terminal will start in the
current working directory.
*ctrl*+*shift*+*u*
*ctrl*+*shift*+*o*
Activate URL mode, allowing you to "launch" URLs.
*ctrl*+*shift*+*u*
Activate Unicode input.
*ctrl*+*shift*+*z*
Jump to the previous, currently not visible, prompt. Requires
shell integration.
@ -283,6 +286,18 @@ default) available; see *foot.ini*(5).
*wheel*
Scroll up/down in history
## TOUCHSCREEN
*tap*
Emulates mouse left button click.
*drag*
Scrolls up/down in history.
Holding for a while before dragging (time delay can be configured)
emulates mouse dragging with left button held.
# FONT FORMAT
The font is specified in FontConfig syntax. That is, a colon-separated
@ -298,7 +313,7 @@ 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
Pressing *ctrl*+*shift*+*o* enters _“Open 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.
@ -546,17 +561,6 @@ In all other cases, the exit code is that of the client application
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).

View file

@ -87,7 +87,7 @@ empty string to be set, but it must be quoted: *KEY=""*)
Examples:
```
font-size-adjustment=0.5 # Adjust by 0.5 points
font-size-adjustment=10xp # Adjust by 10 pixels
font-size-adjustment=10px # Adjust by 10 pixels
font-size-adjustment=7.5% # Adjust by 7.5 percent
```
@ -185,7 +185,7 @@ empty string to be set, but it must be quoted: *KEY=""*)
Default: _no_.
*dpi-aware*
*auto*, *yes*, or *no*.
Boolean.
When set to *yes*, fonts are sized using the monitor's DPI, making
a font of a given size have the same physical size, regardless of
@ -199,12 +199,6 @@ empty string to be set, but it must be quoted: *KEY=""*)
instead sized using the monitor's scaling factor; doubling the
scaling factor *does* double the font size.
Finally, if set to *auto*, fonts will be sized using the monitor's
DPI if _all_ monitors have a scaling factor of 1. If at least one
monitor as a scaling factor larger than 1 (regardless of whether
the foot window is mapped on that monitor or not), fonts will be
scaled using the scaling factor.
Note that this option typically does not work with bitmap fonts,
which only contains a pre-defined set of sizes, and cannot be
dynamically scaled. Whichever size (of the available ones) that
@ -217,7 +211,7 @@ empty string to be set, but it must be quoted: *KEY=""*)
to size the font (*dpi-aware=no*), the font's pixel size will be
multiplied with the scaling factor.
Default: _auto_
Default: _no_
*pad*
Padding between border and glyphs, in pixels (subject to output
@ -289,7 +283,8 @@ empty string to be set, but it must be quoted: *KEY=""*)
*app-id*
Value to set the *app-id* property on the Wayland window to. The
compositor can use this value to e.g. group multiple windows, or
apply window management rules. Default: _foot_.
apply window management rules. Default: _foot_ (normal mode), or
_footclient_ (server mode).
*bold-text-in-bright*
Semi-boolean. When enabled, bold text is rendered in a brighter
@ -314,7 +309,8 @@ empty string to be set, but it must be quoted: *KEY=""*)
and _body_ (message content).
_${app-id}_ is replaced with the value of the command line option
_--app-id_, and defaults to *foot*.
_--app-id_, and defaults to *foot* (normal mode), or
*footclient* (server mode).
_${window-title}_ is replaced with the current window title.
@ -343,9 +339,24 @@ empty string to be set, but it must be quoted: *KEY=""*)
(including SMT). Note that this is not always the best value. In
some cases, the number of physical _cores_ is better.
*utempter*
Path to utempter helper binary. Set to *none* to disable utmp
records. Default: _@utempter@_.
*utmp-helper*
Path to utmp logging helper binary.
When starting foot, an utmp record is created by launching the
helper binary with the following arguments:
```
@utmp_add_args@
```
When foot is closed, the utmp record is removed by launching the
helper binary with the following arguments:
```
@utmp_del_args@
```
Set to *none* to disable utmp records. Default: _@utmp_helper_path@_.
# SECTION: environment
@ -524,6 +535,14 @@ applications can change these at runtime.
Default: _yes_.
# SECTION: touch
*long-press-delay*
Number of milliseconds to distinguish between a short press and
a long press on the touchscreen.
Default: _400_.
# SECTION: colors
This section controls the 16 ANSI colors, the default foreground and
@ -544,15 +563,15 @@ can configure the background transparency with the _alpha_ option.
*regular0*, *regular1* *..* *regular7*
The eight basic ANSI colors (Black, Red, Green, Yellow, Blue,
Magenta, Cyan, White). Default: _073642_, _dc322f_, _859900_,
_b58900_, _268bd2_, _d33682_, _2aa198_ and _eee8d5_ (a variant of
the _solarized dark_ theme).
Magenta, Cyan, White). Default: _242424_, _f62b5a_, _47b413_,
_e3c401_, _24acd4_, _f2affd_, _13c299_, _e6e6e6_ (starlight
theme, V4).
*bright0*, *bright1* *..* *bright7*
The eight bright ANSI colors (Black, Red, Green, Yellow, Blue,
Magenta, Cyan, White). Default: _08404f_, _e35f5c_, _9fb700_,
_d9a400_, _4ba1de_, _dc619d_, _32c1b6_ and _ffffff_ (a variant of
the _solarized dark_ theme).
Magenta, Cyan, White). Default: _616161_, _ff4d51_, _35d450_,
_e9e836_, _5dc5f8_, _feabf2_, _24dfc4_, _ffffff_ (starlight
theme, V4).
*dim0*, *dim1* *..* *dim7*
Custom colors to use with dimmed colors. Dimmed colors do not have
@ -673,6 +692,10 @@ Examples:
is maximized. The completely disable the titlebar, set *size* to 0
instead. Default: _no_.
*double-click-to-maximize*
Boolean. When enabled, double-clicking the CSD titlebar will
(un)maximize the window. Default: _yes_.
*border-width*
Width of the border, in pixels (subject to output scaling). Note
that the border encompasses the entire window, including the title
@ -815,7 +838,7 @@ e.g. *search-start=none*.
*show-urls-launch*
Enter URL mode, where all currently visible URLs are tagged with a
jump label with a key sequence that will open the URL (and exit
URL mode). Default: _Control+Shift+u_.
URL mode). Default: _Control+Shift+o_.
*show-urls-persistent*
Similar to *show-urls-launch*, but does not automatically exit URL
@ -858,7 +881,7 @@ e.g. *search-start=none*.
fallback. The preferred way of entering Unicode characters, emojis
etc is by using an IME.
Default: _none_.
Default: _Control+Shift+u_.
# SECTION: search-bindings

View file

@ -31,7 +31,7 @@ terminal has terminated.
*-a*,*--app-id*=_ID_
Value to set the *app-id* property on the Wayland window
to. Default: _foot_.
to. Default: _foot_ (normal mode), or _footclient_ (server mode).
*-w*,*--window-size-pixels*=_WIDTHxHEIGHT_
Set initial window width and height, in pixels. Default: _700x500_.
@ -163,17 +163,6 @@ fallback to the less specific path, with the following priority:
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).

View file

@ -1,17 +1,25 @@
sh = find_program('sh', native: true)
scdoc_prog = find_program(scdoc.get_variable('scdoc'), native: true)
if utempter_path == ''
default_utempter_value = 'not set'
if utmp_backend != 'none'
utmp_add_args = '@0@ $WAYLAND_DISPLAY'.format(utmp_add)
utmp_del_args = (utmp_del_have_argument
? '@0@ $WAYLAND_DISPLAY'.format(utmp_del)
: '@0@'.format(utmp_del))
utmp_path = utmp_default_helper_path
else
default_utempter_value = utempter_path
utmp_add_args = '<no utmp support in foot>'
utmp_del_args = '<no utmp support in foot>'
utmp_path = 'none'
endif
conf_data = configuration_data(
{
'default_terminfo': get_option('default-terminfo'),
'utempter': default_utempter_value,
'utmp_backend': utmp_backend,
'utmp_add_args': utmp_add_args,
'utmp_del_args': utmp_del_args,
'utmp_helper_path': utmp_path,
}
)
@ -33,8 +41,9 @@ foreach man_src : [{'name': 'foot', 'section' : 1},
out,
output: out,
input: preprocessed,
command: [sh, '-c', '@0@ < @INPUT@'.format(scdoc_prog.full_path())],
command: scdoc_prog.full_path(),
capture: true,
feed: true,
install: true,
install_dir: join_paths(get_option('mandir'), 'man@0@'.format(section)))
endforeach