commiting to master

Author: R. S. Doiel

Makefile

@@ -38,6 +38,11 @@ test:
 clean:
 	if [ -d bin ]; then rm -fR bin; fi
 	if [ -d dist ]; then rm -fR dist; fi
+	if [ -d man ]; then rm -fR man; fi
+
+man: build
+	mkdir -p man/man1
+	bin/rss2json -generate-manpage | nroff -Tutf8 -man > man/man1/rss2json.1
 
 dist/linux-amd64:
 	mkdir -p dist/bin

cmd/rss2json/rss2json.go

@@ -31,14 +31,19 @@ import (
 )
 
 var (
+	synopsis = `rss2json convers the RSS 2 XML to JSON`
+
 	description = `
-%s is a program that converts RSS v2's XML to JSON.
+_rss2json_ does one thing. It is a program that 
+converts RSS v2 XML to JSON.
 `
 
 	examples = `
 Convert *rss.xml* to *rss.json*.
 
-    %s rss.xml rss.json
+` + "```" + `
+    rss2json rss.xml rss.json
+` + "```" + `
 `
 
 	license = `
@@ -68,6 +73,7 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 	quiet            bool
 	newLine          bool
 	generateMarkdown bool
+	generateManPage  bool
 
 	// Application options
 	prettyPrint bool
@@ -81,8 +87,9 @@ func main() {
 	app.AddParams("INPUT_RSS_XML_FILENAME", "[OUTPUT_JSON_FILENAME]")
 
 	// Add Help Docs
-	app.AddHelp("description", []byte(fmt.Sprintf(description, appName)))
-	app.AddHelp("examples", []byte(fmt.Sprintf(examples, appName)))
+	app.AddHelp("synopsis", []byte(synopsis))
+	app.AddHelp("description", []byte(description))
+	app.AddHelp("examples", []byte(examples))
 	app.AddHelp("license", []byte(fmt.Sprintf(license, appName, rss2.Version)))
 
 	// Standard Options
@@ -95,6 +102,7 @@ func main() {
 	app.StringVar(&inputFName, "i,input", "", "set input filename")
 	app.StringVar(&outputFName, "o,output", "", "set output filename")
 	app.BoolVar(&generateMarkdown, "generate-markdown", false, "generate Markdown documentation")
+	app.BoolVar(&generateManPage, "generate-manpage", false, "generate man page")
 
 	// Application Options
 	app.BoolVar(&prettyPrint, "p,pretty", false, "pretty print XML output")
@@ -127,6 +135,10 @@ func main() {
 		app.GenerateMarkdown(os.Stdout)
 		os.Exit(0)
 	}
+	if generateManPage {
+		app.GenerateManPage(os.Stdout)
+		os.Exit(0)
+	}
 	if showHelp || showExamples {
 		if len(args) > 0 {
 			fmt.Fprintln(app.Out, app.Help(args...))

rss2.go

@@ -27,7 +27,7 @@ import (
 	"strings"
 )
 
-const Version = `v0.0.2`
+const Version = `v0.0.3`
 
 type CustomAttrs []xml.Attr