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

No man page #55

Open
gridsystem opened this issue Nov 12, 2013 · 2 comments
Open

No man page #55

gridsystem opened this issue Nov 12, 2013 · 2 comments

Comments

@gridsystem
Copy link

Please stick the git readme in a man page! I'm not keen on referring to websites when I'm working (or playing) in terminal.

@mkilgore
Copy link
Contributor

I agree, I'd like to do that as well (As well as include docs for libreddit). I don't know much about how man pages are made/stored, and how to handle them though, so I'll have to do some research on it.

@omajid
Copy link
Contributor

omajid commented Nov 16, 2013

man pages are essentially text files written in a special markup language. man is mostly a wrapper over troff (or groff) programs which read this file and display in the style of the traditional man page.

A good overview of the syntax is available here.

That said, compared to modern markup languages, it's quite hard to write directly. It's quite common to have this as the generated output from another program. Docbook has man output, as do pandoc and asciidoc (a2x).

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

No branches or pull requests

3 participants