3 ms·
The GNU tar man page is explicitly a shortened reference, because the real manual is in info format. Info manuals are often examples of documentation done well
by mjw1007 7y ago
The GNU tar man page is explicitly a shortened reference, because the real manual is in info format.
Info manuals are often examples of documentation done well, and the tar manual looks pretty decent.
For example it has sections like "Some Definitions" and "What 'tar' Does", then a tutorial, followed by the formal documentation.
It looks like it also separates the coverage of what the program does from the description of how to request those things on the command line. That's also often a sign of high quality documentation.
- davidw 7y agoFair enough; this was nearly 25 years ago on a laptop with 4 megs of ram, and no internet connection, though, so firing up emacs (I used 'jed') was kind of a PITA and I'm not sure I even had the info pages. In those days, it would have been sufficient to have tar czvf something.tar.gz some_directory/ tar xzvf some.tar.gz In the man page.