summaryrefslogtreecommitdiffstatshomepage
path: root/docs/man/chdman.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/chdman.1')
-rw-r--r--docs/man/chdman.1255
1 files changed, 255 insertions, 0 deletions
diff --git a/docs/man/chdman.1 b/docs/man/chdman.1
new file mode 100644
index 00000000000..f81b48abdea
--- /dev/null
+++ b/docs/man/chdman.1
@@ -0,0 +1,255 @@
+.\" -*- nroff -*-
+.\"
+.\" chdman.1
+.\"
+.\" Man page created from source and usage information by
+.\" Ashley T. Howes <debiandev@ashleyhowes.com>, February 2005
+.\" updated by Cesare Falco <c.falco@ubuntu.com>, February 2007
+.\"
+.TH CHDMAN 1 2015-07-22 0.164 "MAME Compressed Hunks of Data (CHD) manager"
+.\"
+.\" NAME chapter
+.SH NAME
+chdman \- MAME Compressed Hunks of Data (CHD) manager
+.\"
+.\" SYNOPSIS chapter
+.SH SYNOPSIS
+.B chdman
+.I option
+.\"
+.\" DESCRIPTION chapter
+.SH DESCRIPTION
+.B chdman
+is the (C)ompressed (H)unks of (D)ata (CHD) manager for MAME.
+It is a tool to manage CHD images.
+.\"
+.\" OPTIONS chapter
+.SH OPTIONS
+Please note that each option allows a set of switches, the meaning of each
+is explained in the \fBSWITCHES\fR section below. Whenever the short form
+for the switch is listed, the long one may be used instead.
+.TP
+.B help \fR[\fIoption\fR]
+Print a summary of the available options or, if \fIoption\fR is given, a
+detailed list of the valid switches for the option.
+.TP
+.B info \
+\-i \fIfilename\fR \
+[\fB\-v\fR]
+Dump the header information from a drive image.
+.TP
+.B verify \
+\-i \fIfileiname\fR \
+[\fB\-ip \fIfilename\fR]
+Validate the MD5/SHA1 on a drive image.
+.TP
+.B createraw \
+\-o \fIfilename\fR \
+[\fB\-op \fIfilename\fR] \
+[\fB\-f\fR] \
+\fB\-i \fIfilename\fR \
+[\fB\-isb \fIoffset\fR] \
+[\fB\-ish \fIoffset\fR] \
+[\fB\-ib \fIlength\fR] \
+[\fB\-ih \fIlength\fR] \
+\fB\-hs \fIbytes\fR \
+\fB\-us \fIbytes\fR \
+[\fB\-c none\fR|type1[,[...]]] \
+[\fB\-np \fIprocessors\fR]
+Create a new compressed raw image from a raw file.
+.TP
+.B createhd \
+\-o \fIfilename\fR \
+[\fB\-op \fIfilename\fR] \
+[\fB\-f\fR] \
+[\fB\-i \fIfilename\fR] \
+[\fB\-isb \fIoffset\fR] \
+[\fB\-ish \fIoffset\fR] \
+[\fB\-ib \fIlength\fR] \
+[\fB\-ih \fIlength\fR] \
+[\fB\-hs \fIbytes\fR] \
+[\fB\-c none\fR|type1[,[...]]] \
+[\fB\-chs \fIcylinders\fB,\fIheads\fB,\fIsectors\fR] \
+[\fB\-ss \fIbytes\fR] \
+[\fB\-np \fIprocessors\fR]
+Create a new compressed hard disk image from a raw file.
+.TP
+.B createcd \
+\-o \fIfilename\fR \
+[\fB\-op \fIfilename\fR] \
+[\fB\-f\fR] \
+\fB\-i \fIfilename\fR \
+[\fB\-hs \fIbytes\fR] \
+[\fB\-c none\fR|type1[,[...]]] \
+[\fB\-np \fIprocessors\fR]
+Create a new compressed CD image from a raw file.
+.TP
+.B createld \
+\-o \fIfilename\fR \
+[\fB\-op \fIfilename\fR] \
+[\fB\-f\fR] \
+\fB\-i \fIfilename\fR \
+[\fB\-isf \fIoffset\fR] \
+[\fB\-if \fIlength\fR] \
+[\fB\-hs \fIbytes\fR] \
+[\fB\-c none\fR|type1[,[...]]] \
+[\fB\-np \fIprocessors\fR]
+Create a new compressed laserdisc image from a raw file.
+.TP
+.B extractraw \
+\-o \fIfilename\fR \
+[\fB\-f\fR] \
+\fB\-i \fIfilename\fR \
+[\fB\-ip \fIfilename\fR] \
+[\fB\-isb \fIoffset\fR] \
+[\fB\-ish \fIoffset\fR] \
+[\fB\-ib \fIlength\fR] \
+[\fB\-ih \fIlength\fR]
+Extract a raw file from a CHD image.
+.TP
+.B extracthd \
+\-o \fIfilename\fR \
+[\fB\-f\fR] \
+\fB\-i \fIfilename\fR \
+[\fB\-ip \fIfilename\fR] \
+[\fB\-isb \fIoffset\fR] \
+[\fB\-ish \fIoffset\fR] \
+[\fB\-ib \fIlength\fR] \
+[\fB\-ih \fIlength\fR]
+Extract a hard disk block image from a CHD image.
+.TP
+.B extractcd \
+\-o \fIfilename\fR \
+[\fB\-ob \fIfilename\fR] \
+[\fB\-f\fR] \
+\fB\-i \fIfilename\fR \
+[\fB\-ip \fIfilename\fR]
+Extract a CDRDAO .toc/.bin, CDRWIN .bin/.cue, or Sega Dreamcast .GDI file from a CHD\-CD image.
+.TP
+.B extractld \
+\-o \fIfilename\fR \
+[\fB\-f\fR] \
+\fB\-i \fIfilename\fR \
+[\fB\-ip \fIfilename\fR] \
+[\fB\-isf \fIoffset\fR] \
+[\fB\-if \fIlength\fR]
+Extract a laserdisc image from a CHD\-LD image.
+.TP
+.B copy \
+\-o \fIfilename\fR \
+[\fB\-op \fIfilename\fR] \
+[\fB\-f\fR] \
+\fB\-i \fIfilename\fR \
+[\fB\-ip \fIfilename\fR] \
+[\fB\-isb \fIoffset\fR] \
+[\fB\-ish \fIoffset\fR] \
+[\fB\-ib \fIlength\fR] \
+[\fB\-ih \fIlength\fR] \
+\fB\-hs \fIbytes\fR \
+[\fB\-c none\fR|type1[,[...]]] \
+[\fB\-np \fIprocessors\fR]
+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.
+.TP
+.B addmeta \
+\fB\-i \fIfilename\fR \
+\fB\-t \fItag\fR \
+[\fB\-ix \fIindex\fR] \
+[\fB\-vt \fItext\fR] \
+[\fB\-vf \fIfilename\fR] \
+[\fB\-nocs\fR]
+Add metadata to the chd.
+.TP
+.B delmeta \
+\fB\-i \fIfilename\fR \
+\fB\-t \fItag\fR \
+[\fB\-ix \fIindex\fR]
+Remove metadata from the chd.
+.TP
+.B dumpmeta \
+\fB\-i \fIfilename\fR \
+[\fB\-o \fIfilename\fR] \
+[\fB\-f\fR] \
+\fB\-t \fItag\fR \
+[\fB\-ix \fIindex\fR]
+Dump metadata from the chd to standard output or to a file.
+.\"
+.\" SWITCHES chapter
+.SH SWITCHES
+.TP
+.B \-\-chs, \-chs \fIcylinders,heads,sectors
+Specifies CHS geometry values for CHD harddisks.
+.TP
+.B \-\-compression, \-c \fInone\fR|\fItype1\fR[,[...]]
+Which compression codecs to use (up to 4).
+.TP
+.B \-\-force, \-f
+Force overwriting an existing file.
+.TP
+.B \-\-hunksize, \-hs \fIbytes
+Size of each unit, in hunks.
+.TP
+.B \-\-ident, \-id \fIfilename
+Name of ident file to provide CHS information.
+.TP
+.B \-\-index, \-ix \fIindex
+Indexed instance of the metadata tag.
+.TP
+.B \-\-input, \-i \fIfilename
+Input file name.
+.TP
+.B \-\-inputbytes, \-ib \fIlength
+Effective length of the input in bytes.
+.TP
+.B \-\-inputframes, \-if \fIlength
+Effective length of the input in frames.
+.TP
+.B \-\-inputhunks, \-ih \fIlength
+Effective length of the input in hunks.
+.TP
+.B \-\-inputparent, \-ip \fIfilename
+Parent CHD's input file name.
+.TP
+.B \-\-inputstartbyte, \-isb \fIoffset
+Starting byte offset within the input.
+.TP
+.B \-\-inputstartframe, \-isf \fIoffset
+Starting frame offset within the input.
+.TP
+.B \-\-inputstarthunk, \-ish \fIoffset
+Starting hunk offset within the input.
+.TP
+.B \-\-nochecksum, \-nocs
+Do not include this metadata information in the overall SHA-1.
+.TP
+.B \-\-numprocessors, \-np \fIcount
+Limits the number of processors to use during compression.
+.TP
+.B \-\-output, \-o \fIfilename
+Output file name.
+.TP
+.B \-\-outputbin, \-ob \fIfilename
+Output binary file name for extractcd.
+.TP
+.B \-\-outputparent, \-op \fIfilename
+Parent CHD's output file name.
+.TP
+.B \-\-sectorsize, \-ss \fIbytes
+Size of each hard disk sector.
+.TP
+.B \-\-tag, \-t \fItag
+4-character tag for metadata.
+.TP
+.B \-\-valuefile, \-vf \fIfilename
+Text file containing data to add.
+.TP
+.B \-\-valuetext, \-vt \fItext
+Text for the metadata.
+.TP
+.B \-\-unitsize, \-us \fIbytes
+Size of each unit, in bytes.
+.TP
+.B \-\-verbose, \-v
+Output additional information about the operation.
+.SH SEE ALSO
+mame(6), mess(6)