MAXStats 1.0.4.0 Documentation
(last change: 13.08.2007)
Author: Hannes "panni" Tismer
Version: 1.0.4.0
Purpose: Client- and serverside match- and general statistics
Contact: #fac.vae, #Q4MAX, hannes@tismer.com
Thanks to alba for providing the neat basic-template!
Another big thank-you goes to spOOnman for his XSL basis.

Index

- General Information
- License Information
- Configuration
- Usage / Installation
- Performance
- Templating
- Bugs
- Upcoming
- Changelog
- Suggestions
- GNU General Public License

General Information

MAXStats is the evolved symbiosis of the clientside q4mXSL and the serverside q4mXML (former q4maxXML).
It provides statistics and details about matches played by a clan or player - serverside (webserver) and clientside (localhost).
When index.html is opened, it detects how it was launched and boots up the corresponding statistics-view.

Generally the output of MAXStats on a webserver (with PHP >4.0.x) includes a way more detailed statistics-view as well as
the features of the clientside version (detailed single-match stats).

If index.html is launched locally, the clientside view is enabled whereas on a webserver the serverside version will be viewed.

All features of q4mXSL and q4mXML have been collected and improved on a high level.

License Information

While MAXStats was designed for the usage of the Q4MAX-mod it is NOT to be used for any other mod or extension.
Because of its modularity it can be extended and improved - all rights/licenses under GPL.

Configuration

DON'T USE ANY OTHER SYMBOLS THAN "/" OR QUOTES. NO QUOTES IN VARIABLE-DATA!

Base-config: "config_clientside.html" - CLIENTside

Information:
The config_clientside.html holds the value for the relative path of your "Q4MAX_DIR/stats" folder. E.g. if MAXStats's
config_clientside.html is located in "Q4MAX_DIR/MAXStats/configs" the folder value would have to be "../../stats".

Values:
../relative/path/to/stats/folder
Example (Default):
../../stats

Base-config: "config.ini" - SERVERside

Section [STATFOLDERS]:

