🔺
250 Words

Tldr Man Pages w/ Pandoc

So I built a thing!

I converted all the tldr pages into roff man pages with pandoc and created some releases of the generated pages on github.

Like why? what is the point of this?

Well… because I kinda like the idea of viewing TLDR pages with man… So you can view Really Long TLDR pages better…

Umm yea.. I just learned how to use pandoc and I wanted to screw around with it.

I wanted to make something useful with my new skills.

How to Install It

opsaaaaa/tldr-man-pandoc-pages

First download the tldr man pages from the github releases. And unzip it.

1
2
3
4
mkdir -p ~/.tldr
cd ~/.tldr
wget https://github.com/opsaaaaa/tldr-man-pandoc-pages/releases/download/5-2022/linux.zip
unzip linux.zip

Then add an alias to your zshrc/bashrc file.

1
alias tldr="man -M ~/.tldr"
1
echo 'alias tldr="man -M ~/.tldr"' >> ~/.zshrc' 

And your done!

Bonus: Most Colorful Pager

if you want bonus points, you can use most as a pager instead of less for colorful man pages.

1
sudo apt install most
1
brew install most
1
2
# bashrc or zshrc
export PAGER=“most”

The Other Tldr Man Page Project

joelekstrom/tldr-man

There is another tldr-man page project that we don’t need to talk about. You see I have three specific issues with it.

  1. I wanted to use pandoc not the ronn gem!
  2. It takes like forever to build! I don’t have time for that!
  3. The default indentation it looks gross.
  4. It mixes all of the OS specific tldr pages together.