doc + meson.build: update information about foot.ini, small cleanup

- foot.ini.5: mention location of example config file
- foot.1: replace outdated (or incomplete) information about the
  location of the config file with references to foot.ini.5
- foot.1 and foot.ini.5: conform to scdoc specification, thus surround each
  header with (at least) one blank line. additionally consistently use exactly
  one line before/after each header (was sometimes two before)
- foot.1: some parts of the keybindings had their own section, move into
  KEYBOARD SHORTCUTS section
- foot.1: move EXIT STATUS section to the end where it is commonly found
- foot.1: copy information about config file handling from the beginning of
  foot.ini.5 into the CONFIGURATION section of foot.1
- INSTALL.md: foot.ini is no longer included in the documentation
- meson.build: do not bundle foot.ini with documentation anymore, see also
  https://codeberg.org/dnkl/foot/pulls/1015

Closes #1002
This commit is contained in:
Merlin Büge 2022-04-21 10:04:11 +02:00 committed by Daniel Eklöf
parent 9907d7bbe9
commit e6f884a9e1
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
4 changed files with 34 additions and 36 deletions

View file

@ -1,6 +1,7 @@
foot.ini(5)
# NAME
foot.ini - configuration file for *foot*(1)
# DESCRIPTION
@ -18,6 +19,9 @@ in this order:
- *XDG_CONFIG_DIRS/foot/foot.ini* (defaulting to
*/etc/xdg/foot/foot.ini* if unset)
An example configuration file containing all options with their default value
commented out will usually be installed to */etc/xdg/foot/foot.ini*.
# SECTION: main
*shell*
@ -301,7 +305,6 @@ in this order:
(including SMT). Note that this is not always the best value. In
some cases, the number of physical _cores_ is better.
# SECTION: bell
*urgent*
@ -333,7 +336,6 @@ in this order:
Whether to run the command on *BEL* even while focused. Default:
_no_
# SECTION: scrollback
*lines*
@ -359,7 +361,6 @@ in this order:
string. This option is ignored if
*indicator-position=none*. Default: _empty string_.
# SECTION: url
*launch*
@ -403,7 +404,6 @@ in this order:
Default:
_abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-\_.,~:;/?#@!$&%\*+="'()[]_
# SECTION: cursor
This section controls the cursor style and color. Note that
@ -446,7 +446,6 @@ applications can change these at runtime.
Default: _font underline thickness_.
# SECTION: mouse
*hide-when-typing*
@ -471,7 +470,6 @@ applications can change these at runtime.
Default: _yes_.
# SECTION: colors
This section controls the 16 ANSI colors, the default foreground and
@ -559,7 +557,6 @@ can configure the background transparency with the _alpha_ option.
Color to use for the underline used to highlight URLs in URL
mode. Default: _regular3_.
# SECTION: csd
This section controls the look of the _CSDs_ (Client Side
@ -640,7 +637,6 @@ Examples:
Close button's background color. Default: use the default
_regular1_ color (red).
# SECTION: key-bindings
This section lets you override the default key bindings.
@ -765,7 +761,6 @@ e.g. *search-start=none*.
jump label with a key sequence that will place the URL in the
clipboard. Default: _none_.
# SECTION: search-bindings
This section lets you override the default key bindings used in
@ -844,7 +839,6 @@ scrollback search mode. The syntax is exactly the same as the regular
Paste from the _primary selection_ into the search
buffer. Default: _Shift+Insert_.
# SECTION: url-bindings
This section lets you override the default key bindings used in URL
@ -871,7 +865,6 @@ Be careful; do not use single-letter keys that are also used in
Default: _t_.
# SECTION: text-bindings
This section lets you remap key combinations to custom escape
@ -902,7 +895,6 @@ Another example: to remap _Super+c_ to _Control+c_:
*\\x03 = Mod4+c*
# SECTION: mouse-bindings
This section lets you override the default mouse bindings.
@ -979,11 +971,9 @@ actions listed under *key-bindings* can be used here as well.
*select-extend* operations to be character wise. This action is
ignored for block selections. Default: _Control+BTN\_RIGHT_.
*primary-paste*
Pastes from the _primary selection_. Default: _BTN\_MIDDLE_.
# TWEAK
This section is for advanced users and describes configuration options
@ -1223,7 +1213,6 @@ any of these options.
*sixel*
Boolean. When enabled, foot will process sixel images. Default: _yes_
# SEE ALSO
*foot*(1), *footclient*(1)