'W' and 'H' args: width and height
[k8sterm.git] / README
blob4b1fc7cd93b620d21ba16774f4657604d0b66153
1 sterm - simple terminal
2 -----------------------
3 sterm is a simple virtual terminal emulator for X which sucks less.
6 Requirements
7 ------------
8 In order to build sterm you need the Xlib header files.
11 Compiling
12 ---------
13 Download, build and install latest K8Jam from http://repo.or.cz/w/k8jam.git
15 * On Mac OS X, install pkg-config by executing
16 * sudo port install pkg-config
17 * set environment variable
18 * PKG_CONFIG_PATH=/usr/X11/lib/pkgconfig
21 execute
23   jam
25 to configure and
27   jam
29 again to build.
32 Using
33 -----
34 Copy .sterm.rc to ~/.sterm.rc
35 Copy ./sterm to /usr/local/bin
36 Type "sterm" to run sterm in rxvt mode.
37 Type "sterm -T xterm" to run sterm in xterm mode.
40 Configuration
41 -------------
42 sterm searches config files in this order:
44   ~/.sterm.rc
45   ~/.config/sterm.rc
46   /etc/sterm.rc
47   /etc/sterm/sterm.rc
48   ./.sterm.rc
51 Features that will not be added
52 -------------------------------
53   * transparency
54   * ttf font support
55   * scripting
56   * japanese and other strange languages
57   * unnecessary (for me) bloating
60 Credits
61 -------
62 Based on AurĂ©lien APTEL <aurelien dot aptel at gmail dot com> bt source code.
63 Heavily modified by Ketmar // Vampire Avalon (xmpp/email: ketmar@ketmar.no-ip.org)
64 Mac OS X support: vb <vctr.br@mail.ru>