Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

TLDR pages: Simplified, community-driven man pages

tldr.sh

Post reply on HN
Print view View original

161–170 of 179 posts

Re: TLDR pages: Simplified, community-driven man pages

#161

Post by techplex »

josephernest wrote: post #62

1) Great project! Is there a simple way to install it without having to install Node.js or Haskell or Ruby? (I don't want to install Node.js just for it) Is there a apt-get install tldr solution on recent Debian / Ubuntu distros without installing another additional package manager ? I mean even the bash solution: bpkg ... does not work out of the box. (bpkg or brew or npm aren't installed by default) 2) Is TLDR link…

There are many clients that are open source that you can use check these out: https://github.com/tldr-pages/tldr#clients

Re: TLDR pages: Simplified, community-driven man pages

#162

Post by catalogia »

jopsen wrote: post #158
catalogia wrote: post #152

Earlier quoted context omitted.

Something I like about tldr is that tldr pages are short enough to not necessitate using a pager, so you can print the tldr of a command and read it while typing the command in the same terminal emulator. I know you can disable the pager for man, but the typical manpage is going to be fairly long anyway so the pager is generally desired. I suppose you could pipe man through head to just print out the first section, b…

But they are not system specific... I don't need `tldr opkg` on my system. In fact, having pages I don't need just causes confusion. Moreover, commands can have system specific names.

My tldr client has a --platform flag that takes 'linux, osx, sunos, or common'. So there is some support there for platform-specific tldr pages at least.

Also my tdlr-pages checkout is only 19MB, so I'm not too concerned about bloat. I'm not really sure how having tldr's for irrelevant commands would be a problem, maybe with some shell autocompletions? Maybe there is a way you could prune the tldr-pages checkout?

I guess all I can really say is tldr works really well for me and I like it a lot. Nothing is perfect, but tldr is quite nice despite some warts.

Re: TLDR pages: Simplified, community-driven man pages

#163

Post by deadbunny »

SanchoPanda wrote: post #154

cheat() { curl "http://cheat.sh/$1" } man2txt() { man "$1" | col -bx } manflags(){ man "$1" | awk '{$1=$1;print}' | grep "^\-" } #man pages just the flags more or less, captures some extra ubuman() { w3m -dump "https://manpages.ubuntu.com/manpages/bionic/en/man1/"$1".1.html" } # ubuntu web manpages note bionic, update with do release up ubumanflags() { w3m -dump "https://manpages.ubuntu.com/manpages/bionic/en/man1/$1…

You could improve the ubuman calls so you don't have to change every release:

  ubuman() { 
   w3m -dump "https://manpages.ubuntu.com/manpages/$(lsb_release -cs)/en/man1/"$1".1.html"
  }

Re: TLDR pages: Simplified, community-driven man pages

#164

Post by hultner »

SanchoPanda wrote: post #154

cheat() { curl "http://cheat.sh/$1" } man2txt() { man "$1" | col -bx } manflags(){ man "$1" | awk '{$1=$1;print}' | grep "^\-" } #man pages just the flags more or less, captures some extra ubuman() { w3m -dump "https://manpages.ubuntu.com/manpages/bionic/en/man1/"$1".1.html" } # ubuntu web manpages note bionic, update with do release up ubumanflags() { w3m -dump "https://manpages.ubuntu.com/manpages/bionic/en/man1/$1…

Is there any app that combines all these alternative man-pages?

Re: TLDR pages: Simplified, community-driven man pages

#166

Post by rwnspace »

hultner wrote: post #164
SanchoPanda wrote: post #154

cheat() { curl "http://cheat.sh/$1" } man2txt() { man "$1" | col -bx } manflags(){ man "$1" | awk '{$1=$1;print}' | grep "^\-" } #man pages just the flags more or less, captures some extra ubuman() { w3m -dump "https://manpages.ubuntu.com/manpages/bionic/en/man1/"$1".1.html" } # ubuntu web manpages note bionic, update with do release up ubumanflags() { w3m -dump "https://manpages.ubuntu.com/manpages/bionic/en/man1/$1…

Is there any app that combines all these alternative man-pages?

If you want, you can alias man to call `tldr $1` or `curl -s "cht.sh/tar" 2>&1` first, then call man, then pipe the output into `cat` and again into `less`, like so:

  man() {
      (tldr $1 ; man $1) | cat | less
  }
Edit: rewrote without the `&&` conditional

Re: TLDR pages: Simplified, community-driven man pages

#167

Post by ori_b »

killjoywashere wrote: post #142
neckardt wrote: post #136

Earlier quoted context omitted.

Ideally I would like to see an additional section in man pages devoted to examples. The TLDR pages could then be moved into the man pages.

tldr didn't choose tar as their front-page demo by accident. The tar manpage is a classic example of the CLI gods apparently going to some effort to design the Examples section to effectively tell new users to bugger the hell off.

This reads fine to me: https://man.openbsd.org/tar

Re: TLDR pages: Simplified, community-driven man pages

#169

Post by SanchoPanda »

deadbunny wrote: post #163
SanchoPanda wrote: post #154

cheat() { curl "http://cheat.sh/$1" } man2txt() { man "$1" | col -bx } manflags(){ man "$1" | awk '{$1=$1;print}' | grep "^\-" } #man pages just the flags more or less, captures some extra ubuman() { w3m -dump "https://manpages.ubuntu.com/manpages/bionic/en/man1/"$1".1.html" } # ubuntu web manpages note bionic, update with do release up ubumanflags() { w3m -dump "https://manpages.ubuntu.com/manpages/bionic/en/man1/$1…

You could improve the ubuman calls so you don't have to change every release: ubuman() { w3m -dump "https://manpages.ubuntu.com/manpages/$(lsb_release -cs)/en/man1/"$1".1.html" }

I like that, thank you.

Re: TLDR pages: Simplified, community-driven man pages

#170

Post by SanchoPanda »

hultner wrote: post #164
SanchoPanda wrote: post #154

cheat() { curl "http://cheat.sh/$1" } man2txt() { man "$1" | col -bx } manflags(){ man "$1" | awk '{$1=$1;print}' | grep "^\-" } #man pages just the flags more or less, captures some extra ubuman() { w3m -dump "https://manpages.ubuntu.com/manpages/bionic/en/man1/"$1".1.html" } # ubuntu web manpages note bionic, update with do release up ubumanflags() { w3m -dump "https://manpages.ubuntu.com/manpages/bionic/en/man1/$1…

Is there any app that combines all these alternative man-pages?

I would just make it into one function, and call each one every time, with headings seperated by figlet.

It would make a straightforward gui app for rofi or zenity or yad etc, with only one input and just a list of output.

Post reply on HN