Android: fix another build typo
[oweals/minetest.git] / doc / minetest.6
1 .TH minetest 6 "10 September 2013" "" ""
2
3 .SH NAME
4 minetest, minetestserver \- Multiplayer infinite-world block sandbox
5
6 .SH SYNOPSIS
7 .B minetest
8 [\fB--server SERVER OPTIONS\fR | \fBCLIENT OPTIONS\fR]
9 [\fBCOMMON OPTIONS\fR]
10 [\fBWORLD PATH\fR]
11
12 .B minetestserver
13 [\fBSERVER OPTIONS\fR]
14 [\fBCOMMON OPTIONS\fR]
15 [\fBWORLD PATH\fR]
16
17 .SH DESCRIPTION
18 .B Minetest
19 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.
20 .PP
21 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.
22
23 .SH COMMON OPTIONS
24 .TP
25 .B \-\-help
26 Print allowed options and exit
27 .TP
28 .B \-\-version
29 Print version information and exit
30 .TP
31 .B \-\-config <value>
32 Load configuration from specified file
33 .TP
34 .B \-\-logfile <value>
35 Set logfile path (debug.txt)
36 .TP
37 .B \-\-info
38 Print more information to console
39 .TP
40 .B \-\-verbose
41 Print even more information to console
42 .TP
43 .B \-\-trace
44 Print enormous amounts of information to console
45 .TP
46 .B \-\-gameid <value>
47 Set gameid
48 .TP
49 .B \-\-worldname <value>
50 Set world path by name
51 .TP
52 .B \-\-world <value> | list
53 Set world path or list worlds
54 .TP
55 .B \-\-map\-dir <value>
56 Same as \-\-world (deprecated)
57 .TP
58 .B \-\-port <value>
59 Set network port (UDP) to use
60 .TP
61 .B \-\-run\-unittests
62 Run unit tests and exit
63
64 .SH CLIENT OPTIONS
65 .TP
66 .B \-\-address <value>
67 Address to connect to
68 .TP
69 .B \-\-go
70 Disable main menu
71 .TP
72 .B \-\-name <value>
73 Set player name
74 .TP
75 .B \-\-password <value>
76 Set password
77 .TP
78 .B \-\-random\-input
79 Enable random user input, for testing (client only)
80 .TP
81 .B \-\-videomodes
82 List available video modes (client only)
83 .TP
84 .B \-\-speedtests
85 Run speed tests
86
87 .SH SERVER OPTIONS
88 .TP
89 .B \-\-migrate <value>
90 Migrate from current map backend to another. Possible values are sqlite3,
91 leveldb, redis, and dummy.
92 .TP
93 .B \-\-terminal
94 Display an interactive terminal over ncurses during execution.
95
96 .SH ENVIRONMENT
97 .TP
98 .B MINETEST_SUBGAME_PATH
99 Colon delimited list of directories to search for subgames.
100
101 .SH BUGS
102 Please report all bugs to Perttu Ahola <celeron55@gmail.com>.
103
104 .SH AUTHOR
105 .PP
106 Perttu Ahola <celeron55@gmail.com>
107 and contributors.
108 .PP
109 This man page was originally written by
110 Juhani Numminen <juhaninumminen0@gmail.com>.
111
112 .SH WWW
113 http://www.minetest.net/
114