Skip to main content

Julia Evans

12 comments on "Notes on clarifying man pages"

If you have a Mastodon or Fediverse account, you can reply to this post to leave a comment.

Optionally, set the Mastodon server for "Reply" links:

schamschula

@b0rk Another good example is the main curl man page.

rodneylives.bsky.social

I find myself using tldr more than man pages. Man pages are absurdly complete and list every detail of operation, but that makes them wordy, spilling forth for dozens of screen-sized pages, and it becomes an effort just to sift through them. tldr just presents a basic description and typical uses.

malin

@b0rk
Can you do gpg next? Someone needs to do something about that thing.

It's a serious security flaw; some sysadmins can't handle basic operations because the programme and docs are an unsightly mess.

b0rk
Reply to malin

@malin talked about that here recently social.jvns.ca/@b0rk/116035837

david

@b0rk Oh this is excellent, thanks!

elliotguest

@b0rk another interesting thing related to this is cheat.sh which is similar to tldr but just functions through curl or wget to the url

lovely blog post by the way

zekjur

@b0rk I think the Zsh man pages are well split, in the sense that “zshall” gives you all the sections, but if you know roughly which section you’re looking for, you can get to the more targeted (more manageable) part of the manual. Also, I can find the parts of the shell I’m looking for in these docs.

Perl is similar with its many pages, see manpages.debian.org/trixie/per for a listing :)

bpacia
Reply to zekjur

@zekjur @b0rk I too love man pages of zsh!

bnut

@b0rk it’d be interesting to talk about what’s displayed in --help on a command vs how man pages are used. I almost always use the former over the latter, and often forget about man

castanearie

@b0rk I've been really happy reading man pages on mankier.com/. It's nicely formatted, hyperlinked, has a table of contents, tl;dr integration, and even allows you to add it as a search engine.

ilikepi
Reply to castanearie

@castanearie @b0rk

> If you have a complex command and aren't sure what it does, ManKier can help explain the programs and options. Just paste the command on /explain, e.g.: du -s * | sort -n | tail.

Woah 😮 You can even add a description to an /explain page and share it. Very cool site!

b0rk
Reply to castanearie

@castanearie thanks, this looks nice!