summaryrefslogtreecommitdiffstats
path: root/src/desktop/colobot.pod
diff options
context:
space:
mode:
authorPiotr Dziwiński <piotrdz@gmail.com>2012-12-27 07:36:58 -0800
committerPiotr Dziwiński <piotrdz@gmail.com>2012-12-27 07:36:58 -0800
commit0a0e536d650b794fc185eab3605bbc785951a2dd (patch)
treead02cd9ca1e7fabb3ac2eb1e0ac0423e324153e5 /src/desktop/colobot.pod
parent45bee618f91ae13f48e082b5b44c8c796564d2b5 (diff)
parentafea08d57049b58361059cd0a11b92c942ff5458 (diff)
downloadcolobot-0a0e536d650b794fc185eab3605bbc785951a2dd.tar.gz
colobot-0a0e536d650b794fc185eab3605bbc785951a2dd.tar.bz2
colobot-0a0e536d650b794fc185eab3605bbc785951a2dd.zip
Merge pull request #105 from OdyX/dev-desktop-file-man
Add manpage for colobot
Diffstat (limited to 'src/desktop/colobot.pod')
-rw-r--r--src/desktop/colobot.pod47
1 files changed, 47 insertions, 0 deletions
diff --git a/src/desktop/colobot.pod b/src/desktop/colobot.pod
new file mode 100644
index 0000000..2fc3a00
--- /dev/null
+++ b/src/desktop/colobot.pod
@@ -0,0 +1,47 @@
+=encoding utf8
+
+=head1 COLOBOT
+
+colobot - educational programming strategy game
+
+=head1 SYNOPSIS
+
+B<colobot> [B<-datadir> I<path>] [B<-debug>] [B<-loglevel> I<level>] [B<-language> I<lang>]
+
+=head1 DESCRIPTION
+
+Colobot (Colonize with Bots) is an educational game aiming to teach
+programming through entertainment. You are playing as an astronaut on a
+journey with robot helpers to find a planet for colonization. It features 3D
+real-time graphics and a C++ and Java-like, object-oriented language, CBOT,
+which can be used to program the robots available in the game.
+
+=head1 OPTIONS
+
+=over 8
+
+=item B<-help>
+
+Display a short help text
+
+=item B<-datadir> F</path/to/data/>
+
+Set custom data directory path
+
+=item B<-debug>
+
+Enable debug mode (more info printed in logs)
+
+=item B<-loglevel> I<level>
+
+Set log level. Possible choices are: trace, debug, info, warn, error, none.
+
+=item B<-language> I<lang>
+
+Set language. Note that you can also fill the B<LANG> environment variable.
+
+=back
+
+=head1 AUTHOR
+
+This manpage was written by Didier Raboud <S<odyx@debian.org>>.