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 (eg. \-g 800x600)
  29 .TP
  30 .B \-a, \-\-aspect WIDTH:HEIGHT
  31 Run SuperTux with given aspect ratio (eg. \-a 4:3)
  32 .TP
  33 .B \-\-disable\-sfx
  34 Disable sound effects
  35 .TP
  36 .B \-\-disable\-music
  37 Disable music
  38 .TP
  39 .B \-\-help
  40 Show this help message
  41 .TP
  42 .B \-\-version
  43 Display SuperTux version and quit
  44 .TP
  45 .B \-\-console
  46 Enable ingame scripting console
  47 .TP
  48 .B \-\-noconsole
  49 Disable ingame scripting console
  50 .TP
  51 .B \-\-show\-fps
  52 Display framerate in levels
  53 .TP
  54 .B \-\-no\-show\-fps
  55 Do not display framerate in levels
  56 .TP
  57 .B \-\-record\-demo FILE LEVEL
  58 Record a demo to FILE
  59 .TP
  60 .B \-\-play\-demo FILE LEVEL
  61 Play a recorded demo
  62 .SH ENVIRONMENT
  63 .TP
  64 .B SUPERTUX_LANG
  65 overrides locale detection and forces locale to given value, e.g. "de_DE"
  66 .SH FILES
  67 .TP
  68 .B ~/.supertux2
  69 Contains configuration and savegames.
  70 Also acts as an overlay of the SuperTux game data path:
  71 Files placed here will override or supplement game data files.
  72 .SH EXAMPLES
  73 .TP
  74 supertux --window --geometry 800x600
  75 "/usr/share/supertux/levels/world1/26 - The Castle of Nolok.stl"
  76 .TP
  77 supertux --play-demo
  78 "~/Desktop/level26.demo"
  79 .br
  80 "/usr/share/supertux/levels/world1/26 - The Castle of Nolok.stl"
  81 .PP
  82 Custom-made levels can be conveniently stored in the overlay data folder.
  83 Make sure to also create an "info" file, so the collection will be
  84 recognized by SuperTux.
  85 .PP
  86 .B ~/.supertux2/levels/sample_collection/info
  87 .nf
  88 ;SuperTux-Level-Subset
  89 (supertux-level-subset
  90   (title "Sample Collection")
  91   (description "")
  92 )
  93 .fi
  94 .PP
  95 .B ~/.supertux2/levels/sample_collection/level01.stl
  96 .nf
  97 (supertux-level
  98   (version 2)
  99   (name (_ "Sample Level"))
 100   (author "Myself")
 101   ...
 102 .fi
 103
 104 .SH BUGS
 105 This is a development version, so expect plenty of bugs.
 106 .SH AUTHOR
 107 This manual page was written by the SuperTux Devel Team
 108 and is placed in the public domain.