Very useful. Thank you for supporting multiple platforms, and the MIT license.
TLDR pages: Simplified, community-driven man pages
31–40 of 179 posts
Re: TLDR pages: Simplified, community-driven man pages
#32I 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…
It may contain all information, but a clear F on UX. What I find annoying is the number of command line programs that don't even have man pages anymore. Or maybe that's just an artifact of installing them with brew? What I find interesting is that for the most part (there are exceptions), the older the man page, the more useful it is. Realistic examples. Succinct descriptions. User-friendly terminology. Too many of t…
I have added packages to Homebrew, and they install man pages when available. Homebrew provides a pretty simple mechanism for doing so. The problem is that many projects just prefer web documents to man pages, likely because the man page tooling is not great.
Re: TLDR pages: Simplified, community-driven man pages
#33I 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…
It may contain all information, but a clear F on UX. What I find annoying is the number of command line programs that don't even have man pages anymore. Or maybe that's just an artifact of installing them with brew? What I find interesting is that for the most part (there are exceptions), the older the man page, the more useful it is. Realistic examples. Succinct descriptions. User-friendly terminology. Too many of t…
Some ecosystems even eschew manpages. For example, I wouldn't know how to ship manpages as part of a Ruby gem, it's discouraged iirc
Re: TLDR pages: Simplified, community-driven man pages
#34A heartfelt plea: The man pages are community driven, too. If you think they can be improved, instead of investing in rapidly decaying third-party documentation, please take your improvements upstream. The maintainers would be thrilled to have them.
It seems like the maintainers of man pages just refuse to bother with something so obvious. It's been decades, and man pages are still archaic and not user friendly.
Re: TLDR pages: Simplified, community-driven man pages
#35A heartfelt plea: The man pages are community driven, too. If you think they can be improved, instead of investing in rapidly decaying third-party documentation, please take your improvements upstream. The maintainers would be thrilled to have them.
it's not the same use-case, manpages are detailed instructions, tldr is just the 7 most used commands
Re: TLDR pages: Simplified, community-driven man pages
#36A heartfelt plea: The man pages are community driven, too. If you think they can be improved, instead of investing in rapidly decaying third-party documentation, please take your improvements upstream. The maintainers would be thrilled to have them.
How is this "rapidly decaying third-party documentation" in any way that man isn't?
Re: TLDR pages: Simplified, community-driven man pages
#37Neither this, nor the traditional man page list of options is useful on its own. You need a detailed reference of the things you can do, and then you need examples for how to pull those things together in common usages.
For a code equivalent, Rust encourages function level documentation. This gives you detailed information on the full API surface and is vital, but if you only had that you wouldn't know where to start. Rust also has the 'examples' directory (I'm talking about a library project) which usually has a few executables that use the library.
Re: TLDR pages: Simplified, community-driven man pages
#38FWIW, 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
Yeah cargo install tealdeer was worthwhile. Really good.
Re: TLDR pages: Simplified, community-driven man pages
#39Shout out to http://cht.sh , which could be used without installing anything: curl cht.sh/tr
Wow that's pretty great. There are so many powerful console utilities with overly opaque manuals that make them hard to jump into when you just want to do a simple thing. Compare these for example:
Re: TLDR pages: Simplified, community-driven man pages
#40A heartfelt plea: The man pages are community driven, too. If you think they can be improved, instead of investing in rapidly decaying third-party documentation, please take your improvements upstream. The maintainers would be thrilled to have them.
it's not the same use-case, manpages are detailed instructions, tldr is just the 7 most used commands
manpages often have an examples section on OpenBSD showcasing different ways to use programs. It can be done...