-
Notifications
You must be signed in to change notification settings - Fork 38
MPF CLI
MPF Check is an optional commandline component in the MPF project. This came about as a response to a lack of UI support on the Linux side. The goal of this program is to provide a way to invoke dumping programs in a similar way to the UI but on all supported platforms.
MPF.CLI <standalone>
OR
MPF.CLI <system> [options]
| Flags | Short Description | Long Description |
|---|---|---|
h, ?, help |
Show help | Displays a help text to show possible options and parameters. |
version |
Print version | Prints the current program version and quits |
lc, listcodes |
List supported comment/content site codes | Shows a list of all Redump.org site codes, along with an indicator as to whether they go in the Comments field or the Contents field |
lo, listconfig |
List current configuration values | |
lm, listmedia |
List media types | Shows a list of all possible media types, including ones that are currently unsupported |
ls, listsystems |
List systems | Shows a list of all possible systems, including the ones that are currently unsupported |
lp, listprograms |
List programs | Shows a list of currently supported dumping and verification programs |
i, interactive |
Enable interactive mode | Enters a minimal interactive mode to provide a TUI-like interface for users who want it. |
A list of all site codes is maintained at the Redump Wiki and will not be mirrored here.
A list of all supported media types is available in the Supported Media Types section of the overview.
A list of all supported system types is available in the Supported Systems section of the overview.
Unlike MPF Check, MPF CLI uses the same configuration file that MPF UI does. A blank version of this configuration file will be generated on first run.
| Flags | Short Description | Long Description |
|---|---|---|
-u <program>--use <program>
|
Override default dumping program | Instead of using the dumping program defined in the configuration file, set a different program for this run. See Overview for more details about supported programs. |
-t <type>--mediatype <type>
|
Set media type for dumping | REQUIRED for DiscImageCreator only. Explicitly set the media type for dumping. For most programs, this only affects default parameters and dumping speed. See below for accepted values. |
-d <devicepath>--device <devicepath>
|
Physical drive path |
REQUIRED if no custom parameters are set. Set the physical device path to use for dumping. e.g. D:\ or /dev/sg0
|
-m <dirpath>--mounted <dirpath>
|
Mounted filesystem path for additional checks | Set a separate path to be used for filesystem checks, such as copy protection scanning. |
-f "<filepath>"--file "<filepath>"
|
Output file path | Set the output file path to be used during dumping, otherwise a default output path will be used. This file path should include both the directory and filename. e.g. C:\ISO\track.bin or /opt/mpf/iso/track.bin. |
-s <speed>--speed <speed>
|
Override default dumping speed | Instead of using the default dumping speeds defined in the configuration file, set a different speed for this run. |
-c "<params>"--custom "<params>"
|
Custom parameters to use | Instead of using the default parameters generated for the media type and system combination provided, use an alternative set of parameters instead. |
WARNING: Custom dumping parameters, if used, will fully replace the default parameters All dumping parameters need to be supplied if doing this. Otherwise, both a drive path and output file path are required.
NOTE: Mounted filesystem path is only recommended on OSes that require block device dumping, usually Linux and macOS.
Dump an IBM PC-Compatible CD on Windows, using the configuration-defined dumping program.
pc -d D:\ -f C:\ISO\track.bin
Dump a Sony PlayStation CD on Linux, overriding the configuration-defined dumping program to Redumper and setting the drive speed to 8.
psx -u redumper -d /dev/sg0 -f /home/mpf/iso/track.bin -s 8
Dump a DVD-Video on Linux, overriding the configuration-defined dumping program to Aaru and setting a mounted path.
dvd-video -u aaru -d /dev/sg0 -m /mnt/dvd -f /home/mpf/iso/track.iso
Dump an IBM PC-Compatible DVD on Windows with fully custom parameters.
pc -c "dvd D track.iso 8 /rr 2000"