man-to-html/README.md

27 lines
493 B
Markdown
Raw Permalink Normal View History

2019-04-11 20:12:50 +00:00
# man-to-html
Opinionated man page (roff) to html converter.
### Usage
Here's how [my man page](https://man.eddie.sh) is created:
```bash
2019-04-11 20:41:30 +00:00
./man-to-html edward-shen.man index.html
2019-04-11 20:12:50 +00:00
```
2019-04-11 20:41:30 +00:00
This script will automatically fetch in metadata information from the
man page. Specifically, it'll parse the first line:
```roff
.TH cmd-name page date version title
2019-04-11 20:13:57 +00:00
```
2019-04-11 20:12:50 +00:00
2019-04-11 20:41:30 +00:00
This might not work and will likely break if the man page's first line
isn't in that exact format.
2019-04-11 20:12:50 +00:00
### Prereqs
2019-04-11 20:41:30 +00:00
Install `pandoc`.
2019-04-11 20:12:50 +00:00