TLDR pages: Simplified, community-driven man pages • Hacker News Board

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

#121

Post by dbrgn » Wed, Jan 22, 2020, 9:40 PM UTC

codesections wrote: post #5

I like the idea of tldr pages. Unfortunately, by default, they are a bit too slow to display—I know it's under a second, but it's just enough to break my flow. Fortunately, there are other clients, some of which are much faster. My current favorite is tealdeer: https://github.com/dbrgn/tealdeer

Thanks for the shoutout :) It's funny that my weekend project that I wrote to learn Rust suddenly has almost 500 stars on GitHub...

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

#122

Post by hyperpallium » Wed, Jan 22, 2020, 9:52 PM UTC

b3kart wrote: post #18

Shout out to http://cht.sh , which could be used without installing anything: curl cht.sh/tr

How can I remove the colors from the output? It's hard to read on mobile (termux).

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

#123

Post by kccqzy » Wed, Jan 22, 2020, 9:52 PM UTC

Well, man pages cover more than just command-line utilities. These typically go in section 1 only. What about section 2 (system calls) or section 3 (library functions)? I guess the audience of this tool doesn't really need these?

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

#124

Post by gyoza » Wed, Jan 22, 2020, 9:59 PM UTC

Am I the only one who thinks... This is based on npm and this is the sole reason to not even consider using it??

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

#125

Post by read_if_gay_ » Wed, Jan 22, 2020, 10:12 PM UTC

kccqzy wrote: post #123

Well, man pages cover more than just command-line utilities. These typically go in section 1 only. What about section 2 (system calls) or section 3 (library functions)? I guess the audience of this tool doesn't really need these?

Of course some information will be omitted, that is the entire purpose of this tool. What’s your point?

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

#126

Post by noodlesUK » Wed, Jan 22, 2020, 10:19 PM UTC

I think this is an indictment of how awful the man pages are on GNU/Linux systems. The man pages within the various *BSDs are a fantastic resource, as are their other documentation (e.g., the freebsd handbook).

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

#127

Post by Brave-Steak » Wed, Jan 22, 2020, 10:50 PM UTC

b5n wrote: post #119

Brave-Steak wrote: post #114

Earlier quoted context omitted.

1) Bullshit. 2) And the waste of time typing all of that? I’d rather just not.

[flagged]

And your comments are infuriatingly dismissive. Typical of a software engineer to not give a shit about accessibility, ease of use, actual efficiency, tools getting out of the way of people who want to do their actual jobs, etc.

tl;dr You’re arrogant and elitist and think everybody should work like you do.

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

#128

Post by topspin » Wed, Jan 22, 2020, 11:22 PM UTC

JdeBP wrote: post #118

topspin wrote: post #76

Earlier quoted context omitted.

> The maintainers would be thrilled to have them. Would they? The tldr.sh site prominently offers a sample of usage examples for a command; tar specifically. If one checks the tar man page there are no examples. This is policy, apparently promulgated by GNU et al. in favor of "info". I haven't the time right now to hunt down the official position, but here[1] is a SO discussion. Should this TLDR thing correct that lo…

> If one checks the tar man page there are no examples. * https://www.freebsd.org/cgi/man.cgi?query=tar#EXAMPLES * https://man.openbsd.org/tar#EXAMPLES * https://illumos.org/man/1/tar#examples * https://www.ibm.com/support/knowledgecenter/ssw_aix_72/t_com... * http://osr507doc.sco.com/cgi-bin/man?mansearchword=/usr/man2... You are clearly very limited in your user manuals. (-:

I certainly should have qualified with "GNU tar". This raises the question; does TLDR exist simply because of GNU's dysfunction? Would TLDR exist if one could simply 'man tar' on a GNU tar system and pop down to the Examples section as one apparently can in just about every other *nix?

(and one currently can't, given the unmodified man page from the most recent 1.32 release)

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

#129

Post by bostonvaulter2 » Wed, Jan 22, 2020, 11:22 PM UTC

I love using tldr, it is great to have some nice succinct examples at the tip of your fingers. And I love that the whole database is downloaded rather than making a network request.

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

#130

Post by bostonvaulter2 » Wed, Jan 22, 2020, 11:23 PM UTC

b3kart wrote: post #18

Shout out to http://cht.sh , which could be used without installing anything: curl cht.sh/tr

Looks nice, although a benefit of tldr is that it can download the database so all when you look up a command it's not making a network request (which is good for both privacy and speed/reliability)