diff --git a/README.md b/README.md index f663e58..c366b55 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,22 @@ Opinionated man page (roff) to html converter. ### Usage Here's how [my man page](https://man.eddie.sh) is created: ```bash -./man-to-html edward-shen.man index.html edward-shen "Edward Shen Manual" +./man-to-html edward-shen.man index.html ``` -You can also specify version number, page number, and date: -```bash -./man-to-html edward-shen.man index.html edward-shen "Edward Shen Manual" 4.2.0 1 "January 1st, 1970" +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 ``` +This might not work and will likely break if the man page's first line +isn't in that exact format. + ### Prereqs -- `pandoc` +Install `pandoc`. diff --git a/index.html b/index.html index c204b61..ff82147 100644 --- a/index.html +++ b/index.html @@ -64,8 +64,8 @@ Team TBD.
This man page is under GPLv3 or later. To use Edward Shen for any purpose, please contact Edward Shen <code@eddie.sh> to request a license.
3.2.4
-2019-04-11
+4.3.2
+2019-04-10
EDWARD-SHEN(7)