Module disk_space 

Disk usage statistics

Configuration

Key	Values	Default
path	Path to collect information from. Supports path expansions e.g. ~.	"/"
interval	Update time in seconds	20
format	A string to customise the output of this block. See below for available placeholders.	" $icon $available "
format_alt	If set, block will switch between format and format_alt on every click	None
warning	A value which will trigger warning block state	20.0
alert	A value which will trigger critical block state	10.0
info_type	Determines which information will affect the block state. Possible values are "available", "free" and "used"	"available"
alert_unit	The unit of alert and warning options. If not set, percents are used. Possible values are "B", "KB", "KiB", "MB", "MiB", "GB", "Gib", "TB" and "TiB"	None
backend	The backend to use when querying disk usage. Possible values are "vfs" (like du(1)) and "btrfs"	"vfs"

Placeholder	Value	Type	Unit
icon	A static icon	Icon	-
path	The value of path option	Text	-
percentage	Free or used percentage. Depends on info_type	Number	%
total	Total disk space	Number	Bytes
used	Used disk space	Number	Bytes
free	Free disk space	Number	Bytes
available	Available disk space (free disk space minus reserved system space)	Number	Bytes

Action	Description	Default button
toggle_format	Toggles between format and format_alt	Left

Examples

[[block]]
block = "disk_space"
info_type = "available"
alert_unit = "GB"
alert = 10.0
warning = 15.0
format = " $icon $available "
format_alt = " $icon $available / $total "

Update block on right click:

[[block]]
block = "disk_space"
[[block.click]]
button = "right"
update = true

Show the block only if less than 10GB is available:

[[block]]
block = "disk_space"
format = " $free.eng(range:..10e9) |"

Icons Used

• disk_drive

Structs

Config

Enums

Backend

InfoType

Functions

run