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 \-\-renderer RENDERER
  40 Render the game using the specified video renderer. Valid values are sdl, opengl, and auto (the default).
  41 .TP
  42 .B \-\-disable\-sfx
  43 Disable sound effects
  44 .TP
  45 .B \-\-disable\-music
  46 Disable music
  47 .TP
  48 .B \-\-help
  49 Show this help message
  50 .TP
  51 .B \-\-version
  52 Display SuperTux version and quit
  53 .TP
  54 .B \-\-console
  55 Enable ingame scripting console
  56 .TP
  57 .B \-\-noconsole
  58 Disable ingame scripting console
  59 .TP
  60 .B \-\-show\-fps
  61 Display framerate in levels
  62 .TP
  63 .B \-\-no\-show\-fps
  64 Do not display framerate in levels
  65 .TP
  66 .B \-\-record\-demo FILE LEVEL
  67 Record a demo to FILE
  68 .TP
  69 .B \-\-play\-demo FILE LEVEL
  70 Play a recorded demo
  71 .SH ENVIRONMENT
  72 .TP
  73 .B SUPERTUX_LANG
  74 Overrides locale detection and forces locale to given value, e.g. "de_DE".
  75 .SH FILES
  76 .TP
  77 .B ~/.supertux2
  78 Contains configuration and savegames.
  79 Also acts as an overlay of the SuperTux game data path:
  80 Files placed here, as well as contents of Zip archives in this directory,
  81 will override or supplement game data files.
  82 .SH EXAMPLES
  83 To play level /tmp/mylevel.stl in a window of size 800x600, run
  84 the program like this:
  85 .IP
  86 .B supertux2 --window --geometry 800x600 /tmp/mylevel.stl
  87 .LP
  88 To play a previously recorded demo /tmp/mylevel.demo of level
  89 /tmp/mylevel.stl, run SuperTux like this:
  90 .IP
  91 .B supertux2 --play-demo /tmp/mylevel.demo /tmp/mylevel.stl
  92 .LP
  93 .PP
  94 Custom-made levels can be conveniently stored in the overlay data folder.
  95 .PP
  96 .TP
  97 .B ~/.supertux2/levels/sample_collection/level01.stl
  98 .nf
  99 (supertux-level
 100   (version 2)
 101   (name (_ "Sample Level"))
 102   (author "Myself")
 103   ...
 104 .fi
 105 .PP
 106 Make sure to also create an "info" file, so the collection will be
 107 recognized by SuperTux.
 108 .TP
 109 .B ~/.supertux2/levels/sample_collection/info
 110 .nf
 111 ;SuperTux-Level-Subset
 112 (supertux-level-subset
 113   (title "Sample Collection")
 114   (description "")
 115 )
 116 .fi
 117 .PP
 118 For easier distribution, the level collection can be bundled in a Zip
 119 archive.
 120 .PP
 121 .TP
 122 .B ~/.supertux2/sample_collection.zip
 123 .nf
 124 levels/sample_collection/info
 125 levels/sample_collection/level01.stl
 126  ...
 127 .fi
 128 .SH BUGS
 129 This is a development version, so expect plenty of bugs.
 130 .SH AUTHOR
 131 This manual page was written by the SuperTux Devel Team
 132 and is placed in the public domain.