1waybar-disk(5)                File Formats Manual               waybar-disk(5)
2
3
4

NAME

6       waybar - disk module
7

DESCRIPTION

9       The disk module displays the current disk space used.
10

CONFIGURATION

12       Addressed by disk
13
14       path:
15            typeof: string
16            default: "/"
17            Any path residing in the filesystem or mountpoint for which the
18       information should be displayed.
19
20       interval:
21            typeof: integer
22            default: 30
23            The interval in which the information gets polled.
24
25       format:
26            typeof: string
27            default: "{percentage_used}%"
28            The format, how information should be displayed.
29
30       rotate:
31            typeof: integer
32            Positive value to rotate the text label.
33
34       states:
35            typeof: object
36            A number of disk utilization states that get activated on certain
37       percentage thresholds (percentage_used). See waybar-states(5).
38
39       max-length:
40            typeof: integer
41            The maximum length in character the module should display.
42
43       min-length:
44            typeof: integer
45            The minimum length in characters the module should accept.
46
47       align:
48            typeof: float
49            The alignment of the text, where 0 is left-aligned and 1 is right-
50       aligned. If the module is rotated, it will follow the flow of the text.
51
52       on-click:
53            typeof: string
54            Command to execute when clicked on the module.
55
56       on-click-middle:
57            typeof: string
58            Command to execute when middle-clicked on the module using mouse‐
59       wheel.
60
61       on-click-right:
62            typeof: string
63            Command to execute when you right-click on the module.
64
65       on-update:
66            typeof: string
67            Command to execute when the module is updated.
68
69       on-scroll-up:
70            typeof: string
71            Command to execute when scrolling up on the module.
72
73       on-scroll-down:
74            typeof: string
75            Command to execute when scrolling down on the module.
76
77       smooth-scrolling-threshold:
78            typeof: double
79            Threshold to be used when scrolling.
80
81       tooltip:
82            typeof: bool
83            default: true
84            Option to disable tooltip on hover.
85
86       tooltip-format:
87            typeof: string
88            default: "{used} out of {total} used ({percentage_used}%)"
89            The format of the information displayed in the tooltip.
90
91       unit:
92            typeof: string
93            Use with specific_free, specific_used, and specific_total to force
94       calculation to always be in a certain unit. Accepts kB, kiB, MB, Mib,
95       GB, GiB, TB, TiB.
96

FORMAT REPLACEMENTS

98       {percentage_used}: Percentage of disk in use.
99
100       {percentage_free}: Percentage of free disk space
101
102       {total}: Total amount of space on the disk, partition, or mountpoint.
103       Automatically selects unit based on size remaining.
104
105       {used}: Amount of used disk space. Automatically selects unit based on
106       size remaining.
107
108       {free}: Amount of available disk space for normal users. Automatically
109       selects unit based on size remaining.
110
111       {path}: The path specified in the configuration.
112
113       {specific_total}: Total amount of space on the disk, partition, or
114       mountpoint in a specific unit. Defaults to bytes.
115
116       {specific_used}: Amount of used disk space in a specific unit. Defaults
117       to bytes.
118
119       {specific_free}: Amount of available disk space for normal users in a
120       specific unit. Defaults to bytes.
121

EXAMPLES

123           "disk": {
124                "interval": 30,
125                "format": "{percentage_free}% free on {path}",
126           }
127
128           "disk": {
129                "interval": 30,
130                "format": "{specific_free:0.2f} GB out of {specific_total:0.2f} GB available. Alternatively {free} out of {total} available",
131                "unit": "GB"
132                // 1434.25 GB out of 2000.00 GB available. Alternatively 1.4TiB out of 1.9TiB available.
133           }
134

STYLE

136       •   #disk
137
138
139
140                                  2023-11-05                    waybar-disk(5)
Impressum