added some comments
[k8sterm.git] / README
blobf6c5d78779939b6c0e0d6b539262f286d9b6d41e
1 st - simple terminal
2 --------------------
3 st is a simple virtual terminal emulator for X which sucks less.
6 Requirements
7 ------------
8 In order to build st you need the Xlib header files.
11 Installation
12 ------------
13 Edit config.mk to match your local setup (st is installed into
14 the /usr/local namespace by default).
16 Afterwards enter the following command to build and install st (if
17 necessary as root):
19     make clean install
22 Running st
23 ----------
24 If you don't install st, define TNAME to "xterm" in config.h or make sure to at
25 least compile st terminfo entry with the following command:
27     tic -s st.info
29 It should print the path of the compiled terminfo entry. You can
30 safely remove it if you don't plan to use st anymore.
31 See the man page for additional details.
33 Credits
34 -------
35 Based on  AurĂ©lien APTEL <aurelien dot aptel at gmail dot com> bt source code.