.\" 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 "yambar-modules-mem" "5" "2024-04-20"
.PP
.SH NAME
mem - This module provides the memory usage
.PP
.SH TAGS
.PP
.TS
allbox;l l lx
l l lx
l l lx
l l lx
l l lx
l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBDescription\fR
T}
T{
free
T}	T{
int
T}	T{
Free memory in bytes
T}
T{
used
T}	T{
int
T}	T{
Used memory in bytes
T}
T{
total
T}	T{
int
T}	T{
Total memory in bytes
T}
T{
percent_free
T}	T{
range
T}	T{
Free memory in percent
T}
T{
percent_used
T}	T{
range
T}	T{
Used memory in percent
T}
.TE
.sp 1
.SH CONFIGURATION
.PP
.TS
allbox;l l l lx
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
poll-interval
T}	T{
string
T}	T{
no
T}	T{
Refresh interval of the memory usage stats in milliseconds (default=500).\& Cannot be less then 250ms.\&
T}
.TE
.sp 1
.SH EXAMPLES
.PP
.nf
.RS 4
bar:
  left:
    - mem:
        poll-interval: 2500
        content:
          string: {text: "{used:mb}MB"}
.fi
.RE
.PP
.SH SEE ALSO
.PP
\fByambar-modules\fR(5), \fByambar-particles\fR(5), \fByambar-tags\fR(5), \fByambar-decorations\fR(5)