Go to file
Aditya Kumar f5fb45c2c3 use acpilight 2023-03-01 14:19:30 +05:30
modules use acpilight 2023-03-01 14:19:30 +05:30
res Updated picture 2019-11-06 16:10:04 +00:00
COPYING Moved LICENSE to COPYING in compliance with FSF 2019-10-23 15:22:40 +01:00
README.md remove message about project inactivity 2023-03-01 13:39:36 +05:30
bar.sh quotes prevent glob and word splitting + spelling 2023-01-02 13:59:13 -05:00
config quotes prevent glob and word splitting + spelling 2023-01-02 13:59:13 -05:00
dwmbar keep config in user directory 2023-03-01 13:35:35 +05:30
install.sh keep config in user directory 2023-03-01 13:35:35 +05:30
todo.md Added todo item 2019-11-06 15:54:39 +00:00
uninstall.sh Added copyright and license notice at the top of main files 2019-10-23 15:28:41 +01:00

README.md

dwmbar - A Modular Status Bar for dwm

Example image

dwmbar is a very simple status bar written for dwm.

Installation

Prerequisites

While some modules will work without these dependencies, we recommend grabbing the ones you want for specific modules.

Highly Recommended:

  • Any patched Nerd Font for icons.

Optional (By module):

See module prerequisites.

Arch Linux

There is an AUR package for dwmbar, which can be installed with your favourite aur helper, or manually.

Please see the archwiki page for how to manually install AUR packages.

Manual Installation

$ git clone https://github.com/thytom/dwmbar
$ cd dwmbar
$ sudo ./install.sh

Usage

dwmbar works by setting the root window name, which dwm displays. It does this by calling the dwmbarrc file in your .config/dwmbar folder.

Add the line dwmbar & to your .xinitrc file to run on startup. You can also run dwmbar in terminal for testing purposes.

Customisation

Configuring the Bar

Most non-modular configuration is done in ~/.config/dwmbar/dwmbarrc, a bash script that calls scripts in turn, caching their output and then constructing the bar from that.

To add a module to the bar, simply include its name in the MODULES variable:

MODULES="mpd volumebar wifi battery"

Modules are displayed left-to-right in the order they are written in MODULES. By default, they are delimited by the SEPARATOR variable, which you can change.

We also offer a PADDING variable, which contains a string you can include at the start of your bar, on the very right. This can either be padding spaces, to move the bar away from the right edge, or even text. By default, we set PADDING to $USER@$HOSTNAME. Feel free to change this.

Writing Modules

Default modules are located within /usr/share/dwmbar/modules, and custom modules can be placed in ~/.config/dwmbar/modules/custom. If a default module exists with the same name as a custom module, then the custom module will take precedence.

Default modules will possibly be overwritten during updates, so if you want to modify them be sure to make a copy in the custom folder, which will not be touched, and edit it there.

Modules can be written in any language, so long as they are executable and print their output to stdout.

Currently available default modules are:

  • archupdates - Gets the number of updates available Arch Linux Only
  • backlight - Shows the brightness of the screen
  • battery - Gets battery percentage
  • bluetooth - Shows bluetooth status
  • cpuload - Shows the CPU load in %
  • date - Shows the calendar date
  • daypercentage - Shows how far through the day you are, in %
  • disksize - Shows the disk usage
  • ethernet - Shows ethernet connection
  • fanspeed - Shows the rpm of your main fan
  • hostname - Shows your current user and hostname
  • internet - Shows whether internet is available (TODO)
  • kernel - Shows the kernel version
  • localip - Shows your local IP address
  • mail - Shows how much mail you have
  • mpd - Shows MPD status
  • networkdowntraffic - Gets the download traffic in Kb/s
  • networkuptraffic - Gets the upload traffic in Kb/s
  • publicip - Shows your public IP address
  • ram - Shows RAM usage
  • redshift - Shows current screen temperature from Redshift
  • sunmoon - Displays a sun or moon for time of day
  • temperature - Displays the temperature of the CPU
  • time - Displays time
  • todo - Prints the number of todos for the "t" todo manager
  • tor - Prints if the tor service is enabled
  • voidupdates - Gets the number of updates available Void Linux Only
  • volumebar - Displays a volume bar
  • volume - Prints volume in %
  • weather - Shows weather info
  • wifi - Shows wifi connection

Module Prerequisites

See Module Dependencies

  • archupdates
    • Arch Linux
    • yay
    • pacman-contrib
  • backlight
    • light
  • bluetooth
    • bluez
  • fanspeed - lm_sensors
  • mail
  • mpd
    • mpd
    • mpc
  • publicip
    • curl
  • redshift
    • redshift
  • sunmoon
    • redshift
  • temperature
    • lm_sensors
  • todo
  • tor
    • tor
  • voidupdates
    • xbps package manager
  • volume
    • pulseaudio
  • volumebar
    • pulseaudio
  • weather
    • curl
    • Internet connection
  • wifi
    • Wifi card

Feature Wishlist

  • Paralellised Modules
    • Some modules are slower than others. Have modules set a DELAY variable; if they don't have one, use a default.
    • Modules are called and bar is updated when a module finishes, but an internal bar clock updates the clock at a specific delay.