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 \-\-show\-fps
  46 Display framerate in levels
  47 .TP
  48 .B \-\-record\-demo FILE LEVEL
  49 Record a demo to FILE
  50 .TP
  51 .B \-\-play\-demo FILE LEVEL
  52 Play a recorded demo
  53 .SH ENVIRONMENT
  54 .TP
  55 .B SUPERTUX_LANG
  56 overrides locale detection and forces locale to given value, e.g. "de_DE"
  57 .SH FILES
  58 .TP
  59 .B ~/.supertux2
  60 Contains configuration and savegames.
  61 Also acts as an overlay of the SuperTux game data path:
  62 Files placed here will override or supplement game data files.
  63 .SH EXAMPLES
  64 .TP
  65 supertux --window --geometry 800x600
  66 "/usr/share/supertux/levels/world1/26 - The Castle of Nolok.stl"
  67 .TP
  68 supertux --play-demo
  69 "~/Desktop/level26.demo"
  70 .br
  71 "/usr/share/supertux/levels/world1/26 - The Castle of Nolok.stl"
  72 .PP
  73 Custom-made levels can be conveniently stored in the overlay data folder.
  74 Make sure to also create an "info" file, so the collection will be
  75 recognized by SuperTux.
  76 .PP
  77 .B ~/.supertux2/levels/sample_collection/info
  78 .nf
  79 ;SuperTux-Level-Subset
  80 (supertux-level-subset
  81   (title "Sample Collection")
  82   (description "")
  83 )
  84 .fi
  85 .PP
  86 .B ~/.supertux2/levels/sample_collection/level01.stl
  87 .nf
  88 (supertux-level
  89   (version 2)
  90   (name (_ "Sample Level"))
  91   (author "Myself")
  92   ...
  93 .fi
  94
  95 .SH BUGS
  96 This is a development version, so expect plenty of bugs.
  97 .SH AUTHOR
  98 This manual page was written by the SuperTux Devel Team
  99 and is placed in the public domain.