wmii

git clone git://oldgit.suckless.org/wmii/
Log | Files | Refs | README | LICENSE

README (2575B)

      1 
      2 This is a modified version of sunaku's wmiirc, designed for
      3 his Rumai Ruby module. Minor configuration changes, namely to
      4 the color scheme and default key bindings, as well as the
      5 configuration search path, exist in this version. Builtin mpd
      6 support has also been removed. Also added is support for
      7 string interpolation in key bindings, as should be apparent in
      8 the included config.yaml.
      9 
     10 In particular, not that there is no need to copy any files to
     11 @LOCALCONF@ other than config.yaml. The script will happily load
     12 the requisite files from their default install location. They
     13 can be loaded either by involing wmii as follows:
     14 
     15     wmiir -r ruby/wmiirc
     16 
     17 or running the following after startup:
     18 
     19     wmiir xwrite /ctl spawn ruby/wmiirc
     20 
     21 The rumai gem is still required, as noted below.
     22 
     23 The original readme appears below unmodified:
     24 
     25 sunaku's Ruby wmiirc
     26 ====================
     27 
     28 This is my wmii configuration, described in these articles:
     29 
     30   http://wmii.suckless.org/alternative_wmiirc_scripts
     31 
     32   http://snk.tuxfamily.org/lib/rumai/
     33 
     34   http://article.gmane.org/gmane.comp.window-managers.wmii/1704
     35 
     36   http://snk.tuxfamily.org/web/2006-07-01-wmii-3-1-configuration-in-ruby.html
     37 
     38 Dependencies:
     39 
     40     wmii 3.6 or newer (preferably wmii-hg)
     41 
     42     Ruby 1.8.6 or newer
     43 
     44     RubyGems 1.3.1 or newer
     45 
     46 Installation:
     47 
     48     # library
     49     gem install rumai     # required
     50     gem install librmpd   # optional
     51 
     52     # install
     53     mv @LOCALCONF@ @LOCALCONF@.backup
     54     git clone git://github.com/sunaku/wmiirc.git @LOCALCONF@
     55 
     56     # choose
     57     cd @LOCALCONF@
     58     git checkout --track -b CHOICE origin/CHOICE # choices are:
     59 
     60     +--------+------------------------------------------------+
     61     | CHOICE | DESCRIPTION                                    |
     62     +--------+------------------------------------------------+
     63     | dvorak | sunaku's personal configuration; DSK friendly! |
     64     | qwerty | QWERTY port of sunaku's personal configuration |
     65     | strict | port of the default wmiirc shipped with wmii   |
     66     | master | barebones template for starting from scratch   |
     67     +--------+------------------------------------------------+
     68 
     69     # run
     70     @LOCALCONF@/wmiirc
     71 
     72 Documentation:
     73 
     74     # see list of all key bindings
     75     egrep '^ +\$\{\w+\}' @LOCALCONF@/config.yaml
     76 
     77     # read the configuration file
     78     less @LOCALCONF@/config.yaml
     79 
     80 Configuration:
     81 
     82     Edit @LOCALCONF@/config.yaml to your liking.
     83 
     84     Run @LOCALCONF@/wmiirc to apply your changes.
     85 
     86 Contribution:
     87 
     88     Fork this project on GitHub and send pull requests.
     89 
     90 Questions:
     91 
     92     Send me an e-mail (see LICENSE for my address).
     93