Rename our docos from README.html to Quakespasm.html (etc).

git-svn-id: svn://svn.code.sf.net/p/quakespasm/code/trunk/quakespasm@1007 af15c1b1-3010-417e-b628-4374ebc0bcbd
This commit is contained in:
Steven 2014-09-09 00:45:12 +00:00
parent d7d6ad2d05
commit 7724318518
5 changed files with 55 additions and 49 deletions

View file

@ -1,6 +1,6 @@
# sgml tools are from linuxdoc-tools # sgml tools are from linuxdoc-tools
default: README.sgml default: Quakespasm.sgml
sgml2html -s 0 -T 2 README.sgml 2>/dev/null sgml2html -s 0 -T 2 Quakespasm.sgml 2>/dev/null
all: default text all: default text
text txt: README.sgml text txt: Quakespasm.sgml
./sgml2rawtxt README ./sgml2rawtxt Quakespasm

View file

@ -49,7 +49,7 @@ Since version 0.85.4, Quakespasm can play back external MP3, OGG and Wave music
<item>Unix users may need some extra libraries installed: "libmad" or "libmpg123" for MP3, and "libogg" and "libvorbis" for OGG. <item>Unix users may need some extra libraries installed: "libmad" or "libmpg123" for MP3, and "libogg" and "libvorbis" for OGG.
<item>As of 0.85.10, music is played back at 44100Hz by default with no need to adjust "-sndspeed". <item>As of 0.85.10, music is played back at 44100Hz by default with no need to adjust "-sndspeed".
<item>Use the "-noextmusic" option to disable this feature. <item>Use the "-noextmusic" option to disable this feature.
<item>See <url url="README.music"> for more details. <item>See <url url="Quakespasm-Music.txt"> for more details.
</itemize> </itemize>

View file

