[redeclipse] 37/494: Start writing manpage fro template

[Martin Werner]

This is an automated email from the git hooks/post-receive script.

arand-guest pushed a commit to branch debdir
in repository redeclipse.

commit 88bcc84626809cdca44db91cdf3e73cff34d0f82
Author: Arand Nash <ienorand at gmail.com>
Date:   Sat Feb 26 13:45:35 2011 +0000

    Start writing manpage fro template
---
 manpage.example | 115 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 115 insertions(+)

diff --git a/manpage.example b/manpage.example
new file mode 100644
index 0000000..12af06d
--- /dev/null
+++ b/manpage.example
@@ -0,0 +1,115 @@
+.\" In .TH, FOO should be all caps, SECTION should be 1-8, maybe w/ subsection
+.\" other parms are allowed: see man(7), man(1)
+.\"
+.\" This template provided by Tom Christiansen <tchrist at jhereg.perl.com>.
+.\" 
+.TH REDECLIPSE 6 
+.SH REDECLIPSE
+redeclipse \- Single-player and multi-player first-person ego-shooter
+.SH SYNOPSIS
+.B redeclipse
+.RB [ \-k ]
+.RB [ \-v ]
+.RB [ \-su\fP\fIserveruprate\fP ]
+.RB [ \-si\fP\fIserverip\fP ]
+.RB [ \-sm\fP\fIservermaster\fP ]
+.RB [ \-ss\fP\fIservertype\fP ]
+.RB [ \-sp\fP\fIserverport\fP ]
+.RB [ \-sa\fP\fIservermasterport\fP ]
+.RB [ \-h\fP\fIhomedir\fP ]
+.RB [ \-o\fP\fIoctadir\fP ]
+.RB [ \-p\fP\fIpackagedir\fP ]
+.RB [ \-g\fP\fIlogfile\fP ]
+.SH DESCRIPTION
+Redeclipse is a single-player and multi-player first-person ego-shooter, built as a total conversion of Cube Engine 2, which lends itself toward a balanced gameplay, with a general theme of agility in a variety of environments.
+.SH OPTIONS
+.TP
+.BR \-k
+no idea what this does
+.TP
+.B \-v
+Verbose output - does this actually do anything?
+.TP
+.BR \-su
+no idea what this does with
+.I serveruprate
+.TP
+.BR \-si
+Set server IP address to
+.I serverip
+.TP
+.BR \-sm
+no idea what this does with
+.I servermaster
+.TP
+.BR \-sl
+no idea what this does with
+.I serverload
+.TP
+.BR \-ss
+no idea what this does with
+.I serverload
+.TP
+.BR \-sp
+Set server port to
+.I serverport
+.TP
+.BR \-sa
+Set server master port to
+.I servermasterport
+.TP
+.BR \-h
+Reads and saves game configuration to
+.I homedir
+.TP
+.BR \-o
+no idea what this does with
+.I octodir
+.TP
+.BR \-p
+Add
+.I packagedir
+to the directories scanned for game data
+.TP
+.BR \-g
+Output log to
+.I logfile
+.SH "RETURN VALUE"
+What the program or function returns if successful.
+.SH ERRORS
+Return codes, either exit status or errno settings.
+.SH EXAMPLES
+Give some example uses of the program.
+.SH ENVIRONMENT
+Environment variables this program might care about.
+.SH FILES
+All files used by the program.
+Typical usage is like this:
+.br
+.nf
+.\" set tabstop to longest possible filename, plus a wee bit
+.ta \w'/usr/lib/perl/getopts.pl   'u
+\fI/usr/man\fR	default man tree
+\fI/usr/man/man*/*.*\fR	unformatted (nroff source) man pages
+.SH NOTES
+Miscellaneous commentary.
+.SH CAVEATS
+Things to take special care with, sometimes called WARNINGS.
+.SH DIAGNOSTICS
+All the possible error messages the program can print out,
+what they mean, and how to correct them if applicable.
+.SH BUGS
+Things that are broken or just don't work quite right.
+.SH RESTRICTIONS
+Bugs you don't plan to fix. :-)
+.SH AUTHOR
+Who wrote it (or AUTHORS if multiple).
+.SH HISTORY
+Programs derived from other sources sometimes have this.
+.SH "SEE ALSO"
+.\" Always quote multiple words for .SH
+Other man pages to check out, like
+.BR man (1),
+.BR man (7),
+.BR mandb (8),
+.BR catman (8).

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-games/redeclipse.git