2019-08-26 15:12:42 +01:00
waybar-memory(5)
# NAME
waybar - memory module
# DESCRIPTION
2019-08-30 09:41:01 +01:00
The * memory * module displays the current memory utilization.
2019-08-26 15:12:42 +01:00
# CONFIGURATION
Addressed by * memory *
* interval * : ++
typeof: integer++
default: 30 ++
The interval in which the information gets polled.
* format * : ++
typeof: string ++
default: {percentage}% ++
The format, how information should be displayed.
2021-08-23 07:30:07 +02:00
* format-icons * : ++
typeof: array/object ++
Based on the current percentage, the corresponding icon gets selected. ++
The order is *low* to *high*. Or by the state if it is an object.
2019-08-26 15:12:42 +01:00
* rotate * : ++
typeof: integer ++
Positive value to rotate the text label.
* states * : ++
2022-11-07 20:30:01 +13:00
typeof: object ++
2019-08-26 15:12:42 +01:00
A number of memory utilization states which get activated on certain percentage thresholds. See *waybar-states(5)*.
* max-length * : ++
typeof: integer ++
The maximum length in character the module should display.
2021-02-01 08:34:51 -08:00
* min-length * : ++
2023-07-30 17:33:02 +02:00
typeof: integer ++
2023-10-21 21:15:25 +05:30
The minimum length in characters the module should accept.
2021-02-01 08:34:51 -08:00
* align * : ++
2023-07-30 17:33:02 +02:00
typeof: float ++
2024-03-04 20:00:57 +01:00
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.
* justify * : ++
typeof: string ++
The alignment of the text within the module's label, allowing options 'left', 'right', or 'center' to define the positioning.
2021-02-01 08:34:51 -08:00
2019-08-26 15:12:42 +01:00
* on-click * : ++
typeof: string ++
Command to execute when clicked on the module.
2019-12-28 20:11:22 -08:00
* on-click-middle * : ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
2019-08-26 15:12:42 +01:00
* on-click-right * : ++
typeof: string ++
2023-10-21 21:15:25 +05:30
Command to execute when you right-click on the module.
2019-08-26 15:12:42 +01:00
2020-04-12 18:35:41 +02:00
* on-update * : ++
typeof: string ++
Command to execute when the module is updated.
2019-08-26 15:12:42 +01:00
* on-scroll-up * : ++
typeof: string ++
Command to execute when scrolling up on the module.
* on-scroll-down * : ++
typeof: string ++
Command to execute when scrolling down on the module.
* smooth-scrolling-threshold * : ++
typeof: double ++
Threshold to be used when scrolling.
* tooltip * : ++
typeof: bool ++
default: true ++
Option to disable tooltip on hover.
# FORMAT REPLACEMENTS
* {percentage} * : Percentage of memory in use.
2021-08-29 16:37:02 +03:00
* {swapPercentage} * : Percentage of swap in use.
2019-08-26 15:12:42 +01:00
* {total} * : Amount of total memory available in GiB.
2021-08-29 16:37:02 +03:00
* {swapTotal} * : Amount of total swap available in GiB.
2019-08-26 15:12:42 +01:00
* {used} * : Amount of used memory in GiB.
2021-08-29 16:37:02 +03:00
* {swapUsed} * : Amount of used swap in GiB.
2019-08-26 15:12:42 +01:00
* {avail} * : Amount of available memory in GiB.
2021-08-29 16:37:02 +03:00
* {swapAvail} * : Amount of available swap in GiB.
2019-08-26 22:28:24 +01:00
# EXAMPLES
2019-08-26 15:12:42 +01:00
```
"memory": {
"interval": 30,
"format": "{}% ",
"max-length": 10
}
```
## FORMATTED MEMORY VALUES
```
"memory": {
"interval": 30,
"format": "{used:0.1f}G/{total:0.1f}G "
}
```
# STYLE
- * #memory *
