Require request_insecure_environment to be called from the mod's main scope
[oweals/minetest.git] / doc / minetest.6
index ef425a6df57aac110146edeaaa0e3d69e58a645b..a135e541cfbc4bc7fcd4dccefdeb8140685c3d88 100644 (file)
@@ -1,12 +1,18 @@
-.\" Minetest man page
-.TH minetest 6 "29 January 2012" "" ""
+.TH minetest 6 "10 September 2013" "" ""
 
 .SH NAME
-minetest \- Multiplayer infinite-world block sandbox
+minetest, minetestserver \- Multiplayer infinite-world block sandbox
 
 .SH SYNOPSIS
 .B minetest
-[ OPTION ... ]
+[\fB--server SERVER OPTIONS\fR | \fBCLIENT OPTIONS\fR]
+[\fBCOMMON OPTIONS\fR]
+[\fBWORLD PATH\fR]
+
+.B minetestserver
+[\fBSERVER OPTIONS\fR]
+[\fBCOMMON OPTIONS\fR]
+[\fBWORLD PATH\fR]
 
 .SH DESCRIPTION
 .B Minetest
@@ -14,41 +20,84 @@ is one of the first InfiniMiner/Minecraft(/whatever) inspired games (started Oct
 .PP
 The main design philosophy is to keep it technically simple, stable and portable. It will be kept lightweight enough to run on fairly old hardware.
 
-.SH OPTIONS
+.SH COMMON OPTIONS
 .TP
-\-\-address <value>
-Address to connect to
+.B \-\-help
+Print allowed options and exit
+.TP
+.B \-\-version
+Print version information and exit
 .TP
-\-\-config <value>
+.B \-\-config <value>
 Load configuration from specified file
 .TP
-\-\-disable\-unittests
-Disable unit tests
+.B \-\-logfile <value>
+Set logfile path (debug.txt)
+.TP
+.B \-\-info
+Print more information to console
+.TP
+.B \-\-verbose
+Print even more information to console
+.TP
+.B \-\-trace
+Print enormous amounts of information to console
+.TP
+.B \-\-gameid <value>
+Set gameid
+.TP
+.B \-\-worldname <value>
+Set world path by name
+.TP
+.B \-\-world <value> | list
+Set world path or list worlds
 .TP
-\-\-enable\-unittests
-Enable unit tests
+.B \-\-map\-dir <value>
+Same as \-\-world (deprecated)
 .TP
-\-\-help
-Show allowed options
+.B \-\-port <value>
+Set network port (UDP) to use
 .TP
-\-\-info\-on\-stderr
-Print debug information to console
+.B \-\-run\-unittests
+Run unit tests and exit
+
+.SH CLIENT OPTIONS
+.TP
+.B \-\-address <value>
+Address to connect to
 .TP
-\-\-map\-dir <value>
-Map directory (where everything in the world is stored)
+.B \-\-go
+Disable main menu
 .TP
-\-\-port <value>
-Set network port to connect to
+.B \-\-name <value>
+Set player name
 .TP
-\-\-random\-input
-Enable random user input, for testing
+.B \-\-password <value>
+Set password
 .TP
-\-\-server
-Run server directly
+.B \-\-random\-input
+Enable random user input, for testing (client only)
 .TP
-\-\-speedtests
+.B \-\-videomodes
+List available video modes (client only)
+.TP
+.B \-\-speedtests
 Run speed tests
 
+.SH SERVER OPTIONS
+.TP
+.B \-\-migrate <value>
+Migrate from current map backend to another. Possible values are sqlite3,
+leveldb, redis, and dummy.
+.TP
+.B \-\-terminal
+Display an interactive terminal over ncurses during execution.
+
+.SH ENVIRONMENT
+.TP
+.B MINETEST_SUBGAME_PATH
+Colon delimited list of directories to search for subgames.
+
 .SH BUGS
 Please report all bugs to Perttu Ahola <celeron55@gmail.com>.
 
@@ -57,11 +106,9 @@ Please report all bugs to Perttu Ahola <celeron55@gmail.com>.
 Perttu Ahola <celeron55@gmail.com>
 and contributors.
 .PP
-This man page was written by
+This man page was originally written by
 Juhani Numminen <juhaninumminen0@gmail.com>.
 
 .SH WWW
-http://c55.me/minetest/
+http://www.minetest.net/
 
-.SH "SEE ALSO"
-.BR minetestserver(6)
\ No newline at end of file