Live data from Hacker News

TLDR pages: Simplified, community-driven man pages

tldr.sh

11–20 of 179 posts

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

#12
I would be happy to see such a thing taking off.

Typical man pages are well, like learning a language by studying a dictionary, alphabetically. It may contain all information, but a clear F on UX. Some packages get slightly better with starting from the most common use cases, with examples (and digestible errors).

However, I would be even more interested to see what is the actual usage pattern (e.g. from .bash_history / .zsh_history). Do you know any datasets with longer such?

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

#13
post #8
post #7

There was a previous HN discussion of "bro", can anyone comment on the differences? "Bro pages: like man pages, but with examples only" https://news.ycombinator.com/item?id=7121268

tldr has a better name.

Was BroPages name the only reason it hasn't gone mainstream?

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

#15
post #10

FWIW, can be installed on macOS with brew: brew install tldr EDIT to add: and so can the faster (caching) Rust version (note: install one or the other, not both, since they use the same `tldr` command) brew install tealdeer

Woah. That's way faster. Thanks for mentioning this! I'll switch all my machines over to tealdeer now.

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

#16
post #12

I would be happy to see such a thing taking off. Typical man pages are well, like learning a language by studying a dictionary, alphabetically. It may contain all information, but a clear F on UX. Some packages get slightly better with starting from the most common use cases, with examples (and digestible errors). However, I would be even more interested to see what is the actual usage pattern (e.g. from .bash_histor…

Also, I see that there are other similar projects: https://www.ostechnix.com/3-good-alternatives-man-pages-ever...

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

#19
post #12

I would be happy to see such a thing taking off. Typical man pages are well, like learning a language by studying a dictionary, alphabetically. It may contain all information, but a clear F on UX. Some packages get slightly better with starting from the most common use cases, with examples (and digestible errors). However, I would be even more interested to see what is the actual usage pattern (e.g. from .bash_histor…

Man pages are intended to be an exhaustive description of the individual options, switches and command arguments and what they do; but they won't tell you how to combine those to be useful in your particular case. It's up to you to figure that out.

tldr caters to an entirely different heuristic: I have this use case, give me a list of use cases and the corresponding combination of switches, options and arguments for each respective use case. tldr won't explain to you what each individual switch, option or argument does, turning the provided commands into black boxes.

Here's the trade off:

The former has a steep learning curve and figuring out how a tool works doesn't solve your immediate problem. But if you commit the meaning of switches, options and arguments for common tools such as awk, sed, tar, ls,... to memory, you will become proficient at solving any problem with a few tools over time.

The latter has a low learning curve and you just have to copy/paste a command to solve your problem. But tldr won't tell you how those switches and options work. And you will just use them as incantations that magically help you to solve a limited number of cases. If you end up with a use case that isn't listed, you are left in the dark as far as tldr is concerned.

So, is tldr a bad tool then? No! If you are confronted with the command line sparingly, then tldr helps to lower the bar and solve your immediate problem. But if you hope to grow into a proficient shell user, then you're still going to have to grok the man pages one switch, option and argument at a time.

I'm a polyglot. Studying a language by opening a dictionary and starting alphabetically, is arguably, the worst way to get there. You would start with learning a set of common words and basic grammatical rules, and then expand over time through practice and instruction: speaking, reading and writing.

The same applies to command line tools and man pages: they are reference materials first and foremost.

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

#20
post #9
post #8

Earlier quoted context omitted.

tldr has a better name.

Having skimmed the endless discussion about the "bro" name, I have to agree.

I can think of about four other projects called bro so without context the name is fairly useless and it appears this is a competitive space, I wouldn't hold much hope for the tdlr esc bro
Post reply on HN