Module memory

Memory and swap usage

Configuration

Key	Values	Default
format	A string to customise the output of this block when in “Memory” view. See below for available placeholders.	" $icon $mem_used.eng(prefix:Mi)/$mem_total.eng(prefix:Mi)($mem_used_percents.eng(w:2)) "
format_alt	If set, block will switch between format and format_alt on every click	None
interval	Update interval in seconds	5
warning_mem	Percentage of memory usage, where state is set to warning	80.0
warning_swap	Percentage of swap usage, where state is set to warning	80.0
critical_mem	Percentage of memory usage, where state is set to critical	95.0
critical_swap	Percentage of swap usage, where state is set to critical	95.0

Placeholder	Value	Type	Unit
icon	Memory icon	Icon	-
icon_swap	Swap icon	Icon	-
mem_total	Total physical ram available	Number	Bytes
mem_free	Free memory not yet used by the kernel or userspace (in general you should use mem_avail)	Number	Bytes
mem_free_percents	as above but as a percentage of total memory	Number	Percents
mem_avail	Kernel estimate of usable free memory which includes cached memory and buffers	Number	Bytes
mem_avail_percents	as above but as a percentage of total memory	Number	Percents
mem_total_used	mem_total - mem_free	Number	Bytes
mem_total_used_percents	as above but as a percentage of total memory	Number	Percents
mem_used	Memory used, excluding cached memory and buffers; same as htop’s green bar	Number	Bytes
mem_used_percents	as above but as a percentage of total memory	Number	Percents
buffers	Buffers, similar to htop’s blue bar	Number	Bytes
buffers_percent	as above but as a percentage of total memory	Number	Percents
cached	Cached memory (taking into account ZFS ARC cache), similar to htop’s yellow bar	Number	Bytes
cached_percent	as above but as a percentage of total memory	Number	Percents
swap_total	Swap total	Number	Bytes
swap_free	Swap free	Number	Bytes
swap_free_percents	as above but as a percentage of total memory	Number	Percents
swap_used	Swap used	Number	Bytes
swap_used_percents	as above but as a percentage of total memory	Number	Percents
zram_compressed	Compressed zram memory usage	Number	Bytes
zram_decompressed	Decompressed zram memory usage	Number	Bytes
‘zram_comp_ratio’	Ratio of the decompressed/compressed zram memory	Number	-
zswap_compressed	Compressed zswap memory usage (>=Linux 5.19)	Number	Bytes
zswap_decompressed	Decompressed zswap memory usage (>=Linux 5.19)	Number	Bytes
zswap_decompressed_percents	as above but as a percentage of total zswap memory (>=Linux 5.19)	Number	Percents
‘zswap_comp_ratio’	Ratio of the decompressed/compressed zswap memory (>=Linux 5.19)	Number	-

Action	Description	Default button
toggle_format	Toggles between format and format_alt	Left

Examples

[[block]]
block = "memory"
format = " $icon $mem_used_percents.eng(w:1) "
format_alt = " $icon_swap $swap_free.eng(w:3,u:B,p:Mi)/$swap_total.eng(w:3,u:B,p:Mi)($swap_used_percents.eng(w:2)) "
interval = 30
warning_mem = 70
critical_mem = 90

Show swap and hide if it is zero:

[[block]]
block = "memory"
format = " $icon $swap_used.eng(range:1..) |"

Icons Used

• memory_mem
• memory_swap

Structs

• Config

Functions

• run