Updated some documentation.

git-svn-id: svn://svn.code.sf.net/p/stella/code/trunk@2873 8b62c5a3-ac7e-4cc8-8f21-d9a121418aba
This commit is contained in:
stephena 2014-03-12 16:56:15 +00:00
parent d0d04948c7
commit bc9e50f0f1
2 changed files with 68 additions and 60 deletions

View File

@ -346,8 +346,7 @@
<li>MacOSX 10.7 (Lion) or above</li>
<li>Intel processor</li>
<li>OpenGL capable video card</li>
<li>FIXSDL Xcode 3.1 and SDL 1.2.14 required to compile a 10.4 compatible Universal Binary version;
Xcode 3.2 and SDL 1.2.15 required to compile the Intel/64-bit version</li>
<li>Xcode 5.0 is required to compile the Stella source code</li>
</ul>
<p>
@ -360,7 +359,7 @@
<li>Direct3D or OpenGL capable video card</li>
<li>64-bit port has been tested on Windows Vista and above only; it may work on
WinXP64 as well, but isn't a priority</li>
<li>Visual C++ 2013 (or Express version) is required to compile the Stella source code</li>
<li>Visual C++ 2012 (or Express version) is required to compile the Stella source code</li>
</ul>
<p>
@ -1736,8 +1735,9 @@
</tr>
<tr>
<td><pre>-video &lt;soft|gl&gt;</pre></td>
<td>FIXSDL Use software or OpenGL rendering mode.</td>
<td><pre>-video &lt;direct3d|opengl|opengles2|opengles|software&gt;</pre></td>
<td>Use the given rendering backend (where applicable); default is the best available
mode detected.</td>
</tr>
<tr>
@ -1747,13 +1747,12 @@
</tr>
<tr>
<td><pre>-fullscreen &lt;1|0|-1&gt;</pre></td>
<td>Play the game in fullscreen mode (1 or 0), or completely disable
fullscreen mode (-1).</td>
<td><pre>-fullscreen &lt;1|0&gt;</pre></td>
<td>Enable fullscreen mode.</td>
</tr>
<tr>
<td><pre>-fullres &lt;auto|WxH&gt;</pre></td>
<td><pre>FIXSDL-fullres &lt;auto|WxH&gt;</pre></td>
<td>Use the given resolution in fullscreen mode. If 'auto', let Stella decide
which resolution to use.</td>
</tr>
@ -1799,6 +1798,29 @@
shown.</td>
</tr>
<tr>
<td><pre>-sound &lt;1|0&gt;</pre></td>
<td>Enable or disable sound generation.</td>
</tr>
<tr>
<td><pre>-fragsize &lt;number&gt;</pre></td>
<td>Specify the sound fragment size to use. Linux/Mac seems to work
with 512, Windows usually needs 1024.</td>
</tr>
<tr>
<td><pre>-freq &lt;number&gt;</pre></td>
<td>Set sound sample output frequency (11025,22050,31400,44100,48000)
Default is 31400. Do not change unless you experience sound
issues.</td>
</tr>
<tr>
<td><pre>-volume &lt;number&gt;</pre></td>
<td>Set the volume (0 - 100).</td>
</tr>
<tr>
<td><pre>-tia.filter &lt;filter&gt;</pre></td>
<td>Use the specified filter while in TIA/emulation mode. Currently,
@ -1821,8 +1843,8 @@
</tr>
<tr>
<td><pre>-gl_fsscale &lt;1|0&gt;</pre></td>
<td>FIXSDL OpenGL mode only. Stretch TIA image completely while in fullscreen mode
<td><pre>FIXSDL-gl_fsscale &lt;1|0&gt;</pre></td>
<td>OpenGL mode only. Stretch TIA image completely while in fullscreen mode
(vs. an integral stretch which won't necessarily completely fill the screen).</td>
</tr>
@ -1905,30 +1927,6 @@
range -1.0 to 1.0).</td>
</tr>
<tr>
<td><pre>-sound &lt;1|0&gt;</pre></td>
<td>Enable or disable sound generation.</td>
</tr>
<tr>
<td><pre>-fragsize &lt;number&gt;</pre></td>
<td>Specify the sound fragment size to use. Linux/Mac seems to work
with 512, Windows may need 2048 (but newer versions work with
512 as well).</td>
</tr>
<tr>
<td><pre>-freq &lt;number&gt;</pre></td>
<td>Set sound sample output frequency (11025,22050,31400,44100,48000)
Default is 31400. Do not change unless you experience sound
issues.</td>
</tr>
<tr>
<td><pre>-volume &lt;number&gt;</pre></td>
<td>Set the volume (0 - 100).</td>
</tr>
<tr>
<td><pre>-cheat &lt;code&gt;</pre></td>
<td>Use the specified cheatcode (see Cheat section for description).</td>
@ -1962,7 +1960,7 @@
</tr>
<tr>
<td><pre>-grabmouse &lt;1|0&gt;</pre></td>
<td><pre>FIXSDL-grabmouse &lt;1|0&gt;</pre></td>
<td>Keeps the mouse in the game window in emulation mode.</td>
</tr>
@ -2242,6 +2240,11 @@
If disabled, use the last databus value for those pins instead.</td>
</tr>
<tr>
<td><pre>-cpurandom &lt;1|0&gt;</pre></td>
<td>On reset, randomize the content CPU registers.</td>
</tr>
<tr>
<td><pre>-ramrandom &lt;1|0&gt;</pre></td>
<td>On reset, either randomize all RAM content, or zero it out instead.</td>

View File

