Skip to content

Mounts Module

Sam edited this page Aug 7, 2024 · 3 revisions

The mounts module displays information about your connected and mounted drives/partitions. It creates a new line for each mount.

Using

Insert into the modules array.

Configuration

  • title -> (String) The module title for each drive. Check below to see available placeholders.
  • format -> (String) The format used for each drive. Check below to see available placeholders.
  • ignore -> (String Array) Any mount points to ignore and not display.
  • title_color -> (Optional/String) Override the title color to be used.
  • title_bold -> (Optional/Bool) Make the title bold.
  • title_italic -> (Optional/Bool) Make the title italic.
  • separator -> (Optional/Char) Override the separator to be used.
  • progress_left_border -> (Optional/Char) The left border character of the progress bar.
  • progress_right_border -> (Optional/Char) The right border character of the progress bar.
  • progress_progress -> (Optional/Char) The character used to fill in the progress bar.
  • progress_empty -> (Optional/Char) The character used to fill in empty space in the progress bar.
  • progress_target_length -> (Optional/Number) The target length of the progress bar.
  • use_ibis -> (Optional/Bool) Override whether to display in 'ibibytes instead of 'gabytes.
  • decimal_places -> (Optional/Number) Override the decimal places to be displayed.
title placeholders;
  • {device} -> The device name, e.g /dev/sda
  • {mount} -> The mount point for the device e.g /home/hdd
format placeholders;
  • {device} -> The device name, e.g /dev/sda
  • {mount} -> The mount point for the device e.g /home/hdd
  • {space_used} -> The space used on the mount.
  • {space_avail} -> The space available on the mount.
  • {space_total} -> The total space on the mount.
  • {bar} -> A progress bar display for the space on the mount.
  • {percent} -> The percentage of space used on the mount.
Default Configuration
[mounts]
title = "Disk ({mount})"
format = "{space_used} used of {space_total} ({percent})"
ignore = [
    # Filesystems
    "tmpfs", 
    "fuse", 
    "binfmt", 
    "configfs", 
    "debugfs", 
    "mqueue", 
    "tracefs", 
    "hugetlbfs", 
    "bpf", 
    "pstore", 
    "cgroup", 
    "dev", 
    "securityfs", 
    "autofs", 
    "efivar", 
    "sys", 
    "proc", 
    "swap", 
    "ramfs", 

    # Mounts
    "/boot/",     # Boot partition 
    "/snap/",     # Snap
    # Android-Specific Ignored Mounts
    # I have no idea what these do, they just seem to be irrelevant to my termux environment
    "/sys/",
    "/apex/",
    "/dev/",
    "/cache",
    "/data",
    "/product",
    "/prism",
    "/omr",
    "/odm",
    "/efs",
    "/optics",
    "/vendor",
    "/metadata",
    "/system"
]

Example

modules = [
    "mounts"
]

[mounts]
title = "Mount {device}"
format = "{space_used} / {space_total} (Using {percent})"
ignore = ["/boot", "/snap"]