@ -15,51 +15,51 @@
<P><EM>Page last edited Sep. 08, 2014</EM></P> <P><EM>Page last edited Sep. 08, 2014</EM></P>
<P> <P>
<H2><A NAME="toc1">1.</A> <A HREF="README.html#s1">About </A></H2> <H2><A NAME="toc1">1.</A> <A HREF="Quakespasm.html#s1">About </A></H2>
<P> <P>
<H2><A NAME="toc2">2.</A> <A HREF="README.html#s2">Downloads </A></H2> <H2><A NAME="toc2">2.</A> <A HREF="Quakespasm.html#s2">Downloads </A></H2>
<P> <P>
<H2><A NAME="toc3">3.</A> <A HREF="README.html#s3">Hints </A></H2> <H2><A NAME="toc3">3.</A> <A HREF="Quakespasm.html#s3">Hints </A></H2>
<UL> <UL>
<LI><A NAME="toc3.1">3.1</A> <A HREF="README.html#ss3.1">Music Playback</A> <LI><A NAME="toc3.1">3.1</A> <A HREF="Quakespasm.html#ss3.1">Music Playback</A>
</UL> </UL>
<P> <P>
<H2><A NAME="toc4">4.</A> <A HREF="README.html#s4">Compiling </A></H2> <H2><A NAME="toc4">4.</A> <A HREF="Quakespasm.html#s4">Compiling </A></H2>
<UL> <UL>
<LI><A NAME="toc4.1">4.1</A> <A HREF="README.html#ss4.1">Linux/Unix </A> <LI><A NAME="toc4.1">4.1</A> <A HREF="Quakespasm.html#ss4.1">Linux/Unix </A>
<LI><A NAME="toc4.2">4.2</A> <A HREF="README.html#ss4.2">Windows </A> <LI><A NAME="toc4.2">4.2</A> <A HREF="Quakespasm.html#ss4.2">Windows </A>
<LI><A NAME="toc4.3">4.3</A> <A HREF="README.html#ss4.3">Mac OS X </A> <LI><A NAME="toc4.3">4.3</A> <A HREF="Quakespasm.html#ss4.3">Mac OS X </A>
</UL> </UL>
<P> <P>
<H2><A NAME="toc5">5.</A> <A HREF="README.html#s5">Known Bugs </A></H2> <H2><A NAME="toc5">5.</A> <A HREF="Quakespasm.html#s5">Known Bugs </A></H2>
<P> <P>
<H2><A NAME="toc6">6.</A> <A HREF="README.html#s6">Changes</A></H2> <H2><A NAME="toc6">6.</A> <A HREF="Quakespasm.html#s6">Changes</A></H2>
<UL> <UL>
<LI><A NAME="toc6.1">6.1</A> <A HREF="README.html#ss6.1">Changes in 0.85.10</A> <LI><A NAME="toc6.1">6.1</A> <A HREF="Quakespasm.html#ss6.1">Changes in 0.85.10</A>
<LI><A NAME="toc6.2">6.2</A> <A HREF="README.html#ss6.2">Changes in 0.85.9</A> <LI><A NAME="toc6.2">6.2</A> <A HREF="Quakespasm.html#ss6.2">Changes in 0.85.9</A>
<LI><A NAME="toc6.3">6.3</A> <A HREF="README.html#ss6.3">Changes in 0.85.8</A> <LI><A NAME="toc6.3">6.3</A> <A HREF="Quakespasm.html#ss6.3">Changes in 0.85.8</A>
<LI><A NAME="toc6.4">6.4</A> <A HREF="README.html#ss6.4">Changes in 0.85.7</A> <LI><A NAME="toc6.4">6.4</A> <A HREF="Quakespasm.html#ss6.4">Changes in 0.85.7</A>
<LI><A NAME="toc6.5">6.5</A> <A HREF="README.html#ss6.5">Changes in 0.85.6</A> <LI><A NAME="toc6.5">6.5</A> <A HREF="Quakespasm.html#ss6.5">Changes in 0.85.6</A>
<LI><A NAME="toc6.6">6.6</A> <A HREF="README.html#ss6.6">Changes in 0.85.5</A> <LI><A NAME="toc6.6">6.6</A> <A HREF="Quakespasm.html#ss6.6">Changes in 0.85.5</A>
<LI><A NAME="toc6.7">6.7</A> <A HREF="README.html#ss6.7">Changes in 0.85.4</A> <LI><A NAME="toc6.7">6.7</A> <A HREF="Quakespasm.html#ss6.7">Changes in 0.85.4</A>
<LI><A NAME="toc6.8">6.8</A> <A HREF="README.html#ss6.8">Changes in 0.85.3</A> <LI><A NAME="toc6.8">6.8</A> <A HREF="Quakespasm.html#ss6.8">Changes in 0.85.3</A>
<LI><A NAME="toc6.9">6.9</A> <A HREF="README.html#ss6.9">Changes in 0.85.2</A> <LI><A NAME="toc6.9">6.9</A> <A HREF="Quakespasm.html#ss6.9">Changes in 0.85.2</A>
<LI><A NAME="toc6.10">6.10</A> <A HREF="README.html#ss6.10">Changes in 0.85.1</A> <LI><A NAME="toc6.10">6.10</A> <A HREF="Quakespasm.html#ss6.10">Changes in 0.85.1</A>
</UL> </UL>
<P> <P>
<H2><A NAME="toc7">7.</A> <A HREF="README.html#s7">Todo </A></H2> <H2><A NAME="toc7">7.</A> <A HREF="Quakespasm.html#s7">Todo </A></H2>
<P> <P>
<H2><A NAME="toc8">8.</A> <A HREF="README.html#s8">Copyright </A></H2> <H2><A NAME="toc8">8.</A> <A HREF="Quakespasm.html#s8">Copyright </A></H2>
<P> <P>
<H2><A NAME="toc9">9.</A> <A HREF="README.html#s9">Links </A></H2> <H2><A NAME="toc9">9.</A> <A HREF="Quakespasm.html#s9">Links </A></H2>
<HR> <HR>
@ -116,7 +116,7 @@ It includes 64bit CPU support, a new sound driver, several networking fixes and
<LI>As of 0.85.10, music is played back at 44100Hz by default with no need to adjust "-sndspeed".</LI> <LI>As of 0.85.10, music is played back at 44100Hz by default with no need to adjust "-sndspeed".</LI>
<LI>Use the "-noextmusic" option to disable this feature.</LI> <LI>Use the "-noextmusic" option to disable this feature.</LI>
<LI>See <LI>See
<A HREF="README.music">README.music</A> for more details.</LI> <A HREF="Quakespasm-Music.txt">Quakespasm-Music.txt</A> for more details.</LI>
</UL> </UL>
</P> </P>

