summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorShadowNinja <shadowninja@minetest.net>2015-02-27 18:05:29 -0500
committerShadowNinja <shadowninja@minetest.net>2015-03-27 15:00:48 -0400
commit93fcab952b28f4db39d9326b83f14cbd86c0cf17 (patch)
tree4a2f0fcf7341c596f50ec24ff0a5a81d43d17ccd /doc
parent284fefb0c32e8222fadd78eeec6e7e718fe25668 (diff)
downloadminetest-93fcab952b28f4db39d9326b83f14cbd86c0cf17.tar.gz
minetest-93fcab952b28f4db39d9326b83f14cbd86c0cf17.tar.bz2
minetest-93fcab952b28f4db39d9326b83f14cbd86c0cf17.zip
Clean up and tweak build system
* Combine client and server man pages. * Update unit test options and available databases in man page. * Add `--worldname` to man page. * Fix a bunch of places where `"Minetest"` was used directly instead of `PROJECT_NAME`. * Disable server build by default on all operating systems. * Make `ENABLE_FREETYPE` not fail if FreeType isn't found. * Enable LevelDB, Redis, and FreeType detection by default. * Remove the `VERSION_PATCH_ORIG` hack. * Add option to search for and use system JSONCPP. * Remove broken LuaJIT version detection. * Rename `DISABLE_LUAJIT` to `ENABLE_LUAJIT`. * Rename `minetest_*` variables in `version.{h,cpp}` to `g_*`. * Clean up style of CMake files.
Diffstat (limited to 'doc')
-rw-r--r--doc/minetest.6110
-rw-r--r--doc/minetestserver.677
2 files changed, 58 insertions, 129 deletions
diff --git a/doc/minetest.6 b/doc/minetest.6
index cd818e1d8..036cea6c9 100644
--- a/doc/minetest.6
+++ b/doc/minetest.6
@@ -1,12 +1,18 @@
-.\" Minetest man page
.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,79 +20,79 @@ 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
-\-\-config <value>
+.B \-\-version
+Print version information and exit
+.TP
+.B \-\-config <value>
Load configuration from specified file
.TP
-\-\-disable\-unittests
-Disable unit tests
+.B \-\-logfile <value>
+Set logfile path (debug.txt)
.TP
-\-\-enable\-unittests
-Enable unit tests
+.B \-\-info
+Print more information to console
.TP
-\-\-gameid <value>
-Set gameid
+.B \-\-verbose
+Print even more information to console
.TP
-\-\-go
-Disable main menu
+.B \-\-trace
+Print enormous amounts of information to console
.TP
-\-\-help
-Show allowed options
+.B \-\-gameid <value>
+Set gameid
.TP
-\-\-version
-Show version information
+.B \-\-worldname <value>
+Set world path by name
.TP
-\-\-logfile <value>
-Set logfile path (debug.txt)
+.B \-\-world <value> | list
+Set world path or list worlds
.TP
-\-\-map\-dir <value>
+.B \-\-map\-dir <value>
Same as \-\-world (deprecated)
.TP
-\-\-name <value>
-Set player name
-.TP
-\-\-password <value>
-Set password
-.TP
-\-\-port <value>
+.B \-\-port <value>
Set network port (UDP) to use
.TP
-\-\-random\-input
-Enable random user input, for testing
-.TP
-\-\-server
-Run dedicated server
+.B \-\-run\-unittests
+Run unit tests and exit
+
+.SH CLIENT OPTIONS
.TP
-\-\-speedtests
-Run speed tests
+.B \-\-address <value>
+Address to connect to
.TP
-\-\-videomodes
-List available video modes
+.B \-\-go
+Disable main menu
.TP
-\-\-info
-Print more information to console
+.B \-\-name <value>
+Set player name
.TP
-\-\-verbose
-Print even more information to console
+.B \-\-password <value>
+Set password
.TP
-\-\-trace
-Print enormous amounts of information to console
+.B \-\-random\-input
+Enable random user input, for testing (client only)
.TP
-\-\-world <value>
-Set world path
+.B \-\-videomodes
+List available video modes (client only)
.TP
-\-\-migrate <value>
-Migrate from current map backend to another. Possible values are sqlite3
-and leveldb. Only works when using \-\-server.
+.B \-\-speedtests
+Run speed tests
-.SH ENVIRONMENT VARIABLES
+.SH SERVER OPTIONS
+.TP
+.B \-\-migrate <value>
+Migrate from current map backend to another. Possible values are sqlite3,
+leveldb, redis, and dummy.
+.SH ENVIRONMENT
.TP
-MINETEST_SUBGAME_PATH
+.B MINETEST_SUBGAME_PATH
Colon delimited list of directories to search for subgames.
.SH BUGS
@@ -103,5 +109,3 @@ Juhani Numminen <juhaninumminen0@gmail.com>.
.SH WWW
http://www.minetest.net/
-.SH "SEE ALSO"
-.BR minetestserver(6)
diff --git a/doc/minetestserver.6 b/doc/minetestserver.6
index 1d4a5f838..db5330d3c 100644
--- a/doc/minetestserver.6
+++ b/doc/minetestserver.6
@@ -1,77 +1,2 @@
-.\" Minetestserver man page
-.TH minetestserver 6 "10 September 2013" "" ""
+.so man6/minetest.6
-.SH NAME
-minetestserver \- Minetest server
-
-.SH SYNOPSIS
-.B minetestserver
-[ OPTION ... ]
-
-.SH DESCRIPTION
-.B Minetest
-is one of the first InfiniMiner/Minecraft(/whatever) inspired games (started October 2010), with a goal of taking the survival multiplayer gameplay to a slightly different direction.
-.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
-.TP
-\-\-config <value>
-Load configuration from specified file
-.TP
-\-\-disable\-unittests
-Disable unit tests
-.TP
-\-\-enable\-unittests
-Enable unit tests
-.TP
-\-\-gameid <value>
-Set gameid
-.TP
-\-\-help
-Show allowed options
-.TP
-\-\-version
-Show version information
-.TP
-\-\-logfile <value>
-Set logfile path (debug.txt)
-.TP
-\-\-map\-dir <value>
-Same as \-\-world (deprecated)
-.TP
-\-\-port <value>
-Set network port (UDP) to use
-.TP
-\-\-info
-Print more information to console
-.TP
-\-\-verbose
-Print even more information to console
-.TP
-\-\-trace
-Print enormous amounts of information to console
-.TP
-\-\-world <value>
-Set world path
-.TP
-\-\-migrate <value>
-Migrate from current map backend to another. Possible values are sqlite3
-and leveldb.
-
-.SH BUGS
-Please report all bugs to Perttu Ahola <celeron55@gmail.com>.
-
-.SH AUTHOR
-.PP
-Perttu Ahola <celeron55@gmail.com>
-and contributors.
-.PP
-This man page was originally written by
-Juhani Numminen <juhaninumminen0@gmail.com>.
-
-.SH WWW
-http://www.minetest.net/
-
-.SH "SEE ALSO"
-.BR minetest(6)