man/man6/supertux2.6

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