fast-syntax-highlighting
fast-syntax-highlighting copied to clipboard
zdharma-continuum
Long freeze with man command on MacOS
When I use the man command and hit space there is a 3-5 second pause before any input is registered, it happens irrespective of terminal emulator used. Man seems to be the only command it happens with. I am using the current version of MacOS.
Happens here too, making FSH unusable with major pauses.
- Terminal: iTerm2 latest
- macOS: Catalina latest 10.15.7 (19H1922)
- zsh: 5.9
I switched to zsh-syntax-highlighting because it works for me.
That’s what I ended up doing as well.
As a workaround just create a quick wrapper function (can't be named man),
help() { man "$@"; }
Just creating an alias (e.g. alias help='man') also did not work and still causes the terminal to freeze.
If you don't care about installing another package, you could use batman instead. Now you have colored man pages 🌈.
Same problem here (macOS): after man, there are intermittent lags (1-3 seconds) when continuing to type.
This happens both on Terminal.app and iTerm2 (3.4.16).
versions: zsh 5.8.1 (x86_64-apple-darwin21.0) macOS 12.5.1 (21G83)
I did som digging on this.
Workaround
Anywhere in .zshrc, add this line:
function whatis() { if [[ -v THEFD ]]; then :; else command whatis "$@"; fi; }
Explanation:
The lag is caused by calls to whatis, which the highlighter calls when highlighting whatis and man commands. whatis typically takes a few seconds or so to execute, so the terminal will be blocked for that time.
The line above declares a function, which will have precedence over the system whatis command. The function returns immediately if called from within the syntax highlighter (by testing if variable THEFD exists, which happens to be present in the syntax highlighter where the whatis calls are made). Otherwise, e.g. when calling whatis from the terminal, the function dispatches the system whatis command.
Some more info for anyone trying to fix this
The whatis calls are made in file /:chroma/-whatis.ch, function -fast-whatis-chroma-callback(), as exec {THEFD}< <( [...] LANG=C whatis [...] ). This command doesn't block though. It however stores a file descriptor for the output of the command to $THEFD. This file descriptor is read from in file/function -fast-zts-read-all with the sysread command - this is the call that will actually block.
An easy quick-fix would be to simply disable syntax highlighting of the man and whatis commands for macOS.
unfortunately this plugin is REALLY slow in OSX, even with a m1pro max.
when I try to input something like
git checkout branch/
it starts freezing for full seconds
The workaround from @LeuschkeTressa did not fix it.
Another workround is disable highlight for man command
FAST_HIGHLIGHT[chroma-man]=
unfortunately this plugin is REALLY slow in OSX, even with a m1pro max.
when I try to input something like
git checkout branch/it starts freezing for full seconds
The workaround from @LeuschkeTressa did not fix it.
+1
This issue also occurs on Ubuntu varieties (I'm using Kubuntu 23.04).
👍 to @LeuschkeTressa - his workaround does fix the man freezing for me.
@lucax88x , @londbell
My workaround is only expected to work for freezing behaviour when colorizing the man commands (and as a consequence, the whatis command).
For any significant lags when other commands are colorized, there is probably something else that fast-syntax-highlighting does upon colorizing that specific command that is blocking for some time.
To solve such problems, you could try to disable syntax highlighting entirely for that specific command, e.g. trying the suggestion by @Aloxaf above.
For anyone wanting to find a better fix
For anyone wanting to trouble-shoot lag when highlighting other commands than man/whatis, to try to find a workaround that doesn't involve disabling highlighting for that command, this is the best solution I found:
# new shell without loading the typical zsh startup files:
zsh -f
# manually load the highlighter (you might need to change the path):
_zfst_file="/opt/homebrew/opt/zsh-fast-syntax-highlighting/share/zsh-fast-syntax-highlighting/fast-syntax-highlighting.plugin.zsh"
[[ -f "$_zfst_file" ]] && source "$_zfst_file" && fast-theme -q free
# load zsh's profiler module:
zmodload zsh/zprof
# here: start typing the misbehaving command, so the lag/blocking behaviour is triggered. Wait it out.
man cow # replace with misbehaving command
# save profiling results:
zprof > zprof.txt
Copy-paste the above to the terminal without the comments, otherwise zsh will yield an error for the #'s since we're using the default shell options.
Now check zprof.txt. It will list the executed functions ordered by execution time, with the longest-running first: this will have been numbered 1) by zprof. The function indicated there will probably be some top-level function, so check the breakdown of 1) slightly further down. There you'll see the specific highligter function that caused the lag.
E.g. for the lagging man command:
$ grep ' 1)' -B 2 zprof.txt
# output:
num calls time self name
-----------------------------------------------------------------------------------
1) 2 9045.14 4522.57 99.72% 9045.14 4522.57 99.72% -fast-zts-read-all
--
2/2 9045.14 4522.57 99.72% 9045.14 4522.57 -fast-whatis-chroma-callback [6]
1) 2 9045.14 4522.57 99.72% 9045.14 4522.57 99.72% -fast-zts-read-all
So: the lag (9 seconds) happened in the function -fast-zts-read-all, who's break-down shows that it was the call to -fast-whatis-chroma-callback that caused the lag. Hence, further investigation/profiling should be done on this function.