Skip to content

#7484 Create man pages for all tools #7632

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

Closed
wants to merge 3 commits into from

Conversation

gavinb
Copy link
Contributor

@gavinb gavinb commented Jul 7, 2013

This patch updates the existing manpage and creates new pages for all of the rust command line tools. Closes #7484.

@graydon
Copy link
Contributor

graydon commented Jul 7, 2013

These are great. I'm curious where you got the rustpkg docs from, though; the man page in this PR describes how rustpkg worked in 0.6 but it has been substantially changed for 0.7, so those docs aren't really accurate. The current markdown docs are mostly up-to-date: https://github.com/mozilla/rust/blob/master/doc/rustpkg.md

@gavinb
Copy link
Contributor Author

gavinb commented Jul 8, 2013

I must have somehow used the older version; I will update the rustpkg page based on the Markdown and update the PR.

@gavinb
Copy link
Contributor Author

gavinb commented Jul 8, 2013

@graydon Here's the proper rustpkg manpage. Hope it's all good to go now.

@kud1ing
Copy link

kud1ing commented Jul 9, 2013

Very nice. I wonder though whether we could hold the tool documentation in one format, say markdown, and generate HTML and man pages e.g. using pandoc.

@gavinb
Copy link
Contributor Author

gavinb commented Jul 9, 2013

@kud1ing This is certainly possible, though not without compromises. A manpage has particular formatting conventions, such as section headings, ordering, option layout and so on. So unless the original Markdown followed this general layout, the result would be a document viewable with man, without being an actual manpage.

I just tried using pandoc to do just this; produce a man document from Markdown. It seems to work ok (once I added a title for the .TH).

However, the original Markdown documents would need some major editing for the result to resemble a proper manpage. But then we should also ensure the format produces decent HTML (and possibly PDF) output as well. So it's hard to serve all purposes well.

I'm happy to do this if that's what people want. Perhaps the pages in this patch could serve in the interim? Should this become another issue?

bors added a commit that referenced this pull request Jul 11, 2013
This patch updates the existing manpage and creates new pages for all of the rust command line tools. Closes #7484.
@bors bors closed this Jul 11, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create man pages for all tools
5 participants