Sprinter/mame
2
0
Fork 0
mirror of https://github.com/holub/mame synced 2025-10-07 17:27:06 +03:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

SDL: Revise the *IX man pages [wallyweek]

Browse Source
This commit is contained in:
Scott Stone 2013-08-06 22:09:48 +00:00
parent e9ec79734d
commit 6a10775f6f
2 changed files with 116 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
src/osd/sdl/man/mame.6
View File

@ -13,7 +13,7 @@
.\" and updated by Andrew Burton <burtona@gol.com>, July 2003 .\" and updated by Andrew Burton <burtona@gol.com>, July 2003
.\" .\"
.\" .\"
.TH MAME 6 2013-01-28 0.148u1 "MAME \- The Multiple Arcade Machine Emulator" .TH MAME 6 2013-06-12 0.149 "MAME \- The Multiple Arcade Machine Emulator"
.\" .\"
.\" .\"
.\" NAME chapter .\" NAME chapter
@ -155,17 +155,24 @@ Output the list of available media for the system.
.B \-listsoftware, \-lsoft .B \-listsoftware, \-lsoft
Output the list of known software for the system. Output the list of known software for the system.
.TP .TP
.B \-verifysoftware, \-vsoft .B \-verifysoftware, \-vsoft \fR[\fIgamename\fR|\fIwildcard\fR]
Verify known software for the system. Checks for invalid or missing ROM images in your software lists.
By default all drivers that have valid ZIP files or directories
in the rompath are verified; however, you can limit this list by
specifying a specific driver name or wildcard.
.TP .TP
.B \-getsoftlist, \-glist .B \-getsoftlist, \-glist
Retrieve software list by name. Retrieve software list by name.
.TP .TP
.B \-verifysoftlist, \-vlist .B \-verifysoftlist, \-vlist \fR[\fIsoftwarelistname\fR]
Verify software list by name. Checks a specified software list for missing ROM images if files exist
for issued softwarelistname. By default, all drivers that have valid
ZIP files or directories in the rompath are verified; however, you can
limit this list by specifying a specific softwarelistname (without .XML).
.TP .TP
.B \-listmidi, \-mlist .B \-listmidi, \-mlist
List available MIDI I/O devices. Create a list of list available MIDI I/O devices for use with emulation.
.\" .\"
.\" ******************************************************* .\" *******************************************************
.SS Configuration options .SS Configuration options
@ -179,7 +186,7 @@ Enables or disables the reading of the config files. When enabled
.br .br
the main configuration file the main configuration file
.br .br
2. \fI[name]\fB.ini\fR 2. \fIname\fB.ini\fR
.br .br
where \fIname\fR is your executable name, i.e. mame unless you changed it where \fIname\fR is your executable name, i.e. mame unless you changed it
(e.g. if you renamed mame to mame0137, the parsed file will be (e.g. if you renamed mame to mame0137, the parsed file will be
@ -361,18 +368,21 @@ consistent, you should only record and playback with all configuration
(.cfg), NVRAM (.nv), and memory card files deleted. The default is NULL (.cfg), NVRAM (.nv), and memory card files deleted. The default is NULL
(no recording). (no recording).
.TP .TP
.B \-snapname \fIname .B \-snapname \fIstring
Describes how MAME should name files for snapshots. \fIname\fP is a string Describes how MAME should name files for snapshots. \fIstring\fP
that provides a template that is used to generate a filename. Three provides a template that is used to generate a filename. Three
simple substitutions are provided: the / character represents the simple substitutions are provided: the / character represents the
path separator on any target platform (even Windows); the string \fI%g\fP path separator on any target platform (even Windows); the literal \fB%g\fP
represents the driver name of the current game; and the string \fI%i\fP represents the driver name of the current game; and the literal \fB%i\fP
represents an incrementing index. If \fI%i\fP is omitted, then each represents an incrementing index. If \fB%i\fP is omitted, then each
snapshot taken will overwrite the previous one; otherwise, MAME will snapshot taken will overwrite the previous one; otherwise, MAME will
find the next empty value for \fI%i\fP and use that for a filename. The find the next empty value for \fB%i\fP and use that for a filename. The
default is \fI%g/%i\fP, which creates a separate folder for each game, default is \fB%g/%i\fP, which creates a separate folder for each game,
and names the snapshots under it starting with 0000 and increasing and names the snapshots under it starting with 0000 and increasing
from there. from there. Example: if you use
.B mame robby \-snapname foo/%g%i
snapshots will be saved as \fBsnaps/foo/robby0000.png\fP,
\fBsnaps/foo/robby0001.png\fP and so on.
.TP .TP
.B \-snapsize \fIwidth\fPx\fIheight .B \-snapsize \fIwidth\fPx\fIheight
Hard\-codes the size for snapshots and movie recording. By default, Hard\-codes the size for snapshots and movie recording. By default,
@ -396,6 +406,17 @@ specified by \fIviewname\fP. For example, \-snapview native will match the
\fIviewname\fP can also be 'auto', which selects the first view with all \fIviewname\fP can also be 'auto', which selects the first view with all
screens present. The default value is 'internal'. screens present. The default value is 'internal'.
.TP .TP
.B \-statename \fIstring
Describes how MAME should store save state files, relative to the
state_directory path. \fIstring\fP provides a template that
is used to generate a relative path. Two simple substitutions are
provided: the / character represents the path separator on any target
platform (even Windows); the literal \fB%g\fP represents the driver name of
the current game. The default is '%g', which creates a separate folder
for each game. Example: if you use
.B mame robby \-statename foo/%g
save states will be stored inside \fBsta/foo/robby/\fP.
.TP
.B \-mngwrite \fIfilename .B \-mngwrite \fIfilename
Writes each video frame to the given \fIfilename\fP in MNG format, producing Writes each video frame to the given \fIfilename\fP in MNG format, producing
an animation of the game session. Note that \-mngwrite only writes video an animation of the game session. Note that \-mngwrite only writes video
@ -913,7 +934,10 @@ the maximum range. This option expects a float in the range of 0.0 to
The default is 0.85. The default is 0.85.
.TP .TP
.B \-natural, \-nat .B \-natural, \-nat
Specifies whether to use a natural keyboard or not. Allows user to specify whether or not to use a natural keyboard.
This allows you to start your game or system in a 'native' mode, depending
on your region, allowing compatability for non\-"QWERTY" style keyboards.
The default is OFF (-nonatural).
.TP .TP
.B \-joystick_contradictory .B \-joystick_contradictory
Enable contradictory direction digital joystick input at the same time. Enable contradictory direction digital joystick input at the same time.
@ -1055,6 +1079,20 @@ Display confirm quit screen on exit.
.TP .TP
.B \-ui_mouse .B \-ui_mouse
Display UI mouse cursor. Display UI mouse cursor.
.TP
.B \-autoboot_command, \-ab \fIcommand
Command string to execute after machine boot (in quotes ""). To issue
a quote to the emulation, use \fB"""\fP in the string.
Using \fB\\n\fP will issue a create a new line, issuing what was
typed prior as a command. Example:
\fB\-autoboot_command "load """$""",8,1\\n"\fP.
.TP
.B \-autoboot_delay \fR[\fIseconds\fP]
Timer delay (in seconds) to trigger command execution on autoboot.
Default is 2.
.TP
.B \-autoboot_script, \-script \fR[\fIfilename.lua\fP]
File containing scripting to execute after machine boot.
.\" +++++++++++++++++++++++++++++++++++++++++++++++++++++++ .\" +++++++++++++++++++++++++++++++++++++++++++++++++++++++
.\" SDL specific .\" SDL specific
.\" +++++++++++++++++++++++++++++++++++++++++++++++++++++++ .\" +++++++++++++++++++++++++++++++++++++++++++++++++++++++

76
src/osd/sdl/man/mess.6
View File

@ -16,7 +16,7 @@
.\" http://www.mess.org/ .\" http://www.mess.org/
.\" .\"
.\" .\"
.TH MESS 6 2013-01-28 0.148u1 "The Multiple Emulator Super System (MESS)" .TH MESS 6 2013-06-12 0.149 "The Multiple Emulator Super System (MESS)"
.\" .\"
.\" .\"
.\" NAME chapter .\" NAME chapter
@ -154,14 +154,20 @@ Output the list of available media for the system.
.B \-listsoftware, \-lsoft .B \-listsoftware, \-lsoft
Output the list of known software for the system. Output the list of known software for the system.
.TP .TP
.B \-verifysoftware, \-vsoft .B \-verifysoftware, \-vsoft \fR[\fIgamename\fR|\fIwildcard\fR]
Verify known software for the system. Checks for invalid or missing ROM images in your software lists.
By default all drivers that have valid ZIP files or directories
in the rompath are verified; however, you can limit this list by
specifying a specific driver name or wildcard.
.TP .TP
.B \-getsoftlist, \-glist .B \-getsoftlist, \-glist
Retrieve software list by name. Retrieve software list by name.
.TP .TP
.B \-verifysoftlist, \-vlist .B \-verifysoftlist, \-vlist \fR[\fIsoftwarelistname\fR]
Verify software list by name. Checks a specified software list for missing ROM images if files exist
for issued softwarelistname. By default, all drivers that have valid
ZIP files or directories in the rompath are verified; however, you can
limit this list by specifying a specific softwarelistname (without .XML).
.TP .TP
.B \-listmidi, \-mlist .B \-listmidi, \-mlist
List available MIDI I/O devices. List available MIDI I/O devices.
@ -353,18 +359,25 @@ consistent, you should only record and playback with all configuration
(.cfg), NVRAM (.nv), and memory card files deleted. The default is NULL (.cfg), NVRAM (.nv), and memory card files deleted. The default is NULL
(no recording). (no recording).
.TP .TP
.B \-snapname \fIname .B \-snapname \fIstring
Describes how MESS should name files for snapshots. \fIname\fP is a string Describes how MESS should name files for snapshots. \fIstring\fP
that provides a template that is used to generate a filename. Three provides a template that is used to generate a filename. Three
simple substitutions are provided: the / character represents the simple substitutions are provided: the / character represents the
path separator on any target platform (even Windows); the string \fI%g\fP path separator on any target platform (even Windows); the literal \fB%g\fP
represents the driver name of the current system; and the string \fI%i\fP represents the driver name of the current system; and the literal \fB%i\fP
represents an incrementing index. If \fI%i\fP is omitted, then each represents an incrementing index. If \fB%i\fP is omitted, then each
snapshot taken will overwrite the previous one; otherwise, MESS will snapshot taken will overwrite the previous one; otherwise, MESS will
find the next empty value for \fI%i\fP and use that for a filename. The find the next empty value for \fB%i\fP and use that for a filename. The
default is \fI%g/%i\fP, which creates a separate folder for each game, default is '%g/%i', which creates a separate folder for each game,
and names the snapshots under it starting with 0000 and increasing and names the snapshots under it starting with 0000 and increasing
from there. from there. In addition to the above, for drivers using different
media, like carts or floppy disks, you can also use the
\fB%d\fP\fI_[media]\fP indicator. Replace \fI[media]\fP with the media
switch you want to use. A few examples: if you use
.B mess nes \-cart robby \-snapname %g/%d_cart
snapshots will be saved as \fBsnaps/nes/robby.png\fP; if you use
.B mess c64 \-flop1 robby \-snapname %g/%d_flop1/%i
snapshots will be saved as \fBsnaps/c64/robby/0000.png\fP.
.TP .TP
.B \-snapsize \fIwidth\fRx\fIheight .B \-snapsize \fIwidth\fRx\fIheight
Hard\-codes the size for snapshots and movie recording. By default, Hard\-codes the size for snapshots and movie recording. By default,
@ -388,6 +401,22 @@ specified by \fIviewname\fP. For example, \-snapview native will match the
\fIviewname\fP can also be 'auto', which selects the first view with all \fIviewname\fP can also be 'auto', which selects the first view with all
screens present. The default value is 'internal'. screens present. The default value is 'internal'.
.TP .TP
.B \-statename \fIstring
Describes how MESS should store save state files, relative to the
state_directory path. \fIstring\fP provides a template that
is used to generate a relative path. Two simple substitutions are
provided: the / character represents the path separator on any target
platform (even Windows); the literal \fB%g\fP represents the driver name of
the current game. The default is '%g', which creates a separate folder
for each game. In addition to the above, for drivers using different
media, like carts or floppy disks, you can also use the
\fB%d_\fP\fI[media]\fP indicator. Replace \fI[media]\fP with the media
switch you want to use. A few examples: if you use
.B mess nes \-cart robby \-statename %g/%d_cart
save states will be stored inside \fBsta/nes/robby/\fP; if you use
.B mess c64 \-flop1 robby \-statename %g/%d_flop1
save states will be stored inside \fBsta/c64/robby/\fP.
.TP
.B \-mngwrite \fIfilename .B \-mngwrite \fIfilename
Writes each video frame to the given file in MNG format, producing Writes each video frame to the given file in MNG format, producing
an animation of the system session. an animation of the system session.
@ -893,7 +922,10 @@ the maximum range. This option expects a float in the range of 0.0 to
The default is 0.85. The default is 0.85.
.TP .TP
.B \-natural, \-nat .B \-natural, \-nat
Specifies whether to use a natural keyboard or not. Allows user to specify whether or not to use a natural keyboard.
This allows you to start your game or system in a 'native' mode, depending
on your region, allowing compatability for non\-"QWERTY" style keyboards.
The default is OFF (-nonatural).
.TP .TP
.B \-uimodekey, \-umk .B \-uimodekey, \-umk
Specifies the key used to toggle between full and partial UI mode. Specifies the key used to toggle between full and partial UI mode.
@ -1030,6 +1062,20 @@ Display confirm quit screen on exit.
.B \-ui_mouse .B \-ui_mouse
Display UI mouse cursor. Display UI mouse cursor.
.TP .TP
.B \-autoboot_command, \-ab \fIcommand
Command string to execute after machine boot (in quotes ""). To issue
a quote to the emulation, use \fB"""\fP in the string.
Using \fB\\n\fP will issue a create a new line, issuing what was
typed prior as a command. Example:
\fB\-autoboot_command "load """$""",8,1\\n"\fP.
.TP
.B \-autoboot_delay \fR[\fIseconds\fP]
Timer delay (in seconds) to trigger command execution on autoboot.
Default is 2.
.TP
.B \-autoboot_script, \-script \fR[\fIfilename.lua\fP]
File containing scripting to execute after machine boot.
.TP
.B \-newui, \-nu .B \-newui, \-nu
Use the new MESS UI. Use the new MESS UI.
.TP .TP