@ -341,10 +341,33 @@ void Settings::usage()
<< "Valid options are:" << endl
<< endl
<< " -video <type> Type is one of the following:\n"
<< " soft SDL software mode\n"
// FIXSDL
<< " gl SDL OpenGL mode\n"
#ifdef BSPF_WINDOWS
<< " direct3d Direct3D 9/11 acceleration\n"
#endif
<< " opengl OpenGL acceleration\n"
<< " opengles2 OpenGLES 2 acceleration\n"
<< " opengles OpenGLES 1 acceleration\n"
<< " software Software mode (no acceleration)\n"
<< endl
<< " -vsync <1|0> Enable 'synchronize to vertical blank interrupt'\n"
<< " -fullscreen <1|0> Enable fullscreen mode\n"
<< "FIXSDL -fullres <auto|WxH> The resolution to use in fullscreen mode\n"
<< " -center <1|0> Centers game window (if possible)\n"
<< " -palette <standard| Use the specified color palette\n"
<< " z26|\n"
<< " user>\n"
<< " -colorloss <1|0> Enable PAL color-loss effect\n"
<< " -framerate <number> Display the given number of frames per second (0 to auto-calculate)\n"
<< " -timing <sleep|busy> Use the given type of wait between frames\n"
<< " -uimessages <1|0> Show onscreen UI messages for different events\n"
<< endl
#ifdef SOUND_SUPPORT
<< " -sound <1|0> Enable sound generation\n"
<< " -fragsize <number> The size of sound fragments (must be a power of two)\n"
<< " -freq <number> Set sound sample output frequency (11025|22050|31400|44100|48000)\n"
<< " -volume <number> Set the volume (0 - 100)\n"
<< endl
#endif
<< " -tia.filter <filter> Use the specified filter for TIA image\n"
<< " -tia.inter <1|0> Enable interpolated (smooth) scaling for TIA image\n"
<< " -tia.aspectn <number> Scale the TIA width by the given percentage in NTSC mode\n"
@ -365,31 +388,12 @@ void Settings::usage()
<< " -tv.fringing <value> Set TV effects custom fringing to value 1.0 - 1.0\n"
<< " -tv.bleed <value> Set TV effects custom bleed to value 1.0 - 1.0\n"
<< endl
<< " -vsync <1|0> Enable 'synchronize to vertical blank interrupt'\n"
<< " -fullscreen <1|0|-1> Use fullscreen mode (1 or 0), or disable switching to fullscreen entirely\n"
<< " -fullres <auto|WxH> The resolution to use in fullscreen mode\n"
<< " -center <1|0> Centers game window (if possible)\n"
<< " -grabmouse <1|0> Keeps the mouse in the game window\n"
<< " -palette <standard| Use the specified color palette\n"
<< " z26|\n"
<< " user>\n"
<< " -colorloss <1|0> Enable PAL color-loss effect\n"
<< " -framerate <number> Display the given number of frames per second (0 to auto-calculate)\n"
<< " -timing <sleep|busy> Use the given type of wait between frames\n"
<< " -uimessages <1|0> Show onscreen UI messages for different events\n"
<< endl
#ifdef SOUND_SUPPORT
<< " -sound <1|0> Enable sound generation\n"
<< " -fragsize <number> The size of sound fragments (must be a power of two)\n"
<< " -freq <number> Set sound sample output frequency (11025|22050|31400|44100|48000)\n"
<< " -volume <number> Set the volume (0 - 100)\n"
<< endl
#endif
<< " -cheat <code> Use the specified cheatcode (see manual for description)\n"
<< " -loglevel <0|1|2> Set level of logging during application run\n"
<< " -logtoconsole <1|0> Log output to console/commandline\n"
<< " -joydeadzone <number> Sets 'deadzone' area for analog joysticks (0-29)\n"
<< " -joyallow4 <1|0> Allow all 4 directions on a joystick to be pressed simultaneously\n"
<< "FIXSDL -grabmouse <1|0> Keeps the mouse in the game window\n"
<< " -usemouse <always|\n"
<< " analog|\n"
<< " never> Use mouse as a controller as specified by ROM properties in given mode(see manual)\n"
@ -419,6 +423,7 @@ void Settings::usage()
<< " -romviewer <0|1|2> Show ROM info viewer at given zoom level in ROM launcher (0 for off)\n"
<< " -listdelay <delay> Time to wait between keypresses in list widgets (300-1000)\n"
<< " -mwheel <lines> Number of lines the mouse wheel will scroll in UI\n"
<< " -romdir <dir> Directory in which to load ROM files\n"
<< " -statedir <dir> Directory in which to save/load state files\n"
<< " -cheatfile <file> Full pathname of cheatfile database\n"
<< " -palettefile <file> Full pathname of user-defined palette file\n"
@ -426,7 +431,6 @@ void Settings::usage()
<< " -nvramdir <dir> Directory in which to save/load flash/EEPROM files\n"
<< " -cfgdir <dir> Directory in which to save Distella config files\n"
<< " -avoxport <name> The name of the serial port where an AtariVox is connected\n"
<< " -maxres <WxH> Used by developers to force the maximum size of the application window\n"
<< " -holdreset Start the emulator with the Game Reset switch held down\n"
<< " -holdselect Start the emulator with the Game Select switch held down\n"
<< " -holdjoy0 <U,D,L,R,F> Start the emulator with the left joystick direction/fire button held down\n"
@ -434,6 +438,7 @@ void Settings::usage()
<< " -tiadriven <1|0> Drive unused TIA pins randomly on a read/peek\n"
<< " -cpurandom <1|0> Randomize the contents of CPU registers on reset\n"
<< " -ramrandom <1|0> Randomize the contents of RAM on reset\n"
<< " -maxres <WxH> Used by developers to force the maximum size of the application window\n"
<< " -help Show the text you're now reading\n"
#ifdef DEBUGGER_SUPPORT
<< endl