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

doc: foot.ini: update max-shm-pool-size-mb section

Browse source 
* less highlighting
* it’s ‘virtual *address space*’
* mention it’s only supported on Linux
* mention it’s only supported on 64-bit archs (but not necessarily x86_64)
This commit is contained in:
Daniel Eklöf 2021-05-05 09:12:43 +02:00
parent f08f880911
commit b712bd9c24
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
1 changed files with 10 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -878,10 +878,11 @@ any of these options.
Default: _no_. Default: _no_.
*max-shm-pool-size-mb* *max-shm-pool-size-mb*
This option controls the amount of *virtual* memory used by the This option controls the amount of virtual address space used by
pixmap memory to which the terminal screen content is rendered. the pixmap memory to which the terminal screen content is
rendered.
It does *not* change how much physical memory foot uses. It does not change how much physical memory foot uses.
Foot uses a memory mapping trick to implement fast rendering of Foot uses a memory mapping trick to implement fast rendering of
interactive scrolling (typically, but applies to "slow" scrolling interactive scrolling (typically, but applies to "slow" scrolling
@ -889,7 +890,7 @@ any of these options.
scroll in a text editor. scroll in a text editor.
For this to work, it needs a large amount of virtual address For this to work, it needs a large amount of virtual address
space. Again, note that this is *not* physical memory. space. Again, note that this is not physical memory.
On a normal x64 based computer, each process has 128TB of virtual On a normal x64 based computer, each process has 128TB of virtual
address space, and newer ones have 64PB. This is an insane amount address space, and newer ones have 64PB. This is an insane amount
@ -900,10 +901,10 @@ any of these options.
of 65536 windows in server/daemon mode (for 2GB). That should be of 65536 windows in server/daemon mode (for 2GB). That should be
enough, yes? enough, yes?
However, the Wayland compositor *also* needs to allocate the same However, the Wayland compositor also needs to allocate the same
amount of virtual address space. Thus, it has a slightly higher amount of virtual address space. Thus, it has a slightly higher
chance of running out of address space since it needs to host chance of running out of address space since it needs to host
*all* running Wayland clients in the same way, at the same time. all running Wayland clients in the same way, at the same time.
In the off chance that this becomes a problem for you, you can In the off chance that this becomes a problem for you, you can
reduce the amount used with this option. reduce the amount used with this option.
@ -914,7 +915,9 @@ any of these options.
Setting it to 0 disables the feature. Setting it to 0 disables the feature.
Note: this feature is always disabled in 32-bit. Limitations:
- only supported on 64-bit architectures
- only supported on Linux
Default: _512_. Maximum allowed: _2048_ (2GB). Default: _512_. Maximum allowed: _2048_ (2GB).