DOS commands

dosbox-automation provides a comprehensive set of commands available at the DOS prompt. Most are clean-room reimplementations of classic MS-DOS commands, designed to be compatible with their original counterparts but not derived from MS-DOS source code. A number of additional commands are specific to dosbox-automation and provide emulator management features like mounting drives and controlling the audio mixer.

See The DOSBox shell to learn about the shell itself --- line editing, tab completion, command history, piping, and other interactive features.

Tip

Type HELP at the DOS prompt to see the most commonly used commands, or HELP /ALL for the complete list. Every command supports the /? flag for detailed usage help - for example, MOUNT /? or DIR /?.

dosbox-automation commands

These commands are specific to dosbox-automation and have no MS-DOS equivalent.

CommandDescription
AUTOTYPEPerform scripted keyboard entry into a running DOS game
BOOTBoot dosbox-automation from a DOS drive or disk image
CLIPCopy text to the clipboard or retrieve the clipboard's content
CONFIGPerform configuration management and other miscellaneous actions
GUIDEOpen the Tutorials guide in your default web browser
LOADROMLoad a ROM image of the video BIOS or IBM BASIC
MAKEIMGCreate a new empty disk image
MANUALOpen the user manual in your default web browser
MIXERDisplay or change the sound mixer settings
MOUNTMount a directory or an image file to a drive letter
MOUSECTLManage physical and logical mice
RESCANScan for changes on mounted DOS drives
SERIALManage the serial ports
SHOWPICDisplay an image file

Note

IMGMOUNT is still accepted as an alias for MOUNT.

File & directory commands

CommandAliasesDescription
ATTRIBDisplay or change file attributes
CDCHDIRDisplay or change the current directory
COPYCopy one or more files
DELDELETE, ERASERemove one or more files
DIRDisplay a list of files and subdirectories in a directory
LSDisplay directory contents in wide list format
MDMKDIRCreate a directory
MOREDisplay command output or text file one screen at a time
MOVEMove files and rename files and directories
RDRMDIRRemove a directory
RENRENAMERename one or more files
SUBSTAssign an internal directory to a drive
TREEDisplay directory tree in a graphical form

Batch file commands

CommandDescription
CALLStart a batch program from within another batch program
CHOICEWait for a keypress and set an ERRORLEVEL value
ECHODisplay messages and enable/disable command echoing
FORRun a specified command for each string in a set
GOTOJump to a labeled line in a batch program
IFPerform conditional processing in batch programs
PAUSEWait for a keystroke to continue
REMAdd comments in a batch program
SHIFTLeft-shift command-line parameters in a batch program

Miscellaneous commands

CommandAliasesDescription
CLSClear the DOS screen
DATEDisplay or change the internal date
EXITExit from the DOS shell
HELPDisplay help information for DOS commands
KEYBConfigure a keyboard layout and screen font
LHLOADHIGHLoad a DOS program into upper memory
LOADFIXLoad a program in a specific memory region and then run it
MEMDisplay the amount of used and free memory
MODESet the display mode or the keyboard's typematic rate
MOUSELoad the built-in mouse driver
PATHDisplay or set a search path for executable files
SETDisplay or change environment variables
SETVERDisplay or set the DOS version reported to applications
TIMEDisplay or change the internal time
TYPEDisplay the contents of a text file
VERDisplay the DOS version
VOLDisplay the disk volume and serial number, if they exist

Bundled third-party programs

dosbox-automation ships a small number of FreeDOS utilities as pre-compiled binaries on the Y: drive. When the Y: drive is automounted (enabled by default), the Y:\DOS directory is added to the PATH automatically, making these commands available from any drive.

These are not dosbox-automation reimplementations - they are third-party open-source programs included for convenience.

CommandDescriptionOrigin
DEBUGInteractive DOS debuggerDOS-debug
DELTREEDelete a directory tree including all files and subdirectoriesFreeDOS
XCOPYExtended file copy with subdirectory supportFreeDOS

Automation utilities

The Y: drive also carries small helpers written for dosbox-automation itself. They are ordinary DOS programs, so batch files and install recipes can call them like any other command.

SETMODE nn

Sets the video mode nn (hexadecimal) through INT 10h. Useful for putting the machine into a defined graphics or text mode from a batch file, which the scripting API cannot do on its own. Source is included on the drive.

OSD text / OSD /C

Shows the given text as an on-screen overlay, or clears it with /C. This lets a batch file label what it is doing while automation runs. The command only works while the web server is running; without it, it prints nothing and exits with errorlevel 1.