README

   1 evilwm 1.1 by Ciaran Anscomb <evilwm@6809.org.uk>
   2
   3 evilwm is a minimalist window manager for the X Window System.
   4
   5 The name evil came from Stuart 'Stuii' Ford, who thinks that any software
   6 I use must be evil and masochistic.  In reality, this window manager is
   7 clean and easy to use.
   8
   9
  10 FEATURES
  11
  12  * No window decorations apart from a simple 1 pixel border.
  13  * No icons.
  14  * Good keyboard control, including repositioning and maximise toggles.
  15  * Solid window drags (optional - may be slow on old machines).
  16  * Virtual desktops.
  17  * Small binary size (even with everything turned on).
  18  * Reasonable EWMH support (though not yet fully compliant).
  19  * Configuration file read on startup.
  20
  21
  22 INSTALLATION
  23
  24 Please see the file INSTALL for details on building evilwm.
  25
  26
  27 STARTING EVILWM
  28
  29 If you're using a standard X desktop, you can start evilwm by just
  30 changing your ~/.xinitrc file.  Here's a pretty standard sample file:
  31
  32 -----CUT HERE-----
  33 [ -f $HOME/.Xdefaults ] && xrdb $HOME/.Xdefaults
  34 xsetroot -solid \#400040 -cursor_name top_left_arrow
  35 /usr/bin/evilwm -snap 10 &
  36 exec xclock -digital -padding 2 -g -0+0
  37 -----CUT HERE-----
  38
  39 Note that in this case 'xclock' is the magic process (the one that if
  40 you kill it, your session dies).  You could change it around and have
  41 evilwm be your magic process if you prefer.  Also note that it sets the
  42 cursor shape and background colour with standard X tools (evilwm won't
  43 do this for you - the tools already exist!).
  44
  45 If you use the GNOME session manager, you can configure it to
  46 use evilwm as its window manager.  Run gconf-editor and set the
  47 key /desktop/gnome/session/required_components/windowmanager
  48 to "evilwm".  It is probably also a good idea to set the key
  49 /desktop/gnome/session/required_components/filemanager to an empty string,
  50 as nautilus (the default) will try to create its own desktop backdrop as
  51 a full-screen window, and evilwm does not treat these windows specially.
  52
  53
  54 CONTROLS
  55
  56 You can use the mouse to manipulate windows either by click/dragging
  57 the 1 pixel border, or by holding down Alt and doing so anywhere in the
  58 client window.  The controls are:
  59
  60 Button 1        Move window.
  61 Button 2        Resize window.
  62 Button 3        Lower window.
  63
  64 Most keyboard controls are used by holding down Control and Alt, then
  65 pressing a key.  Available functions are:
  66
  67 Return          Spawn new xterm.
  68 Escape          Delete current window.
  69 Insert          Lower current window.
  70 H, J, K, L      Move window left, down, up or right (16 pixels).
  71                 Holding Shift resizes the window instead.
  72 Y, U, B, N      Move window to top-left, top-right, bottom-left or
  73                 bottom-right of screen.
  74 I               Show information about current window.
  75 Equals          Maximise current window vertically (toggle).
  76 X               Maximise current window (toggle).
  77 D               Toggle visible state of docks (e.g., pagers and launch bars).
  78
  79 If compiled with virtual desktop support, these functions are also
  80 available:
  81
  82 F               Fix or unfix window.
  83 1 - 8           Switch virtual desktop.
  84 Left            Previous virtual desktop.
  85 Right           Next virtual desktop.
  86
  87 In addition to the above, Alt+Tab can be used to cycle through windows
  88 on screen.
  89
  90
  91 ACKNOWLEDGEMENTS
  92
  93 The original code base for this project was that of aewm by Decklin
  94 Foster.  His code is very clean and, in later versions, very well
  95 commented.  I'd recommend it if you want to learn more about window
  96 manager theory (or indeed want title bars, etc ;).
  97
  98 http://www.red-bean.com/~decklin/aewm/
  99                 - aewm homepage
 100
 101
 102 LICENCE
 103
 104 evilwm 1.1
 105 Copyright (C) 1999-2009 Ciaran Anscomb <evilwm@6809.org.uk>
 106
 107 This is free software.  You can do what you want to it, but if it
 108 breaks something, you get to pay for the counselling.  The code was
 109 originally based on aewm, so this is distributed under the same terms,
 110 which follow.
 111
 112
 113 AEWM LICENCE
 114
 115 Copyright (c) 1998-2000 Decklin Foster.
 116
 117 THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS", WITHOUT ANY EXPRESS
 118 OR IMPLIED WARRANTIES OF ANY KIND. IN NO EVENT SHALL THE AUTHOR BE
 119 HELD LIABLE FOR ANY DAMAGES CONNECTED WITH THE USE OF THIS PROGRAM.
 120
 121 You are granted permission to copy, publish, distribute, and/or sell
 122 copies of this program and any modified versions or derived works,
 123 provided that this copyright and notice are not removed or altered.
 124
 125 Portions of the code were based on 9wm, which contains this license:
 126
 127 > 9wm is free software, and is Copyright (c) 1994 by David Hogan.
 128 > Permission is granted to all sentient beings to use this software,
 129 > to make copies of it, and to distribute those copies, provided
 130 > that:
 131 >
 132 >     (1) the copyright and licence notices are left intact
 133 >     (2) the recipients are aware that it is free software
 134 >     (3) any unapproved changes in functionality are either
 135 >           (i) only distributed as patches
 136 >       or (ii) distributed as a new program which is not called 9wm
 137 >               and whose documentation gives credit where it is due
 138 >     (4) the author is not held responsible for any defects
 139 >         or shortcomings in the software, or damages caused by it.
 140 >
 141 > There is no warranty for this software.  Have a nice day.