do you have a favourite man page?
Uncategorized
119
Posts
85
Posters
0
Views
-
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 sox(1), for Sound eXchange (the Swiss Army knife of audio manipulation). It's very long, yet gives examples of all of its filters and complicated syntax.
Its sound format conversion section got so long that it ended up in soxformat(7)
-
@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)
@b0rk @nabnux these day's yes. Back in the day the next best was to send it to the line printer and read it on a fan fold continuous feed printout. Many people I knew kept a copy on their desk. https://en.wikipedia.org/wiki/Continuous_stationery#/media/File:Endlospapier_fan-fold_paper.jpg
-
@b0rk I like the man page for strace, because it groups the options by categories: General/Startup/Tracing/Filtering/Output. This makes it easier to discover what is available for a specific purpose. Other man pages just list the options strictly alphabetically (let's say for example the GNU ls man page).
@raimue ooh that's really cool, I don't know how I never noticed that! I think I always assume man pages will be hard to use and I often don't even bother to check and miss it when they're actually well organized
-
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 the Linux man pages for sync(2) and setpriority(2) since they list perfectly sane deviations from the behavior that POSIX mandates.
Sync being synchronous instead of asynchronous and nice/setpriority acting on thread level and not on per process level.
-
@b0rk it's an uncool example these days but...
i always really appreciated how `man perl` links to 40+ other man pages that collectively describe the entire language and its standard library and tools. so if you are trying to learn about it everything you need is there and can be browsed or searched for. the prose is fairly engaging and well-written.
(these days online might make more sense but at the time having it available offline in a very lightweight format that was readable from the terminal was great.)
P.S. the manual pages are actually produced by perldoc which is also a very cool related tool.
-
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 find the BUGS section on Linux's man page cu(1) pretty amusing. It simply says "This program does not work very well".
-
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 favorite one is man after midnight (gimme gimme gimme!)
https://unix.stackexchange.com/questions/405783/why-does-man-print-gimme-gimme-gimme-at-0030
-
@b0rk my favorite one is man after midnight (gimme gimme gimme!)
https://unix.stackexchange.com/questions/405783/why-does-man-print-gimme-gimme-gimme-at-0030
@b0rk “The maintainer of man is a good friend of mine, and one day six years ago I jokingly said to him that if you invoke man after midnight it should print "gimme gimme gimme", because of the Abba song called "Gimme gimme gimme a man after midnight":
Well, he did actually put it in.” -
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
literally anything at man.openbsd.org is amazing
-
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 top(1) on linux. starts out with how to quit and how to get interactive help, ends with a "stupid tricks" section providing food for thought about what top actually does.
-
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 the mdoc man page (at https://man.openbsd.org/mdoc ), partly because it's a nice example of a high-quality readable-and-searchable comprehensive reference for something that's by necessity large and somewhat complicated, and partly because it's one of not very many man pages out there that can be _its own_ example.
-
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 tealdeer (tldr) precisely because it fills the manpage gap in examples for every common operation
-
@b0rk @d6 Here's a very rough count (based on git-blame) from v5.26.0:
842 Nick Ing-Simmons
964 David Mitchell
1197 Nicholas Clark
1331 Yves Orton
1453 Ricardo Signes
1854 brian d foy
2186 Sean M. Burke
2513 Andy Dougherty
2851 Perl 5 Porters
3441 Lukas Mai
3485 Tom Christiansen
3836 Rafael Garcia-Suarez
4454 Dave Rolsky
5181 Father Chrysostomos
5313 Jarkko Hietaniemi
5782 Larry Wall
8959 Gurusamy Sarathy
11712 Karl WilliamsonThis has all the usual problems with git-blame. For example, if one person wrote a file and late someone else rewrapped all the line breaks, that second person would get all the credit.
Tom and Larry's contributions, being older, are going to be obscured by stuff like that.
The cast is only a cast of a couple of hundred, not anything like thousands.
-
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 ipfw on FreeBSD is quite long but very well laid out IMHO -
@b0rk I love tealdeer (tldr) precisely because it fills the manpage gap in examples for every common operation
@b0rk actual manpages that I like:
#3. man 5 systemd.network
#2. man 6 nethack
#1. man 7 asciihonorable mention: man 6 oneko
honorable mention: info libc -
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 really like the git-revisions manpage.
-
@shnizmuffin thanks, will change my link!
I use `man date` very often when I have to format dates - most programming languages use the same syntax so it's convenient when I don't remember if %m is "month" or "minute"
I like it because I know where to look and it works for a *lot* of programming languages (Go and php being rare exceptions)
-
I think my favourite man page example so far is this rsync man page (via @shnizmuffin) https://download.samba.org/pub/rsync/rsync.1
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/?)
i tried implementing this OUTPUT SUMMARY format for grep's man page, I can't tell if I like it or not but it's an interesting exercise to try to give a 1-line description of each item, categorize them, and then order them most-frequently-used-by-me first https://gist.github.com/jvns/9f5966633875a4758e0d947a5b4dbdcf
(probably some of the descriptions are wrong, I only thought about them for maybe 3 seconds each, also this is Mac grep)
(3/?)
-
I think my favourite man page example so far is this rsync man page (via @shnizmuffin) https://download.samba.org/pub/rsync/rsync.1
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
The rsync manpage is among the greatest. One of its great feature is the list of every return code and their meaning, really helpful when scripting!I'm quite fond of the bash manpage
@shnizmuffin -
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 ascii` is the one i look at most often
Gli ultimi otto messaggi ricevuti dalla Federazione
-
What are the most underappreciated TLDs?
-
Astronomia e politica
Quest'anno il Ramadan non comincia nello stesso giorno ovunque.
-
The Fediverse is part of how we get through all this. It's worth fighting for.
-
@courtcan that recommendation just put it on my list. Thanks!
-
Cortei contro il ddl Buongiorno. Le foto dalla piazza romana
@anarchia
Contro un ddl che vuole riscrivere la legge sulla violenza sessuale e che, a a differenza della prima bozza, condivisa anche dalle opposizioni, sostituisce il “consenso” con la «volontà contraria all’atto sessuale», https://www.rivoluzioneanarchica.it/cortei-contro-il-ddl-buongiorno-le-foto-dalla-piazza-romana/
-
So, I just finished reading DEMON COPPERHEAD by Barbara Kingsolver. It was utterly unputdownable, I got mad at my family for speaking to me while I was reading it, and when I read the final sentence and closed the book all I could say was "DAMN."
Highly recommend, y'all. HIGHEST OF HIGHLY.
#BarbaraKingsolver
#DemonCopperhead
#UPDA
#books
#amreading
#ILoveBooks
-
#Quicksy is getting an unusually high amount of registrations from Russia and the US. I wonder if these two countries have something in common.
-
@matt I didn't say it was often. It's just more often than finding real serious bugs. It's mostly things like, "it assumed I wanted to keep backward compatibility with an old API endpoint, even though there are no consumers of the old API and killing old code is actually a benefit".
I'm not convinced it's writing more bugs than I would have written in the same amount of code or that my bugs are more likely to be caught in review. I don't write 100% test coverage for any of my projects...
