man/man6/supertux2.6

   1 .TH SUPERTUX2 6 "December 17, 2006" "SuperTux 0.3.2-SVN" "Games"
   2 .SH NAME
   3 supertux2 \- preview release of SuperTux Milestone 2, a classic style 2D platform game
   4 .SH SYNOPSIS
   5 .B supertux2
   6 .RI [ options ]
   7 .br
   8 .B supertux2
   9 .RI [ options ] " level.stl"
  10 .br
  11 .B supertux2
  12 .RI [ options ] " worldmap.stwm"
  13 .br
  14 .SH DESCRIPTION
  15 SuperTux is a classic style 2D platform game.
  16 Run and jump through multiple worlds, fighting off enemies by jumping
  17 on them, bumping them from below or tossing objects at them, grabbing
  18 power-ups and other stuff on the way.
  19 .SH OPTIONS
  20 These programs follow the usual GNU command line syntax, with long
  21 options starting with two dashes (`-').
  22 A summary of options is included below.
  23 .TP
  24 .B \-f, \-\-fullscreen
  25 Run in fullscreen mode
  26 .TP
  27 .B \-w, \-\-window
  28 Run in window mode
  29 .TP
  30 .B \-g, \-\-geometry WIDTHxHEIGHT
  31 Run SuperTux in given resolution (eg. \-g 800x600)
  32 .TP
  33 .B \-a, \-\-aspect WIDTH:HEIGHT
  34 Run SuperTux with given aspect ratio (eg. \-a 4:3)
  35 .TP
  36 .B \-d, \-\-default
  37 Reset video settings to default values (\-g 800x600 \-a auto \-w)
  38 .TP
  39 .B \-\-disable\-sfx
  40 Disable sound effects
  41 .TP
  42 .B \-\-disable\-music
  43 Disable music
  44 .TP
  45 .B \-\-help
  46 Show this help message
  47 .TP
  48 .B \-\-version
  49 Display SuperTux version and quit
  50 .TP
  51 .B \-\-console
  52 Enable ingame scripting console
  53 .TP
  54 .B \-\-noconsole
  55 Disable ingame scripting console
  56 .TP
  57 .B \-\-show\-fps
  58 Display framerate in levels
  59 .TP
  60 .B \-\-no\-show\-fps
  61 Do not display framerate in levels
  62 .TP
  63 .B \-\-record\-demo FILE LEVEL
  64 Record a demo to FILE
  65 .TP
  66 .B \-\-play\-demo FILE LEVEL
  67 Play a recorded demo
  68 .SH ENVIRONMENT
  69 .TP
  70 .B SUPERTUX_LANG
  71 Overrides locale detection and forces locale to given value, e.g. "de_DE".
  72 .SH FILES
  73 .TP
  74 .B ~/.supertux2
  75 Contains configuration and savegames.
  76 Also acts as an overlay of the SuperTux game data path:
  77 Files placed here, as well as contents of Zip archives in this directory,
  78 will override or supplement game data files.
  79 .SH EXAMPLES
  80 To play level /tmp/mylevel.stl in a window of size 800x600, run
  81 the program like this:
  82 .IP
  83 .B supertux2 --window --geometry 800x600 /tmp/mylevel.stl
  84 .LP
  85 To play a previously recorded demo /tmp/mylevel.demo of level
  86 /tmp/mylevel.stl, run SuperTux like this:
  87 .IP
  88 .B supertux2 --play-demo /tmp/mylevel.demo /tmp/mylevel.stl
  89 .LP
  90 .PP
  91 Custom-made levels can be conveniently stored in the overlay data folder.
  92 .PP
  93 .TP
  94 .B ~/.supertux2/levels/sample_collection/level01.stl
  95 .nf
  96 (supertux-level
  97   (version 2)
  98   (name (_ "Sample Level"))
  99   (author "Myself")
 100   ...
 101 .fi
 102 .PP
 103 Make sure to also create an "info" file, so the collection will be
 104 recognized by SuperTux.
 105 .TP
 106 .B ~/.supertux2/levels/sample_collection/info
 107 .nf
 108 ;SuperTux-Level-Subset
 109 (supertux-level-subset
 110   (title "Sample Collection")
 111   (description "")
 112 )
 113 .fi
 114 .PP
 115 For easier distribution, the level collection can be bundled in a Zip
 116 archive.
 117 .PP
 118 .TP
 119 .B ~/.supertux2/sample_collection.zip
 120 .nf
 121 levels/sample_collection/info
 122 levels/sample_collection/level01.stl
 123 ...
 124 .fi
 125 .SH BUGS
 126 This is a development version, so expect plenty of bugs.
 127 .SH AUTHOR
 128 This manual page was written by the SuperTux Devel Team
 129 and is placed in the public domain.