loading...

re: Reading The Fancy Manual: Documentation in Bash VIEW POST

TOP OF THREAD FULL DISCUSSION
re: man is also used in Linux and BSD; usually --help is a cheatsheet with the usage man is commonly more detailed, of course it depends on the specifi...
 

Thank you for the explanation robertorojasr!
I wonder if BSD has any equivalent --help cheatsheet (either built-in or 3rd party)?

 

yea, same thing, in general having a --help is just a good practice for any CLI program, if you think about it, those are the "original" UI, since even before the internet, imagine a program without a --help, is useless, every parameter not mentioned in --help is like it doesn't exist, how would you know that -sh in ls do something?, no internet, no help menu, no web documentations, no github, where else do you document a program?, where do you explain what a program do and how?. In that sense OpenBSD got it right, a CLI program, any program in tha matter, shouldn't assume the existence of internet, should be self-contained, self-documented. From our "modern" POV man pages and --help is some "bonus" or even unnecessary thing but without internet they become essential. And even the only way for a programmer to communicate with the user.

Code of Conduct Report abuse