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

Could use a UNIX man page #202

Closed
drwebb opened this issue Jun 6, 2015 · 9 comments
Closed

Could use a UNIX man page #202

drwebb opened this issue Jun 6, 2015 · 9 comments
Assignees
Milestone

Comments

@drwebb
Copy link
Contributor

drwebb commented Jun 6, 2015

Related to #74

It would be nice to provide a man page with the distribution packages that are installed on the user's system.

@drwebb drwebb added this to the Third release milestone Jun 6, 2015
@bitemyapp
Copy link
Contributor

@drwebb do you know of any Haskell projects that have examples of manpages and the installation thereof provided for as part of the install? Would make it easier for somebody to jump in and do this as a first ticket.

@drwebb
Copy link
Contributor Author

drwebb commented Jun 6, 2015

I took a lucky guess and it looks like pandoc does it:
https://github.com/jgm/pandoc/blob/master/Makefile
I have never looked into it myself, but this might be a jumping off point.

@bitemyapp
Copy link
Contributor

@drwebb excellent, thank you. Now a contributor knows where to look! 👍 🐻 😄

@chreekat
Copy link
Member

chreekat commented Jun 7, 2015

See also the mini howto. Even if someone wants to start with markdown and convert with pandoc, it's still a nice reference for the structure of a man page.

@chrisdone
Copy link
Member

One of the options parsers libraries does support generating man pages. Bas van Dyke made one at Better, but I don't recall in what form it was released.

@drwebb drwebb self-assigned this Jun 15, 2015
@drwebb
Copy link
Contributor Author

drwebb commented Jun 15, 2015

If there are no other takers, I'll try to throw up something for the next release and we can refine the generation later if I end up just writing it by hand.

@snoyberg
Copy link
Contributor

Sold!

@snoyberg snoyberg modified the milestones: 0.1.0.0, 0.2.0.0 Jun 22, 2015
@drwebb
Copy link
Contributor Author

drwebb commented Jun 23, 2015

Added a basic man page in c2e5af3. It's mostly hand written. Are we going to keep all the config parsers in Main.hs? It makes the a little inaccessible to an auto generation using pandoc.

pinging @manny-fp and @dysinger to remember to include them in their distro releases

@drwebb
Copy link
Contributor Author

drwebb commented Jun 24, 2015

Closing this now for the moment, we should move to improving the current man page as part of the release process and look to auto generation in the future.

@drwebb drwebb closed this as completed Jun 24, 2015
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

5 participants