cmdtree

A trie command launcher for X11
git clone git://jb55.com/cmdtree
Log | Files | Refs | README | LICENSE

README.md (1257B)


      1 
      2 cmdtree
      3 =======
      4 
      5 ![cmdtree](https://jb55.com/s/cmdtree.png?)
      6 
      7 ![cmdtree2](https://jb55.com/s/cmdtree2.png?)
      8 
      9 cmdtree is a command launcher in the form of a tree. Commands are launched by a
     10 sequence of keys that form a path in this tree.
     11 
     12 Configuring cmdtree currently requires you to edit a C header file, similar to
     13 dmenu. You will need to tweak [cfg.def.h](cfg.def.h) to your liking before
     14 building. ~This is temporary until the configuration file format is complete~,
     15 but it has the benefit of being quite fast to launch!
     16 
     17 If you're curious, you can check out [my config here](https://github.com/jb55/cmdtree/blob/my-config/cfg.def.h)
     18 
     19 Installing
     20 ----------
     21 
     22 First customize [cfg.def.h](cfg.def.h) to include your menu items.
     23 
     24 libX11 and libXft are required. Once you have those installed, simply type:
     25 
     26     make && make install
     27 
     28 To launch `cmdtree` with a key binding, use something like
     29 [xbindkeys](https://wiki.archlinux.org/index.php/Xbindkeys)
     30 
     31 
     32 Key Bindings
     33 ------------
     34 
     35 ```
     36 ESC         quit
     37 Backspace   go up one level
     38 ```
     39 
     40 
     41 Shout-outs
     42 ----------
     43 
     44 Thanks to the dmenu developers I was able to reuse and repurpose their drw_
     45 machinery for cmdtree! This project shares dmenu's [LICENSE](LICENSE) as much of
     46 the code was ported from there. Thanks!