aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 78e1ce905f6a0f23fb50d1d64edda87161f74a4f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
st - simple terminal
====================

About
-----

`st` is a simple terminal emulator for X which sucks less. Though it works find
in Wayland as well (with XWayland mind you :-) ).

Main differences with normal branch:

 * patched to have scrollback with basic mousewheel function (Shift+Mousewheel)
 * patched to support *old schoool* clipboard interaction - in Wayland this does
   not work well, yet
 * Personalisation of `config.def.h` 


Requirements
------------

In order to build st you need the Xlib header files.


Installation
------------

Edit config.mk to match your local setup (st is installed into
the /usr/local namespace by default).

Afterwards enter the following command to build and install st (if
necessary as root):

``` bash
make clean install
```

Additionally I have created a PKGBUILD under `archlinux/` for building and
installing on ArchLinux.

Running st
----------

If you did not install st with make clean install, you must compile
the st terminfo entry with the following command:

    tic -sx st.info

See the man page for additional details.

Credits
-------

Based on Aurélien APTEL <aurelien dot aptel at gmail dot com> bt source code.