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

Document the command line console command interface.

Browse source
This commit is contained in:
Bill Currie 2011-09-08 13:06:11 +09:00
parent 6da725d510
commit 1dda097c65
2 changed files with 35 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
doc/config.dox
View file

@ -3,6 +3,7 @@
/**
\page run_config Runtime Configuration.
\li \subpage cmdline
\li \subpage cvars
\li \subpage filesystem
\li \subpage dirconf
@ -13,6 +14,37 @@
*/
/**
\page cmdline Command Line
The \QF servers (\c nq-server, \c qw-server, and \c qtv), and clients
(\c nq-glx, \c nq-wgl, \c qw-client-glx, \c qw-client-wgl etc) all parse
the program command line looking for console commands.
Console commands on the command line are marked with a \c + that follows
whitespace. They continue until the next \c + or \c - that follows
whitespace. This allows commands and arguments to contain \c + and \c - so
long as the preceeding character is not whitespace, but also prevents
command line switches (eg \c -nosound) from becoming part of the console
command. Using careful quoting, it is even possible for a command or
argument to beging with \c + or \c -.
The following command line will fail to set m_pitch because the -0.022
will not be part of the console command. <code>usage: setrom \<cvar\>
\<value\></code> will be displayed instead.
\verbatim
nq-glx +setrom m_pitch -0.022
\endverbatim
The following command line will successfully set m_pitch to \c -0.022
because \QF will see the \c " before the \c - and thus \c -0.022 will be
part of the console command.
\verbatim
nq-glx +setrom m_pitch \"-0.022\"
\endverbatim
\note The above works in bash. Other shells may vary.
*/
/**
\page cvars Configuration variables
@ -110,7 +142,7 @@ The global and user configuration files are normal quake scripts, but only
It might seem strange to have the global and user configuration files
specified by cvars, but \QF's startup sequence is quite intense:
\li Execute any \c set commands given on the command line. This way, \c
\li Execute any \c set commands given on the \ref cmdline. This way, \c
fs_globalcfg can be set.
\li Execute any \c set commands in the global configuration file. This way,
\c fs_usercfg can be set.
@ -130,7 +162,7 @@ fs_usercfg (just before reading the user configuration file). Thus, it is
possible to set <em>any</em> cvar in \QF.
The above means that:
\li The command line can be used to set any cvar in \QF.
\li The \ref cmdline can be used to set any cvar in \QF.
\li The global config file can be used to set any cvar but \c
fs_globalcfg.
\li The user config file can be used to set any cvar but \c fs_globalcfg

2
doc/filesystem.dox
View file

@ -42,7 +42,7 @@ when the trees are in the same place.
Once QuakeForge is running, \c fs_sharepath and \c fs_userpath cannot be
altered. However, they may be altered by setting them in the system
configuration file, the user configuration file, or on the command line
(see \ref cvar_rom).
(see \ref cvar_rom and \ref cmdline).
The internal layout of the shared and user data trees are, by default, the
same as Quake (an \c id1 directory tree, plus other mod directories), but