Configuration file for dwm-bar on macbook air
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

110 lines
3.1 KiB

5 years ago
5 years ago
5 years ago
5 years ago
  1. # dwm-bar
  2. A modular statusbar for DWM
  3. ## Table of Contents
  4. - [Current Functions](#current-functions)
  5. - [dwm_alsa](#dwm_alsa)
  6. - [dwm_countdown](#dwm_countdown)
  7. - [dwm_keyboard](#dwm_keyboard)
  8. - [dwm_resources](#dwm_resources)
  9. - [dwm_cmus](#dwm_cmus)
  10. - [dwm_date](#dwm_date)
  11. - [dwm_mail](#dwm_mail)
  12. - [dwm_weather](#dwm_weather)
  13. - [Installation](#installation)
  14. - [Usage](#usage)
  15. - [Customizing](#customizing)
  16. - [Acknowledgements](#acknowledgements)
  17. - [More to come!](#more-to-come)
  18. ## Current Functions
  19. ### dwm_alsa
  20. Displays the current master volume of ALSA
  21. ```
  22. [🔉 55]
  23. ```
  24. Dependencies: ```alsa-utils```
  25. ### dwm_countdown
  26. Displays the status of [countdown](https://github.com/joestandring/countdown)
  27. ```
  28. [⏳ 00:10:00]
  29. ```
  30. Dependeincies: ```[countdown](https://github.com/joestandring/countdown)```
  31. ### dwm_keyboard
  32. Displays the current keyboard layout
  33. ```
  34. [⌨ gb]
  35. ```
  36. Dependencies: ```xorg-setxkbmap```
  37. ### dwm_resources
  38. Displays information regarding memory, CPU temperature, and storage
  39. ```
  40. [🖥 MEM 1.3Gi/15Gi CPU 45C STO 2.3G/200G: 2%]
  41. ```
  42. ### dwm_cmus
  43. displays current cmus status, artist, track, position, duration, and shuffle
  44. ```
  45. [▶ The Unicorns - Tuff Ghost 0:43/2:56 🔀]
  46. ```
  47. Dependencies: ```cmus```
  48. ### dwm_date
  49. Displays the current date and time
  50. ```
  51. [🕰 Mon 06-05-19 21:31:58]
  52. ```
  53. ### dwm_mail
  54. Displays the current number of emails in an inbox
  55. ```
  56. [📫 2]
  57. ```
  58. ### dwm_weather
  59. Displays the current weather provided by [wttr.in](https://wttr.in)
  60. ```
  61. [☀ +20°C]
  62. ```
  63. ## Installation
  64. 1. Clone and enter the repository:
  65. ```
  66. $ git clone https://github.com/joestandring/dwm-bar
  67. $ cd dwm-bar
  68. ```
  69. 2. Make the script executable
  70. ```
  71. $ chmod +x dwm_bar.sh
  72. ```
  73. ## Usage
  74. Simply run the script and dwm should display your bar:
  75. ```
  76. $ ./dwm_bar.sh
  77. ```
  78. If you would like your bar to be displayed when X starts, add this to your .xinitrc file before launching dwm. For example, if the script is located in /home/$USER/dwm-bar/:
  79. ```
  80. # Statusbar
  81. /home/$USER/dwm-bar/dwm_status.sh &
  82. # Start dwm
  83. exec dwm
  84. ```
  85. ## Customizing
  86. dwm-bar is completley modular, meaning you can mix and match functions to your hearts content. It's functions are located in the functions/ subdirectory and included in dwm_bar.sh
  87. If you want to make your own function, for example dwm_myfunction.sh, you should create it in the functions/ subdirectory before including it in dwm_bar.sh and adding it to the xsetroot command:
  88. ```
  89. # Import the modules
  90. . "$DIR/functions/dwm_myfucntion"
  91. while true
  92. do
  93. xsetroot -name "$(dwm_myfunction)"
  94. sleep 1
  95. done
  96. ```
  97. ## Acknowledgements
  98. Code for some functions was modified from:
  99. * [Klemens Nanni](https://notabug.org/kl3)
  100. * [@boylemic](https://github.com/boylemic/configs/blob/master/dwm_status)
  101. * [Parket Johnson](https://github.com/ronno/scripts/blob/master/xsetcmus)
  102. * [suckless.org](https://dwm.suckless.org/status_monitor/)
  103. ## More to come!
  104. * Ability to choose between showing unicode charachters or plaintext for identifiers in the bar
  105. * dwm_pulse function to control pulseaudio sound
  106. * dwm_bat function to display battery percentage and status
  107. * dwm_notifs function to show the last recieved notification in the bar
  108. * The ability to show network speeds and SSID in dwm_network