https://github.com/ngzhian/help-me-man

man pages with instant lookup of arguments and what they mean
https://github.com/ngzhian/help-me-man

Last synced: about 1 month ago
JSON representation

man pages with instant lookup of arguments and what they mean

• Host: GitHub
• URL: https://github.com/ngzhian/help-me-man
• Owner: ngzhian
• Created: 2015-05-16T01:19:18.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-05-16T21:24:35.000Z (over 9 years ago)
• Last Synced: 2024-10-13T06:50:58.274Z (3 months ago)
• Language: Python
• Size: 83.4 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.mdown

Awesome Lists containing this project

README

        
# Help me man!

Run commands with instant lookup of what arguments mean from the man pages

![Help me man! demo gif](demo.gif)

## Why

When running certain commands from the shell, e.g. `grep`, it can be pretty hard to remember

what a certain argument does. (how does the `--exclude` option for `grep work`?)

One way is to fire up `man`, look for the argument, exit the pager, and continue typing. That's just distracting.

Another way is to fire up a tmux pane at the side, look up the argument, switch back to your original pane, and continue.

This is slightly better, but when you need to look up multiple arguments it can be quite a hassle switching panes constantly.

Help me man is a small python script that allows you to compose your commands, and instantly grabs the argument description from

the man pages.

## TODO

1. instructions to use

2. package and upload on pypi