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

doc: add ENVIRONMENT section to foot(1) and footclient(1) man pages

Browse source 
Closes #556
This commit is contained in:
Craig Barnes 2021-05-30 03:29:31 +01:00 • committed by Daniel Eklöf
parent 23e6a0a0ee
commit d08096b201
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
3 changed files with 69 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -55,6 +55,7 @@
* `${window-title}` to `notify`.
* Support for including files in `foot.ini`
(https://codeberg.org/dnkl/foot/issues/555).
* `ENVIRONMENT` section in **foot**(1) and **footclient**(1) man pages.
### Changed
@ -145,6 +146,7 @@
### Security
### Contributors
* [r\_c\_f](https://codeberg.org/r_c_f)
* [craigbarnes](https://codeberg.org/craigbarnes)
## 1.7.2

43
doc/foot.1.scd
View file

@ -325,6 +325,49 @@ numbers, when in _application_ mode.
See *foot.ini*(5)
# ENVIRONMENT
The following environment variables are used by foot:
*SHELL*
The default child process to run, when no _command_ argument is
specified and the *shell* option in *foot.ini*(5) is not set.
*XDG\_CONFIG\_HOME*
Used to determine the default location of *foot.ini*(5).
*XDG\_CONFIG\_DIRS*
Used to determine the default fallback location of *foot.ini*(5),
when not found in *${XDG\_CONFIG\_HOME:-~/.config}*.
*XDG\_RUNTIME\_DIR*
Used to construct the default _PATH_ for the *--server*
option, when no explicit argument is given (see above).
*WAYLAND\_DISPLAY*
Used to construct the default _PATH_ for the *--server*
option, when no explicit argument is given (see above).
*XCURSOR\_THEME*
The name of the *Xcursor*(3) theme to use for pointers (typically
set by the Wayland compositor).
*XCURSOR\_SIZE*
The size to use for *Xcursor*(3) pointers (typically set by the
Wayland compositor).
The following environment variables are set in the child process:
*TERM*
terminfo/termcap identifier. This is used by client applications
to determine which capabilities a terminal supports. The value is
set according to either the *--term* command-line option or the
*term* config option in *foot.ini*(5).
*COLORTERM*
This variable is set to *truecolor*, to indicate to client
applications that 24-bit RGB colors are supported.
# BUGS
Please report bugs to https://codeberg.org/dnkl/foot/issues

24
doc/footclient.1.scd
View file

@ -88,6 +88,30 @@ failure in the foot server.
In all other cases the exit code is that of the client application
(i.e. the shell).
# ENVIRONMENT
The following environment variables are used by footclient:
*XDG\_RUNTIME\_DIR*
Used to construct the default _PATH_ for the *--server-socket*
option, when no explicit argument is given (see above).
*WAYLAND\_DISPLAY*
Used to construct the default _PATH_ for the *--server-socket*
option, when no explicit argument is given (see above).
The following environment variables are set in the child process:
*TERM*
terminfo/termcap identifier. This is used by client applications
to determine which capabilities a terminal supports. The value is
set according to either the *--term* command-line option or the
*term* config option in *foot.ini*(5).
*COLORTERM*
This variable is set to *truecolor*, to indicate to client
applications that 24-bit RGB colors are supported.
# SEE ALSO
*foot*(1)