From f481e6b23a09293b44bf9806a870f5957d47c00f Mon Sep 17 00:00:00 2001 From: Firehawke <34792592+Firehawke@users.noreply.github.com> Date: Wed, 24 Jan 2018 14:37:48 -0700 Subject: Overhaul commandline section of docs, includes index with linkable anchors. (#3112) * The first set of commandline overhauls. (NW) * Correct case on headings, further improvements to index, spelling fix * More updates to the index and cleanup to the commandline stuff. [NW] * More core options in the index. [NW] * Finished multiplatform commandline index [NW] * Completion of first revision commandline index [NW] --- docs/source/commandline/commandline-index.rst | 400 ++++++++++++++++++++++++++ 1 file changed, 400 insertions(+) create mode 100644 docs/source/commandline/commandline-index.rst (limited to 'docs/source/commandline/commandline-index.rst') diff --git a/docs/source/commandline/commandline-index.rst b/docs/source/commandline/commandline-index.rst new file mode 100644 index 00000000000..267c82e8aad --- /dev/null +++ b/docs/source/commandline/commandline-index.rst @@ -0,0 +1,400 @@ +.. _index-commandline: + +Commandline Index +================= + +This is a complete index of all commandline options and commands for MAME, suitable for quickly finding a given command. + +Universal Commandline Options +----------------------------- + +This section contains configuration options that are applicable to *all* MAME sub-builds (both SDL and Windows native). + + +Core Commands +~~~~~~~~~~~~~ + +| :ref:`help ` +| :ref:`validate ` + + +Configuration Commands +~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`createconfig ` +| :ref:`showconfig ` +| :ref:`showusage ` + + +Frontend Commands +~~~~~~~~~~~~~~~~~ + +| :ref:`listxml ` +| :ref:`listfull ` +| :ref:`listsource ` +| :ref:`listclones ` +| :ref:`listbrothers ` +| :ref:`listcrc ` +| :ref:`listroms ` +| :ref:`listsamples ` +| :ref:`verifyroms ` +| :ref:`verifysamples ` +| :ref:`romident ` +| :ref:`listdevices ` +| :ref:`listslots ` +| :ref:`listmedia ` +| :ref:`listsoftware ` +| :ref:`verifysoftware ` +| :ref:`getsoftlist ` +| :ref:`verifysoftlist ` + + +OSD-related Options +~~~~~~~~~~~~~~~~~~~ + +| :ref:`uimodekey ` +| :ref:`uifontprovider ` +| :ref:`menu ` +| :ref:`keyboardprovider ` +| :ref:`mouseprovider ` +| :ref:`lightgunprovider ` +| :ref:`joystickprovider ` + + +OSD CLI Options +~~~~~~~~~~~~~~~ + +| :ref:`listmidi ` +| :ref:`listnetwork ` + + +OSD Output Options +~~~~~~~~~~~~~~~~~~ + +| :ref:`output ` + + +Configuration Options +~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`noreadconfig ` + + +Core Search Path Options +~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`rompath ` +| :ref:`hashpath ` +| :ref:`samplepath ` +| :ref:`artpath ` +| :ref:`ctrlrpath ` +| :ref:`inipath ` +| :ref:`fontpath ` +| :ref:`cheatpath ` +| :ref:`crosshairpath ` +| :ref:`pluginspath ` +| :ref:`languagepath ` + + +Core Output Directory Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`cfg_directory ` +| :ref:`nvram_directory ` +| :ref:`input_directory ` +| :ref:`state_directory ` +| :ref:`snapshot_directory ` +| :ref:`diff_directory ` +| :ref:`comment_directory ` + + +Core State/Playback Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]rewind / rewind` +| :ref:`rewind_capacity ` +| :ref:`state ` +| :ref:`[no]autosave ` +| :ref:`playback ` +| :ref:`exit_after_playback ` +| :ref:`record ` +| :ref:`record_timecode ` +| :ref:`mngwrite ` +| :ref:`aviwrite ` +| :ref:`wavwrite ` +| :ref:`snapname ` +| :ref:`snapsize ` +| :ref:`snapview ` +| :ref:`[no]snapbilinear ` +| :ref:`statename ` +| :ref:`[no]burnin ` + + +Core Performance Options +~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]autoframeskip ` +| :ref:`frameskip ` +| :ref:`seconds_to_run ` +| :ref:`[no]throttle ` +| :ref:`[no]sleep ` +| :ref:`speed ` +| :ref:`[no]refreshspeed ` +| :ref:`numprocessors ` +| :ref:`bench ` + + +Core Rotation Options +~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]rotate ` +| :ref:`[no]ror ` +| :ref:`[no]rol ` +| :ref:`[no]autoror ` +| :ref:`[no]autorol ` +| :ref:`[no]flipx ` +| :ref:`[no]flipy ` + + +Core Video Options +~~~~~~~~~~~~~~~~~~ + +| :ref:`video ` +| :ref:`numscreens ` +| :ref:`[no]window ` +| :ref:`[no]maximize ` +| :ref:`[no]keepaspect ` +| :ref:`[no]waitvsync ` +| :ref:`[no]syncrefresh ` +| :ref:`prescale ` +| :ref:`[no]filter ` +| :ref:`[no]unevenstretch ` + + +Core Full Screen Options +~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]switchres ` + + +Core Per-Window Video Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`screen ` +| :ref:`aspect ` +| :ref:`resolution ` +| :ref:`view ` + + +Core Artwork Options +~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]artwork_crop ` +| :ref:`[no]use_backdrops ` +| :ref:`[no]use_overlays ` +| :ref:`[no]use_bezels ` +| :ref:`[no]use_cpanels ` +| :ref:`[no]use_marquees ` + + +Core Screen Options +~~~~~~~~~~~~~~~~~~~ + +| :ref:`brightness ` +| :ref:`contrast ` +| :ref:`gamma ` +| :ref:`pause_brightness ` +| :ref:`effect ` + + +Core Vector Options +~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]antialias ` +| :ref:`beam ` +| :ref:`flicker ` + + +Core Sound Options +~~~~~~~~~~~~~~~~~~ + + +| :ref:`samplerate ` +| :ref:`[no]samples ` +| :ref:`volume ` +| :ref:`sound ` +| :ref:`audio_latency ` + + +Core Input Options +~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]coin_lockout ` +| :ref:`ctrlr ` +| :ref:`[no]mouse ` +| :ref:`[no]joystick ` +| :ref:`[no]lightgun ` +| :ref:`[no]multikeyboard ` +| :ref:`[no]multimouse ` +| :ref:`[no]steadykey ` +| :ref:`[no]ui_active ` +| :ref:`[no]offscreen_reload ` +| :ref:`joystick_map ` +| :ref:`joystick_deadzone ` +| :ref:`joystick_saturation ` +| :ref:`natural ` +| :ref:`joystick_contradictory ` +| :ref:`coin_impulse ` + + +Core Input Automatic Enable Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`paddle_device ` +| :ref:`adstick_device ` +| :ref:`pedal_device ` +| :ref:`dial_device ` +| :ref:`trackball_device ` +| :ref:`lightgun_device ` +| :ref:`positional_device ` +| :ref:`mouse_device ` + + +Core Debugging Options +~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]verbose ` +| :ref:`[no]oslog ` +| :ref:`[no]log ` +| :ref:`[no]debug ` +| :ref:`debugscript ` +| :ref:`[no]update_in_pause ` +| :ref:`watchdog ` + + +Core Communication Options +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`comm_localhost ` +| :ref:`comm_localport ` +| :ref:`comm_remotehost ` +| :ref:`comm_remoteport ` + + +Core Misc Options +~~~~~~~~~~~~~~~~~ + +| :ref:`[no]drc ` +| :ref:`drc_use_c ` +| :ref:`drc_log_uml ` +| :ref:`drc_log_native ` +| :ref:`bios ` +| :ref:`[no]cheat ` +| :ref:`[no]skip_gameinfo ` +| :ref:`uifont ` +| :ref:`ramsize ` +| :ref:`confirm_quit ` +| :ref:`ui_mouse ` +| :ref:`autoboot_command ` +| :ref:`autoboot_delay ` +| :ref:`autoboot_script ` +| :ref:`language ` + + +Windows-Specific Commandline Options +------------------------------------ + +Windows Debugging options +~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`debugger_font ` +| :ref:`debugger_font_size ` + + +Windows Performance Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`priority ` +| :ref:`profile ` + + +Windows Full Screen Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]triplebuffer ` +| :ref:`full_screen_brightness ` +| :ref:`full_screen_contrast ` +| :ref:`full_screen_gamma ` + + +Windows Input Device Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]dual_lightgun ` + + +SDL-Specific Commandline Options +-------------------------------- + +This section contains configuration options that are specific to any build supported by SDL (including Windows where compiled as SDL instead of native). + + +SDL Performance Options +~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`sdlvideofps ` + + +SDL Video Options +~~~~~~~~~~~~~~~~~ + +| :ref:`[no]centerh ` +| :ref:`[no]centerv ` + + +SDL Video Soft-Specific Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`scalemode ` + + +SDL Video OpenGL Debugging Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`[no]gl_forcepow2texture ` +| :ref:`[no]gl_notexturerect ` +| :ref:`[no]gl_vbo ` +| :ref:`[no]gl_pbo ` + + +SDL Video OpenGL GLSL Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`gl_glsl ` +| :ref:`gl_glsl_filter ` +| :ref:`glsl_shader_mame[0-9] ` +| :ref:`glsl_shader_screen[0-9] ` +| :ref:`gl_glsl_vid_attr ` + + +SDL Keyboard Mapping +~~~~~~~~~~~~~~~~~~~~ + +| :ref:`keymap ` +| :ref:`keymap_file ` + + +SDL Joystick Mapping +~~~~~~~~~~~~~~~~~~~~ + +| :ref:`joyidx ` +| :ref:`sixaxis ` + + +SDL Low-level Driver Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| :ref:`videodriver ` +| :ref:`audiodriver ` +| :ref:`gl_lib ` + -- cgit v1.2.3-70-g09d2