Trying to separate Menu and Menu management stuff

[supertux.git] / man / man6 / supertux2.6

diff --git a/man/man6/supertux2.6 b/man/man6/supertux2.6
index d42e335..31d913c 100644 (file)
--- a/man/man6/supertux2.6
+++ b/man/man6/supertux2.6
@@ -1,11 +1,14 @@
-.TH SUPERTUX 6 "December 17, 2006" "0.3.0" "SuperTux"
+.TH SUPERTUX2 6 "December 17, 2006" "SuperTux 0.3.2-SVN" "Games"

 .SH NAME
 .SH NAME

-supertux \- a classic style 2D platform game
+supertux2 \- preview release of SuperTux Milestone 2, a classic style 2D platform game

 .SH SYNOPSIS
 .SH SYNOPSIS

-.B supertux
+.B supertux2
+.RI [ options ]
+.br
+.B supertux2

 .RI [ options ] " level.stl"
 .br
 .RI [ options ] " level.stl"
 .br

-.B supertux
+.B supertux2

 .RI [ options ] " worldmap.stwm"
 .br
 .SH DESCRIPTION
 .RI [ options ] " worldmap.stwm"
 .br
 .SH DESCRIPTION


@@ -30,6 +33,12 @@ Run SuperTux in given resolution (eg. \-g 800x600)
 .B \-a, \-\-aspect WIDTH:HEIGHT
 Run SuperTux with given aspect ratio (eg. \-a 4:3) 
 .TP
 .B \-a, \-\-aspect WIDTH:HEIGHT
 Run SuperTux with given aspect ratio (eg. \-a 4:3) 
 .TP

+.B \-d, \-\-default
+Reset video settings to default values (\-g 800x600 \-a auto \-w) 
+.TP
+.B \-\-renderer RENDERER
+Render the game using the specified video renderer. Valid values are sdl, opengl, and auto (the default). 
+.TP

 .B \-\-disable\-sfx
 Disable sound effects
 .TP
 .B \-\-disable\-sfx
 Disable sound effects
 .TP


@@ -62,27 +71,41 @@ Play a recorded demo
 .SH ENVIRONMENT
 .TP
 .B SUPERTUX_LANG
 .SH ENVIRONMENT
 .TP
 .B SUPERTUX_LANG

-overrides locale detection and forces locale to given value, e.g. "de_DE"
+Overrides locale detection and forces locale to given value, e.g. "de_DE".

 .SH FILES
 .TP
 .B ~/.supertux2
 Contains configuration and savegames.
 Also acts as an overlay of the SuperTux game data path: 
 .SH FILES
 .TP
 .B ~/.supertux2
 Contains configuration and savegames.
 Also acts as an overlay of the SuperTux game data path: 

-Files placed here will override or supplement game data files.
+Files placed here, as well as contents of Zip archives in this directory, 
+will override or supplement game data files.

 .SH EXAMPLES
 .SH EXAMPLES

-.TP
-supertux --window --geometry 800x600
-"/usr/share/supertux/levels/world1/26 - The Castle of Nolok.stl"
-.TP
-supertux --play-demo 
-"~/Desktop/level26.demo" 
-.br
-"/usr/share/supertux/levels/world1/26 - The Castle of Nolok.stl"
+To play level /tmp/mylevel.stl in a window of size 800x600, run 
+the program like this:
+.IP
+.B supertux2 --window --geometry 800x600 /tmp/mylevel.stl
+.LP
+To play a previously recorded demo /tmp/mylevel.demo of level 
+/tmp/mylevel.stl, run SuperTux like this: 
+.IP
+.B supertux2 --play-demo /tmp/mylevel.demo /tmp/mylevel.stl
+.LP

 .PP
 Custom-made levels can be conveniently stored in the overlay data folder. 
 .PP
 Custom-made levels can be conveniently stored in the overlay data folder. 

+.PP
+.TP
+.B ~/.supertux2/levels/sample_collection/level01.stl
+.nf
+(supertux-level
+  (version 2)
+  (name (_ "Sample Level"))
+  (author "Myself")
+  ...
+.fi
+.PP

 Make sure to also create an "info" file, so the collection will be 
 recognized by SuperTux.
 Make sure to also create an "info" file, so the collection will be 
 recognized by SuperTux.

-.PP
+.TP

 .B ~/.supertux2/levels/sample_collection/info
 .nf
 ;SuperTux-Level-Subset
 .B ~/.supertux2/levels/sample_collection/info
 .nf
 ;SuperTux-Level-Subset


@@ -92,15 +115,16 @@ recognized by SuperTux.
 )
 .fi
 .PP
 )
 .fi
 .PP

-.B ~/.supertux2/levels/sample_collection/level01.stl
+For easier distribution, the level collection can be bundled in a Zip
+archive.
+.PP
+.TP
+.B ~/.supertux2/sample_collection.zip

 .nf
 .nf

-(supertux-level
-  (version 2)
-  (name (_ "Sample Level"))
-  (author "Myself")
-  ...
+levels/sample_collection/info
+levels/sample_collection/level01.stl
+...

 .fi
 .fi

-

 .SH BUGS
 This is a development version, so expect plenty of bugs.
 .SH AUTHOR
 .SH BUGS
 This is a development version, so expect plenty of bugs.
 .SH AUTHOR