aboutsummaryrefslogtreecommitdiff
path: root/README
blob: 3f2289dd7944e015fcdb43085fef19e2a2dd077b (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
st - simple terminal (patched)
------------------------------
This is *NOT* a fork of upstream st, it's rebased off of upstream with every
release.

st is a simple terminal emulator for X which sucks less. This repository carries
a few patches that are not applied by default upstream. Those patches are:

 * https://st.suckless.org/patches/xresources/
 * https://st.suckless.org/patches/anysize/
 * https://st.suckless.org/patches/boxdraw/
 * https://st.suckless.org/patches/vertcenter/
 * https://st.suckless.org/patches/clipboard/

The patches are modified as necessary to apply alongside each other or to fix
bugs in the upstream patches.

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):

    make clean install


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.