Difference between revisions of "Usage"

From DOSBoxWiki
Jump to navigationJump to search
(→‎Usage: better explanation of -userconf parameter and minor formatting changes)
Line 5: Line 5:
 
;<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>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>-exit</code>: DOSBox will close itself when the DOS application "name" 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>-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>-fullscreen</code>: Starts DOSBox in fullscreen mode.
  
−
 
+
;<code>-userconf</code>[http://www.vogons.org/viewtopic.php?f=31&t=38724#p349443]: Start DOSBox and load the default configuration as the primary configuration file. This will normally be used in conjunction with a game specific stub .conf file.
−
;<code>-userconf</code>: Start DOSBox with the options specified in "configfilelocation". Multiple -conf options may be present.
 
−
 
 
  
 
;<code>-conf configfilelocation</code>: Start DOSBox with the options specified in <code>configfilelocation</code>. Multiple -conf options may be present.
 
;<code>-conf configfilelocation</code>: Start DOSBox with the options specified in <code>configfilelocation</code>. Multiple -conf options may be present.
−
 
  
 
;<code>-lang languagefilelocation</code>: Start DOSBox using the language string specified in <code>languagefilelocation</code>.
 
;<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>-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>-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>-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>-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>-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>-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>-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>-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>-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>-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>-printconf</code>: prints the location of the default configuration file.
−
 
  
 
;<code>-resetconf</code>: removes 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>-resetmapper</code>: removes the mapperfile used by the default clean configuration file.
−
 
  
 
;<code>-socket</code>: passes the socket number to the nullmodem emulation.
 
;<code>-socket</code>: passes the socket number to the nullmodem emulation.
−
 
  
 
===Notes===
 
===Notes===

Revision as of 23:50, 8 June 2015

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.
If name is an executable, DOSBox will mount the directory of name as the C drive, and start executing name.
-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]
Start DOSBox and load the default configuration as the primary configuration file. This will normally be used in conjunction with a game specific stub .conf file.
-conf configfilelocation
Start DOSBox with the options specified in configfilelocation. Multiple -conf options may be present.
-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 and stderr.txt. This is useful if DOSBox crashes, since the error messages stored in stdout.txt and stderr.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 whole name/ 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.

Retrieved from "https://www.dosbox.com/wiki/index.php?title=Usage&oldid=134597"