summaryrefslogtreecommitdiffstatshomepage
path: root/docs/man/mame.6
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/mame.6')
-rw-r--r--docs/man/mame.6173
1 files changed, 149 insertions, 24 deletions
diff --git a/docs/man/mame.6 b/docs/man/mame.6
index 64150f128ea..da51b1f2c41 100644
--- a/docs/man/mame.6
+++ b/docs/man/mame.6
@@ -13,7 +13,7 @@
.\" and updated by Andrew Burton <burtona@gol.com>, July 2003
.\"
.\"
-.TH MAME 6 2015-07-22 0.164 "MAME \- The Multiple Arcade Machine Emulator"
+.TH MAME 6 2016-07-21 0.176 "MAME \- The Multiple Arcade Machine Emulator"
.\"
.\"
.\" NAME chapter
@@ -281,6 +281,16 @@ the MAME executable). If the Crosshair is set to default in the menu,
MAME will look for gamename\cross#.png and then cross#.png in the
specified crosshairpath, where # is the player number. Failing that,
MAME will use built\-in default crosshairs.
+.TP
+.B \-pluginspath \fIpathname
+Specifies a single path within which to find plugins. The default
+is 'plugins' (that is, a directory 'plugins' in the same directory as
+the MAME executable).
+.TP
+.B \-languagepath \fIpathname
+Specifies a single path within which to find language files. The default
+is 'language' (that is, a directory 'language' in the same directory as
+the MAME executable).
.\"
.\" *******************************************************
.SS Output Directory Options
@@ -632,15 +642,19 @@ Name of a PNG file to use for visual effects, or 'none'. Default is 'none'.
.SS Vector rendering options
.\" *******************************************************
.TP
-.B \-[no]antialias, \-[no]aa
-Enables antialiased line rendering for vector games. The default is ON
-(\-antialias).
+.B \-beam_width_min \fIvalue
+.TP
+.B \-beam_width_max \fIvalue
+Sets the minimum and maximum width of the vectors. This is a scaling factor
+against the standard vector width, which is interpolated between minimum and
+maximum according to the beam's intensity. A value of 1.0 will keep the
+default vector line width. Smaller values will reduce the width, and larger
+values will increase the width. The default is 1.0.
.TP
-.B \-beam \fIvalue
-Sets the width of the vectors. This is a scaling factor against the
-standard vector width. A value of 1.0 will keep the default vector line
-width. Smaller values will reduce the width, and larger values will
-increase the width. The default is 1.0.
+.B \-beam_intensity_weight \fIvalue
+Applies an exponential weight to the minimum and maximum beam width. For
+positive values the interpolated scaling factor will affect lines with higher
+intensity more than lines with lower intensity. The default is 0.0.
.TP
.B \-flicker \fIvalue
Simulates a vector "flicker" effect, similar to a vector monitor that
@@ -666,7 +680,10 @@ output on some cards.
.br
\fBnone\fR does no drawing and is intended for CPU benchmarking.
.br
-Default is SOFT.
+Default is 'soft'.
+.TP
+.B \-numscreens \fR[\fI1-4\fR]
+Number of screens to create; usually, you want just one. Default is '1'.
.TP
.B \-[no]window, \-[no]w
Run MAME in either full screen or a window. This is a fully\-featured window
@@ -693,6 +710,18 @@ Allow non\-integer stretch factors. Video purists should stay far, far away
from this option, while everyone else will be happy to know that it lets you
fill the screen properly in full\-screen mode. Default is ON (\-unevenstretch).
.TP
+.B \-[no]unevenstretchx, \-[no]uesx
+Act as \-[no]unevenstretch on horizontal basis only.
+.TP
+.B \-[no]intoverscan, \-[no]ios
+Allow overscan on integer scaled targets.
+.TP
+.B \-intscalex, \-sx
+Set horizontal integer scale factor.
+.TP
+.B \-intscaley, \-sy
+Set vertical integer scale factor.
+.TP
.B \-[no]centerh
Center horizontally within the view area. Default is ON (\-centerh).
.TP
@@ -745,7 +774,7 @@ Default is NONE.
.\" +++++++++++++++++++++++++++++++++++++++++++++++++++++++
.B NOTE:
All the options in this group are available only with OpenGL video
-rendering subsystem, i.e \fB\-video opengl\fR or \fB\-video opengl16\fR.
+rendering subsystem, i.e \fB\-video opengl\fR.
.TP
.B \-[no]filter, \-[no]glfilter, \-[no]flt
Enable bilinear filtering on screen output. Default is ON (\-filter).
@@ -783,10 +812,6 @@ Preferred custom OpenGL GLSL shader set mame bitmap (from 0 to 9).
.B \-glsl_shader_screen[0\-9]
Preferred custom OpenGL GLSL shader screen bitmap (from 0 to 9).
.TP
-.B \-gl_glsl_vid_attr
-Enable OpenGL GLSL handling of brightness and contrast. Better RGB game
-performance for free. Default is ON.
-.TP
.B \-screen
Explicit name for all screens; 'auto' here will try to make a best guess.
.TP
@@ -816,6 +841,51 @@ format is \fIwidth\fRx\fIheight\fR[@\fIrefreshrate\fR] or 'auto'.
Preferred view for the first|second|third|fourth screen.
.\"
.\" *******************************************************
+.SS BGFX post\-processing options
+.\" *******************************************************
+.B NOTE:
+All the options in this group are available only when BGFX video
+post\-processing is enabled, i.e \fB\-video bgfx\fR. For full info on BGFX
+please visit official MAME documentation page:
+.br
+http://docs.mamedev.org/advanced/bgfx.html
+.TP
+.B \-bgfx_path \fIpathname
+This is where your BGFX shader files are stored.
+The default is 'bgfx' (that is, a directory "bgfx" in the same directory
+as the MAME executable).
+.TP
+.B \-bgfx_backend \fIauto\fR|\fIopengl\fR
+Selects a rendering backend for BGFX to use. The default is 'auto',
+which will let MAME choose the best selection for you.
+.TP
+.B \-bgfx_debug
+Enables BGFX debugging features. Most users will not need to use this.
+.TP
+.B \-bgfx_screen_chains \fIdefault\fR|\fIunfiltered\fR|\fIhlsl\fR[,...]
+This dictates how to handle BGFX rendering on a per\-display basis.
+For each display specify one of the possible choices:
+.br
+\fBdefault\fR default bilinear filterered output
+.br
+\fBunfiltered\fR nearest neighbor unfiltered output
+.br
+\fBhlsl\fR HLSL display simulation through shaders
+.br
+Separate directives for each window with a comma (,) and for each physical
+screen with a colon (:). For example, for an emulated game with 3 displays
+emulated on 3 windows on your monitor,
+.B \-bgfx_screen_chains default,unfiltered,default
+specifies to apply default filter on what is been rendered on the first
+and third window and leave the content of the second window unfiltered.
+.TP
+.B \-bgfx_shadow_mask \fIfilename
+This specifies the shadow mask effect PNG file. Default is 'slot-mask.png'.
+.TP
+.B \-bgfx_avi_name \fIfilename
+This specifies a filename for BGFX output logging.
+.\"
+.\" *******************************************************
.SS Full screen options
.\" *******************************************************
.\" +++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -973,9 +1043,27 @@ set \fItime\fR to 0 to obey driver or give a positive value to set impulse time.
.\" SDL specific
.\" +++++++++++++++++++++++++++++++++++++++++++++++++++++++
.TP
-.B \-uimodekey, \-umk
+.B \-uimodekey, \-umk \fIvalue
Specifies the key used to toggle between full and partial UI mode.
.TP
+.B \-uifontprovider \fIauto\fR|\fIsdl\fR|\fInone
+Provider for ui font.
+.TP
+.B \-output \fIconsole\fR|\fInetwork\fR|\fInone
+Provider for output.
+.TP
+.B \-keyboardprovider \fIauto\fR|\fIsdl\fR|\fInone
+Provider for keyboard input.
+.TP
+.B \-mouseprovider \fIauto\fR|\fIsdl\fR|\fInone
+Provider for mouse input.
+.TP
+.B \-lightgunprovider \fIauto\fR|\fInone
+Provider for lightgun input.
+.TP
+.B \-joystickprovider \fIauto\fR|\fIsdl\fR|\fInone
+Provider for joystick input.
+.TP
.B \-[no]keymap
Enable keymap for non\-QWERTY keyboards. Used in conjunction with
\fB\-keymap_file\fR. Default is OFF (\-nokeymap).
@@ -995,17 +1083,23 @@ Default is 'auto'.
Use special handling for PS3 Sixaxis controllers.
Default is OFF (\-nosixaxis).
.TP
-.B \-lightgun_index[1\-8]
-Map lightgun to specific index in MAME.
+.B \-mouse_index[1\-8]
+Map mouse to specific index in MAME.
+.TP
+.B \-keyb_idx[0\-8] \fIkeyboard
+With these options you can assign a keyboard to a specific index in MAME.
.TP
-.B \-videodriver, \-vd \fIx11\fR|\fIdirectfb\fR|\fIauto\fR
-SDL video driver to use; auto selects SDL default.
+.B \-videodriver, \-vd \fIauto\fR|\fIx11\fR|\fIdirectfb
+SDL video driver to use; 'auto' selects SDL default.
.TP
-.B \-audiodriver, \-ad \fIalsa\fR|\fIarts\fR|\fIauto\fR
-SDL audio driver to use; auto selects SDL default.
+.B \-renderdriver, \-rd \fIauto\fR|\fIsoftware\fR|\fIopengl\fR|\fIdirectfb
+SDL render driver to use; 'auto' selects SDL default.
.TP
-.B \-gl_lib \fIalsa\fR|\fIarts\fR|\fIauto\fR
-Alternative libGL.so to use; auto selects SDL default.
+.B \-audiodriver, \-ad \fIauto\fR|\fIalsa\fR|\fIarts
+SDL audio driver to use; 'auto' selects SDL default.
+.TP
+.B \-gl_lib \fIauto\fR|\fIalsa\fR|\fIarts
+Alternative libGL.so to use; 'auto' selects SDL default.
.\"
.\" *******************************************************
.SS Input automatic enable options
@@ -1081,6 +1175,22 @@ the same time as \-log to output the log data to both targets as well.
Default is OFF (\-nooslog).
.\"
.\" *******************************************************
+.SS Communication options
+.\" *******************************************************
+.TP
+.B \-comm_localhost
+Local address to bind to.
+.TP
+.B \-comm_localport
+Local port to bind to.
+.TP
+.B \-comm_remotehost
+Remote address to connect to.
+.TP
+.B \-comm_remoteport
+Remote port to connect to.
+.\"
+.\" *******************************************************
.SS Misc options
.\" *******************************************************
.TP
@@ -1117,6 +1227,9 @@ to its built\-in UI font. On some platforms \fIfontname\fP can be a system
font name instead of a BDF font file. The default is 'default' (use
the OSD\-determined default font).
.TP
+.B \-ui \fIsimple\fR|\fIcabinet
+Type of UI.
+.TP
.B \-ramsize, \-ram \fIvalue
Size of RAM (if supported by driver).
.TP
@@ -1142,6 +1255,18 @@ File containing scripting to execute after machine boot.
.TP
.B \-[no]console
Enable emulator LUA console. Default is OFF (\-noconsole).
+.TP
+.B \-[no]plugins
+Enable LUA plugin support. Default is ON (\-plugins).
+.TP
+.B \-plugin \fIvalue
+List of plugins to enable.
+.TP
+.B \-noplugin \fIvalue
+List of plugins to disable.
+.TP
+.B \-language, \-lang \fIvalue
+Display language. Default is 'English'.
.\" +++++++++++++++++++++++++++++++++++++++++++++++++++++++
.\" SDL specific
.\" +++++++++++++++++++++++++++++++++++++++++++++++++++++++