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: array
36            A number of disk utilization states which 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       on-click:
44            typeof: string
45            Command to execute when clicked on the module.
46
47       on-click-middle:
48            typeof: string
49            Command to execute when middle-clicked on the module using mouse‐
50       wheel.
51
52       on-click-right:
53            typeof: string
54            Command to execute when you right clicked on the module.
55
56       on-update:
57            typeof: string
58            Command to execute when the module is updated.
59
60       on-scroll-up:
61            typeof: string
62            Command to execute when scrolling up on the module.
63
64       on-scroll-down:
65            typeof: string
66            Command to execute when scrolling down on the module.
67
68       smooth-scrolling-threshold:
69            typeof: double
70            Threshold to be used when scrolling.
71
72       tooltip:
73            typeof: bool
74            default: true
75            Option to disable tooltip on hover.
76
77       tooltip-format:
78            typeof: string
79            default: "{used} out of {total} used ({percentage_used}%)"
80            The format of the information displayed in the tooltip.
81

FORMAT REPLACEMENTS

83       {percentage_used}: Percentage of disk in use.
84
85       {percentage_free}: Percentage of free disk space
86
87       {total}: Total amount of space on the disk, partition or mountpoint.
88
89       {used}: Amount of used disk space.
90
91       {free}: Amount of available disk space for normal users.
92
93       {path}: The path specified in the configuration.
94

EXAMPLES

96           "disk": {
97                "interval": 30,
98                "format": "{percentage_free}% free on {path}",
99           }
100

STYLE

102       ·   #disk
103
104
105
106                                  2021-02-10                    waybar-disk(5)
Impressum