6mo ago

Is there a better way to browse man pages?

For many, many years now when I want to browse a man page about something I'll type man X into my terminal, substituting X for whatever it is I wish to learn about. Depending on the manual, it's short and therefore easy to find what I want, or I am deep in the woods because I'm trying to find a specific flag that appears many times in a very long document. Woe is me if the flag switch is a bare letter, like x.

And let's say it is x. Now I am searching with /x followed by n n n n n n n n N n n n n n. Obviously I'm not finding the information I want, the search is literal (not fuzzy, nor "whole word"), and even if I find something the manual pager might overshoot me because finding text will move the found line to the top of the terminal, and maybe the information I really want comes one or two lines above.

So... there HAS to be a better way, right? There has to be a modern, fast, easily greppable version to go through a man page. Does it exist?

P.S. I am not talking about summaries like tldr because I typically don't need summaries but actual technical descriptions.

54 comments

Kind of off topic, but you know what would be cool? If you had an 'man explain' command that would define all the flags/args in a command, like:
man explain rsync --append-verify --progress -avz -e "ssh -p 2222" root@$dip:/sdcard/DCIM/Camera newphonepix
Would give you:
undefined

rsync - a fast, versatile, remote (and local) file-copying tool --append-verify --append w/old data in file checksum --progress show progress during transfer --archive, -a archive mode is -rlptgoD (no -A,-X,-U,-N,-H) --verbose, -v increase verbosity --compress, -z compress file data during the transfer --rsh=COMMAND, -e specify the remote shell to use
etc.
- Like this?
  
  Or these?
- You can just grep the help output
  bash
  
  $ rsync --help 2>&1 | grep -E '^ *(--append-verify|--progress|--archive)' --archive, -a archive mode is -rlptgoD (no -A,-X,-U,-N,-H) --append-verify --append w/old data in file checksum --progress show progress during transfer
  So it should be possible to create a simple script to do that. Similarly one can output the man document as text to stdout, which in turn can be grepped. I have no grep command at hand to do this in a useful way:
  bash
  
  man grep | col -b
- Here's what I get in fish when I start writing a rsync command and hit tab to ask for completions:
  undefined
  
  ❱ rsync --append-verify --progress -avz - -0 --from0 (All *from/filter files are delimited by 0s) --delete (Delete files that don’t exist on sender) -4 --ipv4 (Prefer IPv4) --delete-after (Receiver deletes after transfer, not before) -6 --ipv6 (Prefer IPv6) --delete-before (Receiver deletes before transfer (default)) -8 --8-bit-output (Leave high-bit chars unescaped in output) --delete-delay (Find deletions during, delete after) [more lines omitted]
- There is a Plugin for Zsh (ohmyzsh) that gives you that right in the shell. I use it all the time and rely on it. Don't have the name on my mind though, sorry.
  
  Please do tell once you've figured it out.
- Fish does this but is intentionally POSIX noncompliant so you'd wanr to keep the old shell installed if you run other people's script.

Bonus:
You can open man pages inside GNOME Help by using yelp man:X
- wow I kept opening man:somethingwithoutsectionunfortunately in firefox instead of doing that lol

Still waiting for someone to create Woman
- It's a thing!
- I picture these pages being inviting and helpful, with maybe ascii art "awk sweet awk" or the like, rather than the current "maintenance locker full of random tools" vibe

I always add a space or two before the flag: / -x

I am searching with /x
On most systems these days you can use regular expressions there. If /-x isn't good enough try /-x[ ,] or whatever.

I’d also like some guidance on this problem (other than “use emacs”), but searching for “ -x” will have a lower false positive rate

As someone with 0 knowledge of Linux (and very little of programming/command lines in general), this thread reads funny AF.
- We are deep in the technical weeds here. 95% of Linux usage really doesn't require such humour unfortunately.

I like tldr. It doesnt give incredibly in depth explanations, but it does show the basics of using most commands.
- I have to remember to use tldr, one of these days. Some manpages get so lost in the pedantry of covering everything that the 99 percentile stuff is buried.
- https://tldr.inbrowser.app/ for anyone curious. There’s also a command line version you can install.

Honestly, I usually just “man command” in google.
I know it’s wrong but my browser is tiled next to my terminal and it’s easy to look up stuff.
- I did this before being in emacs made it so convenient to avoid, but got bit randomly by different versions or gnu vs BSD.

