Giter Club home page Giter Club logo

xmonadkeymap's Introduction

Xmonad shourtcut keymap visualizer

View what keys your xmonad currently uses.

How to use:

  • Copy the script.sh file, place it wherever you want, put it on $PATH if you prefer.
  • Copy the Keymap.sh file, add it under the lib folder of your xmonad config or paste it in your xmonad.hs file
  • Add a shortcut to view the keymap:
myKeys conf@XConfig {XMonad.modMask = modm} = M.fromList $
    [ (...)
    , ((modm .|. shiftMask, xK_e), Keymap.viewKeymap (myKeys conf) "/home/yogurt/code/xmonadkeymap/script.sh")
    ]

How it works

This is done through a script file and some haskell code. The idea is that the script file can be used for implementing this functionality in any other WM, as long as it provides a list of key codes that it uses

xkbprint is able to produce a drawing of your keyboard, what's needed is that it colours specific keys.

First, the haskell function collects all keycodes that you use and sends it to the script.

Then, the script looksup through xkbcomp what these keycodes correlate to, in terms of xkb symbols, for example: <AE01> = keycode 10 (key for "1").

After we have those values, xkbprint is ran which generates Postscript, we go through each line of PostScript and when we find the command that draws rectangles for keys, set the color to red and reset it after.

Script dependencies

  • xkbcomp
  • ghostscript (for ps2pdf)
  • xkbprint
  • awk
  • zathura (for viewing pdfs through a UNIX pipe)

TODO: (PR's welcome)

  • Publish to xmonad-contrib
  • make it work for xf86 keys (play, pause, etc)
  • view keys used inside submaps (XMonad.Actions.Submap)
  • configurable colors to display based on modifier keys

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.