Skip to content

opsaaaaa/tldr-man-pandoc-pages

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tldr Man Pages

A repository of pre-built tldr pages in man formate. Inspired by tldr-man.

Why?

I like the idea of using man for tldr. However building tldr-man takes like forever. so in the releases you can find pre-built man pages. Also I wanted try doing this with Pandoc.

Installing

Download the latest release from the releases page.

Extract the build of your choice and place the files inside of ~/.tldr or anywhere you want. And add a man alias for tldr in your .bashrc or .zshrc.

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

Colorful man pages with most

Most is like less but colorful. you can tell man to use most instead of less like so:

sudo apt install most
export PAGER=“most”

Building

Building project requites pandoc. I paru requires newer version so I recommend installing the latest release.

bundle
make

About languages.

I coppied the same directory structure found in '/usr/share/man' for the locales. I have not tested that the locales work with man myself.

the pages.zip include all the locales and platforms. the other zipfiles just include the main pages for their platforms.

You can tell make to build specific locales.

linux_uk.zip: tmp.build/
	./bin/build linux_uk uk linux
# ---
make linux_uk.zip