qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2024-11-25 22:01:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

Docs: minor cleanups

Browse source
This commit is contained in:
Jeff Teunissen 2011-12-15 00:13:56 -05:00
parent 69aa6c0e7e
commit e9ab230626
2 changed files with 13 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/config.dox
View file

@ -1,7 +1,7 @@
//unfortunately, have to wrap the docs in a C comment for doxygen //unfortunately, have to wrap the docs in a C comment for doxygen
// vim:tw=74:formatoptions-=l // vim:tw=74:formatoptions-=l
/** /**
\page run_config Runtime Configuration. \page run_config Runtime Configuration
\li \subpage cmdline \li \subpage cmdline
\li \subpage cvars \li \subpage cvars
@ -13,7 +13,6 @@
\li \subpage key_binding \li \subpage key_binding
\li \subpage cshift_cvars \li \subpage cshift_cvars
\li \subpage server_timestamps \li \subpage server_timestamps
*/ */
/** /**
@ -44,13 +43,12 @@ part of the console command.
nq-glx +setrom m_pitch \"-0.022\" nq-glx +setrom m_pitch \"-0.022\"
\endverbatim \endverbatim
\note The above works in bash. Other shells may vary. \note The above works in bash. Other shells may vary.
*/ */
/** /**
\page cvars Configuration variables \page cvars Config Variables (Cvars)
The core of \QF's configurabitly is the cvar. The core of \QF's configuration is the cvar.
\section cvar_value Cvar values. \section cvar_value Cvar values.
Depending on the engine's use of the cvar, the value will be treated as a Depending on the engine's use of the cvar, the value will be treated as a
@ -64,7 +62,7 @@ From the user's perspective, there are three types of cvar:
automatically saved. automatically saved.
\li archive cvar: like a plain cvar, the value can be displayed or set, but \li archive cvar: like a plain cvar, the value can be displayed or set, but
the cvar will be automatically saved to \c config.cfg by the engine on the cvar will be automatically saved to \c config.cfg by the engine on
shutdown or gamedir change (quakeworld). shutdown or gamedir change (QuakeWorld).
\li read-only cvar: the value can be displayed but not changed in any way \li read-only cvar: the value can be displayed but not changed in any way
(value or flags). If the cvar also happens to be an archive cvar (the (value or flags). If the cvar also happens to be an archive cvar (the
archive flag was set before the read-only flag), then the cvar will be archive flag was set before the read-only flag), then the cvar will be
@ -139,7 +137,7 @@ is set, or WINDOWS if not).
<code>~/.config/quakeforge/quakeforge.conf</code> on Linux and other UNIX <code>~/.config/quakeforge/quakeforge.conf</code> on Linux and other UNIX
like systems, and \c ~/quakeforgerc on Windows. like systems, and \c ~/quakeforgerc on Windows.
The global and user configuration files are normal quake scripts, but only The global and user configuration files are normal Quake scripts, but only
\c set, \c seta, and \c setrom commands are executed. \c set, \c seta, and \c setrom commands are executed.
It might seem strange to have the global and user configuration files It might seem strange to have the global and user configuration files
@ -177,6 +175,7 @@ user config file or the global config file. If \c setrom is used on the
command line, even \c setrom in the config files can be overridden. command line, even \c setrom in the config files can be overridden.
*/ */
/** /**
\page cmdcvarlist Command and Cvar Lists \page cmdcvarlist Command and Cvar Lists
Lists of commands and cvars by program. Lists of commands and cvars by program.

14
doc/faq.dox
View file

@ -11,10 +11,10 @@
\li \ref faq_cvar_rom \li \ref faq_cvar_rom
\section gfx_wad What does "W_LoadWadFile: unable to load gfx.wad" mean? \section gfx_wad What does "W_LoadWadFile: unable to load gfx.wad" mean?
The most common cause of this error is QuakeForge is unable to find The most common cause of this error is \QF is unable to find
pak0.pak. QuakeForge looks for pak0.pak in both the $fs_userpath/id1 and pak0.pak. \QF looks for pak0.pak in both the $fs_userpath/id1 and
$fs_sharepath/id1 directories. In Windows, both fs_userpath and fs_sharepath $fs_sharepath/id1 directories. In Windows, both fs_userpath and fs_sharepath
default to "." (ie, the current directory: the same as id's quake clients). In default to "." (ie, the current directory: the same as id's Quake clients). In
Linux (and other UNIX like operating systems), fs_userpath defaults to Linux (and other UNIX like operating systems), fs_userpath defaults to
~/.quakeforge and fs_sharepath defaults to $prefix/share/games/quakeforge ~/.quakeforge and fs_sharepath defaults to $prefix/share/games/quakeforge
(distribution packages might alter the exact path). (distribution packages might alter the exact path).
@ -24,16 +24,16 @@ See \ref filesystem for more details.
\section pak0_pak Where can I get pak0.pak? \section pak0_pak Where can I get pak0.pak?
See \ref game_data See \ref game_data
\section game_data Why doesn't QuakeForge come with the game data? \section game_data Why doesn't \QF come with the game data?
While QuakeForge itself (and the Quake source code in general) is Free While \QF itself (and the Quake source code in general) is Free
Software, the game itself is not free. You need to either purchase it from <a Software, the game itself is not free. You need to either purchase it from <a
href="http://www.idsoftware.com/store/index.php?view=quake">id Software</a> or href="http://www.idsoftware.com/store/index.php?view=quake">id Software</a> or
you can use <a href="http://openquartz.sourceforge.net/">OpenQuartz</a>, a you can use <a href="http://openquartz.sourceforge.net/">OpenQuartz</a>, a
project developing GPL compatible game data for Quake. project developing GPL-compatible game data for Quake.
\section git_compile_error Checking out git and running ./bootstrap creates a configure that syntax errors when I run it! What's wrong? \section git_compile_error Checking out git and running ./bootstrap creates a configure that syntax errors when I run it! What's wrong?
Unlike downloading and compiling a release, when you checkout from git, you Unlike downloading and compiling a release, when you checkout from git, you
must have all the dependencies of QuakeForge already installed as when must have all the dependencies of \QF already installed as when
configure is being created autotools sources m4 files... If the files do not configure is being created autotools sources m4 files... If the files do not
exist, you get the errors you have seen. Try installing packages which contain exist, you get the errors you have seen. Try installing packages which contain
the libraries that caused the syntax error, including the -dev versions, then the libraries that caused the syntax error, including the -dev versions, then