dwmblocks

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

commit 41cf9cd337661f7761e5d44811bb953d285f079c
parent 67b64a8bd9656c5c6c1691cf5570f9bd7819c17c
Author: Luke Smith <luke@lukesmith.xyz>
Date:   Mon, 25 May 2020 21:14:16 -0400

readme additions

Diffstat:
MREADME.md | 58+++++++++++++++++++++++++++++++++++++++++++---------------
1 file changed, 43 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md @@ -1,18 +1,46 @@ # dwmblocks + Modular status bar for dwm written in c. -# modifying blocks -The statusbar is made from text output from commandline programs. -Blocks are added and removed by editing the blocks.h header file. -# Luke's bulid -I have dwmblocks read my preexisting scripts [here in my dotfiles repo](https://github.com/LukeSmithxyz/voidrice/tree/master/.local/bin/statusbar). -So if you want my build out of the box, download those and put them in your `$PATH`. -I do this to avoid redundancy in LARBS, both i3 and dwm use the same statusbar scripts. -# signalling changes -For example, the audio module has the update signal 10 by default. -Thus, running `pkill -RTMIN+10 dwmblocks` will update it. -# clickable modules -Like i3blocks, this build allows you to build in additional actions into your scripts in response to click events. -See the above linked scripts for examples of this using the `$BLOCK_BUTTON` variable. - -For this feature to work, you need the appropriate patch in dwm as well. See [here](https://gist.github.com/danbyl/54f7c1d57fc6507242a95b71c3d8fdea). + +# Modifying blocks + +The statusbar is made from text output from commandline programs. Blocks are +added and removed by editing the config.h file. + +# Luke's build + +I have dwmblocks read my preexisting scripts +[here in my dotfiles repo](https://github.com/LukeSmithxyz/voidrice/tree/master/.local/bin/statusbar). +So if you want my build out of the box, download those and put them in your +`$PATH`. I do this to avoid redundancy in LARBS, both i3 and dwm use the same +statusbar scripts. + +# Signalling changes + +Most statusbars constantly rerun every script every several seconds to update. +This is an option here, but a superior choice is giving your module a signal +that you can signal to it to update on a relevant event, rather than having it +rerun idly. + +For example, the audio module has the update signal 10 by default. Thus, +running `pkill -RTMIN+10 dwmblocks` will update it. + +You can also run `kill -44 $(pidof dwmblocks)` which will have the same effect, +but is faster. Just add 34 to your typical signal number. + +My volume module *never* updates on its own, instead I have this command run +along side my volume shortcuts in dwm to only update it when relevant. + +Note that if you signal an unexpected signal to dwmblocks, it will probably +crash. So if you disable a module, remember to also disable any cronjobs or +other scripts that might signal to that module. + +# Clickable modules + +Like i3blocks, this build allows you to build in additional actions into your +scripts in response to click events. See the above linked scripts for examples +of this using the `$BLOCK_BUTTON` variable. + +For this feature to work, you need the appropriate patch in dwm as well. See +[here](https://gist.github.com/danbyl/54f7c1d57fc6507242a95b71c3d8fdea). Credit for those patches goes to Daniel Bylinka (daniel.bylinka@gmail.com).