View file

@ -38,7 +38,6 @@
Page last edited Sep. 08, 2014 Page last edited Sep. 08, 2014
1. About 1. About
QuakeSpasm is a Quake 1 engine based on the SDL port of FitzQuake. It QuakeSpasm is a Quake 1 engine based on the SDL port of FitzQuake. It
@ -47,14 +46,13 @@
<http://quakespasm.sourceforge.net> <http://quakespasm.sourceforge.net>
2. Downloads 2. Downloads
o Project Downloads <http://quakespasm.sourceforge.net/download.htm> o Project Downloads <http://quakespasm.sourceforge.net/download.htm>
o Automatic Builds <http://quakespasm.ericwa.com/job/quakespasm/> o Automatic Builds <http://quakespasm.ericwa.com/job/quakespasm/>
3. Hints 3. Hints
Visit the FitzQuake Homepage <http://www.celephais.net/fitzquake> for Visit the FitzQuake Homepage <http://www.celephais.net/fitzquake> for
@ -65,6 +63,7 @@
o For different sound drivers use "SDL_AUDIODRIVER=DRIVER o For different sound drivers use "SDL_AUDIODRIVER=DRIVER
./quakespasm" , where DRIVER may be alsa, dsp, pulse, esd ... ./quakespasm" , where DRIVER may be alsa, dsp, pulse, esd ...
o Shift+Escape draws the Console. o Shift+Escape draws the Console.
o From the console, use UP to browse the command line history and TAB o From the console, use UP to browse the command line history and TAB
@ -95,8 +94,7 @@
o Use the "-noextmusic" option to disable this feature. o Use the "-noextmusic" option to disable this feature.
o See <README.music> for more details. o See <Quakespasm-Music.txt> for more details.
4. Compiling 4. Compiling
@ -128,10 +126,12 @@
The project can also be built with Codeblocks (project files The project can also be built with Codeblocks (project files
included). included).
4.2. Windows 4.2. Windows
The QuakeSpasm developers cross-compile windows binaries using MinGW The QuakeSpasm developers cross-compile windows binaries using MinGW
<http://www.mingw.org> and Mingw-w64 <http://mingw-w64.sf.net>. <http://www.mingw.org> and Mingw-w64 <http://mingw-w64.sf.net>.
The project can also be built using Visual Studio 2005 (or newer). The project can also be built using Visual Studio 2005 (or newer).
4.3. Mac OS X 4.3. Mac OS X
@ -142,7 +142,6 @@
Alternatively, have a look at Makefile.darwin for more instructions on Alternatively, have a look at Makefile.darwin for more instructions on
building from a console. building from a console.
5. Known Bugs 5. Known Bugs
Some versions of Xorg and SDL have brightness issues. Some versions of Xorg and SDL have brightness issues.
@ -160,11 +159,11 @@
OS X has a well known gamma issue where the screen turns dark, but we OS X has a well known gamma issue where the screen turns dark, but we
currently have no fix. currently have no fix.
6. Changes 6. Changes
6.1. Changes in 0.85.10 6.1. Changes in 0.85.10
o Console speed now resolution-independent. o Console speed now resolution-independent.
o Disabled gl_zfix, which caused glitches and is undesirable for new o Disabled gl_zfix, which caused glitches and is undesirable for new
@ -193,7 +192,7 @@
o Music and sfx now mixed at 44100Hz to avoid downsampling music. o Music and sfx now mixed at 44100Hz to avoid downsampling music.
Low-pass filter applied to the sfx if -sndspeed is 11025 (the Low-pass filter applied to the sfx if -sndspeed is 11025 (the
default), to preserve the same sound quality as 0.85.9. New default), to preserve the same sound quality as 0.85.9. New
-mixspeed option sets the rate for mixing sfx and music, and output -mixspeed option sets the rate for mixing sfx and music, and output
to the OS (default 44100), setting to 11025 reverts to 0.85.9 to the OS (default 44100), setting to 11025 reverts to 0.85.9
behaviour. New snd_filterquality cvar, value can be between 1 behaviour. New snd_filterquality cvar, value can be between 1
@ -244,9 +243,9 @@
o Other fixes and clean-ups. o Other fixes and clean-ups.
6.2. Changes in 0.85.9 6.2. Changes in 0.85.9
o Fixes for several undefined behaviors in C code (gcc-4.8 support.) o Fixes for several undefined behaviors in C code (gcc-4.8 support.)
o Implemented Hor+ style field of view (FOV) scaling, useful for o Implemented Hor+ style field of view (FOV) scaling, useful for
@ -273,6 +272,7 @@
o Support for demo recording after connection to server. (thanks to o Support for demo recording after connection to server. (thanks to
Baker for a patch) Baker for a patch)
o Corner case fixes in COM_Parse() for quoted strings and support for o Corner case fixes in COM_Parse() for quoted strings and support for
C-style /*..*/ comments. C-style /*..*/ comments.
@ -290,9 +290,9 @@
o Several other minor fixes/cleanups. o Several other minor fixes/cleanups.
6.3. Changes in 0.85.8 6.3. Changes in 0.85.8
o Made Quake shareware 1.00 and 1.01 versions to be recognized o Made Quake shareware 1.00 and 1.01 versions to be recognized
properly. properly.
@ -324,6 +324,7 @@
o Increased string buffer size from 256 to 384 for PF_VarString to o Increased string buffer size from 256 to 384 for PF_VarString to
work around broken mods such as UQC. work around broken mods such as UQC.
o Restored original behavior for Quake registered version detection. o Restored original behavior for Quake registered version detection.
o Minor demo recording/playback tweaks. o Minor demo recording/playback tweaks.
@ -337,9 +338,9 @@
o Miscellaneous source code cleanups. o Miscellaneous source code cleanups.
6.4. Changes in 0.85.7 6.4. Changes in 0.85.7
o Added support for cross-level demo playback o Added support for cross-level demo playback
o gl_texturemode is reimplemented as a cvar with a callback and the o gl_texturemode is reimplemented as a cvar with a callback and the
@ -363,9 +364,9 @@
o Several other small changes mostly invisible to the end-user o Several other small changes mostly invisible to the end-user
6.5. Changes in 0.85.6 6.5. Changes in 0.85.6
o More work for string buffer safety o More work for string buffer safety
o Reverted v0.85.5 change of not allowing deathmatch and coop cvars o Reverted v0.85.5 change of not allowing deathmatch and coop cvars
@ -376,9 +377,9 @@
o Minor SDL video fixes. o Minor SDL video fixes.
6.6. Changes in 0.85.5 6.6. Changes in 0.85.5
o SDL input driver updated adding native keymap and dead key support o SDL input driver updated adding native keymap and dead key support
to the console to the console
@ -389,6 +390,7 @@
o Added workaround against GL texture flicker (z fighting), o Added workaround against GL texture flicker (z fighting),
controlled by new cvar 'gl_zfix' controlled by new cvar 'gl_zfix'
o Read video variables early so that a vid_restart isn't necessary o Read video variables early so that a vid_restart isn't necessary
after init after init
@ -407,9 +409,9 @@
o Several code updates from uHexen2 project, several code cleanups. o Several code updates from uHexen2 project, several code cleanups.
6.7. Changes in 0.85.4 6.7. Changes in 0.85.4
o Implement music (OGG, MP3, WAV) playback o Implement music (OGG, MP3, WAV) playback
o A better fix for the infamous SV_TouchLinks problem, no more hard o A better fix for the infamous SV_TouchLinks problem, no more hard
@ -435,9 +437,9 @@
o Other minor sound and cdaudio updates o Other minor sound and cdaudio updates
6.8. Changes in 0.85.3 6.8. Changes in 0.85.3
o Fix the "-dedicated" option (thanks Oz) and add platform specific o Fix the "-dedicated" option (thanks Oz) and add platform specific
networking code (default) rather than SDL_net networking code (default) rather than SDL_net
@ -454,6 +456,7 @@
o Connect status bar size to the scale slider o Connect status bar size to the scale slider
o Include an ISNAN (is not-a-number) fix to catch the occassional o Include an ISNAN (is not-a-number) fix to catch the occassional
quake C bug giving traceline problems quake C bug giving traceline problems
@ -472,9 +475,9 @@
o Add a "-cd" option to let the CD Player work in dedicated mode, and o Add a "-cd" option to let the CD Player work in dedicated mode, and
some other CD tweaks. some other CD tweaks.
6.9. Changes in 0.85.2 6.9. Changes in 0.85.2
o Replace the old "Screen size" slider with a "Scale" slider o Replace the old "Screen size" slider with a "Scale" slider
o Don't constantly open and close condebug log o Don't constantly open and close condebug log
@ -500,9 +503,9 @@
o Add OSX Makefile (tested?) o Add OSX Makefile (tested?)
6.10. Changes in 0.85.1 6.10. Changes in 0.85.1
o 64 bit CPU support o 64 bit CPU support
o Restructured SDL sound driver o Restructured SDL sound driver
@ -519,6 +522,7 @@
o Show helpful info on start-up o Show helpful info on start-up
o Include real map name (sv.name) and skill in the status bar o Include real map name (sv.name) and skill in the status bar
o Remove confirm quit dialog o Remove confirm quit dialog
@ -538,9 +542,9 @@
o Changes to cvar persistence gl_flashblend (default 0), r_shadow, o Changes to cvar persistence gl_flashblend (default 0), r_shadow,
r_wateralpha, r_dynamic, r_novis r_wateralpha, r_dynamic, r_novis
7. Todo 7. Todo
o Add uHexen2's first person camera (and menu item) o Add uHexen2's first person camera (and menu item)
o Native CD audio support (if desired). cd_sdl.c doesn't have proper o Native CD audio support (if desired). cd_sdl.c doesn't have proper
@ -550,9 +554,9 @@
o Complete the unix user directories support o Complete the unix user directories support
8. Copyright 8. Copyright
o Quake and Quakespasm are released under the GNU GENERAL PUBLIC o Quake and Quakespasm are released under the GNU GENERAL PUBLIC
LICENSE Version 2 <http://www.gnu.org/licenses/gpl-2.0.html> LICENSE Version 2 <http://www.gnu.org/licenses/gpl-2.0.html>
@ -560,9 +564,9 @@
CREATIVE COMMONS PUBLIC LICENSE CREATIVE COMMONS PUBLIC LICENSE
<http://creativecommons.org/licenses/by/3.0/legalcode> <http://creativecommons.org/licenses/by/3.0/legalcode>
9. Links 9. Links
o QuakeSpasm Homepage <http://quakespasm.sourceforge.net> o QuakeSpasm Homepage <http://quakespasm.sourceforge.net>
o QuakeSpasm Project page o QuakeSpasm Project page
@ -584,9 +588,11 @@
o Ozkan's email <mailto:gmail - dot - com - username - sezeroz> o Ozkan's email <mailto:gmail - dot - com - username - sezeroz>
o Stevenaaus email <mailto:yahoo - dot - com - username - stevenaaus> o Stevenaaus email <mailto:yahoo - dot - com - username - stevenaaus>
o Kristian's email <mailto:gmail - dot - com - username - inveigle> o Kristian's email <mailto:gmail - dot - com - username - inveigle>
o Sander's email <mailto:gmail - dot - com - username - a.h.vandijk> o Sander's email <mailto:gmail - dot - com - username - a.h.vandijk>