update commandline switch documentation

git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@4352 e016b1c5-ed68-44aa-a2f7-31cac88cffde

config/servercmdline.txt

@@ -0,0 +1,75 @@
+// example servercmdline.txt file (1.1)
+// to use this file, add -Cconfig/servercmdline.txt to your servers commandline
+//
+// * you can't use cubescript here!
+// * everything after '//' in a line will be ignored
+// * one commandline parameter per line only
+// * you have to use the '-' characters for the switches
+// * you can separate the switch and it's argument by whitespace
+//
+// see docs/commandline.html for full parameter descriptions
+
+// example MOTD:
+ -o \f3server using example cmdline file\n\f2feel free to change this :)
+
+
+// commonly used commandline switches:
+
+// -o     // MOTD
+// -n     // server description
+// -n1    // custom server description prefix
+// -n2    // custom server description suffix
+// -f     // port, 1..65534, default 28763
+// -c     // max client number, 1..20, default 6
+// -D     // number of demos to keep in RAM, default 5
+
+// the switches o, n, n1 and n2 support coloring and character escaping; 'o' also supports escaped newlines
+// the available colors are: 0: green, 1: blue, 2: yellow, 3: red, 4: gray, 5: white, 6: dark brown, 7: dark red
+// example multiline MOTD: -o line 1\nline 2\nline 3
+// example colored server description: -n \f3red\f1blue
+
+
+// change these, if you don't like the defaults:
+
+// -k     // kickthreshold, -1..-100, default -5
+// -y     // banthreshold, -1..-100, default -6
+// -r     // server maprot file, default config/maprot.cfg
+// -X     // server passwords file, default config/serverpwd.cfg
+// -B     // server IP blacklist file, default config/serverblacklist.cfg
+// -K     // server nickname blacklist file, default config/nicknameblacklist.cfg
+// -P     // voting permission string (read docs/commandline.html)
+//    k kick players
+//    b ban players (and remove bans)
+//    m change mastermode (open/private)
+//    f force a player to the other team
+//    a enable/disable autoteam
+//    s shuffle the teams
+//    r record a demo of the next game (if autorecording is disabled)
+//    c clear all demos on server
+//    d change server description
+//    e vote for coopedit mode
+//    p vote for a gamemode that is not supported by the map (default: no one can)
+//    default: fkBMasRCDE (lowercase: a user can vote for it; uppercase: admin role is required to vote)
+// -M     // sendmap permission string (read docs/commandline.html)
+//    c create new map (initial map upload)
+//    u update existing map
+//    d delete map (default: no one can)
+//    default: CU (lowercase: any user is allowed to do it; uppercase: admin role is required)
+
+// rarely used switches:
+
+// -p     // serverpassword, for passworded servers
+// -N     // syslog identity string
+// -F     // syslog facility, 0..7, default 6
+// -x     // adminpasswd, don't use, use serverpwd.cfg instead
+// -W     // demopath, path & file prefix to store recorded demos at
+// -V     // verbose logging (enable this via commandline, until you're sure, there are no errors in your config left)
+// -C     // import commandline options from file (can be used recursively)
+
+
+// don't use this switches, unless you really know what you're doing:
+
+// -u     // uprate
+// -i     // ip, only for machines with multiple network interfaces
+// -m     // masterserver URL (exception: use "-m localhost", if you don't want AC to register at a masterserver at all)
+

docs/commandline.html

@@ -321,6 +321,16 @@
 						Sets the log identity to ID. By default, the log identity is 'IP[port]'. On linux systems,
 						the log identity is used for the syslog to identify server log entries. On windows and
 						apple systems, the log identity is used to create the server logfile filename.
+         </td>
+				</tr>
+				<tr>
+					<td style="text-align: center;vertical-align: top">
+						<span class="codecommandline">-F</span>n
+					</td>
+					<td>
+						Sets the syslog facility to n. Values from 0 to 7 are allowed to use the facilities
+						local0..local7. By default, local6 is used. For further information, check the
+						documentation of your installed syslog deamon.
          </td>
 				</tr>
 				<tr>
@@ -389,6 +399,15 @@
 						<span class="code">-Bconfig/serverblacklist.cfg</span>
 					</td>
 				</tr>
+				<tr>
+					<td style="text-align: center;vertical-align: top">
+						<span class="codecommandline">-K</span>f
+					</td>
+					<td>
+						Sets the nickname blacklist file. The default is
+						<span class="code">-Kconfig/nicknameblacklist.cfg</span>
+					</td>
+				</tr>
 				<tr>
 					<td style="text-align: center;">
 						<span class="codecommandline">-o</span>N
@@ -482,11 +501,12 @@
 				</tr> 
 				<tr>
 					<td style="text-align: center;vertical-align: top">
-						<span class="codecommandline">-D</span>
+						<span class="codecommandline">-D</span>n
 					</td>
 					<td>
-						Enables permanent demo recording. Every game will
-						be recorded. The recorded demos will be held in RAM. By default, up to 5 demos will be kept.
+					  Sets the maximum number of recorded demos to be held in server RAM.
+						Every game will be recorded. The recorded demos will be held in RAM. By default, up to 5 demos will be kept.
+						To disable automatic demo recording, set the number to 0.
 						The oldest demo will be deleted automatically if necessary, to allow recording of further demos.
 						To change the default of 5 demos in RAM, you can add the number of demos to the parameter,
 						e.g. <span class="code">-D5</span>
@@ -516,6 +536,18 @@
 						is started directly from the windows service manager.
 					</td>
 				</tr>
+				<tr>
+					<td style="text-align: center;vertical-align: top">
+						<span class="codecommandline">-C</span>f
+					</td>
+					<td>
+						Reads commandline arguments from a file. For example, 
+						<span class="code">-Cconfig/servercmdline.txt</span> will read arguments from that file.
+            Only one parameter per line is allowed. Empty lines, and any text after '//' will be ignored.
+						The file is only read once at server startup; changing the file's content will not affect a running server.
+						See config/servercmdline.txt for additional info. No file is read by default.
+					</td>
+				</tr>
 				<tr>
 					<td style="text-align: center;">
 						<span class="codecommandline">-V</span>