when do you usually use the man page for a complex command line tool to answer a question you have?
-
@karabaic I've never used openbsd but I'm so curious about the openbsd man page culture because of how people talk about it
do you know if there's anywhere that I can read about the documentation philosophy or about how people relate to it?
-
when do you usually use the man page for a complex command line tool to answer a question you have? (like git, openssl, rsync, curl, etc)
(edit: no need to say "i use --help then man")
I voted 'first' because it's close enough; it's usually second after '-?'
(-? is not be a valid argument in many programs, but most dump their usage on an invalid argument, and it's easier than typing --help)
-
i think part of the reason I'm feeling interested in man pages right now even though I rarely use them is that search has gotten so much worse, it's frustrating, and it makes it feel more appealing to have trustworthy sources with clear explanations
@b0rk
I tend to look for examples close to what I want to do, or tutorials. I would love if man pages were more consistent in giving clear examples for common use cases. This is much easier to parse quickly than detailed explanations. -
i'm very curious about everyone who says "I'd look there first", if I want to figure out how to do something new I think I'll usually google how to do it rather than look at the man page, and then maybe later look at the man page to look up the details
(I've gotten enough of these answers:
- "I like that man pages don't require changing context"
- "with the man page I know I have the right version of the docs")@b0rk for rsync, find or ls I use the man page. For ffmpeg or imagemagick I use duck duck go 🙂
-
i'm very curious about everyone who says "I'd look there first", if I want to figure out how to do something new I think I'll usually google how to do it rather than look at the man page, and then maybe later look at the man page to look up the details
(I've gotten enough of these answers:
- "I like that man pages don't require changing context"
- "with the man page I know I have the right version of the docs")@b0rk my experience is that I can often figure out what I need from the man page in one of 3 ways:
- often the first paragraph(ish) clarifies whatever I was confused about
- the EXAMPLES section (usually near the end) often has exactly the example I'd want
- often searching the man page ('/' to search, 'n' for next result) for keywords finds me what I need (another option) pretty fastI'm skewed towards this from years of offline computer use (work on trains with crappy/no wifi, though it started with an offline desktop in my room in high school before wifi was a thing), but also reinforced by recent nonsense in both AI summaries and keyword-spamming sites...
-
when do you usually use the man page for a complex command line tool to answer a question you have? (like git, openssl, rsync, curl, etc)
(edit: no need to say "i use --help then man")
@b0rk other = on FreeBSD I have found the documentation pretty useful for most commands. On Linux, much less so.
-
i'm very curious about everyone who says "I'd look there first", if I want to figure out how to do something new I think I'll usually google how to do it rather than look at the man page, and then maybe later look at the man page to look up the details
(I've gotten enough of these answers:
- "I like that man pages don't require changing context"
- "with the man page I know I have the right version of the docs")@b0rk Yestwrday I wanted to use exiftool to strip all tags from an image. Couldn’t easily find it in the man page so I piped it to an AI and it spat out the answer. I’m not sure if this was better, or more ecological. But Google was going to give me an AI summary anyway amidst AI slop posts so why not skip the middleman
-
i think part of the reason I'm feeling interested in man pages right now even though I rarely use them is that search has gotten so much worse, it's frustrating, and it makes it feel more appealing to have trustworthy sources with clear explanations
@b0rk One thing, and I don't know that this is solveable or maybe it was supposed to be solved by info pages but those were hard to memorize how to use, is learning the capabilities of a tool like...up front and at the top.
It's so hard to find the ingredients I need to concoct the correct incantation from man pages, even when I've done the thing with the tool before.
And sometimes you find things that SEEM like what you need but aren't.
-
i think part of the reason I'm feeling interested in man pages right now even though I rarely use them is that search has gotten so much worse, it's frustrating, and it makes it feel more appealing to have trustworthy sources with clear explanations
@b0rk I agree with the sentiment, and I think that's why I installed tldr.sh again recently 🥲 granted that's far less in depth that what is provided by the man pages, but examples are concise.
-
i'm very curious about everyone who says "I'd look there first", if I want to figure out how to do something new I think I'll usually google how to do it rather than look at the man page, and then maybe later look at the man page to look up the details
(I've gotten enough of these answers:
- "I like that man pages don't require changing context"
- "with the man page I know I have the right version of the docs")@b0rk i like to look first and then search for examples elsewhere. otherwise my search may not be relevant
-
when do you usually use the man page for a complex command line tool to answer a question you have? (like git, openssl, rsync, curl, etc)
(edit: no need to say "i use --help then man")
@b0rk I'd say I'd indeed look at the man page first. I've still voted "other", as I immediately turn away if it doesn't give a usage example in the first few lines.
I need to know if it's the right tool for the job, and only very few man pages declare what it does properly. I often need stackoverflow or blogs for that.
Then I return regularly to the man page to look up syntax of what I already know is there. -
i think part of the reason I'm feeling interested in man pages right now even though I rarely use them is that search has gotten so much worse, it's frustrating, and it makes it feel more appealing to have trustworthy sources with clear explanations
@b0rk I have a lingering guilt about not going to man pages first, but often a blog post has been better crafted than the friendly manual. Not all manuals but enough to encourage an antipattern in search first.
I totally agree with your motivation to address/revaluate that.
-
i think part of the reason I'm feeling interested in man pages right now even though I rarely use them is that search has gotten so much worse, it's frustrating, and it makes it feel more appealing to have trustworthy sources with clear explanations
@b0rk i remember this: when i learned about man and started using it, the stuff i wanted to know usually was on page 5 (quick reference / parameters). But i always forget that so it felt frustrating and abandoned them.
Instead I use --help command options. I only go to man when i want to learn the full and long version. But sometimes I do.
-
when do you usually use the man page for a complex command line tool to answer a question you have? (like git, openssl, rsync, curl, etc)
(edit: no need to say "i use --help then man")
@b0rk I generally go to `--help` first, and then a man page, often looking for the EXAMPLE section.
-
@b0rk using #freebsd and having started on SCO Unix, I’m used to better than average man pages. And I learned sco before the web: so man and Usenet.
—help is my first stop these days.
Knowing how to use man means I can work offline too. So practicing that skill when a fallback is present is a worthy investment
-
i think part of the reason I'm feeling interested in man pages right now even though I rarely use them is that search has gotten so much worse, it's frustrating, and it makes it feel more appealing to have trustworthy sources with clear explanations
@b0rk usually I'd first look at --help, then web search, then man page. If I know it's a certain option and I just don't remember the name or how to use it it might be --help, man page then web search.
-
i'm very curious about everyone who says "I'd look there first", if I want to figure out how to do something new I think I'll usually google how to do it rather than look at the man page, and then maybe later look at the man page to look up the details
(I've gotten enough of these answers:
- "I like that man pages don't require changing context"
- "with the man page I know I have the right version of the docs")@b0rk Depends on the tool. You included --help, which I use more often than man. For git I prefer the internet, because it's too complex and I usually need a combination of options. For others I prefer --help or man. Just today I did that for adduser.
-
i think part of the reason I'm feeling interested in man pages right now even though I rarely use them is that search has gotten so much worse, it's frustrating, and it makes it feel more appealing to have trustworthy sources with clear explanations
@b0rk I'm the kind of person who enjoyed reading man pages for leisure.
I read through the entirety of the rsync man page to compose my own favourite rsync invocation once.
The only tools where I resort to web search are shells, because their man pages are really hard to navigate (finding documentation for `read` in the bash man page is ... a nightmare).
Web search is often imprecise and as you note, has gotten so much worse that I am glad I never fully relied on it.
-
i think part of the reason I'm feeling interested in man pages right now even though I rarely use them is that search has gotten so much worse, it's frustrating, and it makes it feel more appealing to have trustworthy sources with clear explanations
@b0rk I gave up on groff so long ago that I forgot to try using an LLM to create a man page from HeaderDoc and Markdown. I'll have to give that a shot sometime.
-
i'm very curious about everyone who says "I'd look there first", if I want to figure out how to do something new I think I'll usually google how to do it rather than look at the man page, and then maybe later look at the man page to look up the details
(I've gotten enough of these answers:
- "I like that man pages don't require changing context"
- "with the man page I know I have the right version of the docs")@b0rk I guess if I am doing stuff on the terminal, the terminal it's the first place I look for help, so --help, man pages, and tldr. My gateway drug to Linux was DJGPP on DOS, and I was using quite a lot the info pages there, even a decade before adopting Emacs. I know Info gets a bad rap, and I admittedly not use it anymore, but I liked that it was giving way more information than a man page, often with tutorial like spirit,