.\" 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-memory" "5" "2024-09-15"
.PP
.SH NAME
.PP
waybar - memory module
.PP
.SH DESCRIPTION
.PP
The \fBmemory\fR module displays the current memory utilization.\&
.PP
.SH CONFIGURATION
.PP
Addressed by \fBmemory\fR
.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}% 
.br
	The format, how information should be displayed.\&
.PP
\fBformat-icons\fR: 
.br
	typeof: array/object 
.br
	Based on the current percentage, the corresponding icon gets selected.\& 
.br
	The order is \fBlow\fR to \fBhigh\fR.\& Or by the state if it is an object.\&
.PP
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.\&
.PP
\fBstates\fR: 
.br
	typeof: object 
.br
	A number of memory utilization states which get activated on certain percentage thresholds.\& 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
\fBmenu\fR: 
.br
	typeof: string 
.br
	Action that popups the menu.\&
.PP
\fBmenu-file\fR: 
.br
	typeof: string 
.br
	Location of the menu descriptor file.\& There need to be an element of type
.RS 4
GtkMenu with id \fBmenu\fR
.PP
.RE
\fBmenu-actions\fR: 
.br
	typeof: array 
.br
	The actions corresponding to the buttons of the menu.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{percentage}\fR: Percentage of memory in use.\&
.PP
\fB{swapPercentage}\fR: Percentage of swap in use.\&
.PP
\fB{total}\fR: Amount of total memory available in GiB.\&
.PP
\fB{swapTotal}\fR: Amount of total swap available in GiB.\&
.PP
\fB{used}\fR: Amount of used memory in GiB.\&
.PP
\fB{swapUsed}\fR: Amount of used swap in GiB.\&
.PP
\fB{avail}\fR: Amount of available memory in GiB.\&
.PP
\fB{swapAvail}\fR: Amount of available swap in GiB.\&
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"memory": {
	"interval": 30,
	"format": "{}% ",
	"max-length": 10
}
.fi
.RE
.PP
.SS FORMATTED MEMORY VALUES
.PP
.nf
.RS 4
"memory": {
	"interval": 30,
	"format": "{used:0\&.1f}G/{total:0\&.1f}G "
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#memory\fR