Information:
A folder variable isn't fixed to any name. It must contain a relative or absolute path to the Q4MAX /stats folder.
If the section has more than one folder specified the system will merge all stats found in those folders.
Currently a folder variable can ONLY contain relative or absolute paths (even symlinks) of the same server.
No external links are supported.
The given folders have to be in Q4MAX-stat-style, like "../q4max/stats", containing the following structure:
/yearname/monthname/dayname/*.xml
Please make sure the folder variables don't end with a "/".
Values:
folderX = "/path/to/q4max/stats/folder"
Example:
folder1 = "../../q4max/stats"
folder2 = "/an/absolute/path"

Section [GENERAL]:

Information:
This section contains general settings for output and stat-generation.
Values:
servername = "your server's name"
- Default: ""
Sets the servername which will be displayed on the stats-page.

reparse_stats = NUMERIC_VALUE
- Default: 120
This is the internal value for a full timestamp-based reparse of all collected stats, in seconds. It will reinclude all previously parsed
information of the internal "parsed.ini", with looking for new, unprocessed XML files.

top_count = NUMERIC_VALUE
- Default: 10
This setting determines how many players and clans are to be shown in the "Top-XX-Players/Clans"-Section in MAXStats'
generated output.

dump_stats = 0/1
- Default: 1
By setting dump_stats to 1 the system will dump all collected statistics into the internal "parsed.ini" which improves
the script's loadtime by the factor of 10. This setting is defaulted to 1 and highly recommended.

snip_tags = NUMERIC_VALUE
- Default: 30
This variable contains the maximum-length for playernames and clantags. Names/tags having a bigger length than "snip_tags"
will get truncated.

tp_snip_tags = NUMERIC_VALUE
- Default: 15
This variable contains the maximum-length for playernames and clantags for the "Top-Players"-section in stat-output. Names/tags having a bigger length than "tp_snip_tags" will get truncated.

crop_servername = NUMERIC_VALUE
- Default: 90
The server-name set by "servername"-setting will be cut down to that value if its length is higher.

pdeterm_guid = 0/1
- Default: 1
This setting forces the system to assign a generated, nick-based GuID to every player without a valid GuID set (e.g. for players
without valid CDKey) - leaving it at "1" is suggested

tpdeterm_type = "overall_eff" | "player_eff" | "kills" | "deaths" | "dnet"
- Default: "dnet"
Set this setting to one of the options above - it directly affects the way of the "Top-Players"-ordering.

tcdeterm_type = "avg_playereff" | "kills" | "deaths"
- Default: "avg_playereff"
Set this setting to one of the options above - it directly affects the way of the "Top-Clans"-ordering.
Examples:
servername = "Fragstore - official #Q4MAX public server - www.fragstore.net"
reparse_stats = 120
skip_awards = "holy_shit, impressive"
skip_weapons = "Dark Matter Gun, Railgun"
top_count = 10
dump_stats = 1
snip_tags = 30
tp_snip_tags = 15
crop_servername = 90
pdeterm_guid = 1
tpdeterm_type = "dnet"
tcdeterm_type = "avg_playereff"

Section [FILTERS]:

Information:
This section defines the filtering for different attributes not to be shown or to be skipped constantly, in a "lazy" style.
Values to be skipped have to be separated by |||. The skiplist uses a lazy search mechanism, so for example skipping a playername like "booboo" would skip player "666BooBOO", too.
Values:
ignoredplayernames = "keel|||sorlag"
- Default: "keel|||sorlag"
Which playernames to skip when parsing XML data.

ignoredweapons = "Dark Matter Gun|||Gauntlet"
- Default: "Dark Matter Gun|||Gauntlet"
Which weapons to skip when parsing XML data.

ignoredawards = "impressive"
- Default: ""
Which awards to skip when parsing XML data.

Usage / Installation

CLIENTside:
For MAXStats on clientside you just need to edit "configs/config_clientside.html" and fill in the relative path to your /stats folder.
After launching up MAXStats_root/index.html then, the clientside view should pop-up.

NOTICE: Currently only Firefox and IE >5 are supported in clientside-view!

SERVERside:

All files included in MAXStats' package are to be placed inside a folder accessible by HTTP. After configuring the system (have a look at the config-section) please make sure that "import/parsed.ini" is available and chmodded "777".

With having set-up the system like described above you should be able to immediately access "http://your.server.or.ip/MAXStatsfolder/" or alternatively "http://your.server.or.ip/MAXStatsfolder/index.html".

The whole script can work as a standalone OR included version. It uses an own session-infiltrating technique to work with clanpage-CMS's.

Basic Page (no parameters given):
"Top X Players | Top X Clans | All " ?detail=X / ?clandetail=X / ?showall:
- S witchable list of players/clans, ordered descending by player-efficiency or average- player-efficiency. By clicking
the non-active option the list will be refreshed to clan or player-view. Clan and nicknames are clickable for further
information and stats.
- If "showall" parameter given (link "All") or "Expand ..." , "top_count" config setting will be ignored and all collected entries will be shown.
"Force reparse of all data" ?reparse:
Reparses a previously dumped "parsed.ini" file containing detailed stats about players and/or clans. This option is triggered
automatically and periodically by the system. Its update-interval is determined by the config-setting "reparse_stats".
If newer undumped XML stat-files are available in given stat-folders they will be collected and added to previously collected
data of "parsed.ini".

"Kill all dumped stats" ?killall:
Removes the previously created "parsed.ini" and regathers all available XML files. This option should only be used when
experiencing a bug or when the stat-folder setting has been changed. This option may consume a very high loadtime
depending on the XML-filecount in specified stat-folders. To prevent a high HDD-overhead and/or CPU-load, don't make this
option clickable for public.

"Debug-mode" ?debug
Forces a "killall" and displays detailed debug-information if anything went wrong (e.g. information about rights-based errors when trying to read out of jailed webfolders etc.)

"DumpDebug-mode" ?dumpdebug
Doesn't force a "killall" over the dumped stats as ?debug does, but displays PHP errors, notices and warnings, too.

Player-Information (?detail=X):
Basic Information
"Name" - holding the player's nickname
"Clan" - holding the player's last used clantag
"GuID" - quake4-internal stat-guid, set by quake4 itself - used for identifying users on the server
"Kills" - summarized kills
"Deaths" - summarized deaths
"Suicides" - summarized suicides
"Thaws" - summarized thaws of freezetag games
"Score" - quake4-internal score value (should be kills - suicides - teamkills)
"Damage given" - summarized damage given to enemies
"Damage recieved" - summarized damage taken by enemies (should include teamdamage)
"DNET" - "Damage Netto": Damage given value substracted by Damage recieved
"Best weapon" - weapon with the best average accuracy
"Most played map" - map which was played most often by the player
"Best map" - map with highest average efficiency of player
"Awards earned" - count of all ingame and endgame-awards earned by the player
"Player efficiency" - efficiency value determined by overall kill/death stats *
"Overall efficiency" - player efficiency together with average weapon accuracy
"Nick History" - history of all alternative nicks used by the player
"Clantag History" - history of all previously used alternative clantags
"Internal plID" - hash of GuID, internal value

Weapon Information
Detailed information about every previously used weapon, including kills, hits and accuracy.

Awards Information
List of all ingame and endgame awards earned, together with the count.

Map Information
List of all maps played by the player, including a play-counter, score, deaths and a per-map-efficiency value.

Clan-Information (?clandetail=X):

Basic Information
"Name" - holding the clanname
"Members" - count of all recorded members of the clan
"Team stats" - show recorded win/loss-summary of all played team-matches
"Kills" - all kills of all recorded clan-members
"Deaths" - all deaths of all recorded clan-members
"Suicides" - all suicides of all recorded clan-members
"Damage given" - summarized damage-given value of all clan-members
"Damage recieved" - summarized damage-taken value of all clan-members
"Best weapon" - clan-averaged weapon with highest per-player accuracy
"Best map" - clan-averaged map with highest per-player efficiency

Player Information
List of all clanmembers with basic information like best weapon, overall and kill/death efficiency, kills and deaths.

Footer-Details:
The footer of a MAXStats-page contains detailed information about the script's recent behaviour:
"Script loaded in 0.xxxxxs, dumped, realtime using MAXStats 0.x.x XX"
- This information show us the basic loadtime of the script, along with the word "dumped", which means that the data
shown has not been taken out of the user's session-space but was "realtime" parsed out of "parsed.ini". If there have
been any changes to the stat-folder's data (e.g. new XML files found or new date-folders created) this phrase also
implements, that new data may have been parsed out of new XML files.
-> second fast load-behaviour
"Script loaded in 0.0xxxxs, dump cached, reparsing in xxxs using MAXStats 0.x.x XX "
- This phrase gives us the info that no locally-saved file has been processed - all data has been taken out of the user's
session-space. "Reparsing in xxxs" holds the value in seconds for the time the next reparse of "parsed.ini" will occur,
as well as a filesystem-check will be done to gather new XML files.
-> fastest load-behaviour

"Script loaded in x.xxxxxs, realtime, for xx XML files using MAXStats 0.x.x XX"
- As you can see this phrase doesn't contain "dump" anywhere but "realtime" as well as a XML-filecount. This ONLY happens
after a "?killall" has been processed - e.g. if the user clicks on "Kill all dumped stats". The system has deleted "parsed.ini"
completely and regathered all stat-information out of all existing XML-files.
-> slowest load-behaviour, with a XML-filecount over 250 it may take a while to compute the stats

Efficiency and Accuracy calculations described:
The player-efficiency is being calculated like it was in Q3OSP's scoreboard. It provides an efficiency-percentage which has a
max-value of 100%. The following formula is used for it: (playerkills * 100 / (playerkills + playerdeaths)).
Weapon-accuracy is being calculated with (hits * 100 / shots), the very basic percentage-formula.
The overall-efficiency is the average percentage of player-efficiency and the average weapon-accuracy:
((player-efficiency + avg-weapon-accuracy) / 2)

Performance

CLIENTside:
MAXStats' CLIENTside mode's performance depends on the browser you are using and the speed of your HDD.
Because the /stats folder has to be indexed on boot-up of MAXStats, it may take some time to index all match-files
contained in /stats, depending on how many files you have got in there.

SERVERside:

MAXStats' SERVERside mode uses three different types of content-handling. The fastest one uses data stored in
the user's session-space for the page-output. This mode is the fastest of all three. The second fastest mode is the dumper-
mode which doesn't use the user's session-space at all, but information out of "parsed.ini", containing previously dumped
data. If new XML files found, that are unprocessed in "parsed.ini" it will gather all new informations and merge them up with
the dumped ones.
The slowest mode is a debug-one. It's forked by the parameter "?killall", which deletes the "parsed.ini" and reparses all
information inside all configured stat-folders. This can take up a hell of loadtime and should only be used and being made
available to admins.

The basic data-lifecycle is:
- page request
1. collect data out of XML files
2. summarize and average information about players and clans
3. dump collected data into "parsed.ini"
4. temporarily store collected data into user's session-space for page-browsing, until next reparse is done
- next page request (without reparse)
1. output data carried by user's session-space

- next page request (with reparse)
1. get summarized data out of "parsed.ini", as well as XML-dump-stat informations
2. search for new XML files based on [PREVPARSED]-section in "parsed.ini"
(3.) if needed, parse collected XML files into local class-instances
(4.) if new data has been collected, resave "parsed.ini"
5. temporarily store collected data into user's session-space for page-browsing, until next reparse is done

Basically the dumper function for "parsed.ini" only is 4 times slower than the internal cached session-space,
but more than 20 times faster than realtime-parsing of all XML files.

A realtime-parse of thirty found XML files takes about 0,25seconds on a 2,4ghz Pentium 4 Prescott with 1024MB of RAM.
A dumped-parse using "parsed.ini" takes about 0,0208seconds for the dumped data of thirty XML files inside.
The fastest mode which is mainly used when browsing MAXStats only takes about 0,005seconds for a session-dump with
high award-, weapon- and map-count.

Without the need of any database-engines MAXStats is one of the fastest stat-parsers available.

Templating

Additionally the whole MAXStats SERVERside output can be customized by editing the template-files located in the "/template"-directory.
"index.tpl" holds the basic layout of the page-output; all files ending with "basic" are static pages with basic information
for the requested section (e.g. "clan_details_basic.tpl" holds the basic layout for the "?clandetail=X" parameter).
All files ending with "repeat" are files containing sub-HTML table-structures for repeated, dynamic output like "Weapon Information"
of the parameter "?detail=X".
Every important HTML tag has been shipped with a class-name, defined in "index.css".

The MAXStats CLIENTside output can be customized by editing styl.xsl and styl.css (in /stats/basics folder).

Bugs

Currently known bugs using an appropriate configuration:
- gauntlet stats don't get counted, sv_logXMLstats issue
- on SERVERside view we had some issues with Firefox 1.5.0.1 crashing randomly on selecting a match-file for XSL view
- Opera browser doesn't support optical javascript helper functions -> nick/clan colorcodes/qcodes won't be stripped
Bug-Reports go to panni (#fac.vae, #q4max, hannes@tismer.com)

Upcoming

Planned changes/updates for upcoming versions:
- IRC-Bot for live-stats
- support for distant www-stat folders not on the same machine as the system is

Changelog

Changes made:
MAXStats 1.0.4.0:
- fixed compatibility problems with current CPMA and Q4MAX XML data structures; old XML format should still be supported but is deprecated
- added "FILTERING" section to config for lazily skipping awards, players or weaponnames
- fixed big reparsing bug of "DNET" and "Thaws" of dumped data
- fixed some internals
- removed unecessary datetime javascript filtering for xsl
MAXStats 1.0.3.2:
- added Freezetag statistics support ("thaws")
MAXStats 1.0.3.1:
- fixed XML view error for teamgames
- probably fixed colorcodes with "+" or "-" for fading
MAXStats 1.0.3:
- comprehensive player/clan-search function added
- damagegiven/damagetaken -> DNET for SERVERside (currently only on CLIENTside or matchview)
- added "DNET" as topplayers ordering-option (now default: dnet)
- Opera 9 support for CLIENT and SERVERside
- optimized XML output
- optimized SERVERside output
- optimized javascript helper functions
- fixed some award pictures
- fixed general parser bug, improved performance
- added filter for empty colorcode-filtered or HTML-tag looking values
- added expand/contract link to top-players/clans (equals "all")
- improved color/qcode filter for names/clans
MAXStats 1.0.2:
- improved compatibility, output and errorhandling
- included single match-file view into SERVERside component
- first public release
MAXStats 1.0.0:
- redesigned folders for higher simplicity and supermerged q4mXSL and q4mXML into MAXStats

Suggestions

Suggestions and tips are very appreciated and welcome. The easiest way to make suggestions for further releases available for the developers is to message panni on quakenet, #q4max, E-Mail him to hannes@tismer.com or go to the forums.

## GNU GENERAL PUBLIC LICENSE

Version 2, June 1991

    Copyright (C) 1989, 1991 Free Software Foundation, Inc.    51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA    Everyone is permitted to copy and distribute verbatim copies  of this license document, but changing it is not allowed.

## Preamble

The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.

To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.

For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.

Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.

Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.

The precise terms and conditions for copying, distribution and modification follow.

## TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".

Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.

1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.

You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.

2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:

  a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.

  b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.

  c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.

In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.

3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:

  a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

  b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

  c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.

If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.

4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.

6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.

7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.

It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.

This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.

8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.

9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.

10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.

NO WARRANTY

11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

## END OF TERMS AND CONDITIONS

## How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.

    one line to give the program's name and an idea of what it does.  Copyright (C) yyyy  name of author    This program is free software; you can redistribute it and/or  modify it under the terms of the GNU General Public License  as published by the Free Software Foundation; either version 2  of the License, or (at your option) any later version.    This program is distributed in the hope that it will be useful,  but WITHOUT ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  GNU General Public License for more details.    You should have received a copy of the GNU General Public License  along with this program; if not, write to the Free Software  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this when it starts in an interactive mode:

    Gnomovision version 69, Copyright (C) year name of author  Gnomovision comes with ABSOLUTELY NO WARRANTY; for details  type `show w'.  This is free software, and you are welcome  to redistribute it under certain conditions; type `show c'   for details.

The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:

    Yoyodyne, Inc., hereby disclaims all copyright  interest in the program `Gnomovision'  (which makes passes at compilers) written   by James Hacker.    signature of Ty Coon, 1 April 1989  Ty Coon, President of Vice

This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License.