Move the sgml stuff to Linux/sgml, and update doco re gamma known-bugs.

git-svn-id: svn+ssh://svn.code.sf.net/p/quakespasm/code/trunk@882 af15c1b1-3010-417e-b628-4374ebc0bcbd
This commit is contained in:
stevenaaus 2013-12-26 21:16:44 +00:00
parent 6ef69df90a
commit e4b5964ac0
5 changed files with 46 additions and 31 deletions

View file

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

View file

@ -4,7 +4,7 @@
<toc> <toc>
<verb></verb> <verb></verb>
<em>Page last edited Oct. 12, 2013</em> <em>Page last edited Dec. 27, 2013</em>
<sect> About <p> <sect> About <p>
@ -85,7 +85,9 @@ Alternatively, have a look at <bf>Makefile.darwin</bf> for more instructions on
</p> </p>
<sect> Known Bugs <p> <sect> Known Bugs <p>
Some versions of Xorg and SDL have brightness issues. If you have Xorg >= 7.5 and broken brightness, Some versions of Xorg and SDL have brightness issues.
<newline>
Try setting "export SDL_VIDEO_X11_NODIRECTCOLOR=1", or if you have Xorg >= 7.5 and broken brightness,
these patched libSDL binaries may help. these patched libSDL binaries may help.
<itemize> <itemize>
<item><url url="http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download" <item><url url="http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download"
@ -94,6 +96,9 @@ these patched libSDL binaries may help.
name="Gamma patched libSDL (x86_64-linux)"> name="Gamma patched libSDL (x86_64-linux)">
</itemize> </itemize>
</p> </p>
<p>
OS X has a well known gamma issue where the screen turns dark, but we currently have no fix.
</p>
<sect> Changes<p> <sect> Changes<p>

View file

@ -0,0 +1,4 @@
#!/bin/bash
sgml2txt -b 2 "$1"
cat "$1.txt" | sed -e 's/[^m]*m//g' -e 's/.//g' >tmp$$
mv tmp$$ "$1.txt"

View file

@ -12,7 +12,7 @@
<PRE> <PRE>
</PRE> </PRE>
</P> </P>
<P><EM>Page last edited Oct. 12, 2013</EM></P> <P><EM>Page last edited Dec. 27, 2013</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="README.html#s1">About </A></H2>
@ -158,7 +158,8 @@ Compile time options include
<P>Alternatively, have a look at <B>Makefile.darwin</B> for more instructions on building from a console.</P> <P>Alternatively, have a look at <B>Makefile.darwin</B> for more instructions on building from a console.</P>
<H2><A NAME="s5">5.</A> <A HREF="#toc5">Known Bugs </A></H2> <H2><A NAME="s5">5.</A> <A HREF="#toc5">Known Bugs </A></H2>
<P>Some versions of Xorg and SDL have brightness issues. If you have Xorg >= 7.5 and broken brightness, <P>Some versions of Xorg and SDL have brightness issues.<BR>
Try setting "export SDL_VIDEO_X11_NODIRECTCOLOR=1", or if you have Xorg >= 7.5 and broken brightness,
these patched libSDL binaries may help. these patched libSDL binaries may help.
<UL> <UL>
<LI> <LI>
@ -167,6 +168,7 @@ these patched libSDL binaries may help.
<A HREF="http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched-AMD64.tgz/download">Gamma patched libSDL (x86_64-linux)</A></LI> <A HREF="http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched-AMD64.tgz/download">Gamma patched libSDL (x86_64-linux)</A></LI>
</UL> </UL>
</P> </P>
<P>OS X has a well known gamma issue where the screen turns dark, but we currently have no fix.</P>
<H2><A NAME="s6">6.</A> <A HREF="#toc6">Changes</A></H2> <H2><A NAME="s6">6.</A> <A HREF="#toc6">Changes</A></H2>
@ -416,4 +418,3 @@ these patched libSDL binaries may help.
</BODY> </BODY>
</HTML> </HTML>

View file

@ -36,8 +36,7 @@
______________________________________________________________________ ______________________________________________________________________
Page last edited Oct. 12, 2013 Page last edited Dec. 27, 2013
1. About 1. About
@ -47,15 +46,14 @@
<http://quakespasm.sourceforge.net> <http://quakespasm.sourceforge.net>
2. Downloads 2. Downloads
o <http://quakespasm.sourceforge.net/download.htm> o <http://quakespasm.sourceforge.net/download.htm>
3. Hints 3. Hints
Visit the FitzQuake Homepage <http://www.celephais.net/fitzquake> for Visit the FitzQuake Homepage <http://www.celephais.net/fitzquake> for
a full run-down of the engine's commands and variables. a full run-down of the engine's commands and variables.
@ -63,7 +61,6 @@
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
@ -78,7 +75,6 @@
o Quakespasm allows loading new games (mods) on the fly with "game o Quakespasm allows loading new games (mods) on the fly with "game
GAMENAME" GAMENAME"
3.1. Music Playback 3.1. Music Playback
Since version 0.85.4, Quakespasm can play back external MP3, OGG and Since version 0.85.4, Quakespasm can play back external MP3, OGG and
@ -97,7 +93,6 @@
o See <README.music> for more details. o See <README.music> for more details.
4. Compiling 4. Compiling
To check-out the latest version of QuakeSpasm, use : To check-out the latest version of QuakeSpasm, use :
@ -113,6 +108,7 @@
cp quakespasm /usr/local/games/quake (for example) cp quakespasm /usr/local/games/quake (for example)
______________________________________________________________________ ______________________________________________________________________
Compile time options include Compile time options include
o make DEBUG=1 for debugging o make DEBUG=1 for debugging
@ -131,7 +127,6 @@
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,11 +137,12 @@
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. If you have Xorg Some versions of Xorg and SDL have brightness issues.
>= 7.5 and broken brightness, these patched libSDL binaries may help. Try setting "export SDL_VIDEO_X11_NODIRECTCOLOR=1", or if you have
Xorg >= 7.5 and broken brightness, these patched libSDL binaries may
help.
o Gamma patched libSDL (i686-linux) o Gamma patched libSDL (i686-linux)
<http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download> <http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched.tgz/download>
@ -155,24 +151,27 @@
<http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched- <http://sourceforge.net/projects/quakespasm/files/Support%20Files/libSDL_gamma_patched-
AMD64.tgz/download> AMD64.tgz/download>
OS X has a well known gamma issue where the screen turns dark, but we
currently have no fix.
6. Changes 6. Changes
6.1. Changes in 0.85.10 6.1. Changes in 0.85.10
o Support for Opus, FLAC, and tracker (S3M/UMX) music (as compile- o Support for Opus, FLAC, and tracker (S3M/UMX) music (as compile-
time options). time options).
o Better Hor+ field of view (FOV) scaling behavior. o Better Hor+ field of view (FOV) scaling behavior.
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
widescreen resolutions. Configured by new cvar fov_adapt: set it widescreen resolutions. Configured by new cvar fov_adapt: set it to
to 1 and your fov will be scaled automatically according to the 1 and your fov will be scaled automatically according to the
resolution. Enabled by default. resolution. Enabled by default.
o Adjusted string buffers for PR_ValueString and friends to fix o Adjusted string buffers for PR_ValueString and friends to fix
@ -194,7 +193,6 @@
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.
@ -212,9 +210,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.
@ -262,6 +260,7 @@
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
@ -285,9 +284,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
@ -298,9 +297,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
@ -329,9 +328,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
@ -357,9 +356,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
@ -394,9 +393,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
@ -422,9 +421,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
@ -460,9 +459,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
@ -472,9 +471,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>
@ -482,9 +481,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