diff --git a/Makefile b/Makefile index 19af26f..122dbeb 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,12 @@ PREFIX = /usr/local +MANTASTIC = http://mantastic.herokuapp.com + +docs: spot.1 + man ./$< + +spot.1: spot.md + curl -s -F page=@$< $(MANTASTIC) > $@ install: cp spot.sh $(PREFIX)/bin/spot @@ -7,4 +14,4 @@ install: uninstall: rm -f $(PREFIX)/bin/spot -.PHONY: install uninstall \ No newline at end of file +.PHONY: docs install uninstall \ No newline at end of file diff --git a/spot.1 b/spot.1 new file mode 100644 index 0000000..935690a --- /dev/null +++ b/spot.1 @@ -0,0 +1,17 @@ +.\" Generated with Ronnjs 0.3.8 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "SPOT" "1" "March 2012" "" "" +. +.SH "NAME" +\fBspot\fR \-\- full\-text bash search utility +. +.SH "Synopsis" + spot [\-s|\-\-sensitive] [\-i|\-\-insensitive] + [\-C|\-\-no\-colors] [\-L|\-\-no\-linenums] + [\-h|\-\-help] [directory] [term \.\.\.] +. +.SH "Description" + By default unless \fB\-\-sensitive\fR or \fB\-\-insensitive\fR is + specified \fBspot(1)\fR implies \fB\-\-sensitive\fR when an + uppercased character is present in the search string\. \ No newline at end of file diff --git a/spot.md b/spot.md new file mode 100644 index 0000000..965fed2 --- /dev/null +++ b/spot.md @@ -0,0 +1,14 @@ +spot(1) -- full-text bash search utility +=========================================== + +## Synopsis + + spot [-s|--sensitive] [-i|--insensitive] + [-C|--no-colors] [-L|--no-linenums] + [-h|--help] [directory] [term ...] + +## Description + + By default unless `--sensitive` or `--insensitive` is + specified __spot(1)__ implies `--sensitive` when an + uppercased character is present in the search string. \ No newline at end of file