do you have a favourite man page?
-
do you have a favourite man page? thinking of writing a short blog post exploring man pages and what makes a good one and I'd love some more examples
my contribution: I think it's cool that `man curl` includes an example for every single option
@b0rk Why were example usages shunned by many man pages I'll never understand.
-
@technicaladept @nabnux i think for bash specifically I might prefer to use the html bash reference manual to reference the docs https://www.gnu.org/software/bash/manual/bash.html (which I believe has the same content but with better formatting)
-
I think my favourite man page example so far is this rsync man page (via @shnizmuffin) https://www.man7.org/linux/man-pages/man1/rsync.1.html
it gives examples BEFORE giving an exhaustive list of options!
the synopsis just says "rsync [OPTION...] SRC... [DEST]" instead of giving you an exhaustive list of options like "-ABCFGHILOPRSTUWabcdefghiklmnopqrstuvwxy1%"!
there's an "OPTION SUMMARY" section that gives you a 1-line summary of each option! (this feels SO SO much useful than the normal SYNOPSIS to me)
(2/?)
@b0rk Special shout out to the official web address, since it's got hyperlinks on all the options:
-
I think my favourite man page example so far is this rsync man page (via @shnizmuffin) https://www.man7.org/linux/man-pages/man1/rsync.1.html
it gives examples BEFORE giving an exhaustive list of options!
the synopsis just says "rsync [OPTION...] SRC... [DEST]" instead of giving you an exhaustive list of options like "-ABCFGHILOPRSTUWabcdefghiklmnopqrstuvwxy1%"!
there's an "OPTION SUMMARY" section that gives you a 1-line summary of each option! (this feels SO SO much useful than the normal SYNOPSIS to me)
(2/?)
@b0rk @shnizmuffin Count on Apple to f*ck things up:
NAME
openrsync – synchronise local and remote filesSYNOPSIS
openrsync [-0468BCDEFHILOPRSTWVabcdefghiklmnopqrtuvxyz] [-e program]
[-f filter] [--address=sourceaddr] [--append]
[--backup-dir=directory] [--bwlimit=limit]
[--cache | --no-cache] [--etc.
-
do you have a favourite man page? thinking of writing a short blog post exploring man pages and what makes a good one and I'd love some more examples
my contribution: I think it's cool that `man curl` includes an example for every single option
false (8) is my favourite
-
do you have a favourite man page? thinking of writing a short blog post exploring man pages and what makes a good one and I'd love some more examples
my contribution: I think it's cool that `man curl` includes an example for every single option
@b0rk grindr (SORRY)
-
I have a soft spot for "man ascii"
-
@d6 this is so cool, I've never looked at this before! makes me want to find out who wrote them.
-
do you have a favourite man page? thinking of writing a short blog post exploring man pages and what makes a good one and I'd love some more examples
my contribution: I think it's cool that `man curl` includes an example for every single option
@b0rk `man man` flashed me recently
-
do you have a favourite man page? thinking of writing a short blog post exploring man pages and what makes a good one and I'd love some more examples
my contribution: I think it's cool that `man curl` includes an example for every single option
@b0rk I'm not sure, if I measure it by times I read it, it should be tar, but because of its number of options. Regarding the fun of reading it or the fact I'm confident I will find the information I need, none really qualify
-
do you have a favourite man page? thinking of writing a short blog post exploring man pages and what makes a good one and I'd love some more examples
my contribution: I think it's cool that `man curl` includes an example for every single option
@b0rk I've always thought the jq man page is quite good. Lots of good examples
-
@thatandromeda I have a hard time with them too, that's why I've been thinking about this
-
do you have a favourite man page? thinking of writing a short blog post exploring man pages and what makes a good one and I'd love some more examples
my contribution: I think it's cool that `man curl` includes an example for every single option
@b0rk
I like section 7 in general - it can provide a good overview and tie together many different manpages relevant to a single topic that'd otherwise be hard to track down.If I have to pick one, I guess it's
capabilities(7) -
@b0rk @thatandromeda Often I pipe the output of `man` into `less`, then try to search for something like -n, which returns way too many results (e.g. mentions of that option before its definition). I wonder if a better `man` could be made that would let me search through an *index* of options instead of doing a full-text search.
@benjamingeer @b0rk @thatandromeda What improved my experience greatly was configuring neovim as man page viewer.
-
do you have a favourite man page? thinking of writing a short blog post exploring man pages and what makes a good one and I'd love some more examples
my contribution: I think it's cool that `man curl` includes an example for every single option
@b0rk I was particularly surprised and happy seeing a code example in xscreensaver-command man page [1], which showcases the way it (xscreensaver-command -watch) can be integrated into the system doing some dynamic stuff.
Despite it's Perl, which I can barely read, but it looked like a really nice addition.
-
@b0rk I was particularly surprised and happy seeing a code example in xscreensaver-command man page [1], which showcases the way it (xscreensaver-command -watch) can be integrated into the system doing some dynamic stuff.
Despite it's Perl, which I can barely read, but it looked like a really nice addition.
@b0rk also, man ascii [1]. While being in misc category, puts the most important information into few different tables and a list. For more convenient exploration and search, in oct, hex, dec, and char representation. Which... fits everything in a single screen.
-
do you have a favourite man page? thinking of writing a short blog post exploring man pages and what makes a good one and I'd love some more examples
my contribution: I think it's cool that `man curl` includes an example for every single option
@b0rk Such a great page to point out. We all learn in different ways.
I don't just want to be told how something works. Please _show_ me how it works.
-
do you have a favourite man page? thinking of writing a short blog post exploring man pages and what makes a good one and I'd love some more examples
my contribution: I think it's cool that `man curl` includes an example for every single option
@b0rk my favourite is the one for `true'. I present it as an example of a documented software. Seriously, how many present day software makers would bother documenting such thing?
-
do you have a favourite man page? thinking of writing a short blog post exploring man pages and what makes a good one and I'd love some more examples
my contribution: I think it's cool that `man curl` includes an example for every single option
@b0rk I love `man ascii`.
-
do you have a favourite man page? thinking of writing a short blog post exploring man pages and what makes a good one and I'd love some more examples
my contribution: I think it's cool that `man curl` includes an example for every single option
@b0rk I am actually surprised how many people here don't know https://tldr.sh. Or at least, thats a feeling I had while reading the comments on bad manpages.
`$ tldr tar`
It's a user composed tl;dr; printing out commonly used commands.
And recently I learned from https://youtube.com/@breadonpenguins about cht.sh. Its even better. Simply type `$ curl cht.sh/cups` and you get a awesome cheatsheet covering basic Linux printer things.
It somehow aggregates multiple sources. One of the sources is actually the tldr.sh page.
