.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "waybar-disk" "5" "2024-05-05"
.PP
.SH NAME
.PP
waybar - disk module
.PP
.SH DESCRIPTION
.PP
The \fBdisk\fR module displays the current disk space used.\&
.PP
.SH CONFIGURATION
.PP
Addressed by \fBdisk\fR
.PP
\fBpath\fR: 
.br
	typeof: string 
.br
	default: "/" 
.br
	Any path residing in the filesystem or mountpoint for which the information should be displayed.\&
.PP
\fBinterval\fR: 
.br
	typeof: integer
.br
	default: 30 
.br
	The interval in which the information gets polled.\&
.PP
\fBformat\fR: 
.br
	typeof: string 
.br
	default: "{percentage_used}%" 
.br
	The format, how information should be displayed.\&
.PP
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.\&
.PP
\fBstates\fR: 
.br
	typeof: object 
.br
	A number of disk utilization states that get activated on certain percentage thresholds (percentage_used).\& See \fBwaybar-states(5)\fR.\&
.PP
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in character the module should display.\&
.PP
\fBmin-length\fR: 
.br
	typeof: integer 
.br
	The minimum length in characters the module should accept.\&
.PP
\fBalign\fR: 
.br
	typeof: float 
.br
	The alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned.\& If the module is rotated, it will follow the flow of the text.\&
.PP
\fBjustify\fR: 
.br
	typeof: string 
.br
	The alignment of the text within the module'\&s label, allowing options '\&left'\&, '\&right'\&, or '\&center'\& to define the positioning.\&
.PP
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when clicked on the module.\&
.PP
\fBon-click-middle\fR: 
.br
	typeof: string 
.br
	Command to execute when middle-clicked on the module using mousewheel.\&
.PP
\fBon-click-right\fR: 
.br
	typeof: string 
.br
	Command to execute when you right-click on the module.\&
.PP
\fBon-update\fR: 
.br
	typeof: string 
.br
	Command to execute when the module is updated.\&
.PP
\fBon-scroll-up\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling up on the module.\&
.PP
\fBon-scroll-down\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling down on the module.\&
.PP
\fBsmooth-scrolling-threshold\fR: 
.br
	typeof: double 
.br
	Threshold to be used when scrolling.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.\&
.PP
\fBtooltip-format\fR: 
.br
	typeof: string 
.br
	default: "{used} out of {total} used ({percentage_used}%)" 
.br
	The format of the information displayed in the tooltip.\&
.PP
\fBunit\fR: 
.br
	typeof: string 
.br
	Use with specific_free, specific_used, and specific_total to force calculation to always be in a certain unit.\& Accepts kB, kiB, MB, Mib, GB, GiB, TB, TiB.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{percentage_used}\fR: Percentage of disk in use.\&
.PP
\fB{percentage_free}\fR: Percentage of free disk space
.PP
\fB{total}\fR: Total amount of space on the disk, partition, or mountpoint.\& Automatically selects unit based on size remaining.\&
.PP
\fB{used}\fR: Amount of used disk space.\& Automatically selects unit based on size remaining.\&
.PP
\fB{free}\fR: Amount of available disk space for normal users.\& Automatically selects unit based on size remaining.\&
.PP
\fB{path}\fR: The path specified in the configuration.\&
.PP
\fB{specific_total}\fR: Total amount of space on the disk, partition, or mountpoint in a specific unit.\& Defaults to bytes.\&
.PP
\fB{specific_used}\fR: Amount of used disk space in a specific unit.\& Defaults to bytes.\&
.PP
\fB{specific_free}\fR: Amount of available disk space for normal users in a specific unit.\& Defaults to bytes.\&
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"disk": {
	"interval": 30,
	"format": "{percentage_free}% free on {path}",
}
.fi
.RE
.PP
.nf
.RS 4
"disk": {
	"interval": 30,
	"format": "{specific_free:0\&.2f} GB out of {specific_total:0\&.2f} GB available\&. Alternatively {free} out of {total} available",
	"unit": "GB"
	// 1434\&.25 GB out of 2000\&.00 GB available\&. Alternatively 1\&.4TiB out of 1\&.9TiB available\&.
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#disk\fR