superatomic / tldr-man

📚 Command-line TLDR client that displays tldr-pages as manpages.

Hi, I’m superatomic! I like computers.

I have 8 years of experience (and counting!) with using Python. I also develop using other languages.

Contact me on Matrix at @atomic:envs.net or send an email to [email protected].

Notable Projects:

• 📚 TLDR Man Client
• 🐚 Xshe – Cross-Shell Environment Variables
• 🗄 Homebrew Bundle Extensions

Contributions:

• I've added type hints to click-help-colors.
• I've added nb, eget, dooit, xdg-ninja, licensor, and tere to Homebrew.
• I've added some pages to tldr-pages.

tldr-man's Issues

Bash shell completion fails

Click shell completion for bash has been silently failing to generate when installed through the tldr-man Homebrew formula.

This bug was discovered when changes to generate_completions.sh in 90eef34 made this error fatal and broke Homebrew HEAD builds (brew install --HEAD superatomic/tap/tldr-man). Before this, empty files were being installed as bash completion scripts, instead of the intentional scripts.

This issue occurs because the only version of Bash that is present during a Homebrew formula build is too old to work with click (bash <4.4). For more information, see pallets/click#2574.

Merging pallets/click#2576 will fix this issue.

zlib.error: Error -3 while decompressing data: invalid stored block lengths

$ tldr --update
Updating tldr-pages cache...
pages       / windows  [####################################]  100%
pages       / osx      [####################################]  100%
pages       / common   [#####-------------------------------]   14%  00:00:06
Traceback (most recent call last):
  File "/apps/hosted/tldr-man/.venv/lib/python3.10/site-packages/tldr_man/main.py", line 59, in wrapper
    func(ctx, param, value)
  File "/apps/hosted/tldr-man/.venv/lib/python3.10/site-packages/tldr_man/main.py", line 80, in subcommand_update
    pages.update_cache()
  File "/apps/hosted/tldr-man/.venv/lib/python3.10/site-packages/tldr_man/pages.py", line 165, in update_cache
    for filename, manpage in fut:
  File "/apps/hosted/tldr-man/.venv/lib/python3.10/site-packages/click/_termui_impl.py", line 328, in generator
    for rv in self.iter:
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/concurrent/futures/_base.py", line 608, in result_iterator
    yield fs.pop().result()
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/concurrent/futures/_base.py", line 438, in result
    return self.__get_result()
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/concurrent/futures/_base.py", line 390, in __get_result
    raise self._exception
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/concurrent/futures/thread.py", line 58, in run
    result = self.fn(*self.args, **self.kwargs)
  File "/apps/hosted/tldr-man/.venv/lib/python3.10/site-packages/tldr_man/pages.py", line 147, in to_manpage
    rendered_manpage = render_manpage(tldr_page.read_text())
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/zipfile.py", line 2352, in read_text
    return strm.read()
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/zipfile.py", line 909, in read
    buf += self._read1(self.MAX_N)
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/zipfile.py", line 999, in _read1
    data = self._decompressor.decompress(data, n)
zlib.error: Error -3 while decompressing data: invalid stored block lengths

Running this again, this happens at different points in the process. For example, on another run, it crashed at converting the linux man pages. And with another error message:

$ tldr --update
Updating tldr-pages cache...
pages       / windows  [####################################]  100%
pages       / osx      [####################################]  100%
pages       / common   [####################################]  100%
pages       / sunos    [####################################]  100%
pages       / android  [####################################]  100%
pages       / linux    [################################----]   91%  00:00:00
Traceback (most recent call last):
  File "/apps/hosted/tldr-man/.venv/lib/python3.10/site-packages/tldr_man/main.py", line 59, in wrapper
    func(ctx, param, value)
  File "/apps/hosted/tldr-man/.venv/lib/python3.10/site-packages/tldr_man/main.py", line 80, in subcommand_update
    pages.update_cache()
  File "/apps/hosted/tldr-man/.venv/lib/python3.10/site-packages/tldr_man/pages.py", line 165, in update_cache
    for filename, manpage in fut:
  File "/apps/hosted/tldr-man/.venv/lib/python3.10/site-packages/click/_termui_impl.py", line 328, in generator
    for rv in self.iter:
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/concurrent/futures/_base.py", line 608, in result_iterator
    yield fs.pop().result()
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/concurrent/futures/_base.py", line 438, in result
    return self.__get_result()
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/concurrent/futures/_base.py", line 390, in __get_result
    raise self._exception
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/concurrent/futures/thread.py", line 58, in run
    result = self.fn(*self.args, **self.kwargs)
  File "/apps/hosted/tldr-man/.venv/lib/python3.10/site-packages/tldr_man/pages.py", line 147, in to_manpage
    rendered_manpage = render_manpage(tldr_page.read_text())
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/zipfile.py", line 2352, in read_text
    return strm.read()
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/zipfile.py", line 909, in read
    buf += self._read1(self.MAX_N)
  File "/apps/hosted/spack/opt/spack/linux-rhel7-haswell/gcc-4.8.5/python-3.10.1-ek76ski4ctzhij7smku7sh3bmupopkou/lib/python3.10/zipfile.py", line 999, in _read1
    data = self._decompressor.decompress(data, n)
zlib.error: Error -3 while decompressing data: invalid distance too far back