https://github.com/dawsbot/woman
man pages that make you say "woah"
https://github.com/dawsbot/woman
documentation man-page
Last synced: 4 days ago
JSON representation
man pages that make you say "woah"
- Host: GitHub
- URL: https://github.com/dawsbot/woman
- Owner: dawsbot
- License: mit
- Created: 2015-10-14T21:14:44.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-05-30T16:23:19.000Z (almost 4 years ago)
- Last Synced: 2024-11-11T05:53:54.564Z (6 months ago)
- Topics: documentation, man-page
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/woman
- Size: 86.9 KB
- Stars: 11
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Woman: Man pages that make you say "woah"
## Why
Reading man pages in your terminal is cluttered and ugly. The first man page was written in **1971**, and they still look the same. With all of the modern UI trends sweeping the web world, we should not have to struggle with outdated manual pages for the very software we have built the web upon.
Where man fails, woman succeeds
Now you can open man pages in your browser using **beautiful, modern css** styling.
## Installation
```bash
npm install -g woman
```
## Windows Users
woman does not work by default in powershell, consider installing [Cygwin](http://cygwin.com) and [add it to your path](https://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/).
See [this prior issue for Windows info](https://github.com/dawsbot/woman/issues/7#issuecomment-564861162)
## Usage
View your man pages in a modern way. Ports local ```man``` pages directly into your browser with modern UI and font trends.
```bash
woman ls #Open the man page for ls using woman
woman man #Open the man page for man using woman
```