Contributions > Development

Man Page

(1/3) > >>

kkmic:
I've slapped together a first draft for a Linux man page: https://bitbucket.org/killermosi/openxcom-man-page/

It is basically a copy/paste from the readme.

Until it will be added to the main trunk, please post your comments/additions/patches here.

SupSuper:
What exactly is a man page? ???

kkmic:
Now that's a question that left me a bit surprised.

http://en.wikipedia.org/wiki/Man_page

Basically, a man page is a quick/detailed help for a specific command/application. Not all applications have a man page, though most of them do. It is used in Unix and Unix-like operating systems.

You can try man command in any terminal.

man cp
man mv

and in the future, man openxcom :D

winterheart:
Pure groff-format is hard to understand and maintain. What about Docbook XML? It can be easly converted with "xmlto" package to various formats including HTML and man.

kkmic:

--- Quote from: winterheart on February 16, 2012, 12:52:08 PM ---Pure groff-format is hard to understand and maintain.
--- End quote ---
Yeah, I've noticed that when I have attempted to edit a man page. I have actually started with another page and modified it until it reached the current form

I'll take a look at Docbook XML, as the name went by when I searched for tips and tricks for man pages. Any pointers? (I mean links :P)

If you're interested, I can give you access to the repo.

Navigation

[0] Message Index

[#] Next page