Constantin Fürst 2 years ago
parent
commit
d9dfe5d085
  1. 7
      README.md
  2. 4
      config.h

7
README.md

@ -1,11 +1,8 @@
# Keympp
This is a complete rework of keym https://github.com/cwkx/keym adding no new features but providing - from my point of view - a better user experience. Its customization will be familiar to users of suckless-dwm. Inspiration was taken from there. See https://dwmsuckless.org/ for a great tiling window manager.
This is a complete rework of keym https://github.com/cwkx/keym adding no new features but providing - from my point of view - a better user experience. Its customization will be familiar to users of suckless-dwm. Inspiration was taken from there. See https://dwm.suckless.org/ for a great tiling window manager.
## Installation
A Makefile is provided and should be modified depending on X11-library locations. Its default is FreeBSD and there is a hint for compiling under OpenBSD. Other platforms are on their own. A quick search will turn up the correct folder.
## Usage
Execute the resulting binary (a mapping e.g. to ``MODKEY + m`` is very useful). It should spin up immeadiately and provides somewhat vim-esque keybindings. These can be changed in config.h to suit your needs. Here are the defaults: The mouse is moved by pressing ``h`` (left) ``j`` (down) ``k`` (up) ``l`` (right). The mouse buttons are ``f`` (left) ``g`` (right) ``d`` (middle). Scrolling is achieved with ``m`` (down) ``i`` (up). There are also two speed-modifiers: holding down ``s`` makes the cursor move quicker, ``a`` slows it down. The application may be quit with ``q``. While using the mouse you can use any keys not mapped by keympp. If you require any of the ones used in parallel with keympp, remapping them is the solution.
## Issues
There is basically only one issue. Using this program will break your Session somewhat. Restarting the Client alone is therefore impossible. A reboot must be carried out. Someone more experienced with X11 will surely find the issue (that also persists in keym) quickly.
Execute the resulting binary (a mapping e.g. to ``MODKEY + m`` is very useful). It should spin up immeadiately and provides somewhat vim-esque keybindings. These can be changed in config.h to suit your needs. Here are the defaults: The mouse is moved by pressing ``h`` (left) ``j`` (down) ``k`` (up) ``l`` (right). The mouse buttons are ``f`` (left) ``g`` (right) ``d`` (middle). Scrolling is achieved with ``m`` (down) ``i`` (up). There are also two speed-modifiers: holding down ``s`` makes the cursor move quicker, ``a`` slows it down. The application may be quit with ``q``. While using the mouse you can use any keys not mapped by keympp. If you require any of the ones used in parallel with keympp, remapping them is the solution.

4
config.h

@ -1,7 +1,3 @@
/* copyright Constantin Fürst 2021, licensed under GPLv3, a copy is provided in LICENSE */
/* non-major portions of the code were taken from DWM (https://dwm.suckless.org) */
/* inspired and named after keym by Chris Willcocks (https://github.com/cwkx/keym) */
#pragma once
#include <X11/keysym.h>

Loading…
Cancel
Save