Add a man page about shellcheck

[cheecheeo]

Pandoc also has man support [1,2]

[1] http://johnmacfarlane.net/pandoc/demo/pandoc.1.md
[2] http://johnmacfarlane.net/pandoc/demos.html

[HairyFotr]

The wiki has some docs in markdown... might serve as a starting point.

[koalaman]

I'm happily accepting pull requests ^____^

[Dridi]

I'm happily accepting pull requests ^____^

\o/

I'll happily send one of course, but first I'd like you to choose one solution between ronn, rst2man and pandoc. I'll first initiate a shellcheck.1 man page but there could also be a shellcheck.7 best-effort man page describing the various SC#### codes.

Whatever markup (rst, markdown) you choose, it could be used to generate both man and html pages.

[koalaman]

I'd prefer markdown, since it's semi-standard and used on github, stackoverflow and others.

Descriptions of the SC codes are probably best left to the wiki.

[koalaman]

Awesome. Thanks, Dridi!

[Dridi]

I'm kind of an offline person, so I hope you'll reconsider my level 7 man page proposal. I believe detailed explanations belong with the source code, and that a man page with full description of the different codes make sense.

I see something like:

.
|- ShellCheck
|  \ ...
|- test
|  \ ...
|- docs
|  \
|   |- docs.md
|   |- SC1000.md
|   |- SC####.md
|   \ ...
|- shellcheck.7.md
\ ...

You could both generate web pages for http://shellcheck.net and generate a local man page from a concatenation of shellcheck.7.md and docs/SC*.md. With github's markdown friendliness, one could also browse the docs repository, get human-readable pages easily editable in-place.

Awesome. Thanks, Dridi!

Seriously ? Thank you for shellcheck, it instantly became mandatory in my toolbox ! By the way, it has landed in Fedora 19+ :)

[koalaman]

It's not that it doesn't make sense or wouldn't be useful. The benefit of the wiki is that it's anyone can quickly and easily edit it in a familiar way without knowing anything about the project or its file structures. A few wonderful people already have.

If it requires examining the doc structure, doing commits and submitting pull requests, I strongly suspect casual users wouldn't bother, even with github's inline editing tools (I know I wouldn't). That would leave me with the task of managing and updating it, and I'm not doing a very good job of that as it is.