.\" Generated by scdoc 1.11.2
.\" 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" "2023-02-28"
.P
.SH NAME
.P
waybar - disk module
.P
.SH DESCRIPTION
.P
The \fBdisk\fR module displays the current disk space used.\&
.P
.SH CONFIGURATION
.P
Addressed by \fBdisk\fR
.P
\fBpath\fR: 
.br
	typeof: string 
.br
	default: "/" 
.br
	Any path residing in the filesystem or mountpoint for which the information should be displayed.\&
.P
\fBinterval\fR: 
.br
	typeof: integer
.br
	default: 30 
.br
	The interval in which the information gets polled.\&
.P
\fBformat\fR: 
.br
	typeof: string 
.br
	default: "{percentage_used}%" 
.br
	The format, how information should be displayed.\&
.P
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.\&
.P
\fBstates\fR: 
.br
	typeof: object 
.br
	A number of disk utilization states which get activated on certain percentage thresholds (percentage_used).\& See \fBwaybar-states(5)\fR.\&
.P
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in character the module should display.\&
.P
\fBmin-length\fR: 
.br
    typeof: integer 
.br
    The minimum length in characters the module should take up.\&
.P
\fBalign\fR: 
.br
    typeof: float 
.br
    The alignment of the text, where 0 is left-aligned and 1 is right-aligned.\& If the module is rotated, it will follow the flow of the text.\&
.P
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when clicked on the module.\&
.P
\fBon-click-middle\fR: 
.br
	typeof: string 
.br
	Command to execute when middle-clicked on the module using mousewheel.\&
.P
\fBon-click-right\fR: 
.br
	typeof: string 
.br
	Command to execute when you right clicked on the module.\&
.P
\fBon-update\fR: 
.br
	typeof: string 
.br
	Command to execute when the module is updated.\&
.P
\fBon-scroll-up\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling up on the module.\&
.P
\fBon-scroll-down\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling down on the module.\&
.P
\fBsmooth-scrolling-threshold\fR: 
.br
	typeof: double 
.br
	Threshold to be used when scrolling.\&
.P
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.\&
.P
\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.\&
.P
.SH FORMAT REPLACEMENTS
.P
\fB{percentage_used}\fR: Percentage of disk in use.\&
.P
\fB{percentage_free}\fR: Percentage of free disk space
.P
\fB{total}\fR: Total amount of space on the disk, partition or mountpoint.\&
.P
\fB{used}\fR: Amount of used disk space.\&
.P
\fB{free}\fR: Amount of available disk space for normal users.\&
.P
\fB{path}\fR: The path specified in the configuration.\&
.P
.SH EXAMPLES
.P
.nf
.RS 4
"disk": {
	"interval": 30,
	"format": "{percentage_free}% free on {path}",
}
.fi
.RE
.P
.SH STYLE
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#disk\fR
.RE