Xinqi Bao's Git

projects / st.git / blobdiff
summary | log | commit | diff | tree
raw | inline | side by side
FAQ: add some details about the w3m img hack
[st.git] / FAQ
diff --git a/FAQ b/FAQ
index cdf4f45..fb40264 100644 (file)
--- a/FAQ
+++ b/FAQ
@@ -1,12 +1,14 @@
 ## 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,19 +17,21 @@ 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?
 
 
 ## How do I scroll back up?
 
-Using a terminal multiplexer.
+* Using a terminal multiplexer.
+       * `st -e tmux` using C-b [
+       * `st -e screen` using C-a ESC
+* Using the excellent tool of [scroll](https://git.suckless.org/scroll/).
+* Using the scrollback [patch](https://st.suckless.org/patches/scrollback/).
+
+
+## I would like to have utmp and/or scroll functionality by default
+
+You can add the absolute patch of both programs in your config.h
+file. You only have to modify the value of utmp and scroll variables.
 
 
-* `st -e tmux` using C-b [
-* `st -e screen` using C-a ESC
 
 ## Why doesn't the Del key work in some programs?
 
 
 ## Why doesn't the Del key work in some programs?
 
@@ -84,27 +88,30 @@ If you are using zsh, then read the zsh FAQ
 
 Putting these lines into your .zshrc will fix the problems.
 
 
 Putting these lines into your .zshrc will fix the problems.
 
+
 ## How can I use meta in 8bit mode?
 
 St supports meta in 8bit mode, but the default terminfo entry doesn't
 use this capability. If you want it, you have to use the 'st-meta' value
 in TERM.
 
 ## How can I use meta in 8bit mode?
 
 St supports meta in 8bit mode, but the default terminfo entry doesn't
 use this capability. If you want it, you have to use the 'st-meta' value
 in TERM.
 
+
 ## I cannot compile st in OpenBSD
 
 ## I cannot compile st in OpenBSD
 
-OpenBSD lacks librt, despite it began to be 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
 included in libc on this platform.
 
 <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
 included in libc on this platform.
 
+
 ## The Backspace Case
 
 St is emulating the Linux way of handling backspace being delete and delete being
 backspace.
 
 This is an issue that was discussed in suckless mailing list
 ## The Backspace Case
 
 St is emulating the Linux way of handling backspace being delete and delete being
 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
@@ -159,9 +166,85 @@ terminal users wants its backspace to be how he feels it:
        [1] http://www.ibb.net/~anne/keyboard.html
        [2] http://www.tldp.org/HOWTO/Keyboard-and-Console-HOWTO-5.html
 
        [1] http://www.ibb.net/~anne/keyboard.html
        [2] http://www.tldp.org/HOWTO/Keyboard-and-Console-HOWTO-5.html
 
+
 ## But I really want the old grumpy behaviour of my terminal
 
 Apply [1].
 
 ## But I really want the old grumpy behaviour of my terminal
 
 Apply [1].
 
-[1] http://st.suckless.org/patches/delkey
-
+[1] https://st.suckless.org/patches/delkey
+
+
+## Why do images not work in st using the w3m image hack?
+
+w3mimg uses a hack that draws an image on top of the terminal emulator Drawable
+window. The hack relies on the terminal to use a single buffer to draw its
+contents directly.
+
+st uses double-buffered drawing so the image is quickly replaced and may show a
+short flicker effect.
+
+Below is a patch example to change st double-buffering to a single Drawable
+buffer.
+
+diff --git a/x.c b/x.c
+--- a/x.c
++++ b/x.c
+@@ -561,10 +561,6 @@ xresize(int col, int row)
+       win.tw = MAX(1, col * win.cw);
+       win.th = MAX(1, row * win.ch);
+ 
+-      XFreePixmap(xw.dpy, xw.buf);
+-      xw.buf = XCreatePixmap(xw.dpy, xw.win, win.w, win.h,
+-                      DefaultDepth(xw.dpy, xw.scr));
+-      XftDrawChange(xw.draw, xw.buf);
+       xclear(0, 0, win.w, win.h);
+ }
+ 
+@@ -921,8 +917,7 @@ xinit(void)
+       gcvalues.graphics_exposures = False;
+       dc.gc = XCreateGC(xw.dpy, parent, GCGraphicsExposures,
+                       &gcvalues);
+-      xw.buf = XCreatePixmap(xw.dpy, xw.win, win.w, win.h,
+-                      DefaultDepth(xw.dpy, xw.scr));
++      xw.buf = xw.win;
+       XSetForeground(xw.dpy, dc.gc, dc.col[defaultbg].pixel);
+       XFillRectangle(xw.dpy, xw.buf, dc.gc, 0, 0, win.w, win.h);
+ 
+@@ -1386,8 +1381,6 @@ void
+ draw(void)
+ {
+       drawregion(0, 0, term.col, term.row);
+-      XCopyArea(xw.dpy, xw.buf, xw.win, dc.gc, 0, 0, win.w,
+-                      win.h, 0, 0);
+       XSetForeground(xw.dpy, dc.gc,
+                       dc.col[IS_SET(MODE_REVERSE)?
+                               defaultfg : defaultbg].pixel);
+
+
+## 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.