Package: xmame-tools
Tags: patch

I noticed that there is a missing man page for romcmp in xmame-tools.
Please find attached one I have created for inclusion.

I was unsure whether the tools for xmame would be in man section 1 (for 
executables) or section 6 (for games).  As this tool is not a game, but
game related, I have placed it in section 1 for now.  Feel free to amend
if required.

--

Ashley T. Howes, Ph.D.
http://www.ashleyhowes.com

"If you always put limits on yourself and what you can do, physical or
anything, you might as well be dead.  It will spread into your work, your
morality, your entire being.  There are not limits, only plateaux.  But you
must not stay there, you must go beyond them.  If it kills you, it kills
you." - Bruce Lee
.\"  -*- nroff -*-
.\"
.\" romcmp.1
.\"
.\" Man page created from FAQs, source and usage information by 
.\" Ashley T. Howes <[EMAIL PROTECTED]>, February 2005
.\" 
.\" References
.\" http://www.mame.net/mamefaq.html
.\"
.TH ROMCMP 1 2005-02-15 0.90 "romcmp"
.\" NAME chapter
.SH NAME
romcmp \- MAME rom and romsets check and comparison tool
.\" SYNOPSIS chapter
.SH SYNOPSIS
\fBromcmp\fP
.RI \|[ \-option \|]
.RI \|[ dir1 | zip1] \|
.RI \|[ dir2 | zip2] \|
.\" DESCRIPTION chapter
.SH DESCRIPTION
An eternal nuisance in arcade emulation are incomplete or corrupt dumps of the 
ROM chips.
\fBromcmp\fP is a tool developed to detect the most common errors that can 
occur when dumping ROMS,
for example stuck bits and address line errors.
.PP
It can check the ROMs in ZIP files or subdirectories.
.PP
\fBromcmp\fP can also be used to compare two ROM sets, by giving it two files 
or subdirectories
as parameters.  It will determine which ROMS are identical and which are the 
closest matches.
This is useful when figuring out if a newly dumped ROM set is a clone of 
another ROM set.
.\" OPTIONS chapter
.SH OPTIONS
.TP
.B \-d
Enables a slower, more comprehensive comparison.
.\" EXAMPLES chapter
.SH EXAMPLES
.B romcmp \fIjumpkids.zip\fP
will output the following:

  11 files
  23.3c                 FIXED BITS (xxxxxx1x)
  23.3c                 FIRST AND SECOND HALF IDENTICAL
      
This tells us that the 23.3C ROM in Jump Kids is bad, and incidentally, it 
causes the missing sound in that game.

Attachment: signature.asc
Description: Digital signature

Reply via email to