Difference between revisions of "Usage"
From DOSBoxWiki
Jump to navigationJump to search (KayEoHwLvMgO) |
|||
(13 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
− | + | == Command Line Parameters == | |
+ | <code>dosbox [name] [-exit] [-c command] [-fullscreen] [-userconf] [-conf congfigfilelocation] [-lang languagefilelocation] [-machine machine type] [-noconsole] [-startmapper] [-noautoexec] [-securemode] [-scaler scaler | -forcescaler scaler] [-version] [-socket socket] [-editconf program] [-opencaptures program] [-printconf] [-eraseconf] [-erasemapper]</code> | ||
+ | |||
+ | ===Usage=== | ||
+ | ;<code>name</code>: If <code>name</code> is a directory, DOSBox will mount the specified directory as the C drive.<br /> If <code>name</code> is an executable, DOSBox will mount the directory of <code>name</code> as the C drive, and start executing <code>name</code>. | ||
+ | |||
+ | ;<code>-exit</code>: DOSBox will close itself when the DOS application <code>name</code> ends. | ||
+ | |||
+ | ;<code>-c command</code>: Runs the specified command before running <code>name</code>. Multiple commands can be specified. Each command should start with <code>-c</code> though. A command can be: an Internal Program, a DOS command or an executable on a mounted drive. | ||
+ | |||
+ | ;<code>-fullscreen</code>: Starts DOSBox in fullscreen mode. | ||
+ | |||
+ | ;<code>-userconf</code>[http://www.vogons.org/viewtopic.php?f=31&t=38724#p349443]: Load the configuration from the user's profile or home directory. This is the default behavior, so this switch is useful when using -conf, below. | ||
+ | |||
+ | ;<code>-conf configfilelocation</code>: Load the config file specified in <code>configfilelocation</code>. Useful for specifying particular options for specific games. If used after <code>-userconf</code>, or if you use multiple <code>-conf</code> switches, options present in multiple configs will be overwritten by the last, except for autoexec entries, which will be appended in order. | ||
+ | |||
+ | ;<code>-lang languagefilelocation</code>: Start DOSBox using the language string specified in <code>languagefilelocation</code>. | ||
+ | |||
+ | ;<code>-machine machinetype</code>: Setup DOSBox to emulate a specific type of machine. Valid choices are: hercules, cga, ega, pcjr, tandy, svga_s3 (default) as well as the additional svga chipsets listed in the [[dosbox.conf|DOSBox configuration file]]. The machinetype affects the video card and the available sound cards. | ||
+ | |||
+ | ;<code>-noconsole</code> (Windows Only): Start DOSBox without showing the console window, output will be redirected to <code>stdout.txt</code> and <code>stderr.txt</code>. This is useful if DOSBox crashes, since the error messages stored in <code>stdout.txt</code> and <code>stderr.txt</code> may help the developers fixing the problem. | ||
+ | |||
+ | ;<code>-startmapper</code>: Enter the [[Mapper|mapper]] directly on startup. Useful for people with keyboard or joystick problems. | ||
+ | |||
+ | ;<code>-noautoexec</code>: Skips the [autoexec] section of the loaded configuration file. | ||
+ | |||
+ | ;<code>-securemode</code>: Same as -noautoexec, but adds config.com <code>-securemode</code> at the bottom of AUTOEXEC.BAT (which in turn disables any changes to how the drives are mounted inside DOSBox). | ||
+ | |||
+ | ;<code>-scaler</code>: Uses the scaler specified by "scaler". See the DOSBox [[dosbox.conf|configuration file]] for the available scalers. | ||
+ | |||
+ | ;<code>-forcescaler</code>: Similar to the -scaler parameter, but tries to force usage of the specified scaler even if it might not fit. | ||
+ | |||
+ | ;<code>-version</code>: output version information and exit. (see stdout.txt) Useful for frontends. | ||
+ | |||
+ | ;<code>-editconf program</code>: calls program with as first parameter the configuration file. You can specify this command more than once. In this case it will move to second program if the first one fails to start. | ||
+ | |||
+ | ;<code>-opencaptures program</code>: calls program with as first parameter the location of the captures folder. | ||
+ | |||
+ | ;<code>-printconf</code>: prints the location of the default configuration file. | ||
+ | |||
+ | ;<code>-resetconf</code>: removes the default configuration file. | ||
+ | |||
+ | ;<code>-resetmapper</code>: removes the mapperfile used by the default clean configuration file. | ||
+ | |||
+ | ;<code>-socket</code>: passes the socket number to the nullmodem emulation. | ||
+ | |||
+ | ===Notes=== | ||
+ | *If a <code>name/ command/ configfilelocation/ languagefilelocation</code> contains a space in it, put the whole <code>name/ command/ configfilelocation/ languagefilelocation</code> between quotes ("example"). | ||
+ | *In Windows you can also drag directories/files onto the DOSBox executable. | ||
+ | |||
+ | |||
+ | ===Example=== | ||
+ | dosbox c:\atlantis\atlantis.exe -c "MOUNT D C:\SAVES" | ||
+ | |||
+ | This would mount <code>c:\atlantis</code> as <code>c:\</code> and run <code>atlantis.exe</code>. Before it does that, it would first mount <code>C:\SAVES</code> as the D drive. |
Latest revision as of 10:29, 5 July 2016
Command Line Parameters
dosbox [name] [-exit] [-c command] [-fullscreen] [-userconf] [-conf congfigfilelocation] [-lang languagefilelocation] [-machine machine type] [-noconsole] [-startmapper] [-noautoexec] [-securemode] [-scaler scaler | -forcescaler scaler] [-version] [-socket socket] [-editconf program] [-opencaptures program] [-printconf] [-eraseconf] [-erasemapper]
Usage
name
- If
name
is a directory, DOSBox will mount the specified directory as the C drive.
Ifname
is an executable, DOSBox will mount the directory ofname
as the C drive, and start executingname
.
-exit
- DOSBox will close itself when the DOS application
name
ends.
-c command
- Runs the specified command before running
name
. Multiple commands can be specified. Each command should start with-c
though. A command can be: an Internal Program, a DOS command or an executable on a mounted drive.
-fullscreen
- Starts DOSBox in fullscreen mode.
-userconf
[1]- Load the configuration from the user's profile or home directory. This is the default behavior, so this switch is useful when using -conf, below.
-conf configfilelocation
- Load the config file specified in
configfilelocation
. Useful for specifying particular options for specific games. If used after-userconf
, or if you use multiple-conf
switches, options present in multiple configs will be overwritten by the last, except for autoexec entries, which will be appended in order.
-lang languagefilelocation
- Start DOSBox using the language string specified in
languagefilelocation
.
-machine machinetype
- Setup DOSBox to emulate a specific type of machine. Valid choices are: hercules, cga, ega, pcjr, tandy, svga_s3 (default) as well as the additional svga chipsets listed in the DOSBox configuration file. The machinetype affects the video card and the available sound cards.
-noconsole
(Windows Only)- Start DOSBox without showing the console window, output will be redirected to
stdout.txt
andstderr.txt
. This is useful if DOSBox crashes, since the error messages stored instdout.txt
andstderr.txt
may help the developers fixing the problem.
-startmapper
- Enter the mapper directly on startup. Useful for people with keyboard or joystick problems.
-noautoexec
- Skips the [autoexec] section of the loaded configuration file.
-securemode
- Same as -noautoexec, but adds config.com
-securemode
at the bottom of AUTOEXEC.BAT (which in turn disables any changes to how the drives are mounted inside DOSBox).
-scaler
- Uses the scaler specified by "scaler". See the DOSBox configuration file for the available scalers.
-forcescaler
- Similar to the -scaler parameter, but tries to force usage of the specified scaler even if it might not fit.
-version
- output version information and exit. (see stdout.txt) Useful for frontends.
-editconf program
- calls program with as first parameter the configuration file. You can specify this command more than once. In this case it will move to second program if the first one fails to start.
-opencaptures program
- calls program with as first parameter the location of the captures folder.
-printconf
- prints the location of the default configuration file.
-resetconf
- removes the default configuration file.
-resetmapper
- removes the mapperfile used by the default clean configuration file.
-socket
- passes the socket number to the nullmodem emulation.
Notes
- If a
name/ command/ configfilelocation/ languagefilelocation
contains a space in it, put the wholename/ command/ configfilelocation/ languagefilelocation
between quotes ("example"). - In Windows you can also drag directories/files onto the DOSBox executable.
Example
dosbox c:\atlantis\atlantis.exe -c "MOUNT D C:\SAVES"
This would mount c:\atlantis
as c:\
and run atlantis.exe
. Before it does that, it would first mount C:\SAVES
as the D drive.