Oh Man !!
Manpages that include a section full of the most common usage examples are the true MVP.
this post was submitted on 30 Jul 2023
225 points (95.5% liked)
GNU+Linux Humor
4820 readers
1 users here now
Memes, jokes and general humor about GNU+Linux
Rules:
- Posts must be relevant to GNU+Linux or at least an open source unix-like operating system
- No NSFW content
- No hate speech, bigotry, etc
founded 5 years ago
MODERATORS
I really think tldr-esque snippets should be mandatory in manpages. Manpages are important documentation for when you already know how to use a program, but sometimes (always) I don't have 30 minutes to read the entire manual to figure out how to start using a program. The ffmpeg man is practically a book! Meanwhile tldr can give me exactly what I need to get started. If there's no tldr and I can't grep something out of the man, then I'm using a search engine.
Isn’t that —help?
Not all programs have a --help, and --help doesn't always give you clear examples of how to use something. For example, ffmpeg's help gives a dump of all the options, and no examples of how you probably want to put them together.
Gotcha I’m still learning Linux, thanks for the clarification.
man -k Keyword search. For when you can't remember the name of the thing you forgot.
apropos is also helpful in that situation.
you can always learn from history...
—help
Or tldr for those of us that are afraid of man
man touch
Lool