aditya/dwmbar
1
0
Fork 0
mirror of https://git.adityakumar.xyz/dwmbar.git synced 2024-09-19 19:03:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Proofreading...

Browse source
This commit is contained in:
Archie Hilton (thytom) 2019-10-22 22:36:13 +01:00
parent e71d3f04ad
commit 6da30bc553
1 changed files with 29 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
README.md
View file

@ -12,14 +12,14 @@ dwmbar, which can be installed with your favourite aur helper, or manually.
Please see the [archwiki Please see the [archwiki
page](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages) page](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages)
for how to manually install packages. for how to manually install AUR packages.
## Manual Installation ## Manual Installation
```bash ```bash
$ git clone https://github.com/thytom/dwmbar $ git clone https://github.com/thytom/dwmbar
$ cd dwmbar $ cd dwmbar
$ sudo install.sh $ sudo ./install.sh
``` ```
# Usage # Usage
@ -54,13 +54,13 @@ move the bar away from the right edge, or even text. By default, we set
### About dwmbarrc ### About dwmbarrc
**Because we expect people to modify `dwmbarrc`, and so we will never update **Because we expect people to modify `dwmbarrc`, we will never update it.
it. dwmbar will automatically create it if it is not there, but once it is dwmbar will automatically create it if it is not there, but once it is there,
there, it must be deleted for another up-to-date version to be given.** it must be deleted for another up-to-date version to be given.**
Interestingly, so long as dwmbarrc prints *something* to stdout, it does not Interestingly, so long as dwmbarrc prints *something* to stdout, it does not
matter what it's written in, or what it does. So if you want to write your own matter what it's written in, or what it does. So if you want to write your own
implementation and use that, go nuts :smile:. implementation and use that, go nuts.
## Writing Modules ## Writing Modules
@ -77,32 +77,29 @@ Modules can be written in any language, so long as they are executable and
print their output to stdout. print their output to stdout.
Currently available default modules are: Currently available default modules are:
- archupdates Gets the number of updates available **Arch Linux Only** - archupdates &tab&tabGets the number of updates available **Arch Linux Only**
- backlight Shows the brightness of the screen - backlight &tab&tabShows the brightness of the screen
- battery Gets battery percentage - battery &tab&tabGets battery percentage
- bluetooth Shows bluetooth status - bluetooth &tab&tabShows bluetooth status
- cpuload Shows the CPU load in % - cpuload &tab&tabShows the CPU load in %
- date Shows the calendar date - date &tab&tabShows the calendar date
- daypercentage Shows how far through the day you are, in % - daypercentage &tab&tabShows how far through the day you are, in %
- disksize Shows the disk usage - disksize &tab&tabShows the disk usage
- ethernet Shows ethernet connection - ethernet &tab&tabShows ethernet connection
- internet Shows whether internet is available (TODO) - internet &tab&tabShows whether internet is available (TODO)
- mail Shows how much mail you have - mail &tab&tabShows how much mail you have
- mpd Shows MPD status - mpd &tab&tabShows MPD status
- ram Shows RAM usage - ram &tab&tabShows RAM usage
- redshift Shows current screen temperature from Redshift - redshift &tab&tabShows current screen temperature from Redshift
- sunmoon Displays a sun or moon for time of day - sunmoon &tab&tabDisplays a sun or moon for time of day
- temperature Displays the temperature of the CPU - temperature &tab&tabDisplays the temperature of the CPU
- time Displays time - time &tab&tabDisplays time
- todo Prints the number of todos for the "t" todo manager - todo &tab&tabPrints the number of todos for the "t" todo manager
- tor Prints if the tor service is enabled - tor &tab&tabPrints if the tor service is enabled
- volume Prints volume in % - volume &tab&tabPrints volume in %
- volumebar Displays a volume bar - volumebar &tab&tabDisplays a volume bar
- weather Shows weather info - weather &tab&tabShows weather info
- wifi Shows wifi connection - wifi &tab&tabShows wifi connection
# Possible Features # Possible Features