https://github.com/carlbordum/manly
manpages to the point
https://github.com/carlbordum/manly
commands compliment easy explain manpage search
Last synced: 6 months ago
JSON representation
manpages to the point
- Host: GitHub
- URL: https://github.com/carlbordum/manly
- Owner: carlbordum
- License: mit
- Created: 2017-09-14T18:14:30.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-15T17:51:48.000Z (over 2 years ago)
- Last Synced: 2025-02-15T19:56:52.955Z (about 1 year ago)
- Topics: commands, compliment, easy, explain, manpage, search
- Language: Python
- Homepage: https://pypi.org/project/manly/
- Size: 67.4 KB
- Stars: 67
- Watchers: 5
- Forks: 12
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# manly
manly is a compliment to man pages.
It's a lot like [explainshell](https://explainshell.com)
(don't worry, that is explain-shell, not explains-hell).
Your good friend has a funky alias in [his dotfiles](
https://github.com/8Banana/dotfiles/blob/master/__Myst__/.zshrc):
`alias alert="notify-send -i terminal -t 5 'Alert from Terminal!'"`:
```
$ manly notify-send -it
notify-send - a program to send desktop notifications
=====================================================
-t, --expire-time=TIME
The duration, in milliseconds, for the notification to appear on screen.
(Ubuntu's Notify OSD and GNOME Shell both ignore this parameter.)
-i, --icon=ICON[,ICON...]
Specifies an icon filename or stock icon to display.
```
Short and sweet!
## Installation
manly supports Python 2 and 3
$ pip install manly
An unofficial Arch User Repository is maintained by mpolidori at
https://aur.archlinux.org/packages/manly/.
## Develop with me :)
Ideas, contributions and everything else is welcome!
``` bash
$ git clone https://github.com/carlbordum/manly
$ cd manly
$ python -m venv manlyenv
$ . manlyenv/bin/activate
$ python manly.py
```
Make sure test locally before sending a Pull Request using:
``` bash
$ pip install pytest
$ py.test
```