Crystal: Create a man page for 'crystal' binary

[anatol]

man pages is a standard UNIX way to document how tools work. It would be great if crystal had a man page as well.

[asterite]

Sure! If anyone wants to do it, please send a pull request :-)

[EvanHahn]

See PR #2147.

[jhass]

Looks like #2147 was abandoned, adoption highly appreciated.

git remote add upstream https://github.com/crystal-lang/crystal.git
git fetch upstream master
git fetch upstream refs/pull/2147/head
git checkout -b manpage FETCH_HEAD
git rebase -i upstream/master # Squash stuff together
# Fix issues mentioned in #2147
# Update for things that changed since

[do-you-dare]

Hm... I guess I'll take this. :smiley:

[asterite]

Just a small question: what's the benefit of a man page in comparison to crystal --help?

[jhass]

People look for it to find help and you can be a lot more verbose since man calls a pager by default. It's just good practice to have one.

[ysbaddaden]

Check this:

• git --help: quick usage reference;
• man git: full reference with all sub-commands, constants, lots of details for each argument, and more.

[miketheman]

triage Re-tag as community:in-progress as there's an open PR that's waiting for someone to review, provide feedback.

[straight-shoota]

The man page is in the repo, but it seems not to be bundled in the Ubuntu package at least as it is not accessible in /usr/share/man/man1.

[Sija]

Same on Debian:

➜ man crystal
No manual entry for crystal
See 'man 7 undocumented' for help when manual pages are not available.

[mverzilli]

Reopening this because otherwise there are super high chances that we won't go the last mile.

[faustinoaq]

Same on Manjaro Linux:

>>> man crystal
No manual entry for crystal
>>> crystal -v
Crystal 0.23.0 (2017-07-13) LLVM 4.0.1

[asterite]

Closed in favor of https://github.com/crystal-lang/omnibus-crystal/issues/21