summaryrefslogtreecommitdiffstatshomepage
path: root/docs/man/romcmp.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/romcmp.1')
-rw-r--r--docs/man/romcmp.156
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/man/romcmp.1 b/docs/man/romcmp.1
new file mode 100644
index 00000000000..d7a89f92e80
--- /dev/null
+++ b/docs/man/romcmp.1
@@ -0,0 +1,56 @@
+.\" -*- nroff -*-
+.\"
+.\" romcmp.1
+.\"
+.\" Man page created from FAQs, source and usage information by
+.\" Ashley T. Howes <debiandev@ashleyhowes.com>, February 2005
+.\" updated by Cesare Falco <c.falco@ubuntu.com>, February 2007
+.\"
+.\" References
+.\" http://www.mame.net/mamefaq.html
+.\"
+.TH ROMCMP 1 2015-07-22 0.164 "MAME romset checking tool"
+.\"
+.\" NAME chapter
+.SH NAME
+romcmp \- MAME rom and romsets check and comparison tool
+.\"
+.\" SYNOPSIS chapter
+.SH SYNOPSIS
+.B romcmp
+.RI [ \-option ]
+.RI [ dir1 | zip1 ]
+.RI [ dir2 | zip2 ]
+.\"
+.\" DESCRIPTION chapter
+.SH DESCRIPTION
+\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; it 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 jumpkids.zip
+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.
+.\"
+.\" SEE ALSO chapter
+.SH SEE ALSO
+mame(6)