man/man6/supertux.6

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