Metadata-Version: 2.1
Name: bunzbar
Version: 0.42
Summary: Display useful information in status bar. Even stabler that the old 0.41 version.
Author: 02742
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Description-Content-Type: text/markdown
License-File: LICENSE

# Bunzbar

## System requirements
+ Linux system where `xsetroot -name {}` is visible. (E.g. Archlinux with Dwm)

## How to get it

+ If you use Archlinux you can get the bunzbar by installing the PKGBUILD file.
+ For other distributions see Manual installation.

## Manual installation

### Install xsetroot
Install the xsetroot package for your disto.

### Get the Python module installed

First of all you need to install the bunzbar python module.
After installing python and pip, use one of the following options to install it.

+  Using pip:
```bash
pip install bunzbar
```
+  From source:
```bash
git clone git@gitlab.com:02742/bunzbar.git
cd bunzbar
pip install build twine
make build
pip install dist/*.whl
```


### Post installation

#### Make the command accessable 

A few options to acceave this

+ Add `~/.local/bin` to your `$PATH` (non persistant)
```bash
export PATH=~/.local/bin:$PATH
```
+ Add it to your `$PATH` using your `.bashrc` file
```bash
echo "export PATH=~/.local/bin:$PATH" >> .bashrc
```
+ Create a link
```bash
ln -s ~/.local/bin/bunzbar /usr/bin/bunzbar
```
+ Get Arch

#### Configuration
You can toggle a info in the bar with the following command:
```bash
bunzbar -it <toogle_name>
```
To get a list of these names simply execute
```bash
bunzbar -il
```
If you want to change an option in the config file you can do that using:
```bash
bunzbar -cs <config_option> <value>
```
Again you can list the config options using:
```bash
bunzbar -cl
```

#### Start bunzbar in daemon mode
For bunzbar to continously update the x root main window name it needs to be started in daemon mode
```bash
bunzbar -d
```

## Links

+ [gitlab](https://gitlab.com/02742/bunzbar/)
+ [pypi](https://pypi.org/project/bunzbar/)
