4 ms·
Personally, sometimes I want just to see few basic examples at the front of the manual page, with inputs and outputs. Rare manual page has an examples section,
by trymas 11y ago
Personally, sometimes I want just to see few basic examples at the front of the manual page, with inputs and outputs.
Rare manual page has an examples section, or sometimes manual is precise (or uses some terminology you do not know/remember), though is not user-friendly to instantly understand the impact of a command.
Like on github. You can find various cool tools, but some include a picture or a gif of example workflow at the top of README, and some don't. Especially I do not understand when some people show their web/gui tool and do not add a screenshot or a gif.
So it's the same with man pages for me: I want to use something I do not know or understand, I want to see explanation and/or example at the top explained in a simple manner. If I know the tool, usually I search for the option keywords instantly.
Just my $0.02.
- justincormack 11y agoYou mean like the excellent FreeBSD man pages, eg tar here https://www.freebsd.org/cgi/man.cgi?query=tar&apropos=0&sektion=0&manpath=FreeBSD+10.2-RELEASE&arch=default&format=html https://www.freebsd.org/cgi/man.cgi?query=tar&apropos=0&sekt... (although they are still not at the top)