diff options
| author | Daniel Eklöf <daniel@ekloef.se> | 2021-10-01 18:50:32 +0000 |
|---|---|---|
| committer | Daniel Eklöf <daniel@ekloef.se> | 2021-10-01 18:50:32 +0000 |
| commit | a082fec786d44bfbe8d2172c6317121027735a6b (patch) | |
| tree | cf2a9fc4a822f4701a0a90db41b1c3ac03dd333a /doc | |
| parent | meson/pkgbuild: bump version to 1.9.0 (diff) | |
| parent | Merge branch 'hacktober-theme' (diff) | |
Merge branch 'master' into releases/1.9
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/foot.1.scd | 33 | ||||
| -rw-r--r-- | doc/foot.ini.5.scd | 52 | ||||
| -rw-r--r-- | doc/footclient.1.scd | 27 |
3 files changed, 54 insertions, 58 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd index cbebd087..91a7808a 100644 --- a/doc/foot.1.scd +++ b/doc/foot.1.scd @@ -141,6 +141,16 @@ the foot command line *-v*,*--version* Show the version number and quit. +*-e* + Ignored; for compatibility with *xterm -e*. + + This option was added in response to several program launchers + passing *-e* to arbitrary terminals, under the assumption that + they all implement the same semantics for it as *xterm*(1). + Ignoring it allows foot to be invoked as e.g. *foot -e man foot* + with the same results as with xterm, instead of producing an + "invalid option" error. + # EXIT STATUS Foot will exit with code 230 if there is a failure in foot itself. @@ -402,29 +412,6 @@ The following environment variables are set in the child process: set according to either the *--term* command-line option or the *term* config option in *foot.ini*(5). -*TERMINFO* - Path to foot's terminfo definitions. These are typically installed - in a non-standard location (though distributions may override - this), to allow them to co-exist with the foot terminfo - definitions in ncurses. Note that applications will search the - default location(s) if *TERM* does not exist in *TERMINFO*. - - Note that applications like sudo and ssh will remove this - environment variable. - - For sudo, you can create a file under _/etc/sudoers.d_ (name does - not matter) with the following content: - - *Defaults env_keep += "TERMINFO"* - - For ssh, you can edit _/etc/ssh/sshd_config_ (on the *server*), - and add: - - *SetEnv TERMINFO=*_<path>_ - - Where path is the location of the terminfo definitions on the - *server*, typically /usr/share/foot/terminfo. - *COLORTERM* This variable is set to *truecolor*, to indicate to client applications that 24-bit RGB colors are supported. diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd index 65a3a4dc..6bc93cc4 100644 --- a/doc/foot.ini.5.scd +++ b/doc/foot.ini.5.scd @@ -6,8 +6,9 @@ foot.ini - configuration file for *foot*(1) # DESCRIPTION *foot* uses the standard _unix configuration format_, with section based -key/value pairs. The default section is unnamed (i.e. not prefixed -with a _[section]_). +key/value pairs. The default section is usually unnamed, i.e. not prefixed +with a _[section]_. However it can also be explicitly named _[main]_, +say if it needs to be reopened after any of the other sections. foot will search for a configuration file in the following locations, in this order: @@ -16,7 +17,7 @@ in this order: - *~/.config/foot/foot.ini* - *XDG_CONFIG_DIRS/foot/foot.ini* -# SECTION: default +# SECTION: main *shell* Executable to launch. Typically a shell. Default: _$SHELL_ if set, @@ -36,7 +37,8 @@ in this order: Comma separated list of fonts to use, in fontconfig format. That is, a font name followed by a list of colon-separated options. Most noteworthy is *:size=n*, which is used to set the - font size. + font size. Note that the font size is also affected by the + *dpi-aware* option. Examples: - Dina:weight=bold:slant=italic @@ -144,11 +146,12 @@ in this order: Default: _no_. *dpi-aware* - *auto*, *yes*, or *no*. 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 monitor. In other words, if you drag - a foot window between different monitors, the font size remains - the same. + *auto*, *yes*, or *no*. + + 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 + monitor. In other words, if you drag a foot window between + different monitors, the font size remains the same. In this mode, the monitor's scaling factor is ignored; doubling the scaling factor will *not* double the font size. @@ -158,8 +161,22 @@ in this order: scaling factor *does* double the font size. Finally, if set to *auto*, fonts will be sized using the monitor's - DPI on monitors with a scaling factor of 1, but otherwise using - the scaling factor. + 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 + best matches the DPI or scaling factor, will be used. + + Also note that if the font size has been specified in pixels + (*:pixelsize=*_N_, instead of *:size=*_N_), DPI scaling + (*dpi-aware=yes*) will have no effect (the specified pixel size + will be used as is). But, if the monitor's scaling factor is used + to size the font (*dpi-aware=no*), the font's pixel size will be + multiplied with the scaling factor. Default: _auto_ @@ -179,7 +196,7 @@ in this order: Default: _2x2_. *resize-delay-ms* - Time, in milliseconds, of "idle time" "before foot sends the new + 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. @@ -1022,6 +1039,17 @@ any of these options. Default: _double-width_ +*font-monospace-warn* + Boolean. When enabled, foot will use heuristics to try to verify + the primary font is a monospace font, and warn if it is not. + + Disable this if you still want to use the font, even if foot + thinks it is not monospaced. + + You may also want to disable it to get slightly faster startup times. + + Default: _yes_ + *max-shm-pool-size-mb* This option controls the amount of virtual address space used by the pixmap memory to which the terminal screen content is diff --git a/doc/footclient.1.scd b/doc/footclient.1.scd index 155683da..9cb4ef69 100644 --- a/doc/footclient.1.scd +++ b/doc/footclient.1.scd @@ -79,6 +79,10 @@ terminal has terminated. *-v*,*--version* Show the version number and quit +*-e* + Ignored; for compatibility with *xterm -e*. See *foot*(1) for more + details. + # EXIT STATUS Footlient will exit with code 220 if there is a failure in footclient @@ -146,29 +150,6 @@ The following environment variables are set in the child process: set according to either the *--term* command-line option or the *term* config option in *foot.ini*(5). -*TERMINFO* - Path to foot's terminfo definitions. These are typically installed - in a non-standard location (though distributions may override - this), to allow them to co-exist with the foot terminfo - definitions in ncurses. Note that applications will search the - default location(s) if *TERM* does not exist in *TERMINFO*. - - Note that applications like sudo and ssh will remove this - environment variable. - - For sudo, you can create a file under _/etc/sudoers.d_ (name does - not matter) with the following content: - - *Defaults env_keep += "TERMINFO"* - - For ssh, you can edit _/etc/ssh/sshd_config_ (on the *server*), - and add: - - *SetEnv TERMINFO=*_<path>_ - - Where path is the location of the terminfo definitions on the - *server*, typically /usr/share/foot/terminfo. - *COLORTERM* This variable is set to *truecolor*, to indicate to client applications that 24-bit RGB colors are supported. |
