Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a man page #38

Open
Airblader opened this issue Jan 13, 2017 · 3 comments
Open

Create a man page #38

Airblader opened this issue Jan 13, 2017 · 3 comments

Comments

@Airblader
Copy link

The title is pretty self-explanatory; tools like these definitely should have a man page. :-)

@fmthoma
Copy link
Owner

fmthoma commented Jan 24, 2017

@Airblader I agree. Since I've never created a man page yet, and since I'm not familiar with the format and the tooling around it, it might take a while for me. Any help would be appreciated!

@Airblader
Copy link
Author

The easy answer is to write the raw man file yourself. An example for this is i3lock's man page. But that's a bit bothersome. Another way is this, using asciidoctor and then generating the man page from it. But I'm not familiar with Haskell build system setup.

I assume other Haskell projects have man pages and I'd take inspiration from there. :-)

@sjakobi
Copy link
Contributor

sjakobi commented Jan 24, 2017

pandoc can generate manpages, but I have no experience with that. Here's a short tutorial.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants