JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
Adding the FAQ entry for zsh.
[st.git] / FAQ
1 --
2 Why does st not handle utmp entries?
3
4 Use the excellent tool of utmp[0] for this task.
5
6 [0] http://git.suckless.org/utmp/
7 --
8 Some _random program_ complains that st is unknown/not
9 recognised/unsupported/whatever!
10
11 It means that st doesn’t have any terminfo entry on your system. Chances are
12 you did not make install. If you just want to test it without installing it,
13 you can manualy run tic -s st.info in st dir. It will compile st.info into a
14 fully working local terminfo description. You can delete it when you’re done.
15 --
16 Nothing works, and nothing is said about an unknown terminal!
17
18 * Some programs just assume they’re running in xterm i.e. they don’t rely on
19   terminfo. What you see is the current state of the “xterm compliance”.
20 * Some programs don’t complain about the lacking st description and default to
21   another terminal. In that case see the question about terminfo.
22 --
23 I get some weird glitches/visual bug on _random program_!
24
25 Try lauching it with a different TERM: $ TERM=xterm myapp. toe(1) will give
26 you a list of available terminals, but you’ll most likely switch between
27 xterm, st or st-256color. The default value for TERM can be changed in
28 config.h (TNAME).
29 --
30 How do I scroll back up?
31
32 Invoke st with a screen multiplexer like GNU screen[0] or tmux[1].
33 st -e screen works better for text reflowing. To enter screen’s scroll
34 back mode aka “copy mode”, it’s C-a ESC. You probably want defscrollback
35 10000 in your ~/.screenrc too.
36
37 [0] http://en.wikipedia.org/wiki/GNU_Screen
38 [1] http://en.wikipedia.org/wiki/Tmux
39 --
40 Why doesn't the Del key work in some programs?
41
42 Taken from the terminfo manpage:
43
44         If the terminal has a keypad that transmits codes when the keys
45         are pressed, this information can be given. Note that it is not
46         possible to handle terminals where the keypad only works in
47         local (this applies, for example, to the unshifted HP 2621 keys).
48         If the keypad can be set to transmit or not transmit, tive these
49         codes as smkx and rmkx. Otherwise the keypad is assumed to
50         always transmit.
51
52 In the st case smkx=\E[?1h\E= and rmkx=\E[?1l\E>, so it is mandatory that
53 applications which want to test against keypad keys, have to send these
54 sequences.
55
56 But buggy applications like bash and irssi for example don't do this. A fast
57 solution for them is to use the following command:
58
59         $ printf "\033?1h\033=" >/dev/tty
60
61 or
62         $ echo $(tput smkx) >/dev/tty
63
64 In the case of bash readline is used. Readline has a different note in its
65 manpage about this issue:
66
67         enable-keypad (Off)
68                 When set to On, readline will try to enable the
69                 application keypad when it is called. Some systems
70                 need this to enable arrow keys.
71
72 Adding this option to your .inputrc will fix the keypad problem for all
73 applications using readline.
74
75 If you are using zsh, then read the zsh FAQ
76 (http://zsh.sourceforge.net/FAQ/zshfaq03.html#l25):
77
78         It should be noted that the O / [ confusion can occur with other keys
79         such as Home and End. Some systems let you query the key sequences
80         sent by these keys from the system's terminal database, terminfo.
81         Unfortunately, the key sequences given there typically apply to the
82         mode that is not the one zsh uses by default (it's the "application"
83         mode rather than the "raw" mode). Explaining the use of terminfo is
84         outside of the scope of this FAQ, but if you wish to use the key
85         sequences given there you can tell the line editor to turn on
86         "application" mode when it starts and turn it off when it stops:
87
88                 function zle-line-init () { echoti smkx }
89                 function zle-line-finish () { echoti rmkx }
90                 zle -N zle-line-init
91                 zle -N zle-line-finish
92
93 Putting these lines into your .zshrc will fix the problems.
94 --
95