man page?

[jfo]

homebrew allows for a man page to be installed, and it made me realize that zig doesn't have one. Do we want one? What would it look like?

I think it would be nice to have it, as itchy fingers often reach for man when perplexed. All the information that would be in there lives in various help flags, but it might be good to flesh it out and keep it in one place. Of course it isn't necessary, strictly speaking.

wdyt?

[andrewrk]

We have --help, which could potentially be used as the man page content.

Otherwise what you are asking for is More Documentation that we need to make sure is available on platforms that don't have man pages, such as Windows.

I think we'll have a section of the documentation dedicated to command line usage of the compiler. This would correspond to man pages, and the content could be shared.

[jfo]

++ sharing with docs

[andrewchambers]

The approach taken by lfe are .md markdown docs compiled to either plaintext, or man pages by pandoc.

example of what I mean:

https://github.com/rvirding/lfe/blob/develop/doc/src/lfe.1.md
https://github.com/rvirding/lfe/blob/develop/doc/lfe.txt
https://github.com/rvirding/lfe/blob/develop/doc/man/lfe.1

It is quite easy to render this style markdown to html too with some minor pre/post processing.

[daurnimator]

Would love to see the current full documentation page simply converted to a man page with e.g. pandoc.

[justinbalexander]

Second the man page.