[bbkeys -- read me first file.  2019-09-09]: #

bbkeys
===============

Package `bbkeys-0.9.2` was released under MIT license 2019-09-09.

This package provides the classic bbkeys utility for setting key
bindings for GNOME/WMH and NetWM/EWMH compliant window managers that
do not provide a key binding mechanism of their own.

Release
-------

This is the `bbkeys-0.9.2` package, released 2019-09-09.  This release, and
the latest version, can be obtained from [GitHub][1], using a command such as:

    $> git clone https://github.com/bbidulock/bbkeys.git

Please see the [NEWS][3] file for release notes and history of user visible
changes for the current version, and the [ChangeLog][4] file for a more
detailed history of implementation changes.  The [TODO][5] file lists features
not yet implemented and other outstanding items.

Please see the [INSTALL][7] file for installation instructions.

When working from `git(1)`, please use this file.  An abbreviated
installation procedure that works for most applications appears below.

This release is published under the MIT/X Consortium
License that can be found in the file [LICENSE][8].
This release is published under GPLv3.  Please see the license
in the file [COPYING][9].


Quick Start
-----------

The quickest and easiest way to get `bbkeys` up and running is to run the
following commands:

    $> git clone https://github.com/bbidulock/bbkeys.git
    $> cd bbkeys
    $> ./autogen.sh
    $> ./configure
    $> make
    $> make DESTDIR="$pkgdir" install

This will configure, compile and install `bbkeys` the quickest.  For those who
like to spend the extra 15 seconds reading `./configure --help`, some compile
time options can be turned on and off before the build.

For general information on GNU's `./configure`, see the file [INSTALL][7].


Running
-------

Read the manual page after installation:

    man bbkeys


Issues
------

Report issues on GitHub [here][2].



[1]: https://github.com/bbidulock/bbkeys
[2]: https://github.com/bbidulock/bbkeys/issues
[3]: https://github.com/bbidulock/bbkeys/blob/master/NEWS
[4]: https://github.com/bbidulock/bbkeys/blob/master/ChangeLog
[5]: https://github.com/bbidulock/bbkeys/blob/master/TODO
[6]: https://github.com/bbidulock/bbkeys/blob/master/COMPLIANCE
[7]: https://github.com/bbidulock/bbkeys/blob/master/INSTALL
[8]: https://github.com/bbidulock/bbkeys/blob/master/LICENSE
[9]: https://github.com/bbidulock/bbkeys/blob/master/COPYING

[ vim: set ft=markdown sw=4 tw=80 nocin nosi fo+=tcqlorn spell: ]: #
