waybar-disk(5)

🌸 waybar-disk(5) 🌸

okay bestie, welcome to the disk module of waybar β€” yeah that waybar, the one that makes your bars look like a whole aesthetic ✨ This page is the File Formats Manual entry for it, and we're gonna get you fully acquainted, no cap πŸ’…


πŸŽ€ NAME πŸŽ€

waybar β€” the disk module. she's the one that tells you how much of your disk is currently spoken for 🫢


πŸ’– DESCRIPTION πŸ’–

The disk module displays the current disk space used.

that's it. that's the whole job. she shows you the disk usage and she does it gorgeously. main character energy fr fr πŸ‘‘


✨ CONFIGURATION ✨

Addressed by disk

like, that's her name in the config, that's how you call her over πŸ’œ


  • path β€” typeof: string, default: "/" Any path residing in the filesystem or mountpoint for which the information should be displayed. so like, point her at whatever mount you're nosy about πŸ¦‹
  • interval β€” typeof: integer, default: 30 The interval in which the information gets polled. every how-many-seconds she goes and peeks, basically ⏱️
  • format β€” typeof: string, default: "{percentage_used}%" The format, how information should be displayed. this is where you make it cute 🌸
  • rotate β€” typeof: integer Positive value to rotate the text label (in 90 degree increments). vertical bar girlies rise πŸ™ˆ
  • states β€” typeof: object A number of disk utilization states that get activated on certain percentage thresholds (percentage_used). See waybar-states(5). yes, you can make her change color when things get dire πŸ’€
  • max-length β€” typeof: integer The maximum length in character the module should display.
  • min-length β€” typeof: integer The minimum length in characters the module should accept.
  • align β€” typeof: float 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. very demure, very mindful πŸ“
  • justify β€” typeof: string The alignment of the text within the module's label, allowing options 'left', 'right', or 'center' to define the positioning.
  • on-click β€” typeof: string Command to execute when clicked on the module.
  • on-click-middle β€” typeof: string Command to execute when middle-clicked on the module using mousewheel.
  • on-click-right β€” typeof: string Command to execute when you right-click on the module.
  • on-update β€” typeof: string Command to execute when the module is updated.
  • 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. she wants to tell you things when you hover, but you can tell her to hush 🫒
  • tooltip-format β€” typeof: string, default: "{used} out of {total} used ({percentage_used}%)" The format of the information displayed in the tooltip.
  • unit β€” typeof: string Use with specific_free, specific_used, and specific_total to force calculation to always be in a certain unit. Accepts kB, kiB, MB, Mib, GB, GiB, TB, TiB. (yes bestie those are written exactly like that, copy them character for character, i don't make the rules 😭)
  • menu β€” typeof: string Action that popups the menu.
  • menu-file β€” typeof: string Location of the menu descriptor file. There need to be an element of type
GtkMenu with id menu
  • menu-actions β€” typeof: array The actions corresponding to the buttons of the menu.
  • expand β€” typeof: bool, default: false Enables this module to consume all left over space dynamically. she's hungry, she wants the whole bar πŸ”₯

🌈 FORMAT REPLACEMENTS 🌈

these are the little magic words you drop inside format and tooltip-format β€” swap them in and she'll fill them out for you πŸ’«

  • {percentage_used}: Percentage of disk in use.
  • {percentage_free}: Percentage of free disk space
  • {total}: Total amount of space on the disk, partition, or mountpoint. Automatically selects unit based on size remaining.
  • {used}: Amount of used disk space. Automatically selects unit based on size remaining.
  • {free}: Amount of available disk space for normal users. Automatically selects unit based on size remaining.
  • {path}: The path specified in the configuration.
  • {specific_total}: Total amount of space on the disk, partition, or mountpoint in a specific unit. Defaults to bytes.
  • {specific_used}: Amount of used disk space in a specific unit. Defaults to bytes.
  • {specific_free}: Amount of available disk space for normal users in a specific unit. Defaults to bytes.

πŸ’• EXAMPLES πŸ’•

exhibit a, the lowkey version:

"disk": {
     "interval": 30,
     "format": "{percentage_free}% free on {path}",
}

exhibit b, the specific-unit version, with her own little comment showing you what it renders as πŸ‘‡

"disk": {
     "interval": 30,
     "format": "{specific_free:0.2f} GB out of {specific_total:0.2f} GB available. Alternatively {free} out of {total} available",
     "unit": "GB"
     // 1434.25 GB out of 2000.00 GB available. Alternatively 1.4TiB out of 1.9TiB available.
}

πŸ‘‘ STYLE πŸ‘‘

  • #disk

that's the CSS selector bestie, go make her pretty πŸŽ€


and that's the whole page!! you're now officially a disk module expert, i don't make the rules, slay πŸ’…βœ¨

signing off from the File Formats Manual, dated 2026-02-08, this was waybar-disk(5) β€” mwah, go check your disk space πŸ¦‹πŸ’–

πŸ“¦ where this page comes from