From b44b188894a057e78459a3af4c4e75c1862d23a0 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Wed, 13 Aug 2014 22:34:55 -0700 Subject: Added man page for stmd. --- man/Makefile | 7 +++++++ man/man1/stmd.1 | 32 ++++++++++++++++++++++++++++++++ man/stmd.1.md | 36 ++++++++++++++++++++++++++++++++++++ 3 files changed, 75 insertions(+) create mode 100644 man/Makefile create mode 100644 man/man1/stmd.1 create mode 100644 man/stmd.1.md (limited to 'man') diff --git a/man/Makefile b/man/Makefile new file mode 100644 index 0000000..98528c3 --- /dev/null +++ b/man/Makefile @@ -0,0 +1,7 @@ +ALL=man1/stmd.1 + +.PHONY: all + +all: $(ALL) +man1/%.1: %.1.md + pandoc $< -o $@ -s -t man diff --git a/man/man1/stmd.1 b/man/man1/stmd.1 new file mode 100644 index 0000000..913d5a7 --- /dev/null +++ b/man/man1/stmd.1 @@ -0,0 +1,32 @@ +.TH "stmd" "1" "August 12, 2014" "stmd manual" "" +.SH NAME +.PP +stmd \- convert markdown formatted text to HTML +.SH SYNOPSIS +.PP +stmd [\f[I]options\f[]] [file*] +.SH DESCRIPTION +.PP +\f[C]stmd\f[] acts as a pipe, reading from stdin or from the specified +files and writing to stdout. +It converts markdown formatted plain text to HTML, using the conventions +described in the standard markdown spec. +.SH OPTIONS +.TP +.B \f[C]\-\-ast\f[] +Print an abstract syntax tree instead of HTML. +.RS +.RE +.TP +.B \f[C]\-\-help\f[] +Print usage information. +.RS +.RE +.TP +.B \f[C]\-\-version\f[] +Print version. +.RS +.RE +.SH AUTHORS +.PP +John MacFarlane diff --git a/man/stmd.1.md b/man/stmd.1.md new file mode 100644 index 0000000..6e38afc --- /dev/null +++ b/man/stmd.1.md @@ -0,0 +1,36 @@ +--- +title: stmd +section: 1 +footer: stmd manual +date: August 12, 2014 +... + +# NAME + +stmd - convert markdown formatted text to HTML + +# SYNOPSIS + +stmd [*options*] [file\*] + +# DESCRIPTION + +`stmd` acts as a pipe, reading from stdin or from the specified +files and writing to stdout. It converts markdown formatted plain +text to HTML, using the conventions described in the standard +markdown spec. + +# OPTIONS + +`--ast` +: Print an abstract syntax tree instead of HTML. + +`--help` +: Print usage information. + +`--version` +: Print version. + +# AUTHORS + +John MacFarlane -- cgit v1.2.3