README

   1 Please read all of this to fully understand options/features of yeahconsole...
   2 Since I'm lazy this  file is also a CHANGELOG...
   3
   4 New in 0.3.4:
   5 Readded the help message (yeahconsole -h).
   6 Resizing the console with the mouse has been improved.
   7
   8 New in 0.3.3:
   9
  10 Support for rxvt-unicode has been added, you can specify
  11 yeahconsole*term:urxvt (or urxvtc if you have urxvtd running) in your .Xdefaults.
  12 An option to restart the terminal has been added (yeahconsole*restart: 1).
  13 All commandline option are passed to the terminal now (if you specify
  14 "-e someprog" it must be the last option)
  15 The autoconf crap has been removed....
  16
  17 Installation: make;make install
  18 Yeahconsole can be configured via xresources:
  19
  20 put something like
  21 yeahconsole*foo:value
  22 in your .Xdefaults.
  23
  24 "foo" can be any standard xresource from xterm (see man xterm) or:
  25
  26 restart:        0 (default) or 1 should the terminal restart?
  27 term:           terminal to use (valid:urxvt, urxvtc, xterm(default))
  28 screenWidth:    width (defaults to display width)
  29 consoleHeight:  number of lines (defaults to 10)
  30 xOffset:        x position (defaults to 0)
  31 aniDelay:       delay for the slide animation (defaults to 40)
  32 stepSize:           step size for the animation (defaults to 1)
  33 handleWidth:    width for the resize handle (defaults to 3)
  34 handleColor:    color for the handle    (defaults to grey70)
  35
  36 Keycombos are specified as follows:
  37
  38 [any combination of "Win" "Alt" "Control" or "None"]+[name of key]
  39
  40 eg. ControlAlt+y,  Control+asciitilde, Win+c, ControlAltWin+y ,None+Menu,....
  41 (the order of modifiers doesn't matter)
  42
  43 toggleKey:      key combo that toggles yeahconsole (defaults to ControlAlt+y)
  44 keyBigger:      increase  height of yeahconsole (default: Control+KP_Add)
  45 keySmaller:     decrease height of yeahconsole (default: Control+KP_Subtract)
  46 keyFull:            toggle fullscreenmode (default: Alt+F11)
  47
  48
  49 xOffset and screenWidth are useful if you use a xinerama setup.
  50 Here is what mine looks like:
  51
  52 yeahconsole*background:black
  53 yeahconsole*foreground:green
  54 yeahconsole*screenWidth:1152
  55 yeahconsole*aniDelay:30
  56 yeahconsole*toggleKey:None+Menu
  57
  58 If you need the name of a "special" key use xev  or have a look in
  59 /usr/include/X11/keysymdef.h.
  60
  61 New in 0.3.2:
  62
  63 Yeahconsole looks up it xresources by its name, that means you can have multiple
  64 instances of yeahconsole with different settings. To make this happen just make
  65 a symbolic link to yeahconsole with a different name, e.g yeahconsole2, and
  66 yeahconsole will look up it's resources in the form "yeahconsole2*foo:value".
  67 You have to specify atleast different toggle keys for all running instances.
  68
  69 A "-e" option has been added to start an initial programm at startup.
  70
  71 The console window can be switched to fullscreen by hitting Alt+F11 (settable via
  72 yeahconsole*keyFull).
  73
  74 A "yeahconsole*stepSize:" option has been added to control the slide animation,
  75 any value greater 0 will be added to the stepsize so the animation will be
  76 faster and less cpu hungry. If you specify 0 the animation is disabled.
  77
  78 New in 0.3.1:
  79 All focus issues got ironed out (I hope so).
  80 A dummy xerror function has been added to avoid crashes.
  81 Modifier and key are now specified with one resource(see below).
  82 Changed resource "height" "consoleHeight" since it interferes with xterm.
  83
  84
  85 New in 0.3:
  86
  87 The console window can now be resized (hit Control + keypad {plus/minus} or
  88 simply drag the grey border with your mouse). Improved focus handling. The
  89 height is now counted in number of lines. Some new xresources (see below).
  90
  91 New in 0.2:
  92
  93 The modifier for the toggle key can now be configured through xresources.You can
  94 also use yeahconsole without a modifier.See below for details.
  95
  96 Yeahconsole puts an xterm window on top of your screen that behaves like a
  97 console found in many games ( similar to kuake). It's visibility can be
  98 toggled by a keyboard shortcut (Control+Alt+y).
  99 You will need xterm version 168 or higher (comes with XFree86 4.2.1) to make
 100 this work.
 101
 102