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       max-length:
35            typeof: integer
36            The maximum length in character the module should display.
37
38       on-click:
39            typeof: string
40            Command to execute when clicked on the module.
41
42       on-click-middle:
43            typeof: string
44            Command to execute when middle-clicked on the module using mouse‐
45       wheel.
46
47       on-click-right:
48            typeof: string
49            Command to execute when you right clicked on the module.
50
51       on-scroll-up:
52            typeof: string
53            Command to execute when scrolling up on the module.
54
55       on-scroll-down:
56            typeof: string
57            Command to execute when scrolling down on the module.
58
59       smooth-scrolling-threshold:
60            typeof: double
61            Threshold to be used when scrolling.
62
63       tooltip:
64            typeof: bool
65            default: true
66            Option to disable tooltip on hover.
67
68       tooltip-format:
69            typeof: string
70            default: "{used} out of {total} used ({percentage_used}%)"
71            The format of the information displayed in the tooltip.
72

FORMAT REPLACEMENTS

74       {percentage_used}: Percentage of disk in use.
75
76       {percentage_free}: Percentage of free disk space
77
78       {total}: Total amount of space on the disk, partition or mountpoint.
79
80       {used}: Amount of used disk space.
81
82       {free}: Amount of available disk space for normal users.
83
84       {path}: The path specified in the configuration.
85

EXAMPLES

87           "disk": {
88                "interval": 30,
89                "format": "{percentage_free}% free on {path}",
90           }
91

STYLE

93       ·   #disk
94
95
96
97                                  2020-04-11                    waybar-disk(5)