ChangeLog update
[tetrinet.git] / tetrinet-server.6
blob109dedb0b1dd83f0069996117118f5b5fdb3dd6c
1 .TH "TETRINET-SERVER" "6" "2004-12-06"
2 .\" Please adjust this date whenever revising the manpage.
3 .SH "NAME"
4 tetrinet-server \- server program for tetrinet
7 .SH "SYNOPSIS"
8 .B tetrinet-server
11 .SH "DESCRIPTION"
12 .B tetrinet-server
13 is a server program for
14 .BR tetrinet (6),
15 a networked version of tetris. You can use it to server both a TetriFast and an
16 original server for up to 6 people to connect and play. It doesn't support any
17 fancy features like different channels, but still includes support for
18 configureable cookie mode and a small winlist.
20 .PP 
22 .SH "OPTIONS"
23 .B tetrinet-server
24 doesn't take any options at all. It reads all its settings from
25 .I ~/.tetrinet
26 on startup and creates a default file if there isn't one already there.
29 .SH "EXAMPLES"
30 This is a short explenation of the configurationfile
31 .I ~/.tetrinet
32 together with its default entries. It is written after every game or when the
33 server quits. If it is not there it will be created automatically.
35 .TP
36 .BI winlist\  "Alcan;0;3;1 AndrewK;0;2;1"
37 This is the winlist the server keeps. Each parameter consists of four
38 semicolon-seperated fields:
39 .IR Name ; Team ; Points ; Games .\  Team
40 is a flag which is either
41 .I 1
42 if the entry is for a team or
43 .I 0
44 if the entry is for a player.
45 .I Points
46 is just the number of points for the entry, and
47 .I Games
48 is the number of games the entry has participated.
50 .TP
51 .BI classic\  1
52 Sets classic mode for the game - that means, no cookies.
54 .TP
55 .BI initiallevel\  1
56 Sets the level in which the game will start. 
58 .TP
59 .BI linesperlevel\  2
60 Defines how many lines will issue a level increase.
62 .TP
63 .BI levelinc\  1
64 How many levels are increased per
65 .B linesperlevel
66 removed lines.
68 .TP
69 .BI averagelevels\  1
70 The levels of all player get averaged if this is set to
71 .IR 1 .
73 .TP
74 .BI speciallines\  1
75 How many lines must be removed to get specials.
77 .TP
78 .BI specialcount\  1
79 The number of specials that are added each time
80 .BR speciallines '
81 lines are removed.
83 .TP
84 .BI specialcapacity\  18
85 This number tells you how many specials you can hold.
87 .TP
88 .BI pieces\  "14 14 15 14 14 14 15"
89 Sets the likeliness of the different pieces. Must sum up to 100. The order is:
90 bar (dark blue), square (yellow), reverse-L (green), L (purple), Z (red), S
91 (light blue), and T (yellow).
93 .TP
94 .BI specials\  "18 18 3 12 0 16 3 12 18"
95 Sets the likeliness of the different specials. Must sum up to 100. The order
96 is: A, C, N, R, S, B, G, Q, O.
98 .TP
99 .BI linuxmode\  0
100 This setting selects whether the client should try to remain compatible with
101 Windows clients.  This only affects the winlist display; if
102 .B linuxmode
103 is set to
104 .IR 1 ,
105 the server will send the number of games played by each player as well as
106 points won.  This is set to zero by default.
109 .BI ipv6_only\  0
110 Listen on ipv6 only.
113 .SH "FILES"
115 .I ~/.tetrinet
116 The configuration file for
117 .BR tetrinet-server .
120 .SH "AUTHOR"
121 This manual page was written by Gerfried Fuchs <alfie@ist.org>.
124 .SH "SEE ALSO"
125 .BR tetrinet (6).