As an emacs user, I use M-x man. All my standard keybindings make finding what I need very easy.
Of course, it's not so fast if you aren't already in emacs.
- I want to mention that one can set the pager for man to be Vim too. Then it would load the document in Vim instead in less for display and navigation. This can be set with option man -P pager or with the environmental variable $MANPAGER or $PAGER . I had set this up in the past with original Vim, but it required some special options for Vim as well. It was nice, but ultimately not needed; so I went back to less. Sometimes less is more.
  Edit: Here is how one can use Neovim as the pager:
  bash
  
  export MANPAGER='nvim +Man!'
  I kind of missed it and will set it to this now. Put this line in the Bash configuration .bashrc and every man document is loaded in Neovim now.
- +1, displaying in a Emacs buffer solves any issues I could have. If you're already 'in' Emacs, this will be more frictionless than shell scripts around man

 undefined

    
       man -k printf
           Search  the short descriptions and manual page names for the keyword
           printf as regular expression.  Print out any matches.  Equivalent to
           apropos printf.

info
- boooooo

Sorry for my previous comment. I was commenting before reading the entire post and was missing the point. On a sidenote, its often enough and helpful to just list the options with program -h or --help . Sometimes the help option has more information or is easier to understand than the man document.
When I search for options in a man document, I usually try it with putting a dash in front of it as -x or --ignore in example. For really large documents sometimes it can help to add a space before it " -x" or a comma after it "-x, " depending on how its actually written. BTW the man program itself has a builtin help you can show by just pressing h while looking at a document.

woman in emacs.
I also find info pages much nicer to use after an adjustment period given I grew up on vim and man.
- Nice operating system. Just lacks a good editor

You can set on what line on the screen less (the pager program man uses by default) puts search results with the -jn/--jump-target=n option. For example, using .5 as a value for n makes less focus the line with the search result on the center of the screen. This should help with your overshoot issue.
Either set the option within less with the - command followed by j.5↵ for the current running instance of less, or set and export the LESS environment variable inside your ~/.bashrc to have less always behave that way.

I read man in nvim, there is a alias on the arch wiki IIRC (and syntax highlighting)

You can search via regex. For instance you know a section heading or flag is the first thing on a line preceded with spaces. I also find it earier to read with extensions for colors.

the / and ? commands in the pagers more and most less implementations should support regular expressions (usually BREs in my experience); which is the same thing grep uses. Consider reading your friendly neighborhood regex formatting manpage, if you are confused. As for easily scrolling, ^G to terminate your search followed by b (or your favorite vi or emacs scrolling bind) to scroll back should be sufficient.
Also, man some-manpage | grep expression works, if you didn't know.

I use nvchad and pipe the man page into it

I've had this same situation happen to me before and my solution was to search -x instead of just x.

I have krunner with the man plugin enabled. When typing man:X in the krunner prompt, a window opens with a nicely styled man page.
- Even quicker is "#X"
  
  I did not know that. Thank you.

I haven't used lsp for a while, but it seemed like a good $PAGER.
https://github.com/dgouders/lsp

Man pages this, man pages that. When will the Linux community start really thinking about woman pages?
- What's a womanual?
  
  That's the point.
  I thought it would be clear that ~~we should start calling them womanuals~~ this was a joke.
- Woman in emacs

Sorry it's not a very direct answer but this is one of the many things that make Emacs such a comfortable environment once you're used to it, which takes ... a while.
There is a man command and then of course it's just more text displayed so you can search and narrow and highlight etc. in the same way you do with any other text. Plus of course there are a few trivial bonuses like links to other man pages being clickable.
It's all text and Emacs is a text manipulation framework (that naturally includes some editors).

As someone else said, setting less' jump value is helpful.
Another tool I use, mostly for the zshall manpage, is https://github.com/kristopolous/mansnip

@GnuLinuxDude@lemmy.ml maybe something like Tkman at https://sourceforge.net/projects/tkman/? Or web based like https://linux.die.net/man/ or https://man7.org/linux/man-pages/index.html.

In KDE, there used to be man: as a protocol that you could use from Konqueror or anything else for that matter. Does it still exist?
I'm at work and cannot check.
- Yup still exists. It is also available in KDE Help Center. And you can quickly jump to a man page you typing "#man" into KRunner.

I lately often use chatgpt for these kind of things. It's amazing in breaking down the parameters and what they mean. Verify, especially when the problem is hard and apparently unfindable. Chatgpt won't find it either. It sometimes makes up things in these scenarios.
edit: You guys are allowed to not like my post but it really helps me so why not try it instead of just downvoting.
- It's amazing
  It sometimes makes up things
  https://xkcd.com/481/

54 comments