summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
author R. Belmont <rb6502@users.noreply.github.com>2012-03-25 02:27:58 +0000
committer R. Belmont <rb6502@users.noreply.github.com>2012-03-25 02:27:58 +0000
commit58eb388fd50a5267b57b9150bc1e3d35dfa7b47e (patch)
treefbaa27a56c38b32f52bf2521eb97ae0a58bfb6f6
parent8453fe90da344796c0501907ac1f22bb393cada4 (diff)
Update SDL man pages. chdman has formatting glitches but at least matches the binary we ship. [wallyweek, R. Belmont]
-rw-r--r--.gitattributes2
-rw-r--r--src/osd/sdl/man/chdman.187
-rw-r--r--src/osd/sdl/man/jedutil.12
-rw-r--r--src/osd/sdl/man/ldplayer.12
-rw-r--r--src/osd/sdl/man/ldverify.12
-rw-r--r--src/osd/sdl/man/mame.6 (renamed from src/osd/sdl/man/mame.1)93
-rw-r--r--src/osd/sdl/man/romcmp.12
-rw-r--r--src/osd/sdl/man/testkeys.12
8 files changed, 127 insertions, 65 deletions
diff --git a/.gitattributes b/.gitattributes
index 9da578efd50..80051564396 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -5160,7 +5160,7 @@ src/osd/sdl/man/chdman.1 svneol=native#text/plain
src/osd/sdl/man/jedutil.1 svneol=native#text/plain
src/osd/sdl/man/ldplayer.1 svneol=native#text/plain
src/osd/sdl/man/ldverify.1 svneol=native#text/plain
-src/osd/sdl/man/mame.1 svneol=native#text/plain
+src/osd/sdl/man/mame.6 svneol=native#text/plain
src/osd/sdl/man/romcmp.1 svneol=native#text/plain
src/osd/sdl/man/testkeys.1 svneol=native#text/plain
src/osd/sdl/netdev.c svneol=native#text/plain
diff --git a/src/osd/sdl/man/chdman.1 b/src/osd/sdl/man/chdman.1
index a8fc29e2271..1f90cc9ed3d 100644
--- a/src/osd/sdl/man/chdman.1
+++ b/src/osd/sdl/man/chdman.1
@@ -6,7 +6,7 @@
.\" Ashley T. Howes <debiandev@ashleyhowes.com>, February 2005
.\" updated by Cesare Falco <cesare.falco@gmail.com>, February 2007
.\"
-.TH CHDMAN 1 2010-06-26 0.138u4 "chdman"
+.TH CHDMAN 1 2012-03-25 0.145u5 "chdman"
.\"
.\" NAME chapter
.SH NAME
@@ -15,7 +15,7 @@ chdman \- MAME Compressed Hunks of Data (CHD) manager
.\" SYNOPSIS chapter
.SH SYNOPSIS
.B chdman
-.I option file
+.I option switches
.\"
.\" DESCRIPTION chapter
.SH DESCRIPTION
@@ -26,53 +26,78 @@ It is a tool to manage CHD images.
.\" OPTIONS chapter
.SH OPTIONS
.TP
-.B \-info \fIinput\fR.chd
+.B \info \fIinput\fR.chd
Dump the header information from a drive image.
.TP
-.B \-createraw \fIinputhd\fR.raw \fIoutput\fR.chd [\fIinputoffs\fR [\fIhunksize\fR]]
+.B verify \fIinput\fR.chd
+Validate the MD5/SHA1 on a drive image.
+.TP
+.B createraw \fIinputhd\fR.raw \fIoutput\fR.chd [\fIinputoffs\fR [\fIhunksize\fR]]
Create a new compressed raw image from a raw file.
.TP
-.B \-createhd \fIinputhd\fR.raw \fIoutput\fR.chd [\fIinputoffs\fR [\fIcylinders \
+.B createhd \fIinputhd\fR.raw \fIoutput\fR.chd [\fIinputoffs\fR [\fIcylinders \
heads sectors \fR[\fIsectorsize\fR [\fIhunksize\fR]]]]
Create a new compressed hard disk image from a raw file.
.TP
-.B \-createblankhd \fIoutput\fR.chd \fIcylinders heads sectors\fR [\fIsectorsize \
-\fR[\fIhunksize\fR]]
-Create a new non\-compressed hard disk image, with all hunks filled with 0s.
-.TP
-.B \-createcd \fIinput\fR.toc \fIoutput\fR.chd
+.B createcd \fIinput\fR.toc \fIoutput\fR.chd
Create a new compressed CD image from a raw file.
.TP
-.B \-copydata \fIinput\fR.chd \fIoutput\fR.chd
+.B createld \fIinput\fR.toc \fIoutput\fR.chd
+Create a new compressed laserdisc image from a raw file.
+.TP
+.B extractraw \fIinput\fR.chd \fIoutput\fR.raw
+Extract a raw file from a CHD image.
+.TP
+.B extracthd \fIinput\fR.chd \fIoutput\fR.toc \fIoutput\fR.bin
+Extract a hard disk block image from a CHD image.
+.TP
+.B extractcd \fIinput\fR.chd \fIoutput\fR.toc \fIoutput\fR.bin
+Extract a CDRDAO .toc/.bin, CDRWIN .bin/.cue, or Sega Dreamcast .GDI file from a CHD\-CD image.
+.TP
+.B extractld \fIinput\fR.chd \fIoutput\fR.toc \fIoutput\fR.bin
+Extract a laserdisc image from a CHD\-LD image.
+.TP
+.B copy \fIinput\fR.chd \fIoutput\fR.chd
Copy all hunks of data from one CHD file to another. The hunk sizes do not need to match.
If the source is shorter than the destination, the source data will be padded with 0s.
+.\" SWITCHES chapter
+.SH SWITCHES
.TP
-.B \-extract \fIinput\fR.chd \fIoutput\fR.raw
-Extract a raw file from a CHD image.
+.B --chs, -chs \fI <cylinders,heads,sectors>: specifies CHS geometry values for CHD harddisks
.TP
-.B \-extractcd \fIinput\fR.chd \fIoutput\fR.toc \fIoutput\fR.bin
-Extract a CDRDAO .toc/.bin file from a CHD\-CD image.
+.B --compression, -c \fI <none|type1[,type2[,...]]>: which compression codecs to use (up to 4)
.TP
-.B \-verify \fIinput\fR.chd
-Validate the MD5/SHA1 on a drive image.
+.B --force, -f \fI : force overwriting an existing file
+.TP
+.B --help, -h \fI : shows the available switches for an option
+.TP
+.B --hunksize, -hs \fI <bytes>: size of each unit, in hunks
+.TP
+.B --ident, -id \fI <filename>: name of ident file to provide CHS information
+.TP
+.B --input, -i \fI <filename>: input file name
+.TP
+.B --inputstartbyte, -isb \fI <offset>: starting byte offset within the input
+.TP
+.B --inputstarthunk, -ish \fI <offset>: starting hunk offset within the input
+.TP
+.B --inputbytes, -ib \fI <length>: effective length of the input in bytes
+.TP
+.B --inputhunks, -ih \fI <length>: effective length of the input in hunks
+.TP
+.B --inputparent, -ip \fI <filename>: parent CHD's input file name
.TP
-.B \-verifyfix \fIinput\fR.chd
-Validate and fix the MD5/SHA1 on a drive image.
+.B --numprocessors, -np \fI <count>: limits the number of processors to use during compression
.TP
-.B \-update \fIinput\fR.chd \fIoutput\fR.chd
-Update CHD image using metadata from input file.
+.B --sectorsize, -ss \fI <bytes>: size of each hard disk sector
.TP
-.B \-chomp \fIinput\fR.chd \fIoutput\fR.chd \fImaxhunk
-Chomp hunk from CHD image.
+.B --verbose, -v \fI : output additional information about the operation
.TP
-.B \-merge \fIparent\fR.chd \fIdiff\fR.chd \fIoutput\fR.chd
-Merge a parent and its child together.
+.B --output, -o \fI <filename>: output file name
.TP
-.B \-diff \fIparent\fR.chd \fIcompare\fR.chd \fIdiff\fR.chd
-Generate a difference between two CHD files.
+.B --outputbin, -ob \fI <filename>: output binary file name for extractcd
.TP
-.B \-setchs \fIinout\fR.chd \fIcylinders heads sections
-Change the CHS values on a hard disk image.
+.B --outputparent, -op \fI <filename>: parent CHD's output file name
.TP
-.B \-split \fIinput\fR.chd \fIoutput\fR.chd \fIlength
-Split a CHD file into multiple parts.
+.B --unitsize, -us \fI <bytes>: size of each unit, in bytes
+
diff --git a/src/osd/sdl/man/jedutil.1 b/src/osd/sdl/man/jedutil.1
index f2fed9704e0..47f9352c4c0 100644
--- a/src/osd/sdl/man/jedutil.1
+++ b/src/osd/sdl/man/jedutil.1
@@ -8,7 +8,7 @@
.\" References
.\" http://aarongiles.com/?p=159
.\"
-.TH JEDUTIL 1 2010-06-26 0.138u4 "jedutil"
+.TH JEDUTIL 1 2012-03-25 0.145u5 "jedutil"
.\"
.\" NAME chapter
.SH NAME
diff --git a/src/osd/sdl/man/ldplayer.1 b/src/osd/sdl/man/ldplayer.1
index e6ea17ee1ec..ef20d659828 100644
--- a/src/osd/sdl/man/ldplayer.1
+++ b/src/osd/sdl/man/ldplayer.1
@@ -5,7 +5,7 @@
.\" Man page created from source and usage information by
.\" Cesare Falco <cesare.falco@gmail.com>, August 2008
.\"
-.TH LDPLAYER 1 2010-07-07 0.138u4 "ldplayer"
+.TH LDPLAYER 1 2012-03-25 0.145u5 "ldplayer"
.\"
.\"
.\" NAME chapter
diff --git a/src/osd/sdl/man/ldverify.1 b/src/osd/sdl/man/ldverify.1
index 5a4024c6a35..714774ba167 100644
--- a/src/osd/sdl/man/ldverify.1
+++ b/src/osd/sdl/man/ldverify.1
@@ -5,7 +5,7 @@
.\" Man page created from source and usage information by
.\" Cesare Falco <cesare.falco@gmail.com>, August 2008
.\"
-.TH LDVERIFY 1 2010-06-26 0.138u4 "ldverify"
+.TH LDVERIFY 1 2012-03-25 0.145u5 "ldverify"
.\"
.\" NAME chapter
.SH NAME
diff --git a/src/osd/sdl/man/mame.1 b/src/osd/sdl/man/mame.6
index 1bf059831c5..1f3c4fd446e 100644
--- a/src/osd/sdl/man/mame.1
+++ b/src/osd/sdl/man/mame.6
@@ -1,6 +1,6 @@
.\" -*- nroff -*-
.\"
-.\" mame.1
+.\" mame.6
.\"
.\" Man page created from usage and source information:
.\" * commands: see src/emu/clifront.c clifront.h
@@ -13,7 +13,7 @@
.\" and updated by Andrew Burton <burtona@gol.com>, July 2003
.\"
.\"
-.TH MAME 1 2010-07-07 0.138u4 "MAME - The Multiple Arcade Machine Emulator"
+.TH MAME 1 2012-03-25 0.145u5 "MAME \- The Multiple Arcade Machine Emulator"
.\"
.\"
.\" NAME chapter
@@ -146,11 +146,17 @@ is returned as one of the following:
.B \-listdevices, \-ld
Output the list of devices referenced by a given game or set of games.
.TP
+.B \-listslots, \-lslot
+Output the list of available slots and slot devices for the system.
+.TP
.B \-listmedia, \-lm
Output the list of available media for the system.
.TP
-.B \-listsoftware
+.B \-listsoftware, \-lsoft
Output the list of known software for the system.
+.TP
+.B \-getsoftlist, \-glist
+Retrieve software list by name.
.\"
.\" *******************************************************
.SS Configuration options
@@ -191,6 +197,9 @@ So, for example, if you wanted to disable overlay effects in the
vector games, you can create a vector.ini with the "effect none" line
in it, and it will override whatever effect value you have in your
mame.ini. The default is ON (\-readconfig).
+.TP
+.B \-writeconfig, \-wc
+Write configuration to \fI[driver]\fR.ini on exit.
.\"
.\" *******************************************************
.SS Search path options
@@ -467,6 +476,10 @@ Set number of processors; this overrides the number the system reports.
.TP
.B \-sdlvideofps
Show SDL video performance.
+.TP
+.B \-bench
+Benchmark for the given number of emulated seconds;
+implies \-video none \-nosound \-nothrottle.
.\"
.\" *******************************************************
.SS Rotation options
@@ -648,6 +661,9 @@ Center vertically within the view area. Default is ON (\-centerv).
.B \-waitvsync
Enable waiting for the start of VBLANK before flipping screens;
reduces tearing effects.
+.TP
+.B \-syncrefresh
+Enable using the start of VBLANK for throttling instead of the game time.
.\"
.\" *******************************************************
.SS Software video rendering subsystem options
@@ -728,24 +744,33 @@ Preferred custom OpenGL GLSL shader screen bitmap (from 0 to 9).
Enable OpenGL GLSL handling of brightness and contrast. Better RGB game
performance for free. Default is ON.
.TP
-.B \-resolution, \-r
-Select the resolution to use in full\-screen mode.
-\fB\-switchres\fR must be enabled for this to work.
-.TP
.B \-screen
+Explicit name for all screens; 'auto' here will try to make a best guess.
.TP
.B \-aspect, \-screen_aspect
+Aspect ratio for all screens; 'auto' here will try to make a best guess.
+.TP
+.B \-resolution, \-r
+Preferred resolution for all screens;
+format is \fIwidth\fRx\fIheight\fR[@\fIrefreshrate\fR] or 'auto'.
.TP
.B \-view
+Preferred view for all screens
.TP
.B \-screen[0\-3]
+Explicit name of the first|second|third|fourth screen; 'auto' here will try
+to make a best guess.
.TP
.B \-aspect[0\-3]
+Aspect ratio of the first|second|third|fourth screen; 'auto' here will try
+to make a best guess.
.TP
.B \-resolution[0\-3], \-r[0\-3]
+Preferred resolution for the first|second|third|fourth screen;
+format is \fIwidth\fRx\fIheight\fR[@\fIrefreshrate\fR] or 'auto'.
.TP
.B \-view[0\-3]
-All these options are reserved for future use.
+Preferred view for the first|second|third|fourth screen.
.\"
.\" *******************************************************
.SS Full screen options
@@ -886,12 +911,19 @@ The default is 0.85.
.B \-natural, \-nat
Specifies whether to use a natural keyboard or not.
.TP
-.B \-uimodekey, \-umk
-Specifies the key used to toggle between full and partial UI mode.
+.B \-joystick_contradictory
+Enable contradictory direction digital joystick input at the same time.
+.TP
+.B \-coin_impulse \fItime
+Set coin impulse time. A negative value for \fItime\fR disables the impulse;
+set \fItime\fR to 0 to obey driver or give a positive value to set impulse time.
.\" +++++++++++++++++++++++++++++++++++++++++++++++++++++++
.\" SDL specific
.\" +++++++++++++++++++++++++++++++++++++++++++++++++++++++
.TP
+.B \-uimodekey, \-umk
+Specifies the key used to toggle between full and partial UI mode.
+.TP
.B \-keymap
Enable keymap for non\-QWERTY keyboards. Used in conjuction with
\fB\-keymap_file\fR.
@@ -900,26 +932,12 @@ Enable keymap for non\-QWERTY keyboards. Used in conjuction with
Specifies the full path to the keymap file to be used. Shipped keymap files lie
in \fB/usr/share/games/mame/keymaps\fR.
.TP
-.B \-joy_idx1 \fIjoystick
-.TP
-.B \-joy_idx2 \fIjoystick
-.TP
-.B \-joy_idx3 \fIjoystick
-.TP
-.B \-joy_idx4 \fIjoystick
-.TP
-.B \-joy_idx5 \fIjoystick
-.TP
-.B \-joy_idx6 \fIjoystick
-.TP
-.B \-joy_idx7 \fIjoystick
-.TP
-.B \-joy_idx8 \fIjoystick
+.B \-joy_idx[0\-8] \fIjoystick
With these options you can assign a joystick to a
specific index in MAME. Even if the kernel will list the joysticks
in a different order on the next boot, MAME will still see the joystick
as e.g. "Joystick 2". Use mame \-v to see which joysticks are recognized.
-Default is AUTO.
+Default is 'auto'.
.TP
.B \-sixaxis
Use special handling for PS3 Sixaxis controllers.
@@ -957,8 +975,7 @@ depending on the presence of a particular class of analog
control for a particular game. For example, if you specify the option
\-paddle mouse, then any game that has a paddle control will automatically
enable mouse controls just as if you had explicitly specified \-mouse.
-Note that these controls override the values of \-[no]mouse,
-\-[no]joystick, etc.
+Note that these controls override the values of \-[no]mouse, \-[no]joystick, etc.
.\"
.\" *******************************************************
.SS Debugging options
@@ -1015,6 +1032,26 @@ menu in the user interface. The default is OFF (\-nocheat).
.B \-[no]skip_gameinfo
Forces MAME to skip displaying the game info screen. The default is OFF
(\-noskip_gameinfo).
+.TP
+.B \-uifont \fIfontname
+Specifies the name of a BDF font file to use for the UI font. If this
+font cannot be found or cannot be loaded, the system will fall back
+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 \-ramsize, \-ram
+Size of RAM (if supported by driver).
+.TP
+.B \-confirm_quit
+Display confirm quit screen on exit.
+.\" +++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.\" SDL specific
+.\" +++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.TP
+.B \-watchdog
+Specifies a number of seconds after which MAME should automatically exit
+if it detects that the emulation has locked up.
.\"
.\"
.\" LEGAL NOTICE chapter
diff --git a/src/osd/sdl/man/romcmp.1 b/src/osd/sdl/man/romcmp.1
index d41960e7dec..692adfa023e 100644
--- a/src/osd/sdl/man/romcmp.1
+++ b/src/osd/sdl/man/romcmp.1
@@ -9,7 +9,7 @@
.\" References
.\" http://www.mame.net/mamefaq.html
.\"
-.TH ROMCMP 1 2010-06-26 0.138u4 "romcmp"
+.TH ROMCMP 1 2012-03-25 0.145u5 "romcmp"
.\"
.\" NAME chapter
.SH NAME
diff --git a/src/osd/sdl/man/testkeys.1 b/src/osd/sdl/man/testkeys.1
index 2a0ef4223b4..35aef508069 100644
--- a/src/osd/sdl/man/testkeys.1
+++ b/src/osd/sdl/man/testkeys.1
@@ -5,7 +5,7 @@
.\" Man page created from source and usage information
.\" Cesare Falco <cesare.falco@gmail.com>, February 2007
.\"
-.TH TESTKEYS 1 2010-06-26 0.138u4 "testkeys"
+.TH TESTKEYS 1 2012-03-25 0.145u5 "testkeys"
.\"
.\" NAME chapter
.SH NAME