update FAQ

[st.git] / FAQ

diff --git a/FAQ b/FAQ
index ee1c154..78c769a 100644 (file)
--- a/FAQ
+++ b/FAQ
@@ -1,12 +1,12 @@
 ## Why does st not handle utmp entries?
 
 ## Why does st not handle utmp entries?
 

-Use the excellent tool of [utmp](http://git.suckless.org/utmp/) for this task.
+Use the excellent tool of [utmp](https://git.suckless.org/utmp/) for this task.

 
 ## Some _random program_ complains that st is unknown/not recognised/unsupported/whatever!
 
 It means that st doesn’t have any terminfo entry on your system. Chances are
 you did not `make install`. If you just want to test it without installing it,
 
 ## Some _random program_ complains that st is unknown/not recognised/unsupported/whatever!
 
 It means that st doesn’t have any terminfo entry on your system. Chances are
 you did not `make install`. If you just want to test it without installing it,

-you can manualy run `tic -s st.info`.
+you can manually run `tic -sx st.info`.

 
 ## Nothing works, and nothing is said about an unknown terminal!
 
 
 ## Nothing works, and nothing is said about an unknown terminal!
 


@@ -15,13 +15,6 @@ you can manualy run `tic -s st.info`.
 * Some programs don’t complain about the lacking st description and default to
   another terminal. In that case see the question about terminfo.
 
 * Some programs don’t complain about the lacking st description and default to
   another terminal. In that case see the question about terminfo.
 

-## I get some weird glitches/visual bug on _random program_!
-
-Try launching it with a different TERM: $ TERM=xterm myapp. toe(1) will give
-you a list of available terminals, but you’ll most likely switch between xterm,
-st or st-256color. The default value for TERM can be changed in config.h
-(TNAME).
-

 ## How do I scroll back up?
 
 Using a terminal multiplexer.
 ## How do I scroll back up?
 
 Using a terminal multiplexer.


@@ -92,7 +85,7 @@ in TERM.
 
 ## I cannot compile st in OpenBSD
 
 
 ## I cannot compile st in OpenBSD
 

-OpenBSD lacks of librt, despite it begin mandatory in POSIX
+OpenBSD lacks librt, despite it being mandatory in POSIX

 <http://pubs.opengroup.org/onlinepubs/9699919799/utilities/c99.html#tag_20_11_13>.
 If you want to compile st for OpenBSD you have to remove -lrt from config.mk, and
 st will compile without any loss of functionality, because all the functions are
 <http://pubs.opengroup.org/onlinepubs/9699919799/utilities/c99.html#tag_20_11_13>.
 If you want to compile st for OpenBSD you have to remove -lrt from config.mk, and
 st will compile without any loss of functionality, because all the functions are


@@ -104,7 +97,7 @@ St is emulating the Linux way of handling backspace being delete and delete bein
 backspace.
 
 This is an issue that was discussed in suckless mailing list
 backspace.
 
 This is an issue that was discussed in suckless mailing list

-<http://lists.suckless.org/dev/1404/20697.html>. Here is why some old grumpy
+<https://lists.suckless.org/dev/1404/20697.html>. Here is why some old grumpy

 terminal users wants its backspace to be how he feels it:
 
        Well, I am going to comment why I want to change the behaviour
 terminal users wants its backspace to be how he feels it:
 
        Well, I am going to comment why I want to change the behaviour


@@ -163,5 +156,40 @@ terminal users wants its backspace to be how he feels it:
 
 Apply [1].
 
 
 Apply [1].
 

-[1] http://st.suckless.org/patches/delkey
+[1] https://st.suckless.org/patches/delkey
+
+## Why do images not work in st (in programs such as w3m)?
+
+This is a terrible hack that overdraws an image on top of the terminal emulator
+window. It also relies on a very specific way the terminal draws it's contents.
+
+A more proper (but limited way) would be using sixels. Which st doesn't
+support.
+
+## BadLength X error in Xft when trying to render emoji
+
+Xft makes st crash when rendering color emojis with the following error:
+
+"X Error of failed request:  BadLength (poly request too large or internal Xlib length error)"
+  Major opcode of failed request:  139 (RENDER)
+  Minor opcode of failed request:  20 (RenderAddGlyphs)
+  Serial number of failed request: 1595
+  Current serial number in output stream:  1818"
+
+This is a known bug in Xft (not st) which happens on some platforms and
+combination of particular fonts and fontconfig settings.
+
+See also:
+https://gitlab.freedesktop.org/xorg/lib/libxft/issues/6
+https://bugs.freedesktop.org/show_bug.cgi?id=107534
+https://bugzilla.redhat.com/show_bug.cgi?id=1498269
+
+The solution is to remove color emoji fonts or disable this in the fontconfig
+XML configuration.  As an ugly workaround (which may work only on newer
+fontconfig versions (FC_COLOR)), the following code can be used to mask color
+fonts:
+
+       FcPatternAddBool(fcpattern, FC_COLOR, FcFalse);

 
 

+Please don't bother reporting this bug to st, but notify the upstream Xft
+developers about fixing this bug.