Skip to content

Instantly share code, notes, and snippets.

@farsil

farsil/en.lng

Last active August 11, 2024 15:33
Show Gist options
  • Save farsil/edd303b716c51b8a1311897654f5330d to your computer and use it in GitHub Desktop.
Save farsil/edd303b716c51b8a1311897654f5330d to your computer and use it in GitHub Desktop.
Download ZIP
English localization reference for DOSBox Staging 0.82
Raw
en.lng
:DOSBOX_HELP
Usage: %s [OPTION]... [PATH]
PATH If PATH is a directory, it's mounted as C:.
If PATH is a bootable disk image (IMA/IMG), it's booted.
If PATH is a CD-ROM image (CUE/ISO), it's mounted as D:.
If PATH is a DOS executable (BAT/COM/EXE), it's parent
path is mounted as C: and the executable is run. When
the executable exits, DOSBox Staging quits.
List of available options:
--conf <config_file> Start with the options specified in <config_file>.
Multiple configuration files can be specified.
Example: --conf conf1.conf --conf conf2.conf
--printconf Print the location of the primary configuration file.
--editconf Open the primary configuration file in a text editor.
--eraseconf Delete the primary configuration file.
--noprimaryconf Don't load or create the primary configuration file.
--nolocalconf Don't load the local 'dosbox.conf' configuration file
if present in the current working directory.
--set <setting>=<value> Set a configuration setting. Multiple configuration
settings can be specified. Example:
--set mididevice=fluidsynth --set soundfont=mysoundfont.sf2
--working-dir <path> Set working directory to <path>. DOSBox will act as if
started from this directory.
--list-countries List all supported countries with their numeric codes.
Codes are to be used in the 'country' config setting.
--list-glshaders List all available OpenGL shaders and their paths.
Shaders are to be used in the 'glshader' config setting.
--fullscreen Start in fullscreen mode.
--lang <lang_file> Start with the language specified in <lang_file>.
--machine <type> Emulate a specific type of machine. The machine type has
influence on both the emulated video and sound cards.
Valid choices are: hercules, cga, cga_mono, tandy,
pcjr, ega, svga_s3 (default), svga_et3000, svga_et4000,
svga_paradise, vesa_nolfb, vesa_oldvbe.
-c <command> Run the specified DOS command before handling the PATH.
Multiple commands can be specified.
--noautoexec Don't run DOS commands from any [autoexec] sections.
--exit Exit after running '-c <command>'s and [autoexec] sections.
--startmapper Run the mapper GUI.
--erasemapper Delete the default mapper file.
--securemode Enable secure mode by disabling the MOUNT and IMGMOUNT
commands.
--socket <num> Run nullmodem on the specified socket number.
-h, -?, --help Print help message and exit.
-V, --version Print version information and exit.
.
:DOSBOX_HELP_LIST_COUNTRIES_1
List of country codes (mostly same as telephone call codes)
-----------------------------------------------------------
.
:DOSBOX_HELP_LIST_COUNTRIES_2
The above numeric country codes can be used exactly as listed
in the 'country' config setting.
.
:COUNTRY_NAME_XXA
International (English)
.
:COUNTRY_NAME_USA
United States
.
:COUNTRY_NAME_CAN_FR
Canada (French)
.
:COUNTRY_NAME_XLA
Latin America
.
:COUNTRY_NAME_CAN_EN
Canada (English)
.
:COUNTRY_NAME_RUS
Russia
.
:COUNTRY_NAME_EGY
Egypt
.
:COUNTRY_NAME_ZAF
South Africa
.
:COUNTRY_NAME_GRC
Greece
.
:COUNTRY_NAME_NLD
Netherlands
.
:COUNTRY_NAME_BEL
Belgium
.
:COUNTRY_NAME_FRA
France
.
:COUNTRY_NAME_ESP
Spain
.
:COUNTRY_NAME_HUN
Hungary
.
:COUNTRY_NAME_YUG
Yugoslavia
.
:COUNTRY_NAME_ITA
Italy
.
:COUNTRY_NAME_ROU
Romania
.
:COUNTRY_NAME_CHE
Switzerland
.
:COUNTRY_NAME_CZE
Czechia
.
:COUNTRY_NAME_AUT
Austria
.
:COUNTRY_NAME_GBR
United Kingdom
.
:COUNTRY_NAME_DNK
Denmark
.
:COUNTRY_NAME_SWE
Sweden
.
:COUNTRY_NAME_NOR
Norway
.
:COUNTRY_NAME_POL
Poland
.
:COUNTRY_NAME_DEU
Germany
.
:COUNTRY_NAME_MEX
Mexico
.
:COUNTRY_NAME_ARG
Argentina
.
:COUNTRY_NAME_BRA
Brazil
.
:COUNTRY_NAME_CHL
Chile
.
:COUNTRY_NAME_COL
Colombia
.
:COUNTRY_NAME_VEN
Venezuela
.
:COUNTRY_NAME_MYS
Malaysia
.
:COUNTRY_NAME_AUS
Australia
.
:COUNTRY_NAME_IDN
Indonesia
.
:COUNTRY_NAME_PHL
Philippines
.
:COUNTRY_NAME_NZL
New Zealand
.
:COUNTRY_NAME_SGP
Singapore
.
:COUNTRY_NAME_THA
Thailand
.
:COUNTRY_NAME_KAZ
Kazakhstan
.
:COUNTRY_NAME_JPN
Japan
.
:COUNTRY_NAME_KOR
South Korea
.
:COUNTRY_NAME_VNM
Vietnam
.
:COUNTRY_NAME_CHN
China
.
:COUNTRY_NAME_TUR
Turkey
.
:COUNTRY_NAME_IND
India
.
:COUNTRY_NAME_PAK
Pakistan
.
:COUNTRY_NAME_XAE
Asia (English)
.
:COUNTRY_NAME_MAR
Morocco
.
:COUNTRY_NAME_DZA
Algeria
.
:COUNTRY_NAME_TUN
Tunisia
.
:COUNTRY_NAME_NER
Niger
.
:COUNTRY_NAME_BEN
Benin
.
:COUNTRY_NAME_NGA
Nigeria
.
:COUNTRY_NAME_FRO
Faroe Islands
.
:COUNTRY_NAME_PRT
Portugal
.
:COUNTRY_NAME_LUX
Luxembourg
.
:COUNTRY_NAME_IRL
Ireland
.
:COUNTRY_NAME_ISL
Iceland
.
:COUNTRY_NAME_ALB
Albania
.
:COUNTRY_NAME_MLT
Malta
.
:COUNTRY_NAME_FIN
Finland
.
:COUNTRY_NAME_BGR
Bulgaria
.
:COUNTRY_NAME_LTU
Lithuania
.
:COUNTRY_NAME_LVA
Latvia
.
:COUNTRY_NAME_EST
Estonia
.
:COUNTRY_NAME_ARM
Armenia
.
:COUNTRY_NAME_BLR
Belarus
.
:COUNTRY_NAME_UKR
Ukraine
.
:COUNTRY_NAME_SRB
Serbia
.
:COUNTRY_NAME_MNE
Montenegro
.
:COUNTRY_NAME_HRV
Croatia
.
:COUNTRY_NAME_SVN
Slovenia
.
:COUNTRY_NAME_BIH_LAT
Bosnia and Herzegovina (Latin)
.
:COUNTRY_NAME_BIH_CYR
Bosnia and Herzegovina (Cyrillic)
.
:COUNTRY_NAME_MKD
North Macedonia
.
:COUNTRY_NAME_SVK
Slovakia
.
:COUNTRY_NAME_GTM
Guatemala
.
:COUNTRY_NAME_SLV
El Salvador
.
:COUNTRY_NAME_HND
Honduras
.
:COUNTRY_NAME_NIC
Nicaragua
.
:COUNTRY_NAME_CRI
Costa Rica
.
:COUNTRY_NAME_PAN
Panama
.
:COUNTRY_NAME_BOL
Bolivia
.
:COUNTRY_NAME_ECU
Ecuador
.
:COUNTRY_NAME_PRY
Paraguay
.
:COUNTRY_NAME_URY
Uruguay
.
:COUNTRY_NAME_XME
Arabic (Middle East)
.
:COUNTRY_NAME_HKG
Hong Kong
.
:COUNTRY_NAME_TWN
Taiwan
.
:COUNTRY_NAME_LBN
Lebanon
.
:COUNTRY_NAME_JOR
Jordan
.
:COUNTRY_NAME_SYR
Syria
.
:COUNTRY_NAME_KWT
Kuwait
.
:COUNTRY_NAME_SAU
Saudi Arabia
.
:COUNTRY_NAME_YEM
Yemen
.
:COUNTRY_NAME_OMN
Oman
.
:COUNTRY_NAME_ARE
United Arab Emirates
.
:COUNTRY_NAME_ISR
Israel
.
:COUNTRY_NAME_BHR
Bahrain
.
:COUNTRY_NAME_QAT
Qatar
.
:COUNTRY_NAME_MNG
Mongolia
.
:COUNTRY_NAME_TJK
Tajikistan
.
:COUNTRY_NAME_TKM
Turkmenistan
.
:COUNTRY_NAME_AZE
Azerbaijan
.
:COUNTRY_NAME_GEO
Georgia
.
:COUNTRY_NAME_KGZ
Kyrgyzstan
.
:COUNTRY_NAME_UZB
Uzbekistan
.
:DOSBOX_HELP_LIST_GLSHADERS_1
List of available GLSL shaders
------------------------------
.
:DOSBOX_HELP_LIST_GLSHADERS_2
The above shaders can be used exactly as listed in the 'glshader'
config setting, without the need for the resource path or .glsl extension.
.
:DOSBOX_HELP_LIST_GLSHADERS_NOT_EXISTS
Path '%s' does not exist.
.
:DOSBOX_HELP_LIST_GLSHADERS_NO_SHADERS
Path '%s' has no shaders.
.
:DOSBOX_HELP_LIST_GLSHADERS_LIST
Path '%s' has:
.
:PROGRAM_CONFIG_PROPERTY_ERROR
No such section or property: %s
.
:PROGRAM_CONFIG_NO_PROPERTY
There is no property '%s' in section [%s]
.
:PROGRAM_CONFIG_SET_SYNTAX
Usage: [color=light-green]config [reset]-set [color=light-cyan][SECTION][reset] [color=white]PROPERTY[reset][=][color=white]VALUE[reset]
.
:TITLEBAR_CYCLES_MS
cycles/ms
.
:TITLEBAR_MUTED
MUTED
.
:TITLEBAR_PAUSED
PAUSED
.
:TITLEBAR_HINT_CAPTURED
mouse captured
.
:TITLEBAR_HINT_CAPTURED_HOTKEY
mouse captured, %s+F10 to release
.
:TITLEBAR_HINT_CAPTURED_HOTKEY_MIDDLE
mouse captured, %s+F10 or middle-click to release
.
:TITLEBAR_HINT_RELEASED_HOTKEY
to capture the mouse press %s+F10
.
:TITLEBAR_HINT_RELEASED_HOTKEY_MIDDLE
to capture the mouse press %s+F10 or middle-click
.
:TITLEBAR_HINT_RELEASED_HOTKEY_ANY_BUTTON
to capture the mouse press %s+F10 or click any button
.
:TITLEBAR_HINT_SEAMLESS_HOTKEY
seamless mouse, %s+F10 to capture
.
:TITLEBAR_HINT_SEAMLESS_HOTKEY_MIDDLE
seamless mouse, %s+F10 or middle-click to capture
.
:CONFIGITEM_OUTPUT_OPENGL_DEFAULT
Rendering backend to use for graphics output ('opengl' by default).
Only the 'opengl' backend has shader support and is thus the preferred option.
The 'texture' backend is only provided as a last resort fallback for buggy or
non-existent OpenGL drivers (this is extremely rare).
.
:CONFIGITEM_OUTPUT_TEXTURE_DEFAULT
Rendering backend to use for graphics output ('texture' by default).
.
:CONFIGITEM_OUTPUT_OPENGL
opengl: OpenGL backend with shader support (default).
.
:CONFIGITEM_OUTPUT_TEXTURE
texture: SDL's texture backend with bilinear interpolation.
.
:CONFIGITEM_OUTPUT_TEXTURENB
texturenb: SDL's texture backend with nearest-neighbour interpolation
(no bilinear).
.
:CONFIG_TEXTURE_RENDERER
Render driver to use in 'texture' output mode ('auto' by default).
Use 'texture_renderer = auto' for an automatic choice.
.
:CONFIG_DISPLAY
Number of display to use; values depend on OS and user settings (0 by default).
.
:CONFIG_FULLSCREEN
Start directly in fullscreen (disabled by default).
Run INTRO and see Special Keys for window control hotkeys.
.
:CONFIG_FULLRESOLUTION
What resolution to use for fullscreen: 'original', 'desktop'
or a fixed size, e.g. 1024x768 ('desktop' by default).
.
:CONFIG_WINDOWRESOLUTION
Set intial window size for windowed mode. You can still resize the window
after startup.
default: Select the best option based on your environment and other
settings (such as whether aspect ratio correction is enabled).
small, medium, large (s, m, l):
Size the window relative to the desktop.
WxH: Specify window size in WxH format in logical units
(e.g., 1024x768).
.
:CONFIG_WINDOW_POSITION
Set initial window position for windowed mode:
auto: Let the window manager decide the position (default).
X,Y: Set window position in X,Y format (e.g., 250,100).
0,0 is the top-left corner of the screen.
.
:CONFIG_WINDOW_DECORATIONS
Enable window decorations in windowed mode (enabled by default).
.
:CONFIG_WINDOW_TITLEBAR
Space separated list of information to be displayed in the window's titlebar
('program=name dosbox=auto cycles=on mouse=full' by default). If a parameter
is not specified, its default value is used.
Possible information to display are:
animation=<value>: If set to 'on' (default), animate the audio/video
recording mark. Set to 'off' to disable animation; this
is useful if your screen font produces weird results.
program=<value>: Display the name of the running program.
<value> can be one of:
none/off: Do not display program name.
name: Program name, with file extension (default).
path: Name, extension, and full absolute path.
segment: Display program memory segment name.
'Title': Custom name. Alternatively, you can use
"Title", (Title), <Title> or [Title] form.
Note: With some software (like Windows 3.1x in enhanced
mode) it is impossible to recognize the full program
name or path; in such cases 'segment' is used instead.
dosbox=<value>: Display 'DOSBox Staging' in the title bar.
<value> can be one of:
always: Always display 'DOSBox Staging'.
auto: Only display it if no program is running or
'program=none' is set (default).
version=<value>: Display DOSBox version information.
<value> can be one of:
none/off: Do not display DOSBox version (default).
simple: Simple version information.
detailed: Include Git hash, if available.
cycles=<value>: If set to 'on' (default), show CPU cycles setting.
Set to 'off' to disable cycles setting display.
mouse=<value>: Mouse capturing hint verbosity level:
none/off: Do not display any mouse hints.
short: Only display if mouse is captured.
full: Display verbose information on how to
capture or release the cursor (default).
.
:CONFIG_TRANSPARENCY
Set the transparency of the DOSBox Staging screen (0 by default).
From 0 (no transparency) to 90 (high transparency).
.
:CONFIG_MAX_RESOLUTION
Moved to [render] section and renamed to 'viewport'.
.
:CONFIG_VIEWPORT_RESOLUTION
Moved to [render] section and renamed to 'viewport'.
.
:CONFIG_HOST_RATE
Set the host's refresh rate:
auto: Use SDI rates, or VRR rates when in fullscreen on a high-refresh
rate display (default).
sdi: Use serial device interface (SDI) rates, without further
adjustment.
vrr: Deduct 3 Hz from the reported rate (best practice for VRR
displays).
N: Specify custom refresh rate in Hz (decimal values are allowed;
23.000 is the allowed minimum).
.
:CONFIG_VSYNC
Set the host video driver's vertical synchronization (vsync) mode:
auto: Limit vsync to beneficial cases, such as when using an
interpolating VRR display in fullscreen (default).
on: Enable vsync. This can prevent tearing in some games but will
impact performance or drop frames when the DOS rate exceeds the
host rate (e.g. 70 Hz DOS rate vs 60 Hz host rate).
adaptive: Enables vsync when the frame rate is higher than the host rate,
but disables it when the frame rate drops below the host rate.
This is a reasonable alternative on macOS instead of 'on'.
Note: only valid in OpenGL output modes; otherwise treated as
'on'.
off: Attempt to disable vsync to allow quicker frame presentation at
the risk of tearing in some games.
yield: Let the host's video driver control video synchronization.
.
:CONFIG_VSYNC_SKIP
Number of microseconds to allow rendering to block before skipping the
next frame. For example, a value of 7000 is roughly half the frame time
at 70 Hz. 0 disables this and will always render (default).
.
:CONFIG_PRESENTATION_MODE
Select the frame presentation mode:
auto: Intelligently time and drop frames to prevent emulation stalls,
based on host and DOS frame rates (default).
cfr: Always present DOS frames at a constant frame rate.
vfr: Always present changed DOS frames at a variable frame rate.
.
:CONFIG_CAPTURE_MOUSE
Moved to [mouse] section and renamed to 'mouse_capture'.
.
:CONFIG_SENSITIVITY
Moved to [mouse] section and renamed to 'mouse_sensitivity'.
.
:CONFIG_RAW_MOUSE_INPUT
Moved to [mouse] section and renamed to 'mouse_raw_input'.
.
:CONFIG_WAITONERROR
Keep the console open if an error has occurred (enabled by default).
.
:CONFIG_PRIORITY
Priority levels to apply when active and inactive, respectively.
('auto auto' by default)
'auto' lets the host operating system manage the priority.
.
:CONFIG_MUTE_WHEN_INACTIVE
Mute the sound when the window is inactive (disabled by default).
.
:CONFIG_PAUSE_WHEN_INACTIVE
Pause emulation when the window is inactive (disabled by default).
.
:CONFIG_MAPPERFILE
Path to the mapper file ('mapper-sdl2-XYZ.map' by default, where XYZ is the
current version). Pre-configured maps are bundled in 'resources/mapperfiles'.
These can be loaded by name, e.g., with 'mapperfile = xbox/xenon2.map'.
Note: The '--resetmapper' command line option only deletes the default mapper
file.
.
:CONFIG_SCREENSAVER
Use 'allow' or 'block' to override the SDL_VIDEO_ALLOW_SCREENSAVER environment
variable which usually blocks the OS screensaver while the emulator is
running ('auto' by default).
.
:CONFIG_LANGUAGE
Select a language to use: 'br', 'de', 'en', 'es', 'fr', 'it', 'nl', 'pl',
or 'ru' (unset by default; this defaults to English).
Notes:
- This setting will override the 'LANG' environment variable, if set.
- The bundled 'resources/translations' directory with the executable holds
these files. Please keep it along-side the executable to support this
feature.
.
:CONFIG_MACHINE
Set the video adapter or machine to emulate:
hercules: Hercules Graphics Card (HGC) (see 'monochrome_palette').
cga_mono: CGA adapter connected to a monochrome monitor (see
'monochrome_palette').
cga: IBM Color Graphics Adapter (CGA). Also enables composite
video emulation (see [composite] section).
pcjr: An IBM PCjr machine. Also enables PCjr sound and composite
video emulation (see [composite] section).
tandy: A Tandy 1000 machine with TGA graphics. Also enables Tandy
sound and composite video emulation (see [composite]
section).
ega: IBM Enhanced Graphics Adapter (EGA).
svga_paradise: Paradise PVGA1A SVGA card (no VESA VBE; 512K vmem by default,
can be set to 256K or 1MB with 'vmemsize'). This is the
closest to IBM's original VGA adapter.
svga_et3000: Tseng Labs ET3000 SVGA card (no VESA VBE; fixed 512K vmem).
svga_et4000: Tseng Labs ET4000 SVGA card (no VESA VBE; 1MB vmem by
default, can be set to 256K or 512K with 'vmemsize').
svga_s3: S3 Trio64 (VESA VBE 2.0; 4MB vmem by default, can be set to
512K, 1MB, 2MB, or 8MB with 'vmemsize') (default)
vesa_oldvbe: Same as 'svga_s3' but limited to VESA VBE 1.2.
vesa_nolfb: Same as 'svga_s3' (VESA VBE 2.0), plus the "no linear
framebuffer" hack (needed only by a few games).
.
:CONFIG_CAPTURES
Moved to [capture] section and renamed to 'capture_dir'.
.
:CONFIG_MEMSIZE
Amount of memory of the emulated machine has in MB (16 by default).
Best leave at the default setting to avoid problems with some games,
though a few games might require a higher value.
There is generally no speed advantage when raising this value.
.
:CONFIG_MCB_FAULT_STRATEGY
How software-corrupted memory chain blocks should be handled:
repair: Repair (and report) faults using adjacent blocks (default).
report: Report faults but otherwise proceed as-is.
allow: Allow faults to go unreported (hardware behavior).
deny: Quit (and report) when faults are detected.
.
:CONFIG_VMEMSIZE
Video memory in MB (1-8) or KB (256 to 8192). 'auto' uses the default for
the selected video adapter ('auto' by default). See the 'machine' setting for
the list of valid options and defaults per adapter.
.
:CONFIG_VMEM_DELAY
Set video memory access delay emulation ('off' by default).
off: Disable video memory access delay emulation (default).
This is preferable for most games to avoid slowdowns.
on: Enable video memory access delay emulation (3000 ns).
This can help reduce or eliminate flicker in Hercules,
CGA, EGA, and early VGA games.
<value>: Set access delay in nanoseconds. Valid range is 0 to 20000 ns;
500 to 5000 ns is the most useful range.
Note: Only set this on a per-game basis when necessary as it slows down
the whole emulator.
.
:CONFIG_DOS_RATE
Customize the emulated video mode's frame rate.
default: The DOS video mode determines the rate (default).
host: Match the DOS rate to the host rate (see 'host_rate' setting).
<value>: Sets the rate to an exact value in between 24.000 and 1000.000 Hz.
Note: We recommend the 'default' rate, otherwise test and set on a per-game
basis.
.
:CONFIG_VESA_MODES
Controls which VESA video modes are available:
compatible: Only the most compatible VESA modes for the configured video
memory size (default). Recommended with 4 or 8 MB of video
memory ('vmemsize') for the widest compatiblity with games.
320x200 high colour modes are excluded as they were not
properly supported until the late '90s. The 256-colour linear
framebuffer 320x240, 400x300, and 512x384 modes are also
excluded as they cause timing problems in Build Engine games.
halfline: Same as 'compatible', but the 120h VESA mode is replaced with
a special halfline mode used by Extreme Assault. Use only if
needed.
all: All modes are available, including extra DOSBox-specific VESA
modes. Use 8 MB of video memory for the best results. Some
games misbehave in the presence of certain VESA modes; try
'compatible' mode if this happens. The 320x200 high colour
modes available in this mode are often required by late '90s
demoscene productions.
.
:CONFIG_VGA_8DOT_FONT
Use 8-pixel-wide fonts on VGA adapters (disabled by default).
.
:CONFIG_VGA_RENDER_PER_SCANLINE
Emulate accurate per-scanline VGA rendering (enabled by default).
Currently, you need to disable this for a few games, otherwise they will crash
at startup (e.g., Deus, Ishar 3, Robinson's Requiem, Time Warriors).
.
:CONFIG_SPEED_MODS
Permit changes known to improve performance (enabled by default).
Currently, no games are known to be negatively affected by this.
Please file a bug with the project if you find a game that fails
when this is enabled so we will list them here.
.
:CONFIG_AUTOEXEC_SECTION
How autoexec sections are handled from multiple config files:
join: Combine them into one big section (legacy behavior; default).
overwrite: Use the last one encountered, like other config settings.
.
:CONFIG_AUTOMOUNT
Mount 'drives/[c]' directories as drives on startup, where [c] is a lower-case
drive letter from 'a' to 'y' (enabled by default). The 'drives' folder can be
provided relative to the current directory or via built-in resources.
Mount settings can be optionally provided using a [c].conf file along-side
the drive's directory, with content as follows:
[drive]
type = dir, overlay, floppy, or cdrom
label = custom_label
path = path-specification, ie: path = %%path%%;c:\tools
override_drive = mount the directory to this drive instead (default empty)
verbose = true or false
readonly = true or false
.
:CONFIG_STARTUP_VERBOSITY
Controls verbosity prior to displaying the program ('auto' by default):
Verbosity | Welcome | Early stdout
high | yes | yes
low | no | yes
quiet | no | no
auto | 'low' if exec or dir is passed, otherwise 'high'
.
:CONFIG_ALLOW_WRITE_PROTECTED_FILES
Many games open all their files with writable permissions; even files that they
never modify. This setting lets you write-protect those files while still
allowing the game to read them (enabled by default). A second use-case: if
you're using a copy-on-write or network-based filesystem, this setting avoids
triggering write operations for these write-protected files.
.
:CONFIG_SHELL_CONFIG_SHORTCUTS
Allow shortcuts for simpler configuration management (enabled by default).
E.g., instead of 'config -set sbtype sb16', it is enough to execute
'sbtype sb16', and instead of 'config -get sbtype', you can just execute
the 'sbtype' command.
.
:CONFIG_FRAMESKIP
Consider capping frame rates using the 'host_rate' setting.
.
:CONFIGITEM_GLSHADER
Set an adaptive CRT monitor emulation shader or a regular GLSL shader in OpenGL
output modes ('crt-auto' by default). Adaptive CRT shader options:
crt-auto: A CRT shader that prioritises developer intent and
how people experienced the game at the time of
release (default). The appropriate shader variant is
automatically selected based the graphics standard of
the current video mode and the viewport size,
irrespective of the 'machine' setting. This means
that even on an emulated VGA card you'll get
authentic single-scanned EGA monitor emulation with
visible "thick scanlines" in EGA games.
crt-auto-machine: Similar to 'crt-auto', but this picks a fixed CRT
monitor appropriate for the video adapter configured
via the 'machine' setting. E.g., CGA and EGA games
will appear double-scanned on an emulated VGA
adapter.
crt-auto-arcade: Emulation of an arcade or home computer monitor less
sharp than a typical PC monitor with thick scanlines
in low-resolution modes. This fantasy option does not
exist in real life, but it can be a lot of fun,
especially with DOS ports of Amiga games.
crt-auto-arcade-sharp: A sharper variant of the arcade shader for those who
like the thick scanlines but want to retain the
horizontal sharpness of a typical PC monitor.
Other shader options include (non-exhaustive list):
sharp: Upscale the image treating the pixels as rectangles.
Results in a sharp image with minimum blur.
bilinear: Upscale the image using bilinear interpolation
(results in a blurry image).
nearest: Upscale the image using nearest-neighbour
interpolation (also known as "no bilinear"). Results
in the sharpest possible image at the expense of
uneven pixels (this is less of an issue on high
resolution screens).
Start DOSBox Staging with the '--list-glshaders' command line option to see the
full list of available shaders. You can also use an absolute or relative path to
a file. In all cases, you may omit the shader's '.glsl' file extension.
.
:CONFIG_ASPECT
Set the aspect ratio correction mode ('auto' by default):
auto, on: Apply aspect ratio correction for modern square-pixel
flat-screen displays, so DOS video modes with non-square
pixels appear as they would on a 4:3 display aspect
ratio CRT monitor the majority of DOS games were
designed for. This setting only affects video modes that
use non-square pixels, such as 320x200 or 640x400;.
square-pixelmodes (e.g., 320x240, 640x480, and 800x600),
are displayed as-is.
square-pixels, off: Don't apply aspect ratio correction; all DOS video modes
are displayed with square pixels. Most 320x200 games
will appear squashed, but a minority of titles (e.g.,
DOS ports of PAL Amiga games) need square pixels to
appear as the artists intended.
stretch: Calculate the aspect ratio from the viewport's
dimensions. Combined with 'viewport', this mode is
useful to force arbitrary aspect ratios (e.g.,
stretching DOS games to fullscreen on 16:9 displays) and
to emulate the horizontal and vertical stretch controls
of CRT monitors.
.
:CONFIG_INTEGER_SCALING
Constrain the horizontal or vertical scaling factor to the largest integer
value so the image still fits into the viewport ('auto' by default). The
configured aspect ratio is always maintained according to the 'aspect' and
'viewport' settings, which may result in a non-integer scaling factor in the
other dimension. If the image is larger than the viewport, the integer scaling
constraint is auto-disabled (same as 'off'). Possible values:
auto: 'vertical' mode auto-enabled for adaptive CRT shaders only
(see 'glshader'), otherwise 'off' (default).
vertical: Constrain the vertical scaling factor to integer values.
This is the recommended setting for CRT shaders to avoid uneven
scanlines and interference artifacts.
horizontal: Constrain the horizontal scaling factor to integer values.
off: No integer scaling constraint is applied; the image fills the
viewport while maintaining the configured aspect ratio.
.
:CONFIG_VIEWPORT
Set the viewport size ('fit' by default). This is the maximum drawable area;
the video output is always contained within the viewport while taking the
configured aspect ratio into account (see 'aspect'). Possible values:
fit: Fit the viewport into the available window/screen (default).
There might be padding (black areas) around the image with
'integer_scaling' enabled.
WxH: Set a fixed viewport size in WxH format in logical units
(e.g., 960x720). The specified size must not be larger than
the desktop. If it's larger than the window size, it's
scaled to fit within the window.
N%%: Similar to 'WxH' but the size is specified as a percentage
of the desktop size.
relative H%% V%%: The viewport is set to a 4:3 aspect ratio rectangle fit into
the available window/screen, then it's scaled by the H and V
horizontal and vertical scaling factors (valid range is from
20%% to 300%%). The resulting viewport is allowed to extend
beyond the window/screen. Useful to force arbitrary display
aspect ratios with 'aspect = stretch' and to zoom into the
image. This effectively emulates the horizontal and vertical
stretch controls of CRT monitors.
Notes:
- Using 'relative' mode with 'integer_scaling' enabled could lead to
surprising (but correct) results.
- You can use the 'Stretch Axis', 'Inc Stretch', and 'Dec Stretch' hotkey
actions to set the stretch in 'relative' mode in real-time.
.
:CONFIG_MONOCHROME_PALETTE
Set the palette for monochrome display emulation ('amber' by default).
Works only with the 'hercules' and 'cga_mono' machine types.
Note: You can also cycle through the available palettes via hotkeys.
.
:CONFIG_CGA_COLORS
Set the interpretation of CGA RGBI colours ('default' by default). Affects all
machine types capable of displaying CGA or better graphics. Built-in presets:
default: The canonical CGA palette, as emulated by VGA adapters
(default).
tandy <bl>: Emulation of an idealised Tandy monitor with adjustable brown
level. The brown level can be provided as an optional second
parameter (0 - red, 50 - brown, 100 - dark yellow;
defaults to 50). E.g. tandy 100
tandy-warm: Emulation of the actual colour output of an unknown Tandy
monitor.
ibm5153 <c>: Emulation of the actual colour output of an IBM 5153 monitor
with a unique contrast control that dims non-bright colours
only. The contrast can be optionally provided as a second
parameter (0 to 100; defaults to 100), e.g. ibm5153 60
agi-amiga-v1, agi-amiga-v2, agi-amiga-v3:
Palettes used by the Amiga ports of Sierra AGI games.
agi-amigaish: A mix of EGA and Amiga colours used by the Sarien
AGI-interpreter.
scumm-amiga: Palette used by the Amiga ports of LucasArts EGA games.
colodore: Commodore 64 inspired colours based on the Colodore palette.
colodore-sat: Colodore palette with 20%% more saturation.
dga16: A modern take on the canonical CGA palette with dialed back
contrast.
You can also set custom colours by specifying 16 space or comma separated
colour values, either as 3 or 6-digit hex codes (e.g. #f00 or #ff0000 for full
red), or decimal RGB triplets (e.g. (255, 0, 255) for magenta). The 16 colours
are ordered as follows:
black, blue, green, cyan, red, magenta, brown, light-grey, dark-grey,
light-blue, light-green, light-cyan, light-red, light-magenta, yellow, white.
Their default values, shown here in 6-digit hex code format, are:
#000000 #0000aa #00aa00 #00aaaa #aa0000 #aa00aa #aa5500 #aaaaaa
#555555 #5555ff #55ff55 #55ffff #ff5555 #ff55ff #ffff55 #ffffff
.
:CONFIG_SCALER
Software scalers are deprecated in favour of hardware-accelerated options:
- If you used the normal2x/3x scalers, set the desired 'windowresolution'
or 'viewport' instead, or consider using 'integer_scaling'.
- If you used an advanced scaler, consider one of the 'glshader'
options instead.
.
:CONFIG_COMPOSITE
Enable composite mode on start (only for 'cga', 'pcjr', and 'tandy' machine
types; 'auto' by default). 'auto' lets the program decide.
Note: Fine-tune the settings below (i.e., 'hue') using the composite hotkeys,
then copy the new settings from the logs into your config.
.
:CONFIG_ERA
Era of composite technology ('auto' by default).
When 'auto', PCjr uses 'new', and CGA/Tandy use 'old'.
.
:CONFIG_HUE
Hue of the RGB palette (0 by default).
For example, adjust until the sky is blue.
.
:CONFIG_SATURATION
Intensity of colors, from washed out to vivid (100 by default).
.
:CONFIG_CONTRAST
Ratio between the dark and light area (100 by default).
.
:CONFIG_BRIGHTNESS
Luminosity of the image, from dark to light (0 by default).
.
:CONFIG_CONVERGENCE
Convergence of subpixel elements, from blurry to sharp (0 by default).
.
:CONFIG_CORE
Type of CPU emulation core to use ('auto' by default).
auto: 'normal' core for real mode programs, 'dynamic' core for protected
mode programs (default). Most programs will run correctly with this
setting.
normal: The DOS program is interpreted instruction by instruction. This
yields the most accurate timings, but puts 3-5 times more load on
the host CPU compared to the 'dynamic' core. Therefore, it's
generally only recommended for real mode programs that don't need
a fast emulated CPU or are timing-sensitive. The 'normal' core is
also necessary for programs that self-modify their code.
simple: The 'normal' core optimised for old real mode programs; it might
give you slightly better compatibility with older games. Auto-
switches to the 'normal' core in protected mode.
dynamic: The instructions of the DOS program are translated to host CPU
instructions in blocks and are then executed directly. This puts
3-5 times less load on the host CPU compared to the 'normal' core,
but the timings might be less accurate. The 'dynamic' core is a
necessity for demanding DOS programs (e.g., 3D SVGA games).
Programs that self-modify their code might misbehave or crash on
the 'dynamic' core; use the 'normal' core for such programs.
.
:CONFIG_CPUTYPE
CPU type to emulate ('auto' by default).
You should only change this if the program doesn't run correctly on 'auto'.
auto: The fastest and most compatible setting (default).
Technically, this is '386_fast' plus 486 CPUID, 486 CR
register behaviour, and extra 486 instructions.
386: 386 CPUID and 386 specific page access level calculation.
386_fast: Same as '386' but with loose page privilege checks which is
much faster.
386_prefetch: Same as '386_fast' plus accurate CPU prefetch queue emulation.
Requires 'core = normal'. This setting is necessary for
programs that self-modify their code or employ anti-debugging
tricks. Games that require '386_prefetch' include Contra, FIFA
International Soccer (1994), Terminator 1, and X-Men: Madness
in The Murderworld.
486: 486 CPUID, 486+ specific page access level calculation, 486 CR
register behaviour, and extra 486 instructions.
pentium: Same as '486' but with Pentium CPUID, Pentium CR register
behaviour, and RDTSC instruction support. Recommended for
Windows 3.x games (e.g., Betrayal in Antara).
pentium_mmx: Same as 'pentium' plus MMX instruction set support. Very few
games use MMX instructions; it's mostly only useful for
demoscene productions.
.
:CONFIG_CYCLES
The 'cycles' setting is deprecated but still accepted; please use the
'cpu_cycles', 'cpu_cycles_protected' and 'cpu_throttle' settings instead as
support will be removed in the future.
.
:CONFIG_CPU_CYCLES
Speed of the emulated CPU ('3000' by default). If 'cpu_cycles_protected' is on
'auto', this sets the cycles for both real and protected mode programs.
<number>: Emulate a fixed number of cycles per millisecond (roughly
equivalent to MIPS). Valid range is from 50 to 2000000.
max: Emulate as many cycles as your host CPU can handle on a single
core. The number of cycles per millisecond can vary; this might
cause issues in some DOS programs.
Notes:
- Setting the CPU speed to 'max' or to high fixed values may result in sound
drop-outs and general lagginess.
- Set the lowest fixed cycles value that runs the game at an acceptable speed
for the best results.
- Ballpark cycles values for common CPUs. DOSBox does not do cycle-accurate
CPU emulation, so treat these as starting points, then fine-tune per game.
8088 (4.77 MHz) 300
286-8 700
286-12 1500
386SX-20 3000
386DX-33 6000
386DX-40 8000
486DX-33 12000
486DX/2-66 25000
Pentium 90 50000
Pentium MMX-166 100000
Pentium II 300 200000
.
:CONFIG_CPU_CYCLES_PROTECTED
Speed of the emulated CPU for protected mode programs only
('60000' by default).
auto: Use the `cpu_cycles' setting.
<number>: Emulate a fixed number of cycles per millisecond (roughly
equivalent to MIPS). Valid range is from 50 to 2000000.
max: Emulate as many cycles as your host CPU can handle on a single
core. The number of cycles per millisecond can vary; this might
cause issues in some DOS programs.
Note: See 'cpu_cycles' setting for further info.
.
:CONFIG_CPU_THROTTLE
Throttle down the number of emulated CPU cycles dynamically if your host CPU
cannot keep up (disabled by default).
Only affects fixed cycles settings. When enabled, the number of cycles per
millisecond can vary; this might cause issues in some DOS programs.
.
:CONFIG_CYCLEUP
Number of cycles to add with the 'Inc Cycles' hotkey (10 by default).
Values lower than 100 are treated as a percentage increase.
.
:CONFIG_CYCLEDOWN
Number of cycles to subtract with the 'Dec Cycles' hotkey (20 by default).
Values lower than 100 are treated as a percentage decrease.
.
:CONFIG_VOODOO
Enable 3dfx Voodoo emulation (enabled by default).
.
:CONFIG_VOODOO_MEMSIZE
Set the amount of video memory for 3dfx Voodoo graphics, either 4 or 12 MB.
The memory is used by the Frame Buffer Interface (FBI) and Texture Mapping Unit
(TMU) as follows:
4: 2 MB for the FBI and one TMU with 2 MB (default).
12: 4 MB for the FBI and two TMUs, each with 4 MB.
.
:CONFIG_VOODOO_MULTITHREADING
Use threads to improve 3dfx Voodoo performance (enabled by default).
.
:CONFIG_VOODOO_BILINEAR_FILTERING
Use bilinear filtering to emulate the 3dfx Voodoo's texture smoothing effect
(disabled by default). Only suggested if you have a fast desktop-class CPU, as
it can impact frame rates on slower systems.
.
:CONFIG_CAPTURE_DIR
Directory where the various captures are saved, such as audio, video, MIDI
and screenshot captures. ('capture' in the current working directory by
default).
.
:CONFIG_DEFAULT_IMAGE_CAPTURE_FORMATS
Set the capture format of the default screenshot action ('upscaled' by
default):
upscaled: The image is bilinear-sharp upscaled and the correct aspect
ratio is maintained, depending on the 'aspect' setting. The
vertical scaling factor is always an integer. For example,
320x200 content is upscaled to 1600x1200 (5:6 integer scaling),
640x480 to 1920x1440 (3:3 integer scaling), and 640x350 to
1400x1050 (2.1875:3 scaling; fractional horizontally and
integer vertically). The filenames of upscaled screenshots
have no postfix (e.g. 'image0001.png').
rendered: The post-rendered, post-shader image shown on the screen is
captured. The filenames of rendered screenshots end with
'-rendered' (e.g. 'image0001-rendered.png').
raw: The contents of the raw framebuffer is captured (this always
results in square pixels). The filenames of raw screenshots
end with '-raw' (e.g. 'image0001-raw.png').
If multiple formats are specified separated by spaces, the default
screenshot action will save multiple images in the specified formats.
Keybindings for taking single screenshots in specific formats are also
available.
.
:CONFIG_MOUSE_CAPTURE
Set the mouse capture behaviour:
onclick: Capture the mouse when clicking any mouse button in the window
(default).
onstart: Capture the mouse immediately on start. Might not work correctly
on some host operating systems.
seamless: Let the mouse move seamlessly between the DOSBox window and the
rest of the desktop; captures only with middle-click or hotkey.
Seamless mouse does not work correctly with all the games.
Windows 3.1x can be made compatible with a custom mouse driver.
nomouse: Hide the mouse and don't send mouse input to the game.
For touch-screen control, use 'seamless'.
.
:CONFIG_MOUSE_MIDDLE_RELEASE
Release the captured mouse by middle-clicking, and also capture it in
seamless mode (enabled by default).
.
:CONFIG_MOUSE_MULTI_DISPLAY_AWARE
Allow seamless mouse behavior and mouse pointer release to work in fullscreen
mode on systems with more than one display (enabled by default).
Note: You should disable this if it incorrectly detects multiple displays
when only one should actually be used. This might happen if you are
using mirrored display mode or using an AV receiver's HDMI input for
audio-only listening.
.
:CONFIG_MOUSE_SENSITIVITY
Global mouse sensitivity for the horizontal and vertical axes, as a percentage
(100 by default). Values can be separated by spaces, commas, or semicolons
(i.e. 100,150). Negative values invert the axis, zero disables it.
Providing only one value sets sensitivity for both axes.
Sensitivity can be further fine-tuned per mouse interface using the internal
MOUSECTL.COM tool available on the Z drive.
.
:CONFIG_MOUSE_RAW_INPUT
Enable to bypass your operating system's mouse acceleration and sensitivity
settings (enabled by default). Works in fullscreen or when the mouse is
captured in windowed mode.
.
:CONFIG_DOS_MOUSE_DRIVER
Enable built-in DOS mouse driver (enabled by default).
Notes:
- Disable if you intend to use original MOUSE.COM driver in emulated DOS.
- When guest OS is booted, built-in driver gets disabled automatically.
.
:CONFIG_DOS_MOUSE_IMMEDIATE
Update mouse movement counters immediately, without waiting for interrupt
(disabled by default). May improve gameplay, especially in fast-paced games
(arcade, FPS, etc.), as for some games it effectively boosts the mouse
sampling rate to 1000 Hz, without increasing interrupt overhead.
Might cause compatibility issues. List of known incompatible games:
- Ultima Underworld: The Stygian Abyss
- Ultima Underworld II: Labyrinth of Worlds
Please report it if you find another incompatible game so we can update this
list.
.
:CONFIG_PS2_MOUSE_MODEL
PS/2 AUX port mouse model:
standard: 3 buttons, standard PS/2 mouse.
intellimouse: 3 buttons + wheel, Microsoft IntelliMouse.
explorer: 5 buttons + wheel, Microsoft IntelliMouse Explorer (default).
none: no PS/2 mouse emulated.
.
:CONFIG_COM_MOUSE_MODEL
COM (serial) port default mouse model:
2button: 2 buttons, Microsoft mouse.
3button: 3 buttons, Logitech mouse;
mostly compatible with Microsoft mouse.
wheel: 3 buttons + wheel;
mostly compatible with Microsoft mouse.
msm: 3 buttons, Mouse Systems mouse;
NOT compatible with Microsoft mouse.
2button+msm: Automatic choice between '2button' and 'msm'.
3button+msm: Automatic choice between '3button' and 'msm'.
wheel+msm: Automatic choice between 'wheel' and 'msm' (default).
Note: Enable COM port mice in the [serial] section.
.
:CONFIG_VMWARE_MOUSE
VMware mouse interface (enabled by default).
Fully compatible only with experimental 3rd party Windows 3.1x driver.
Note: Requires PS/2 mouse to be enabled.
.
:CONFIG_VIRTUALBOX_MOUSE
VirtualBox mouse interface (enabled by default).
Fully compatible only with 3rd party Windows 3.1x driver.
Note: Requires PS/2 mouse to be enabled.
.
:CONFIG_NOSOUND
Enable silent mode (disabled by default).
Sound is still emulated in silent mode, but DOSBox outputs no sound to the host.
Capturing the emulated audio output to a WAV file works in silent mode.
.
:CONFIG_RATE
Sample rate of DOSBox's internal audio mixer in Hz (%s by default).
Valid range is 8000 to 96000 Hz. The vast majority of consumer-grade audio
hardware uses a native rate of 48000 Hz. Recommend leaving this as-is unless
you have good reason to change it. The OS will most likely resample non-standard
sample rates to 48000 Hz anyway.
.
:CONFIG_BLOCKSIZE
Block size of the host audio device in sample frames (%s by default).
Valid range is 64 to 8192. Should be set to power-of-two values (e.g., 256,
512, 1024, etc.) Larger values might help with sound stuttering but will
introduce more latency. Also see 'negotiate'.
.
:CONFIG_PREBUFFER
How many milliseconds of sound to render in advance on top of 'blocksize'
(%s by default). Larger values might help with sound stuttering but will
introduce more latency.
.
:CONFIG_NEGOTIATE
Negotiate a possibly better 'blocksize' setting (%s by default).
Enable it if you're not getting audio or the sound is stuttering with your
'blocksize' setting. Disable it to force the manually set 'blocksize' value.
.
:CONFIG_COMPRESSOR
Enable the auto-leveling compressor on the master channel to prevent clipping
of the audio output:
off: Disable compressor.
on: Enable compressor (default).
.
:CONFIG_CROSSFEED
Enable crossfeed globally on all stereo channels for headphone listening:
off: No crossfeed (default).
on: Enable crossfeed (normal preset).
light: Light crossfeed (strength 15).
normal: Normal crossfeed (strength 40).
strong: Strong crossfeed (strength 65).
Note: You can fine-tune each channel's crossfeed strength using the MIXER.
.
:CONFIG_REVERB
Enable reverb globally to add a sense of space to the sound:
off: No reverb (default).
on: Enable reverb (medium preset).
tiny: Simulates the sound of a small integrated speaker in a room;
specifically designed for small-speaker audio systems
(PC speaker, Tandy, PS/1 Audio, and LPT DAC devices).
small: Adds a subtle sense of space; good for games that use a single
synth channel (typically OPL) for both music and sound effects.
medium: Medium room preset that works well with a wide variety of games.
large: Large hall preset recommended for games that use separate
channels for music and digital audio.
huge: A stronger variant of the large hall preset; works really well
in some games with more atmospheric soundtracks.
Note: You can fine-tune each channel's reverb level using the MIXER.
.
:CONFIG_CHORUS
Enable chorus globally to add a sense of stereo movement to the sound:
off: No chorus (default).
on: Enable chorus (normal preset).
light: A light chorus effect (especially suited for synth music that
features lots of white noise).
normal: Normal chorus that works well with a wide variety of games.
strong: An obvious and upfront chorus effect.
Note: You can fine-tune each channel's chorus level using the MIXER.
.
:CONFIG_MIDIDEVICE
Set where MIDI data from the emulated MPU-401 MIDI interface is sent
('auto' by default):
.
:CONFIGITEM_MIDIDEVICE_COREMIDI
coremidi: Any device that has been configured in the macOS
Audio MIDI Setup.
.
:CONFIGITEM_MIDIDEVICE_COREAUDIO
coreaudio: Use the built-in macOS MIDI synthesiser.
.
:CONFIGITEM_MIDIDEVICE_WIN32
win32: Use the Win32 MIDI playback interface.
.
:CONFIGITEM_MIDIDEVICE_OSS
oss: Use the Linux OSS MIDI playback interface.
.
:CONFIGITEM_MIDIDEVICE_ALSA
alsa: Use the Linux ALSA MIDI playback interface.
.
:CONFIGITEM_MIDIDEVICE_FLUIDSYNTH
fluidsynth: The built-in FluidSynth MIDI synthesizer (SoundFont player).
See the [fluidsynth] section for detailed configuration.
.
:CONFIGITEM_MIDIDEVICE_MT32
mt32: The built-in Roland MT-32 synthesizer.
See the [mt32] section for detailed configuration.
.
:CONFIGITEM_MIDIDEVICE_AUTO
auto: Either one of the built-in MIDI synthesisers (if `midiconfig` is
set to 'fluidsynth' or 'mt32'), or a MIDI device external to
DOSBox (any other 'midiconfig' value). This might be a software
synthesizer or physical device. This is the default behaviour.
.
:CONFIGITEM_MIDIDEVICE_NONE
none: Disable MIDI output.
.
:CONFIG_MIDICONFIG
Configuration options for the selected MIDI interface (unset by default).
This is usually the ID or name of the MIDI synthesizer you want
to use (find the ID/name with the DOS command 'MIXER /LISTMIDI').
Notes:
.
:CONFIGITEM_MIDICONFIG_FLUIDSYNTH_OR_MT32EMU
- This option has no effect when using the built-in synthesizers
('mididevice = fluidsynth' or 'mididevice = mt32').
.
:CONFIGITEM_MIDICONFIG_COREAUDIO
- When using 'coreaudio', you can specify a SoundFont here.
.
:CONFIGITEM_MIDICONFIG_ALSA
- When using ALSA, use the Linux command 'aconnect -l' to list all open
MIDI ports and select one (e.g. 'midiconfig = 14:0' for sequencer
client 14, port 0).
.
:CONFIGITEM_MIDICONFIG_MT32
- If you're using a physical Roland MT-32 with revision 0 PCB, the hardware
may require a delay in order to prevent its buffer from overflowing.
In that case, add 'delaysysex' (e.g. 'midiconfig = 2 delaysysex').
.
:CONFIG_MPU401
MPU-401 mode to emulate ('intelligent' by default).
.
:CONFIG_RAW_MIDI_OUTPUT
Enable raw, unaltered MIDI output (disabled by default).
The MIDI drivers of many games don't fully conform to the MIDI standard,
which makes editing the MIDI recordings of these games very error-prone and
cumbersome in MIDI sequencers, often resulting in hanging or missing notes.
DOSBox corrects the MIDI output of such games by default. This results in no
audible difference whatsoever; it only affects the representation of the MIDI
data. You should only enable 'raw_midi_output' if you really need to capture
the raw, unaltered MIDI output of a program, e.g. when working with music
applications, or when debugging MIDI issues.
.
:CONFIG_SOUNDFONT
Path to a SoundFont file in .sf2 format ('default.sf2' by default).
You can use an absolute or relative path, or the name of an .sf2 inside the
'soundfonts' directory within your DOSBox configuration directory.
An optional percentage value after the name will scale the SoundFont's volume.
This is useful for normalising the volume of different SoundFonts.
E.g. 'my_soundfont.sf2 50' will attenuate the volume by 50%%.
The percentage value can range from 1 to 800.
.
:CONFIG_FSYNTH_CHORUS
Chorus effect: 'auto' (default), 'on', 'off', or custom values.
When using custom values:
All five must be provided in-order and space-separated.
They are: voice-count level speed depth modulation-wave, where:
- voice-count is an integer from 0 to 99
- level is a decimal from 0.0 to 10.0
- speed is a decimal, measured in Hz, from 0.1 to 5.0
- depth is a decimal from 0.0 to 21.0
- modulation-wave is either 'sine' or 'triangle'
For example: chorus = 3 1.2 0.3 8.0 sine
Note: You can disable the FluidSynth chorus and enable the mixer-level chorus
on the FluidSynth channel instead, or enable both chorus effects at the
same time. Whether this sounds good depends on the SoundFont and the
chorus settings being used.
.
:CONFIG_FSYNTH_REVERB
Reverb effect: 'auto' (default), 'on', 'off', or custom values.
When using custom values:
All four must be provided in-order and space-separated.
They are: room-size damping width level, where:
- room-size is a decimal from 0.0 to 1.0
- damping is a decimal from 0.0 to 1.0
- width is a decimal from 0.0 to 100.0
- level is a decimal from 0.0 to 1.0
For example: reverb = 0.61 0.23 0.76 0.56
Note: You can disable the FluidSynth reverb and enable the mixer-level reverb
on the FluidSynth channel instead, or enable both reverb effects at the
same time. Whether this sounds good depends on the SoundFont and the
reverb settings being used.
.
:CONFIG_FSYNTH_FILTER
Filter for the FluidSynth audio output:
off: Don't filter the output (default).
<custom>: Custom filter definition; see 'sb_filter' for details.
.
:CONFIG_MODEL
The Roland MT-32/CM-32ML model to use.
You must have the ROM files for the selected model available (see 'romdir').
The lookup order for models that don't specify a version in their name is
performed in order as listed.
auto: Pick the first available model (default).
cm32l: Pick the first available CM-32L model.
mt32_old: Pick the first available "old" MT-32 model (v1.0x).
mt32_new: Pick the first available "new" MT-32 model (v2.0x).
mt32: Pick the first available MT-32 model.
<version>: Use the exact specified model version (e.g., 'mt32_204').
.
:CONFIG_ROMDIR
The directory containing the Roland MT-32/CM-32ML ROMs (unset by default).
The directory can be absolute or relative, or leave it unset to use the
'mt32-roms' directory in your DOSBox configuration directory. Other common
system locations will be checked as well.
Notes:
- The file names of the ROM files do not matter; the ROMS are identified
by their checksums.
- Both interleaved and non-interlaved ROM files are supported.
.
:CONFIG_MT32_FILTER
Filter for the Roland MT-32/CM-32L audio output:
off: Don't filter the output (default).
<custom>: Custom filter definition; see 'sb_filter' for details.
.
:MT32_NO_SUPPORTED_MODELS
No supported models present
.
:MT32_ROM_NOT_LOADED
No ROM is currently loaded
.
:MT32_INVENTORY_TABLE_MISSING_LETTER
-
.
:MT32_INVENTORY_TABLE_AVAILABLE_LETTER
y
.
:MT32_ROMS_LABEL
MT-32 ROMs
.
:CM32L_ROMS_LABEL
CM-32L ROMs
.
:MT32_ACTIVE_ROM_LABEL
Active ROM
.
:MT32_SOURCE_DIR_LABEL
Loaded from
.
:CONFIG_SBTYPE
Sound Blaster model to emulate ('sb16' by default).
The models auto-selected with 'oplmode' and 'cms' on 'auto' are also listed.
gb: Game Blaster - CMS
sb1: Sound Blaster 1.0 - OPL2, CMS
sb2: Sound Blaster 2.0 - OPL2
sbpro1: Sound Blaster Pro - Dual OPL2
sbpro2: Sound Blaster Pro 2 - OPL3
sb16: Sound Blaster 16 - OPL3 (default)
ess: ESS ES1688 AudioDrive - ESFM
none/off: Disable Sound Blaster emulation.
Notes:
- Creative Music System was later rebranded to Game Blaster; they are the
same card.
- The 'ess' option is for getting ESS Enhanced FM music via the card's ESFM
synthesiser in games that support it. The ESS DAC is not emulated but the
card is Sound Blaster Pro compatible; just configure the game for Sound
Blaster digital sound.
.
:CONFIG_SBBASE
The IO address of the Sound Blaster (220 by default).
.
:CONFIG_IRQ
The IRQ number of the Sound Blaster (7 by default).
.
:CONFIG_DMA
The DMA channel of the Sound Blaster (1 by default).
.
:CONFIG_HDMA
The High DMA channel of the Sound Blaster 16 (5 by default).
.
:CONFIG_SBMIXER
Allow the Sound Blaster mixer to modify volume levels (enabled by default).
Sound Blaster Pro 1 and later cards allow programs to set the volume of the
digital audio (DAC), FM synth, and CD Audio output. These correspond to the
SB, OPL, and CDAUDIO DOSBox mixer channels, respectively.
on: The final level of the above channels is a combination of the volume
set by the program, and the volume set in the DOSBox mixer.
off: Only the DOSBox mixer determines the volume of these channels.
Note: Some games change the volume levels dynamically (e.g., lower the FM music
volume when speech is playing); it's best to leave 'sbmixer' enabled for
such games.
.
:CONFIG_SBWARMUP
Silence initial DMA audio after card power-on, in milliseconds
(100 by default). This mitigates pops heard when starting many SB-based games.
Reduce this if you notice intial playback is missing audio.
.
:CONFIG_SB_FILTER
Type of filter to emulate for the Sound Blaster digital sound output:
auto: Use the appropriate filter determined by 'sbtype'.
sb1, sb2, sbpro1, sbpro2, sb16:
Use the filter of this Sound Blaster model.
modern: Use linear interpolation upsampling that acts as a low-pass
filter; this is the legacy DOSBox behaviour (default).
off: Don't filter the output.
<custom>: One or two custom filters in the following format:
TYPE ORDER FREQ
Where TYPE can be 'hpf' (high-pass) or 'lpf' (low-pass),
ORDER is the order of the filter from 1 to 16
(1st order = 6dB/oct slope, 2nd order = 12dB/oct, etc.),
and FREQ is the cutoff frequency in Hz. Examples:
lpf 2 12000
hpf 3 120 lfp 1 6500
.
:CONFIG_SB_FILTER_ALWAYS_ON
Force the Sound Blaster Pro 2 filter to be always on (disabled by default).
Other Sound Blaster models don't allow toggling the filter in software.
.
:CONFIG_OPLRATE
The OPL output is now transparently resampled to the mixer's sample rate.
.
:CONFIG_OPLMODE
OPL model to emulate ('auto' by default).
auto: Use the appropriate model determined by 'sbtype'.
opl2: Yamaha OPL2 (YM3812, mono).
dualopl2: Dual OPL2 (two OPL2 chips in stereo configuration).
opl3: Yamaha OPL3 (YMF262, stereo).
opl3gold: OPL3 and the optional AdLib Gold Surround module.
Use with 'sbtype = sb16' to emulate the AdLib Gold 1000.
esfm: ESS ESFM (enhanced Yamaha OPL3 compatible FM synth).
none/off: Disable OPL emulation.
Notes:
- 'sbtype = none' and 'oplmode = opl2' emulates the original AdLib card.
- Only 'oplmode = esfm' is not enough to get ESS Enhanced FM music in games;
you'll also need to set 'sbtype = ess'. 'oplmode = esfm' is useful to
get ESFM-flavoured OPL with original Sound Blaster models.
.
:CONFIG_OPL_FADEOUT
Fade out the OPL synth output after the last IO port write:
off: Don't fade out; residual output will play forever (default).
on: Wait 0.5s before fading out over a 0.5s period.
<custom>: A custom fade-out definition in the following format:
WAIT FADE
Where WAIT is how long after the last IO port write fading begins,
ranging between 100 and 5000 milliseconds; and FADE is the
fade-out period, ranging between 10 and 3000 milliseconds.
Examples:
300 200 (Wait 300ms before fading out over a 200ms period)
1000 3000 (Wait 1s before fading out over a 3s period)
.
:CONFIG_OPL_REMOVE_DC_BIAS
Remove DC bias from the OPL output. This should only be used as a last resort
to fix popping in games that play PCM audio using the OPL synthesiser on a
Sound Blaster or AdLib card, such as in: Golden Eagle (1991), Wizardry 6
(1990), and Wizardry 7 (1992). Please open an issue ticket if you find other
affected games.
.
:CONFIG_OPLEMU
Only 'nuked' OPL emulation is supported now.
.
:CONFIG_OPL_FILTER
Type of filter to emulate for the Sound Blaster OPL output:
auto: Use the appropriate filter determined by 'sbtype' (default).
sb1, sb2, sbpro1, sbpro2, sb16:
Use the filter of this Sound Blaster model.
off: Don't filter the output.
<custom>: Custom filter definition; see 'sb_filter' for details.
.
:CONFIG_CMS
Enable CMS emulation ('auto' by default).
off: Disable CMS emulation (except when the Game Blaster is selected).
on: Enable CMS emulation on Sound Blaster 1 and 2.
auto: Auto-enable CMS emulation for Sound Blaster 1 and Game Blaster.
.
:CONFIG_CMS_FILTER
Filter for the Sound Blaster CMS output:
on: Filter the output (default).
off: Don't filter the output.
<custom>: Custom filter definition; see 'sb_filter' for details.
.
:CONFIG_GUS
Enable Gravis UltraSound emulation (disabled by default).
The default settings of base address 240, IRQ 5, and DMA 3 have been chosen so
the GUS can coexist with a Sound Blaster card. This works fine for the majority
of programs, but some games and demos expect the GUS factory defaults of base
address 220, IRQ 11, and DMA 1. The default IRQ 11 is also problematic with
specific versions of the DOS4GW extender that cannot handle IRQs above 7.
.
:CONFIG_GUSBASE
The IO base address of the Gravis UltraSound (240 by default).
.
:CONFIG_GUSIRQ
The IRQ number of the Gravis UltraSound (5 by default).
.
:CONFIG_GUSDMA
The DMA channel of the Gravis UltraSound (3 by default).
.
:CONFIG_GUS_FILTER
Filter for the Gravis UltraSound audio output:
off: Don't filter the output (default).
<custom>: Custom filter definition; see 'sb_filter' for details.
.
:CONFIG_ULTRADIR
Path to UltraSound directory ('C:\ULTRASND' by default).
In this directory, there should be a 'MIDI' directory that contains the patch
files for GUS playback.
.
:CONFIG_IMFC
Enable the IBM Music Feature Card (disabled by default).
.
:CONFIG_IMFC_BASE
The IO base address of the IBM Music Feature Card (2A20 by default).
.
:CONFIG_IMFC_IRQ
The IRQ number of the IBM Music Feature Card (3 by default).
.
:CONFIG_IMFC_FILTER
Filter for the IBM Music Feature Card output:
on: Filter the output (default).
off: Don't filter the output.
<custom>: Custom filter definition; see 'sb_filter' for details.
.
:CONFIG_SIDMODEL
Model of chip to emulate in the Innovation SSI-2001 card:
auto: Use the 6581 chip.
6581: The original chip, known for its bassy and rich character.
8580: A later revision that more closely matched the SID specification.
It fixed the 6581's DC bias and is less prone to distortion.
The 8580 is an option on reproduction cards, like the DuoSID.
none: Disable the card (default).
.
:CONFIG_SIDCLOCK
The SID chip's clock frequency, which is jumperable on reproduction cards:
default: 0.895 MHz, per the original SSI-2001 card (default).
c64ntsc: 1.023 MHz, per NTSC Commodore PCs and the DuoSID.
c64pal: 0.985 MHz, per PAL Commodore PCs and the DuoSID.
hardsid: 1.000 MHz, available on the DuoSID.
.
:CONFIG_SIDPORT
The IO port address of the Innovation SSI-2001 (280 by default).
.
:CONFIG_6581FILTER
Adjusts the 6581's filtering strength as a percentage from 0 to 100
(50 by default). The SID's analog filtering meant that each chip was
physically unique.
.
:CONFIG_8580FILTER
Adjusts the 8580's filtering strength as a percentage from 0 to 100
(50 by default).
.
:CONFIG_INNOVATION_FILTER
Filter for the Innovation audio output:
off: Don't filter the output (default).
<custom>: Custom filter definition; see 'sb_filter' for details.
.
:CONFIG_PCSPEAKER
PC speaker emulation model:
impulse: A very faithful emulation of the PC speaker's output (default).
Works with most games, but may result in garbled sound or silence
in a small number of programs.
discrete: Legacy simplified PC speaker emulation; only use this on specific
titles that give you problems with the 'impulse' model.
none/off: Don't emulate the PC speaker.
.
:CONFIG_PCSPEAKER_FILTER
Filter for the PC speaker output:
on: Filter the output (default).
off: Don't filter the output.
<custom>: Custom filter definition; see 'sb_filter' for details.
.
:CONFIG_ZERO_OFFSET
DC-offset is now eliminated globally from the master mixer output.
.
:CONFIG_TANDY
Set the Tandy/PCjr 3 Voice sound emulation:
auto: Automatically enable Tandy/PCjr sound for the 'tandy' and 'pcjr'
machine types only (default).
on: Enable Tandy/PCjr sound with DAC support, when possible.
Most games also need the machine set to 'tandy' or 'pcjr' to work.
psg: Only enable the card's three-voice programmable sound generator
without DAC to avoid conflicts with other cards using DMA 1.
off: Disable Tandy/PCjr sound.
.
:CONFIG_TANDY_FADEOUT
Fade out the Tandy synth output after the last IO port write:
off: Don't fade out; residual output will play forever (default).
on: Wait 0.5s before fading out over a 0.5s period.
<custom>: Custom fade out definition; see 'opl_fadeout' for details.
.
:CONFIG_TANDY_FILTER
Filter for the Tandy synth output:
on: Filter the output (default).
off: Don't filter the output.
<custom>: Custom filter definition; see 'sb_filter' for details.
.
:CONFIG_TANDY_DAC_FILTER
Filter for the Tandy DAC output:
on: Filter the output (default).
off: Don't filter the output.
<custom>: Custom filter definition; see 'sb_filter' for details.
.
:CONFIG_LPT_DAC
Type of DAC plugged into the parallel port:
disney: Disney Sound Source.
covox: Covox Speech Thing.
ston1: Stereo-on-1 DAC, in stereo up to 30 kHz.
none/off: Don't use a parallel port DAC (default).
.
:CONFIG_LPT_DAC_FILTER
Filter for the LPT DAC audio device(s):
on: Filter the output (default).
off: Don't filter the output.
<custom>: Custom filter definition; see 'sb_filter' for details.
.
:CONFIG_DISNEY
Use 'lpt_dac = disney' to enable the Disney Sound Source.
.
:CONFIG_PS1AUDIO
Enable IBM PS/1 Audio emulation (disabled by default).
.
:CONFIG_PS1AUDIO_FILTER
Filter for the PS/1 Audio synth output:
on: Filter the output (default).
off: Don't filter the output.
<custom>: Custom filter definition; see 'sb_filter' for details.
.
:CONFIG_PS1AUDIO_DAC_FILTER
Filter for the PS/1 Audio DAC output:
on: Filter the output (default).
off: Don't filter the output.
<custom>: Custom filter definition; see 'sb_filter' for details.
.
:CONFIG_REELMAGIC
ReelMagic (aka REALmagic) MPEG playback support:
off: Disable support (default).
cardonly: Initialize the card without loading the FMPDRV.EXE driver.
on: Initialize the card and load the FMPDRV.EXE on startup.
.
:CONFIG_REELMAGIC_KEY
Set the 32-bit magic key used to decode the game's videos:
auto: Use the built-in routines to determine the key (default).
common: Use the most commonly found key, which is 0x40044041.
thehorde: Use The Horde's key, which is 0xC39D7088.
<custom>: Set a custom key in hex format (e.g., 0x12345678).
.
:CONFIG_REELMAGIC_FCODE
Override the frame rate code used during video playback:
0: No override: attempt automatic rate discovery (default).
1 to 7: Override the frame rate to one the following (use 1 through 7):
1=23.976, 2=24, 3=25, 4=29.97, 5=30, 6=50, or 7=59.94 FPS.
.
:CONFIG_JOYSTICKTYPE
Type of joystick to emulate:
auto: Detect and use any joystick(s), if possible (default).
Joystick emulation is disabled if no joystick is found.
2axis: Support up to two joysticks, each with 2 axis.
4axis: Support the first joystick only, as a 4-axis type.
4axis_2: Support the second joystick only, as a 4-axis type.
fcs: Emulate joystick as an original Thrustmaster FCS.
ch: Emulate joystick as an original CH Flightstick.
hidden: Prevent DOS from seeing the joystick(s), but enable them
for mapping.
disabled: Fully disable joysticks: won't be polled, mapped,
or visible in DOS.
Remember to reset DOSBox's mapperfile if you saved it earlier.
.
:CONFIG_TIMED
Enable timed intervals for axis (enabled by default).
Experiment with this option, if your joystick drifts away.
.
:CONFIG_AUTOFIRE
Fire continuously as long as the button is pressed
(disabled by default).
.
:CONFIG_SWAP34
Swap the 3rd and the 4th axis (disabled by default).
Can be useful for certain joysticks.
.
:CONFIG_BUTTONWRAP
Enable button wrapping at the number of emulated buttons (disabled by default).
.
:CONFIG_CIRCULARINPUT
Enable translation of circular input to square output (disabled by default).
Try enabling this if your left analog stick can only move in a circle.
.
:CONFIG_DEADZONE
Percentage of motion to ignore (10 by default).
100 turns the stick into a digital one.
.
:CONFIG_USE_JOY_CALIBRATION_HOTKEYS
Enable hotkeys to allow realtime calibration of the joystick's X and Y axes
(disabled by default). Only consider this if in-game calibration fails and
other settings have been tried.
- Ctrl/Cmd+Arrow-keys adjust the axis' scalar value:
- Left and Right diminish or magnify the x-axis scalar, respectively.
- Down and Up diminish or magnify the y-axis scalar, respectively.
- Alt+Arrow-keys adjust the axis' offset position:
- Left and Right shift X-axis offset in the given direction.
- Down and Up shift the Y-axis offset in the given direction.
- Reset the X and Y calibration using Ctrl+Delete and Ctrl+Home,
respectively.
Each tap will report X or Y calibration values you can set below. When you find
parameters that work, quit the game, switch this setting back to disabled, and
populate the reported calibration parameters.
.
:CONFIG_JOY_X_CALIBRATION
Apply X-axis calibration parameters from the hotkeys ('auto' by default).
.
:CONFIG_JOY_Y_CALIBRATION
Apply Y-axis calibration parameters from the hotkeys ('auto' by default).
.
:CONFIG_SERIAL1
Set type of device connected to the COM1 port.
Can be disabled, dummy, mouse, modem, nullmodem, direct ('dummy' by default).
Additional parameters must be on the same line in the form of
parameter:value. The optional 'irq' parameter is common for all types.
- for 'mouse': model (overrides the setting from the [mouse] section)
- for 'direct': realport (required), rxdelay (optional).
(e.g., realport:COM1, realport:ttyS0).
- for 'modem': listenport, sock, bps (all optional).
- for 'nullmodem': server, rxdelay, txdelay, telnet, usedtr,
transparent, port, inhsocket, sock (all optional).
The 'sock' parameter specifies the protocol to use at both sides of the
connection. Valid values are 0 for TCP, and 1 for ENet reliable UDP.
Example: serial1=modem listenport:5000 sock:1
.
:CONFIG_SERIAL2
See 'serial1' ('dummy' by default).
.
:CONFIG_SERIAL3
See 'serial1' ('disabled' by default).
.
:CONFIG_SERIAL4
See 'serial1' ('disabled' by default).
.
:CONFIG_PHONEBOOKFILE
File used to map fake phone numbers to addresses
('phonebook.txt' by default).
.
:CONFIG_XMS
Enable XMS support (enabled by default).
.
:CONFIG_EMS
Enable EMS support (enabled by default). Enabled provides the best
compatibility but certain applications may run better with other choices,
or require EMS support to be disabled to work at all.
.
:CONFIG_UMB
Enable UMB support (enabled by default).
.
:CONFIG_PCJR_MEMORY_CONFIG
PCjr memory layout ('expanded' by default).
expanded: 640 KB total memory with applications residing above 128 KB.
Compatible with most games.
standard: 128 KB total memory with applications residing below 96 KB.
Required for some older games (e.g., Jumpman, Troll).
.
:CONFIG_VER
Set DOS version (5.0 by default). Specify in major.minor format.
A single number is treated as the major version.
Common settings are 3.3, 5.0, 6.22, and 7.1.
.
:CONFIG_LOCALE_PERIOD
Set locale epoch ('modern' by default). Historic settings (if available
for the given country) try to mimic old DOS behaviour when displaying
information such as dates, time, or numbers, modern ones follow current day
practices for user experience more consistent with typical host systems.
.
:CONFIG_COUNTRY
Set DOS country code ('auto' by default).
This affects country-specific information such as date, time, and decimal
formats. The list of supported country codes can be displayed using
'--list-countries' command-line argument. If set to 'auto', the country code
corresponding to the selected keyboard layout will be used.
.
:CONFIG_KEYBOARDLAYOUT
Keyboard layout code ('auto' by default), i.e. 'us' for US English layout.
Other possible values are the same as accepted by FreeDOS.
.
:CONFIG_EXPAND_SHELL_VARIABLE
Enable expanding environment variables such as %%PATH%% in the DOS command shell
(auto by default, enabled if DOS version >= 7.0).
FreeDOS and MS-DOS 7/8 COMMAND.COM supports this behavior.
.
:CONFIG_SHELL_HISTORY_FILE
File containing persistent command line history ('shell_history.txt'
by default). Setting it to empty disables persistent shell history.
.
:CONFIG_SETVER_TABLE_FILE
File containing the list of applications and assigned DOS versions, in a
tab-separated format, used by SETVER.EXE as a persistent storage
(empty by default).
.
:CONFIGITEM_IPX
Enable IPX over UDP/IP emulation (disabled by default).
.
:CONFIGITEM_NE2000_SLIRP
Enable emulation of a Novell NE2000 network card on a software-based
network (using libslirp) with properties as follows (enabled by default):
- 255.255.255.0: Subnet mask of the 10.0.2.0 virtual LAN.
- 10.0.2.2: IP of the gateway and DHCP service.
- 10.0.2.3: IP of the virtual DNS server.
- 10.0.2.15: First IP provided by DHCP, your IP!
Note: Inside DOS, setting this up requires an NE2000 packet driver, DHCP
client, and TCP/IP stack. You might need port-forwarding from the host
into the DOS guest, and from your router to your host when acting as the
server for multiplayer games.
.
:CONFIGITEM_NICBASE_SLIRP
Base address of the NE2000 card (300 by default).
Note: Addresses 220 and 240 might not be available as they're assigned to the
Sound Blaster and Gravis UltraSound by default.
.
:CONFIGITEM_NICIRQ_SLIRP
The interrupt used by the NE2000 card (3 by default).
Note: IRQs 3 and 5 might not be available as they're assigned to
'serial2' and the Gravis UltraSound by default.
.
:CONFIGITEM_MACADDR_SLIRP
The MAC address of the NE2000 card ('AC:DE:48:88:99:AA' by default).
.
:CONFIGITEM_TCP_PORT_FORWARDS_SLIRP
Forward one or more TCP ports from the host into the DOS guest
(unset by default).
The format is:
port1 port2 port3 ... (e.g., 21 80 443)
This will forward FTP, HTTP, and HTTPS into the DOS guest.
If the ports are privileged on the host, a mapping can be used
host:guest ..., (e.g., 8021:21 8080:80)
This will forward ports 8021 and 8080 to FTP and HTTP in the guest.
A range of adjacent ports can be abbreviated with a dash:
start-end ... (e.g., 27910-27960)
This will forward ports 27910 to 27960 into the DOS guest.
Mappings and ranges can be combined, too:
hstart-hend:gstart-gend ..., (e.g, 8040-8080:20-60)
This forwards ports 8040 to 8080 into 20 to 60 in the guest.
Notes:
- If mapped ranges differ, the shorter range is extended to fit.
- If conflicting host ports are given, only the first one is setup.
- If conflicting guest ports are given, the latter rule takes precedent.
.
:CONFIGITEM_UDP_PORT_FORWARDS_SLIRP
Forward one or more UDP ports from the host into the DOS guest
(unset by default). The format is the same as for TCP port forwards.
.
:AUTOEXEC_CONFIGFILE_HELP
Each line in this section is executed at startup as a DOS command.
Important: The [autoexec] section must be the last section in the config!
.
:CONFIGFILE_INTRO
# This is the configuration file for dosbox-staging (%s).
# Lines starting with a '#' character are comments.
.
:CONFIG_VALID_VALUES
Possible values
.
:CONFIG_DEPRECATED_VALUES
Deprecated values
.
:PROGRAM_CONFIG_NOCONFIGFILE
No config file loaded
.
:PROGRAM_CONFIG_PRIMARY_CONF
[color=white]Primary config file:[reset]
%s
.
:PROGRAM_CONFIG_ADDITIONAL_CONF
[color=white]Additional config files:[reset]
.
:PROGRAM_CONFIG_CONFDIR
[color=white]DOSBox Staging %s configuration directory:[reset]
%s
.
:PROGRAM_CONFIG_FILE_ERROR
Can't open config file '%s'
.
:PROGRAM_CONFIG_FILE_WHICH
Writing current config to '%s'
.
:SHELL_CMD_CONFIG_HELP_LONG
Perform configuration management and other miscellaneous actions.
Usage:
[color=light-green]config[reset] [color=white]COMMAND[reset] [color=light-cyan][PARAMETERS][reset]
Where [color=white]COMMAND[reset] is one of:
-writeconf
-wc write the current configuration to the local `dosbox.conf`
config file in the current working directory
-writeconf [color=white]PATH[reset]
-wc [color=white]PATH [reset]if [color=white]PATH[reset] is a filename, write the current configuration to
that file in the current working directory, otherwise to the
specified absolute or relative path
-wcd write the current configuration to the primary (default)
`dosbox-staging.conf` config file in the configuration
directory
-writelang [color=white]FILENAME[reset]
-wl [color=white]FILENAME [reset]write the current language strings to [color=white]FILENAME [reset]in the
current working directory
-r [color=light-cyan][PROPERTY1=VALUE1 [PROPERTY2=VALUE2 ...]][reset]
restart DOSBox with the optionally supplied config
properties
-l show the currently loaded config files and command line
arguments provided at startup
-help [color=white]SECTION[reset]
-h [color=white]SECTION[reset]
-? [color=white]SECTION [reset]list the names of all properties in a config section
-help [color=light-cyan][SECTION][reset] [color=white]PROPERTY[reset]
-h [color=light-cyan][SECTION][reset] [color=white]PROPERTY[reset]
-? [color=light-cyan][SECTION][reset] [color=white]PROPERTY[reset]
show the description and the current value of a config
property
-help sections
-h sections
-? sections [reset]list the names of all config sections
-axclear clear the [autoexec] section
-axadd [color=white]LINE[reset] append a line to the end of the [autoexec] section
-axtype show the contents of the [autoexec] section
-securemode switch to secure mode
-avistart start AVI recording
-avistop stop AVI recording
-startmapper start the keymapper
-get [color=white]SECTION [reset]show all properties and their values in a config section
-get [color=light-cyan][SECTION][reset] [color=white]PROPERTY[reset]
show the value of a single config property
-set [color=light-cyan][SECTION][reset] [color=white]PROPERTY[reset][=][color=white]VALUE[reset]
set the value of a config property
-securemode enable secure mode
.
:PROGRAM_CONFIG_HLP_PROPHLP
[color=white]Description of the [color=light-green]'%s'[color=white] setting in the [color=light-cyan][%s][color=white] section:[reset]
.
:PROGRAM_CONFIG_HLP_PROPHLP_POSSIBLE_VALUES
[color=white]Possible values:[reset] %s
.
:PROGRAM_CONFIG_HLP_PROPHLP_DEFAULT_VALUE
[color=white]Default value:[reset] %s
.
:PROGRAM_CONFIG_HLP_PROPHLP_CURRENT_VALUE
[color=white]Current value:[reset] %s
.
:PROGRAM_CONFIG_HLP_AUTOEXEC
[color=white]Description of the [color=light-cyan][autoexec][color=white] section:[reset]
%s
.
:PROGRAM_CONFIG_HLP_NOCHANGE
[color=yellow]This setting cannot be changed at runtime.[reset]
.
:PROGRAM_CONFIG_HLP_POSINT
positive integer
.
:PROGRAM_CONFIG_HLP_SECTHLP
[color=white]List of settings in the [color=light-cyan][%s][color=white] section:[reset]
.
:PROGRAM_CONFIG_HLP_SECTLIST
[color=white]List of configuration sections:[reset]
.
:PROGRAM_CONFIG_SECURE_ON
Secure mode enabled.
.
:PROGRAM_CONFIG_SECURE_DISALLOW
This operation is not permitted in secure mode.
.
:PROGRAM_CONFIG_SECTION_ERROR
Section [%s] doesn't exist.
.
:PROGRAM_CONFIG_VALUE_ERROR
'%s' is not a valid value for setting '%s'.
.
:PROGRAM_CONFIG_GET_SYNTAX
Usage: [color=light-green]config[reset] -get [color=light-cyan][SECTION][reset] [color=white]PROPERTY[reset]
.
:PROGRAM_CONFIG_PRINT_STARTUP
[color=white]DOSBox was started with the following command line arguments:[reset]
%s
.
:PROGRAM_CONFIG_MISSINGPARAM
Missing parameter.
.
:PROGRAM_PATH_TOO_LONG
The path '%s' exceeds the DOS limit of %d characters.
.
:PROGRAM_EXECUTABLE_MISSING
Executable file not found: '%s'
.
:CONJUNCTION_AND
and
.
:PROGRAM_CONFIG_NOT_CHANGEABLE
Setting '%s' is not changeable at runtime.
.
:PROGRAM_CONFIG_DEPRECATED
[color=light-red]This is a deprecated setting only kept for compatibility with old configs.
Please use the suggested alternatives; support will be removed in the future.[reset]
.
:MIDI_DEVICE_LIST_NOT_SUPPORTED
Listing not supported
.
:MIDI_DEVICE_NOT_CONFIGURED
Device not configured
.
:BIOS_REBOOTING_3
Rebooting in 3 seconds...
.
:BIOS_REBOOTING_2
Rebooting in 2 seconds...
.
:BIOS_REBOOTING_1
Rebooting in 1 second...
.
:MOUNT_TYPE_LOCAL_DIRECTORY
Local directory
.
:MOUNT_TYPE_CDROM
CD-ROM drive
.
:MOUNT_TYPE_FAT
FAT image
.
:MOUNT_TYPE_ISO
ISO image
.
:MOUNT_TYPE_VIRTUAL
Internal virtual drive
.
:MOUNT_TYPE_UNKNOWN
unknown drive
.
:WIKI_ADD_UTILITIES_ARTICLE
https://github.com/dosbox-staging/dosbox-staging/wiki/Adding-utilities
.
:WIKI_URL
https://github.com/dosbox-staging/dosbox-staging/wiki
.
:PROGRAM_AUTOTYPE_HELP_LONG
Perform scripted keyboard entry into a running DOS game.
Usage:
[color=light-green]autotype[reset] -list
[color=light-green]autotype[reset] [-w [color=white]WAIT[reset]] [-p [color=white]PACE[reset]] [color=light-cyan]BUTTONS[reset]
Parameters:
[color=white]WAIT[reset] number of seconds to wait before typing begins (max of 30)
[color=white]PACE[reset] number of seconds before each keystroke (max of 10)
[color=light-cyan]BUTTONS[reset] one or more space-separated buttons
Notes:
The [color=light-cyan]BUTTONS[reset] supplied in the command will be autotyped into running DOS games
after they start. Autotyping begins after [color=light-cyan]WAIT[reset] seconds, and each button is
entered every [color=white]PACE[reset] seconds. The [color=light-cyan],[reset] character inserts an extra [color=white]PACE[reset] delay.
[color=white]WAIT[reset] and [color=white]PACE[reset] default to 2 and 0.5 seconds respectively if not specified.
A list of all available button names can be obtained using the -list option.
Examples:
[color=light-green]autotype[reset] -list
[color=light-green]autotype[reset] -w [color=white]1[reset] -p [color=white]0.3[reset] [color=light-cyan]up enter , right enter[reset]
[color=light-green]autotype[reset] -p [color=white]0.2[reset] [color=light-cyan]f1 kp_8 , , enter[reset]
[color=light-green]autotype[reset] -w [color=white]1.3[reset] [color=light-cyan]esc enter , p l a y e r enter[reset]
.
:PROGRAM_BOOT_HELP_LONG
Boot DOSBox Staging from a DOS drive or disk image.
Usage:
[color=light-green]boot[reset] [color=white]DRIVE[reset]
[color=light-green]boot[reset] [color=light-cyan]IMAGEFILE[reset]
Parameters:
[color=white]DRIVE[reset] drive to boot from, must be [color=white]A:[reset], [color=white]C:[reset], or [color=white]D:[reset]
[color=light-cyan]IMAGEFILE[reset] one or more floppy images, separated by spaces
Notes:
A DOS drive letter must have been mounted previously with [color=light-green]imgmount[reset] command.
The DOS drive or disk image must be bootable, containing DOS system files.
If more than one disk images are specified, you can swap them with a hotkey.
Examples:
[color=light-green]boot[reset] [color=white]c:[reset]
[color=light-green]boot[reset] [color=light-cyan]disk1.ima disk2.ima[reset]
.
:PROGRAM_BOOT_NOT_EXIST
Bootdisk file does not exist. Failing.
.
:PROGRAM_BOOT_NOT_OPEN
Cannot open bootdisk file. Failing.
.
:PROGRAM_BOOT_WRITE_PROTECTED
Image file is read-only! Might create problems.
.
:PROGRAM_BOOT_PRINT_ERROR
This command boots DOSBox Staging from either a floppy or hard disk image.
For this command, one can specify a succession of floppy disks swappable by
pressing [color=yellow]%s+F4[reset], and -l specifies the mounted drive to boot from. If no drive
letter is specified, this defaults to booting from the A drive. The only
bootable drive letters are A, C, and D. For booting from a hard drive (C or D),
the image should have already been mounted using the [color=light-blue]IMGMOUNT[reset] command.
Type [color=light-blue]BOOT /?[reset] for the syntax of this command.
.
:PROGRAM_BOOT_UNABLE
Unable to boot off of drive %c.
.
:PROGRAM_BOOT_IMAGE_OPEN
Opening image file: %s
.
:PROGRAM_BOOT_IMAGE_MOUNTED
Floppy image(s) already mounted.
.
:PROGRAM_BOOT_IMAGE_NOT_OPEN
Cannot open %s
.
:PROGRAM_BOOT_BOOT
Booting from drive %c...
.
:PROGRAM_BOOT_CART_WO_PCJR
PCjr cartridge found, but machine is not PCjr.
.
:PROGRAM_BOOT_CART_LIST_CMDS
Available PCjr cartridge commands: %s
.
:PROGRAM_BOOT_CART_NO_CMDS
No PCjr cartridge commands found.
.
:MSCDEX_SUCCESS
MSCDEX installed.
.
:MSCDEX_ERROR_MULTIPLE_CDROMS
MSCDEX: Failure: Drive-letters of multiple CD-ROM drives have to be continuous.
.
:MSCDEX_ERROR_NOT_SUPPORTED
MSCDEX: Failure: Not yet supported.
.
:MSCDEX_ERROR_PATH
MSCDEX: Specified location is not a CD-ROM drive.
.
:MSCDEX_ERROR_OPEN
MSCDEX: Failure: Invalid file or unable to open.
.
:MSCDEX_TOO_MANY_DRIVES
MSCDEX: Failure: Too many CD-ROM drives (max: 5). MSCDEX Installation failed.
.
:MSCDEX_LIMITED_SUPPORT
MSCDEX: Mounted subdirectory: limited support.
.
:MSCDEX_INVALID_FILEFORMAT
MSCDEX: Failure: File is either no ISO/CUE image or contains errors.
.
:MSCDEX_UNKNOWN_ERROR
MSCDEX: Failure: Unknown error.
.
:MSCDEX_WARNING_NO_OPTION
MSCDEX: Warning: Ignoring unsupported option '%s'.
.
:PROGRAM_MOUNT_STATUS_DRIVE
Drive
.
:PROGRAM_MOUNT_STATUS_TYPE
Type
.
:PROGRAM_MOUNT_STATUS_LABEL
Label
.
:PROGRAM_MOUNT_STATUS_NAME
Image name
.
:PROGRAM_MOUNT_STATUS_SLOT
Swap slot
.
:PROGRAM_MOUNT_STATUS_2
%s mounted as %c drive
.
:PROGRAM_MOUNT_STATUS_1
The currently mounted drives are:
.
:PROGRAM_MOUNT_READONLY
Mounted read-only
.
:PROGRAM_IMGMOUNT_HELP_LONG
Mount a CD-ROM, floppy, or disk image to a drive letter.
Usage:
[color=light-green]imgmount[reset] [color=white]DRIVE[reset] [color=light-cyan]CDROM-SET[reset] [-fs iso] [-ide] -t cdrom|iso
[color=light-green]imgmount[reset] [color=white]DRIVE[reset] [color=light-cyan]IMAGEFILE[reset] [IMAGEFILE2 [..]] [-fs fat] -t hdd|floppy -ro
[color=light-green]imgmount[reset] [color=white]DRIVE[reset] [color=light-cyan]BOOTIMAGE[reset] [-fs fat|none] -t hdd -size GEOMETRY -ro
[color=light-green]imgmount[reset] -u [color=white]DRIVE[reset] (unmounts the [color=white]DRIVE[reset]'s image)
Parameters:
[color=white]DRIVE[reset] drive letter where the image will be mounted: A, C, D, ...
[color=light-cyan]CDROM-SET[reset] ISO, CUE+BIN, CUE+ISO, or CUE+ISO+FLAC/OPUS/OGG/MP3/WAV
[color=light-cyan]IMAGEFILE[reset] hard drive or floppy image in FAT16 or FAT12 format
[color=light-cyan]BOOTIMAGE[reset] bootable disk image with specified -size GEOMETRY:
bytes-per-sector,sectors-per-head,heads,cylinders
Notes:
- You can use wildcards to mount multiple images, e.g.:
[color=light-green]imgmount[reset] [color=white]A[reset] [color=light-cyan]floppy*.img[reset] -t floppy
- [color=yellow]%s+F4[reset] swaps & mounts the next [color=light-cyan]CDROM-SET[reset] or [color=light-cyan]BOOTIMAGE[reset], if provided.
- The -ro flag mounts the disk image in read-only (write-protected) mode.
- The -ide flag emulates an IDE controller with attached IDE CD drive, useful
for CD-based games that need a real DOS environment via bootable HDD image.
Examples:
.
:PROGRAM_IMGMOUNT_HELP_LONG_WIN32
[color=light-green]imgmount[reset] [color=white]D[reset] [color=light-cyan]C:\Games\doom.iso[reset] -t cdrom
.
:PROGRAM_IMGMOUNT_HELP_LONG_MACOSX
[color=light-green]imgmount[reset] [color=white]D[reset] [color=light-cyan]/Users/USERNAME/Games/doom.iso[reset] -t cdrom
.
:PROGRAM_IMGMOUNT_HELP_LONG_OTHER
[color=light-green]imgmount[reset] [color=white]D[reset] [color=light-cyan]/home/USERNAME/games/doom.iso[reset] -t cdrom
.
:PROGRAM_IMGMOUNT_HELP_LONG_GENERIC
[color=light-green]imgmount[reset] [color=white]D[reset] [color=light-cyan]cd/quake1.cue[reset] -t cdrom
[color=light-green]imgmount[reset] [color=white]A[reset] [color=light-cyan]floppy1.img floppy2.img floppy3.img[reset] -t floppy -ro
[color=light-green]imgmount[reset] [color=white]A[reset] [color=light-cyan]floppy*.img[reset] -t floppy -ro
[color=light-green]imgmount[reset] [color=white]C[reset] [color=light-cyan]bootable.img[reset] -t hdd -fs none -size 512,63,32,1023
.
:PROGRAM_IMGMOUNT_SPECIFY_DRIVE
Must specify drive letter to mount image at.
.
:PROGRAM_IMGMOUNT_SPECIFY2
Must specify drive number (0 or 3) to mount image at (0,1=fda,fdb; 2,3=hda,hdb).
.
:PROGRAM_IMGMOUNT_SPECIFY_GEOMETRY
For CD-ROM images:
[color=light-green]imgmount[reset] [color=white]DRIVE[reset] [color=light-cyan]IMAGEFILE[reset] -t iso
For hard drive images, must specify drive geometry:
bytes-per-sector,sectors-per-head,heads,cylinders
[color=light-green]imgmount[reset] [color=white]DRIVE[reset] [color=light-cyan]IMAGEFILE[reset] -size bps,spc,hpc,cyl
.
:PROGRAM_IMGMOUNT_STATUS_NONE
No drive available.
.
:PROGRAM_IMGMOUNT_IDE_CONTROLLERS_UNAVAILABLE
No available IDE controllers. Drive will not have IDE emulation.
.
:PROGRAM_IMGMOUNT_INVALID_IMAGE
Could not load image file.
Check that the path is correct and the image is accessible.
.
:PROGRAM_IMGMOUNT_INVALID_GEOMETRY
Could not extract drive geometry from image.
Use parameter -size bps,spc,hpc,cyl to specify the geometry.
.
:PROGRAM_IMGMOUNT_TYPE_UNSUPPORTED
Type '%s' is unsupported. Specify 'floppy', 'hdd', 'cdrom', or 'iso'.
.
:PROGRAM_IMGMOUNT_FORMAT_UNSUPPORTED
Format '%s' is unsupported. Specify 'fat', 'iso', or 'none'.
.
:PROGRAM_IMGMOUNT_SPECIFY_FILE
Must specify file-image to mount.
.
:PROGRAM_IMGMOUNT_FILE_NOT_FOUND
Image file not found.
.
:PROGRAM_IMGMOUNT_MOUNT
To mount directories, use the [color=light-green]MOUNT[reset] command, not the [color=light-green]IMGMOUNT[reset] command.
.
:PROGRAM_IMGMOUNT_ALREADY_MOUNTED
Drive already mounted at that letter.
.
:PROGRAM_IMGMOUNT_CANT_CREATE
Can't create drive from file.
.
:PROGRAM_IMGMOUNT_MOUNT_NUMBER
Drive number %d mounted as %s.
.
:PROGRAM_IMGMOUNT_NON_LOCAL_DRIVE
The image must be on a host or local drive.
.
:PROGRAM_INTRO_HELP
Display a full-screen introduction to DOSBox Staging.
.
:PROGRAM_INTRO_HELP_LONG
Usage:
[color=light-green]intro[reset]
[color=light-green]intro[reset] [color=white]PAGE[reset]
Parameters:
[color=white]PAGE[reset] page name to display, including [color=white]cdrom[reset], [color=white]mount[reset], and [color=white]special[reset]
Notes:
Running [color=light-green]intro[reset] without an argument displays one information page at a time;
press any key to move to the next page. If a page name is provided, then the
specified page will be displayed directly.
Examples:
[color=light-green]intro[reset]
[color=light-green]intro[reset] [color=white]cdrom[reset]
.
:PROGRAM_INTRO
[erases=entire][color=light-green]Welcome to DOSBox Staging[reset], an x86 emulator with sound and graphics.
DOSBox creates a shell for you which looks like old plain DOS.
For information about basic mount type [color=light-blue]intro mount[reset]
For information about CD-ROM support type [color=light-blue]intro cdrom[reset]
For information about special keys type [color=light-blue]intro special[reset]
For more information, visit DOSBox Staging wiki:[color=light-blue]
https://github.com/dosbox-staging/dosbox-staging/wiki[reset]
[color=light-red]DOSBox will stop/exit without a warning if an error occurred![reset]
.
:PROGRAM_INTRO_MOUNT_START
[erases=entire][color=light-green]Here are some commands to get you started:[reset]
Before you can use the files located on your own filesystem,
you have to mount the directory containing the files.
.
:PROGRAM_INTRO_MOUNT_WINDOWS
[bgcolor=blue][color=white]╔═════════════════════════════════════════════════════════════════════════╗
║ [color=light-green]mount c c:\dosgames\ [color=white]will create a C drive with c:\dosgames as contents.║
║ ║
║ [color=light-green]c:\dosgames\ [color=white]is an example. Replace it with your own games directory. ║
╚═════════════════════════════════════════════════════════════════════════╝[reset]
.
:PROGRAM_INTRO_MOUNT_OTHER
[bgcolor=blue][color=white]╔══════════════════════════════════════════════════════════════════════╗
║ [color=light-green]mount c ~/dosgames[color=white] will create a C drive with ~/dosgames as contents.║
║ ║
║ [color=light-green]~/dosgames[color=white] is an example. Replace it with your own games directory. ║
╚══════════════════════════════════════════════════════════════════════╝[reset]
.
:PROGRAM_INTRO_MOUNT_END
After successfully mounting the disk you can type [color=light-blue]c:[reset] to go to your freshly
mounted C-drive. Typing [color=light-blue]dir[reset] there will show its contents. [color=light-blue]cd[reset] will allow you to
enter a directory (recognised by the [color=yellow][][reset] in a directory listing).
You can run programs/files with extensions [color=red].exe .bat[reset] and [color=red].com[reset].
.
:PROGRAM_INTRO_CDROM_WINDOWS
[erases=entire][color=light-green]How to mount a real/virtual CD-ROM Drive in DOSBox:[reset]
The [color=light-blue]mount[reset] command works on all normal directories. It installs MSCDEX and marks
the files as read-only.
Usually this is enough for most games:
[color=light-blue]mount D C:\example -t cdrom[reset]
If it doesn't work you might have to tell DOSBox the label of the CD-ROM:
[color=light-blue]mount D C:\example -t cdrom -label CDLABEL[reset]
Additionally, you can use [color=light-blue]imgmount[reset] to mount ISO or CUE/BIN images:
[color=light-blue]imgmount D C:\cd.iso -t cdrom[reset]
[color=light-blue]imgmount D C:\cd.cue -t cdrom[reset]
.
:PROGRAM_INTRO_CDROM_OTHER
[erases=entire][color=light-green]How to mount a real/virtual CD-ROM Drive in DOSBox:[reset]
The [color=light-blue]mount[reset] command works on all normal directories. It installs MSCDEX and marks
the files as read-only.
Usually this is enough for most games:
[color=light-blue]mount D ~/example -t cdrom[reset]
If it doesn't work you might have to tell DOSBox the label of the CD-ROM:
[color=light-blue]mount D ~/example -t cdrom -label CDLABEL[reset]
Additionally, you can use [color=light-blue]imgmount[reset] to mount ISO or CUE/BIN images:
[color=light-blue]imgmount D ~/cd.iso -t cdrom[reset]
[color=light-blue]imgmount D ~/cd.cue -t cdrom[reset]
.
:PROGRAM_INTRO_SPECIAL
[erases=entire][color=light-green]Special keys:[reset]
These are the default keybindings.
They can be changed in the [color=brown]keymapper[reset].
[color=yellow]%s+Enter[reset] Switch between fullscreen and window mode.
[color=yellow]%s+Pause[reset] Pause/Unpause emulator.
[color=yellow]%s+F1[reset] %s Start the [color=brown]keymapper[reset].
[color=yellow]%s+F4[reset] %s Swap mounted disk image, scan for changes on all drives.
[color=yellow]%s+F5[reset] Save a screenshot of the rendered image.
[color=yellow]%s+F5[reset] %s Save a screenshot of the DOS pre-rendered image.
[color=yellow]%s+F6[reset] %s Start/Stop recording sound output to a wave file.
[color=yellow]%s+F7[reset] %s Start/Stop recording video output to a zmbv file.
[color=yellow]%s+F8[reset] %s Mute/Unmute the audio.
[color=yellow]%s+F9[reset] %s Shutdown emulator.
[color=yellow]%s+F10[reset] %s Capture/Release the mouse.
[color=yellow]%s+F11[reset] %s Slow down emulation.
[color=yellow]%s+F12[reset] %s Speed up emulation.
[color=yellow]%s+F12[reset] Unlock speed (turbo button/fast forward).
.
:PROGRAM_KEYB_INFO
Codepage %i has been loaded.
.
:PROGRAM_KEYB_INFO_LAYOUT
Codepage %i has been loaded for layout %s.
.
:PROGRAM_KEYB_HELP_LONG
Configure a keyboard for a specific language.
Usage:
[color=light-green]keyb[reset] [color=light-cyan][LANGCODE][reset]
[color=light-green]keyb[reset] [color=light-cyan]LANGCODE[reset] [color=white]CODEPAGE[reset] [color=white][CODEPAGEFILE][reset]
Parameters:
[color=light-cyan]LANGCODE[reset] language code or keyboard layout ID
[color=white]CODEPAGE[reset] code page number, such as [color=white]437[reset] and [color=white]850[reset]
[color=white]CODEPAGEFILE[reset] file containing information for a code page
Notes:
Running [color=light-green]keyb[reset] without an argument shows the currently loaded keyboard layout
and code page. It will change to [color=light-cyan]LANGCODE[reset] if provided, optionally with a
[color=white]CODEPAGE[reset] and an additional [color=white]CODEPAGEFILE[reset] to load the specified code page
number and code page file if provided. This command is especially useful if
you use a non-US keyboard, and [color=light-cyan]LANGCODE[reset] can also be set in the configuration
file under the [dos] section using the "keyboardlayout = [color=light-cyan]LANGCODE[reset]" setting.
Examples:
[color=light-green]KEYB[reset]
[color=light-green]KEYB[reset] [color=light-cyan]uk[reset]
[color=light-green]KEYB[reset] [color=light-cyan]sp[reset] [color=white]850[reset]
[color=light-green]KEYB[reset] [color=light-cyan]de[reset] [color=white]858[reset] mycp.cpi
.
:PROGRAM_KEYB_NOERROR
Keyboard layout %s loaded for codepage %i.
.
:PROGRAM_KEYB_FILENOTFOUND
Keyboard file %s not found.
.
:PROGRAM_KEYB_INVALIDFILE
Keyboard file %s invalid.
.
:PROGRAM_KEYB_LAYOUTNOTFOUND
No layout in %s for codepage %i.
.
:PROGRAM_KEYB_INVCPFILE
None or invalid codepage file for layout %s.
.
:PROGRAM_LOADFIX_HELP_LONG
Load a program in the specific memory region and then run it.
Usage:
[color=light-green]loadfix[reset] [color=white][-SIZE][reset] [color=light-cyan]GAME[reset] [color=white][PARAMETERS][reset]
[color=light-green]loadfix[reset] [/d] (or [/f])[reset]
Parameters:
[color=light-cyan]GAME[reset] game or program to load, optionally with parameters
[color=white]-SIZE[reset] SIZE indicates the number of kilobytes to be allocated
/d (or /f) Frees the previously allocated memory.
Notes:
- The most common use case of this command is to fix games such as
California Games II and Wing Commander 2 that show [color=white]"Packed File Corrupt"[reset]
or [color=white]"Not enough memory"[reset] error messages.
- Running [color=light-green]loadfix[reset] without an argument simply allocates memory for your game
to run; you can free the memory with either /d or /f option when it
finishes.
Examples:
[color=light-green]loadfix[reset] [color=light-cyan]wc2[reset]
[color=light-green]loadfix[reset] [color=white]-32[reset] [color=light-cyan]wc2[reset]
[color=light-green]loadfix[reset] [color=white]-128[reset]
[color=light-green]loadfix[reset] /d
.
:PROGRAM_LOADFIX_ALLOC
%d kB allocated.
.
:PROGRAM_LOADFIX_DEALLOC
%d kB freed.
.
:PROGRAM_LOADFIX_DEALLOCALL
Used memory freed.
.
:PROGRAM_LOADFIX_ERROR
Memory allocation error.
.
:PROGRAM_LOADROM_HELP_LONG
Load a ROM image of the video BIOS or IBM BASIC.
Usage:
[color=light-green]loadrom [color=light-cyan]IMAGEFILE[reset]
Parameters:
[color=light-cyan]IMAGEFILE[reset] video BIOS or IBM BASIC ROM image
Notes:
After loading an IBM BASIC ROM image into the emulated ROM with the command,
you can run the original IBM BASIC interpreter program in DOSBox Staging.
Examples:
[color=light-green]loadrom[reset] [color=light-cyan]bios.rom[reset]
.
:PROGRAM_LOADROM_SPECIFY_FILE
Must specify ROM file to load.
.
:PROGRAM_LOADROM_CANT_OPEN
ROM file not accessible.
.
:PROGRAM_LOADROM_TOO_LARGE
ROM file too large.
.
:PROGRAM_LOADROM_INCOMPATIBLE
Video BIOS not supported by machine type.
.
:PROGRAM_LOADROM_UNRECOGNIZED
ROM file not recognized.
.
:PROGRAM_LOADROM_BASIC_LOADED
BASIC ROM loaded.
.
:PROGRAM_LS_UNHANDLED_WILDCARD_PATTERN
Unhandled wildcard pattern - '%s'
.
:PROGRAM_LS_HELP_LONG
Display directory contents in wide list format.
Usage:
[color=light-green]ls[reset] [[color=light-cyan]PATTERN[reset] [[color=light-cyan]PATTERN[reset], ...]] [[color=light-cyan]PATH[reset] [[color=light-cyan]PATH[reset], ...]] [/a]
Parameters:
[color=light-cyan]PATTERN[reset] either an exact filename or an inexact filename with wildcards, which
are the asterisk (*) and the question mark (?)
[color=light-cyan]PATH[reset] exact path in a mounted DOS drive to list contents
/a list all files and directories, including hidden and system
Notes:
The command will list directories in [color=light-blue]blue[reset], executable DOS programs
(*.com, *.exe, *.bat) in [color=light-green]green[reset], and other files in the normal color.
Examples:
[color=light-green]ls[reset] [color=light-cyan]file.txt[reset]
[color=light-green]ls[reset] [color=light-cyan]c*.ba?[reset]
.
:PROGRAM_MEM_HELP_LONG
Display the DOS memory information.
Usage:
[color=light-green]mem[reset]
Parameters:
This command has no parameters.
Notes:
This command shows the DOS memory status, including the free conventional
memory, UMB (upper) memory, XMS (extended) memory, and EMS (expanded) memory.
Examples:
[color=light-green]mem[reset]
.
:PROGRAM_MEM_CONVEN
%10d KB free conventional memory
.
:PROGRAM_MEM_EXTEND
%10d KB free extended memory
.
:PROGRAM_MEM_EXPAND
%10d KB free expanded memory
.
:PROGRAM_MEM_UPPER
%10d KB free upper memory in %d blocks (largest UMB %d KB)
.
:SHELL_CMD_MIXER_HELP_LONG
Display or change the sound mixer settings.
Usage:
[color=light-green]mixer[reset] [color=light-cyan][CHANNEL][reset] [color=white]COMMANDS[reset] [/noshow]
[color=light-green]mixer[reset] [/listmidi]
Parameters:
[color=light-cyan]CHANNEL[reset] mixer channel to change the settings of
[color=white]COMMANDS[reset] one or more of the following commands:
Volume: Percentage volume of [color=white]0[reset] to [color=white]9999[reset], or decibel volume prefixed
with [color=white]d[reset] (e.g. [color=white]d-7.5[reset]). Use [color=white]L:R[reset] to set the left and right
volumes of stereo channels separately (e.g. [color=white]10:20[reset], [color=white]150:d6[reset]).
Stereo mode: [color=white]stereo[reset], or [color=white]reverse[reset] (stereo channels only).
Crossfeed: [color=white]x0[reset] to [color=white]x100[reset], set crossfeed strength (stereo channels only).
Reverb: [color=white]r0[reset] to [color=white]r100[reset], set reverb level.
Chorus: [color=white]c0[reset] to [color=white]c100[reset], set chorus level.
Notes:
- Run [color=light-green]mixer[reset] without arguments to view the current settings.
- Run [color=light-green]mixer[reset] /listmidi to list all available MIDI devices.
- You may change the settings of more than one channel in a single command.
- If no channel is specified, you can set crossfeed, reverb, or chorus
of all channels globally.
- The /noshow option applies the changes without showing the mixer settings.
Examples:
[color=light-green]mixer[reset] [color=light-cyan]cdaudio[reset] [color=white]50[reset] [color=light-cyan]sb[reset] [color=white]reverse[reset] /noshow
[color=light-green]mixer[reset] [color=white]x30[reset] [color=light-cyan]master[reset] [color=white]40[reset] [color=light-cyan]opl[reset] [color=white]150 r50 c30[reset] [color=light-cyan]sb[reset] [color=white]x10[reset]
.
:SHELL_CMD_MIXER_HEADER_LAYOUT
%-22s %4.0f:%-4.0f %+6.2f:%-+6.2f %-8s %5s %7s %7s
.
:SHELL_CMD_MIXER_HEADER_LABELS
[color=white]Channel Volume Volume (dB) Mode Xfeed Reverb Chorus[reset]
.
:SHELL_CMD_MIXER_CHANNEL_OFF
off
.
:SHELL_CMD_MIXER_CHANNEL_STEREO
Stereo
.
:SHELL_CMD_MIXER_CHANNEL_REVERSE
Reverse
.
:SHELL_CMD_MIXER_CHANNEL_MONO
Mono
.
:SHELL_CMD_MIXER_INACTIVE_CHANNEL
Channel [color=light-cyan]%s[reset] is not active
.
:SHELL_CMD_MIXER_INVALID_GLOBAL_COMMAND
Invalid global command: [color=white]%s[reset]
.
:SHELL_CMD_MIXER_INVALID_VOLUME_COMMAND
Invalid volume for the [color=light-cyan]%s[reset] channel: [color=white]%s[reset] (run MIXER /? for help)
.
:SHELL_CMD_MIXER_INVALID_CROSSFEED_STRENGTH
Invalid crossfeed strength for the [color=light-cyan]%s[reset] channel: [color=white]%s[reset]
(must be between 0 and 100)
.
:SHELL_CMD_MIXER_INVALID_CHORUS_LEVEL
Invalid chorus level for the [color=light-cyan]%s[reset] channel: [color=white]%s[reset]
(must be between 0 and 100)
.
:SHELL_CMD_MIXER_INVALID_REVERB_LEVEL
Invalid reverb level for the [color=light-cyan]%s[reset] channel: [color=white]%s[reset]
(must be between 0 and 100)
.
:SHELL_CMD_MIXER_MISSING_CROSSFEED_STRENGTH
Missing crossfeed strength after [color=white]x[reset] for the [color=light-cyan]%s[reset] channel
(must be between 0 and 100)
.
:SHELL_CMD_MIXER_MISSING_CHORUS_LEVEL
Missing chorus level after [color=white]c[reset] for the [color=light-cyan]%s[reset] channel
(must be between 0 and 100)
.
:SHELL_CMD_MIXER_MISSING_REVERB_LEVEL
Missing reverb level after [color=white]r[reset] for the [color=light-cyan]%s[reset] channel
(must be between 0 and 100)
.
:SHELL_CMD_MIXER_INVALID_GLOBAL_CROSSFEED_STRENGTH
Invalid global crossfeed strength [color=white]%s[reset] (must be between 0 and 100)
.
:SHELL_CMD_MIXER_INVALID_GLOBAL_CHORUS_LEVEL
Invalid global chorus level [color=white]%s[reset] (must be between 0 and 100)
.
:SHELL_CMD_MIXER_INVALID_GLOBAL_REVERB_LEVEL
Invalid global reverb level [color=white]%s[reset] (must be between 0 and 100)
.
:SHELL_CMD_MIXER_MISSING_GLOBAL_CROSSFEED_STRENGTH
Missing global crossfeed strength after [color=white]x[reset] (must be between 0 and 100)
.
:SHELL_CMD_MIXER_MISSING_GLOBAL_CHORUS_LEVEL
Missing global chorus level after [color=white]c[reset] (must be between 0 and 100)
.
:SHELL_CMD_MIXER_MISSING_GLOBAL_REVERB_LEVEL
Missing global reverb level after [color=white]r[reset] (must be between 0 and 100)
.
:SHELL_CMD_MIXER_MISSING_CHANNEL_COMMAND
Missing command for the [color=light-cyan]%s[reset] channel
.
:SHELL_CMD_MIXER_INVALID_CHANNEL_COMMAND
Invalid command for the [color=light-cyan]%s[reset] channel: [color=white]%s[reset]
.
:PROGRAM_MODE_HELP_LONG
Set the display mode or the keyboard's typematic rate.
Usage:
[color=light-green]mode[reset] [color=white]COLSxLINES[reset]
[color=light-green]mode[reset] [color=white]COLS,LINES[reset]
[color=light-green]mode[reset] rate=[color=white]RATE[reset] delay=[color=white]DELAY[reset]
Parameters:
[color=white]COLS[reset] number of characters (columns) per line (40, 80, or 132)
[color=white]LINES[reset] number of lines on the screen (25, 28, 30, 34, 43, 50, or 60)
[color=white]RATE[reset] key repeat rate, from [color=white]1[reset] to [color=white]32[reset] (1 = slowest, 32 = fastest)
[color=white]DELAY[reset] key repeat delay, from [color=white]1[reset] to [color=white]4[reset] (1 = shortest, 4 = longest)
Notes:
- Valid [color=white]COLSxLINES[reset] combinations per graphics adapter type:
Hercules 80x25
CGA, PCjr, Tandy 40x25, 80x25
EGA 40x25, 80x25, 80x43
SVGA (non-S3) 40x25, 80x25, 80x28, 80x30, 80x34, 80x43, 80x50
SVGA (S3) 40x25, all 80 and 132-column modes
Examples:
[color=light-green]mode[reset] [color=white]132x50
[color=light-green]mode[reset] [color=white]80x43[reset]
[color=light-green]mode[reset] rate=[color=white]32[reset] delay=[color=white]1[reset]
.
:PROGRAM_MODE_INVALID_DISPLAY_MODE
Invalid display mode: [color=white]%s[reset]
.
:PROGRAM_MODE_UNSUPPORTED_DISPLAY_MODE
Display mode [color=white]%s[reset] is not supported on this graphics adapter.
.
:PROGRAM_MODE_INVALID_TYPEMATIC_RATE
Invalid typematic rate setting.
.
:PROGRAM_MORE_HELP_LONG
Display command output or text file one screen at a time.
Usage:
[color=light-cyan]COMMAND[reset] | [color=light-green]more[reset] [/c] [/e] [/p] [[reset]/s] [/t[color=white]n[reset]] [+[color=white]nnn[reset]]
[color=light-green]more[reset] [/c] [/e] [/p] [[reset]/s] [/t[color=white]n[reset]] [+[color=white]nnn[reset]] < [color=light-cyan]FILE[reset]
[color=light-green]more[reset] [/c] [/e] [/p] [[reset]/s] [/t[color=white]n[reset]] [+[color=white]nnn[reset]] [color=light-cyan]PATTERN[reset] [[color=light-cyan]PATTERN[reset] ...]
Parameters:
[color=light-cyan]COMMAND[reset] command to display the output of
[color=light-cyan]FILE[reset] exact name of the file to display, optionally with a path
[color=light-cyan]PATTERN[reset] either a path to a single file or a path with wildcards, which are
the asterisk (*) and the question mark (?)
/c clear the screen before each file
/e extended mode, with more hotkeys available
/p expand the new page / form feed character
/s squish multiple empty lines into one
/t[color=white]n[reset] specify the tab size, 1-9, default is 8
+[color=white]nnn[reset] skip the first [color=white]nnn[reset] lines of the first file
Notes:
- This command is only for viewing text files, not binary files.
- The following hotkeys are available:
[color=yellow]Space[reset] to show the next screen.
[color=yellow]Enter[reset] to show the next line.
[color=yellow]N[reset] or [color=yellow]F[reset] to skip to the next file.
[color=yellow]Q[reset], [color=yellow]Esc[reset], [color=yellow]Ctrl+C[reset] to terminate the command.
- Also, the [color=yellow]Ctrl+C[reset] can be used to terminate the command reading data from the
keyboard input, like when [color=light-green]more[reset] is executed without any arguments.
- The following extra hotkeys are available in extended mode only:
[color=yellow]P[reset] [color=white]nnn[reset] to display the next [color=white]nnn[reset] lines and prompt again.
[color=yellow]S[reset] [color=white]nnn[reset] to skip the next [color=white]nnn[reset] lines.
[color=yellow]=[reset] to display the current line number.
- Option /p disables certain incompatible hotkeys.
Examples:
[color=light-cyan]dir /on[reset] | [color=light-green]more[reset] ; displays sorted directory one screen at a time
[color=light-green]more[reset] /t[color=white]4[reset] < [color=light-cyan]A:\MANUAL.TXT[reset] ; shows the file's content with tab size 4
.
:PROGRAM_MORE_NO_FILE
No input file found.
.
:PROGRAM_MORE_END
[reset][color=brown]--- end of input ---[reset]
.
:PROGRAM_MORE_NEW_FILE
[reset][color=brown]--- file %s ---[reset]
.
:PROGRAM_MORE_NEW_DEVICE
[reset][color=brown]--- device %s ---[reset]
.
:PROGRAM_MORE_PROMPT_SINGLE
[reset][color=brown]--- press SPACE for next page, ENTER for next line, Q to quit ---[reset]
.
:PROGRAM_MORE_PROMPT_PERCENT
[reset][color=brown]--- (%d%%) press SPACE for next page, ENTER for next line, Q to quit ---[reset]
.
:PROGRAM_MORE_PROMPT_MULTI
[reset][color=brown]--- press SPACE or ENTER for more, N for next file, Q to quit ---[reset]
.
:PROGRAM_MORE_PROMPT_SHORT
[reset][color=brown]--- more ---[reset]
.
:PROGRAM_MORE_PROMPT_SHORT_PERCENT
[reset][color=brown]--- (%d%%) more ---[reset]
.
:PROGRAM_MORE_PROMPT_LINE
[reset][color=brown]--- line %u ---[reset]
.
:PROGRAM_MORE_OPEN_ERROR
[reset][color=light-red]--- could not open %s ---[reset]
.
:PROGRAM_MORE_TERMINATE
[reset][color=brown](terminated)[reset]
.
:PROGRAM_MORE_NEXT_FILE
[reset][color=brown](next file)[reset]
.
:PROGRAM_MORE_SKIPPED
[reset][color=brown](skipped content)[reset]
.
:PROGRAM_MORE_HOW_MANY_LINES
[reset][color=brown]how many lines?[reset]
.
:PROGRAM_MOUNT_HELP
Map physical folders or drives to a virtual drive letter.
.
:PROGRAM_MOUNT_HELP_LONG
Mount a directory from the host OS to a drive letter.
Usage:
[color=light-green]mount[reset] [color=white]DRIVE[reset] [color=light-cyan]DIRECTORY[reset] [-t TYPE] [-ro] [-freesize SIZE] [-label LABEL]
[color=light-green]mount[reset] -u [color=white]DRIVE[reset] (unmounts the DRIVE's directory)
Parameters:
[color=white]DRIVE[reset] drive letter where the directory will be mounted: A, C, D, ...
[color=light-cyan]DIRECTORY[reset] directory on the host OS to mount
TYPE type of the directory to mount: dir, floppy, cdrom, or overlay
SIZE free space for the virtual drive (KB for floppies, MB otherwise)
LABEL drive label name to use
Notes:
- '-t overlay' redirects writes for mounted drive to another directory.
- '-ro' mounts the drive as read-only.
- Additional options are described in the manual (README file, chapter 4).
Examples:
.
:PROGRAM_MOUNT_HELP_LONG_WIN32
[color=light-green]mount[reset] [color=white]C[reset] [color=light-cyan]C:\dosgames[reset]
[color=light-green]mount[reset] [color=white]D[reset] [color=light-cyan]D:\ [reset]-t cdrom
[color=light-green]mount[reset] [color=white]C[reset] [color=light-cyan]my_savegame_files[reset] -t overlay
.
:PROGRAM_MOUNT_HELP_LONG_MACOSX
[color=light-green]mount[reset] [color=white]C[reset] [color=light-cyan]~/dosgames[reset]
[color=light-green]mount[reset] [color=white]D[reset] [color=light-cyan]"/Volumes/Game CD"[reset] -t cdrom
[color=light-green]mount[reset] [color=white]C[reset] [color=light-cyan]my_savegame_files[reset] -t overlay
.
:PROGRAM_MOUNT_HELP_LONG_OTHER
[color=light-green]mount[reset] [color=white]C[reset] [color=light-cyan]~/dosgames[reset]
[color=light-green]mount[reset] [color=white]D[reset] [color=light-cyan]"/media/USERNAME/Game CD"[reset] -t cdrom
[color=light-green]mount[reset] [color=white]C[reset] [color=light-cyan]my_savegame_files[reset] -t overlay
.
:PROGRAM_MOUNT_CDROMS_FOUND
CD-ROMs found: %d
.
:PROGRAM_MOUNT_ERROR_1
Directory %s doesn't exist.
.
:PROGRAM_MOUNT_ERROR_2
%s isn't a directory.
.
:PROGRAM_MOUNT_ILL_TYPE
Illegal type %s
.
:PROGRAM_MOUNT_ALREADY_MOUNTED
Drive %c already mounted with %s
.
:PROGRAM_MOUNT_UMOUNT_NOT_MOUNTED
Drive %c isn't mounted.
.
:PROGRAM_MOUNT_UMOUNT_SUCCESS
Drive %c has successfully been removed.
.
:PROGRAM_MOUNT_UMOUNT_NO_VIRTUAL
Virtual Drives can not be unMOUNTed.
.
:PROGRAM_MOUNT_DRIVEID_ERROR
'%c' is not a valid drive identifier.
.
:PROGRAM_MOUNT_WARNING_WIN
[color=light-red]Mounting c:\ is NOT recommended. Please mount a (sub)directory next time.[reset]
.
:PROGRAM_MOUNT_WARNING_OTHER
[color=light-red]Mounting / is NOT recommended. Please mount a (sub)directory next time.[reset]
.
:PROGRAM_MOUNT_NO_OPTION
Warning: Ignoring unsupported option '%s'.
.
:PROGRAM_MOUNT_OVERLAY_NO_BASE
A normal directory needs to be MOUNTed first before an overlay can be added on
top.
.
:PROGRAM_MOUNT_OVERLAY_INCOMPAT_BASE
The overlay is NOT compatible with the drive that is specified.
.
:PROGRAM_MOUNT_OVERLAY_MIXED_BASE
The overlay needs to be specified using the same addressing as the underlying
drive. No mixing of relative and absolute paths.
.
:PROGRAM_MOUNT_OVERLAY_SAME_AS_BASE
The overlay directory can not be the same as underlying drive.
.
:PROGRAM_MOUNT_OVERLAY_GENERIC_ERROR
Something went wrong.
.
:PROGRAM_MOUNT_OVERLAY_STATUS
Overlay %s on drive %c mounted.
.
:PROGRAM_MOUSECTL_HELP_LONG
Manage physical and logical mice.
Usage:
[color=light-green]mousectl[reset] [-all]
[color=light-green]mousectl[reset] [color=white]INTERFACE[reset] -map [color=light-cyan]NAME[reset]
[color=light-green]mousectl[reset] [color=white]INTERFACE[reset] [[color=white]INTERFACE[reset] ...] -map
[color=light-green]mousectl[reset] [[color=white]INTERFACE[reset] ...] -unmap | -on | -off | -reset
[color=light-green]mousectl[reset] [[color=white]INTERFACE[reset] ...] -s | -sx | -sy [sensitivity]
[color=light-green]mousectl[reset] [[color=white]INTERFACE[reset] ...] -s sensitivity_x sensitivity_y
[color=light-green]mousectl[reset] [[color=white]INTERFACE[reset] ...] -r [min_rate]
Parameters:
[color=white]INTERFACE[reset] one of [color=white]DOS[reset], [color=white]PS/2[reset], [color=white]COM1[reset], [color=white]COM2[reset], [color=white]COM3[reset], [color=white]COM4[reset]
-map -unmap map/unmap physical mouse, honoring DOS wildcards in [color=light-cyan]NAME[reset]
-s -sx -sy set sensitivity / for x axis / for y axis, from -999 to +999
-r set minimum mouse sampling rate
-on -off enable or disables mouse on the given interface
-reset restore default mouse settings
Notes:
- If sensitivity or rate is omitted, it is reset to default value.
- Mouse sensitivity set in the configuration file acts as global scale factor,
per-interface sensitivity set by this commands works on top of that.
Examples:
[color=light-green]mousectl[reset] [color=white]DOS[reset] [color=white]COM1[reset] -map ; asks user to select mice for a two player game
.
:PROGRAM_MOUSECTL_SYNTAX_PATTERN
Incorrect syntax, only ASCII characters allowed in pattern.
.
:PROGRAM_MOUSECTL_SYNTAX_SENSITIVITY
Incorrect syntax, sensitivity needs to be in -999 to +999 range.
.
:PROGRAM_MOUSECTL_SYNTAX_DUPLICATED
Incorrect syntax, duplicated mouse interfaces.
.
:PROGRAM_MOUSECTL_SYNTAX_MIN_RATE
Incorrect syntax, sampling rate has to be one of:
%s
.
:PROGRAM_MOUSECTL_MAPPING_NO_MOUSE
Mapping not available in no-mouse mode.
.
:PROGRAM_MOUSECTL_MAPPING_BLOCKED_BY_DRIVER
Mapping not possible with current guest mouse driver.
.
:PROGRAM_MOUSECTL_NO_INTERFACES
No mouse interfaces available.
.
:PROGRAM_MOUSECTL_MISSING_INTERFACES
Mouse interface not available.
.
:PROGRAM_MOUSECTL_NO_PHYSICAL_MICE
No physical mice detected.
.
:PROGRAM_MOUSECTL_NO_MATCH
No available mouse found matching the pattern.
.
:PROGRAM_MOUSECTL_TABLE_HEADER1
[color=white]Interface Sensitivity Rate (Hz) Status[reset]
.
:PROGRAM_MOUSECTL_TABLE_LAYOUT1
[color=light-cyan]%-4s[reset] X:%+.3d Y:%+.3d %1s %3s %s
.
:PROGRAM_MOUSECTL_TABLE_HEADER2
[color=white]Interface Mouse Name[reset]
.
:PROGRAM_MOUSECTL_TABLE_LAYOUT2
[color=light-cyan]%-4s[reset] %s
.
:PROGRAM_MOUSECTL_TABLE_LAYOUT2_UNMAPPED
not mapped %s
.
:PROGRAM_MOUSECTL_TABLE_STATUS_HOST
uses system pointer
.
:PROGRAM_MOUSECTL_TABLE_STATUS_MAPPED
mapped physical mouse
.
:PROGRAM_MOUSECTL_TABLE_STATUS_DISCONNECTED
[color=light-red]mapped mouse disconnected[reset]
.
:PROGRAM_MOUSECTL_TABLE_STATUS_DISABLED
disabled
.
:PROGRAM_MOUSECTL_TABLE_HINT_RATE_COM
Sampling rates for mice on [color=light-cyan]COM[reset] interfaces are estimations only.
.
:PROGRAM_MOUSECTL_TABLE_HINT_RATE_MIN
Sampling rates with minimum value set are marked with '*'.
.
:PROGRAM_MOUSECTL_MAP_ADVICE
Click [color=white]left[reset] mouse button to map the physical mouse to the interface. Clicking
any other button cancels the mapping and assigns system pointer to all the
mouse interfaces.
.
:PROGRAM_MOUSECTL_MAP_CANCEL
(mapping cancelled)
.
:PROGRAM_MOUSECTL_MAP_HINT
Seamless mouse integration is always disabled while mapping is in effect
and mapped mice always receive raw input events.
.
:PROGRAM_RESCAN_HELP_LONG
Scan for changes on mounted DOS drives.
Usage:
[color=light-green]rescan[reset] [color=light-cyan]DRIVE[reset]
[color=light-green]rescan[reset] [/a]
Parameters:
[color=light-cyan]DRIVE[reset] drive to scan for changes
Notes:
- Running [color=light-green]rescan[reset] without an argument scans for changes of the current drive.
- Changes to this drive made on the host will then be reflected inside DOS.
- You can also scan for changes on all mounted drives with the /a option.
Examples:
[color=light-green]rescan[reset] [color=light-cyan]c:[reset]
[color=light-green]rescan[reset] /a
.
:PROGRAM_RESCAN_SUCCESS
Drive re-scanned.
.
:PROGRAM_SERIAL_HELP_LONG
Manage the serial ports.
Usage:
[color=light-green]serial[reset] [color=white][PORT#][reset] List all or specified ([color=white]1[reset], [color=white]2[reset], [color=white]3[reset], or [color=white]4[reset]) ports.
[color=light-green]serial[reset] [color=white]PORT#[reset] [color=light-cyan]DEVICE[reset] [settings] Attach specified device to the given port.
Parameters:
[color=light-cyan]DEVICE[reset] one of: [color=light-cyan]MODEM[reset], [color=light-cyan]NULLMODEM[reset], [color=light-cyan]MOUSE[reset], [color=light-cyan]DIRECT[reset], [color=light-cyan]DUMMY[reset], or [color=light-cyan]DISABLED[reset]
Optional settings for each [color=light-cyan]DEVICE[reset]:
For [color=light-cyan]MODEM[reset] : IRQ, LISTENPORT, SOCK
For [color=light-cyan]NULLMODEM[reset] : IRQ, SERVER, RXDELAY, TXDELAY, TELNET, USEDTR, TRANSPARENT,
PORT, INHSOCKET, SOCK
For [color=light-cyan]MOUSE[reset] : IRQ, RATE (NORMAL or SMOOTH), TYPE (2BTN, 3BTN, WHEEL, MSM,
2BTN+MSM, 3BTN+MSM, or WHEEL+MSM)
For [color=light-cyan]DIRECT[reset] : IRQ, REALPORT (required), RXDELAY
For [color=light-cyan]DUMMY[reset] : IRQ
Examples:
[color=light-green]SERIAL[reset] [color=white]1[reset] [color=light-cyan]NULLMODEM[reset] PORT:1250 : Listen on TCP:1250 as server
[color=light-green]SERIAL[reset] [color=white]2[reset] [color=light-cyan]NULLMODEM[reset] SERVER:10.0.0.6 PORT:1250 : Connect to TCP:1250 as client
[color=light-green]SERIAL[reset] [color=white]3[reset] [color=light-cyan]MODEM[reset] LISTENPORT:5000 SOCK:1 : Listen on UDP:5000 as server
[color=light-green]SERIAL[reset] [color=white]4[reset] [color=light-cyan]DIRECT[reset] REALPORT:ttyUSB0 : Use a physical port on Linux
[color=light-green]SERIAL[reset] [color=white]1[reset] [color=light-cyan]MOUSE[reset] TYPE:MSM : Mouse Systems mouse
.
:PROGRAM_SERIAL_SHOW_PORT
COM%d: %s %s
.
:PROGRAM_SERIAL_BAD_PORT
Must specify a numeric port value between 1 and %d, inclusive.
.
:PROGRAM_SERIAL_BAD_TYPE
Type must be one of the following:
.
:PROGRAM_SERIAL_INDENTED_LIST
%s
.
:PROGRAM_SETVER_HELP_LONG
Display or set the DOS version reported to applications.
Usage:
[color=light-green]setver[reset] \[/b] [/p]
[color=light-green]setver[reset] [color=light-cyan]FILE[reset] [color=light-cyan]VERSION[reset] [/q]
[color=light-green]setver[reset] [color=light-cyan]FILE[reset] /d [/q]
[color=light-green]setver[reset] [color=light-cyan]VERSION[reset] /g [/q]
[color=light-green]setver[reset] /d /g [/q]
[color=light-green]setver[reset] /d /all [/q]
Parameters:
[color=light-cyan]FILE[reset] file (optionally with path) to apply the settings to
[color=light-cyan]VERSION[reset] DOS version, in [color=white]n[reset].[color=white]nn[reset], [color=white]n[reset].[color=white]n[reset] or [color=white]n[reset] format
/g global setting, applied to all executables
/d delete entry from version table
/all together with /d clears the whole version table
/b display the list in a batch file format
/p display one page a time
/q quiet, skip confirmation messages
/delete and /quiet have same meaning as /d and /q, respectively
Notes:
For persistent version table, specify storage in the configuration file under
the [dos] section, using the 'setver_table_file = [color=light-cyan]STORAGE[reset]' setting.
Examples:
[color=light-green]setver[reset] /b ; displays settings as a batch file
[color=light-green]setver[reset] [color=light-cyan]RETRO.COM[reset] [color=white]6[reset].[color=white]22[reset] ; reports DOS version 6.22 for every RETRO.COM file
[color=light-green]setver[reset] [color=light-cyan]RETRO.COM[reset] /d ; stop overriding DOS version reported
.
:PROGRAM_SETVER_WRONG_TABLE
Only version table in Z:\ directory is supported.
.
:PROGRAM_SETVER_INVALID_VERSION
Invalid DOS version.
.
:PROGRAM_SETVER_TABLE_UPDATED
Version table updated.
.
:PROGRAM_SETVER_TABLE_CLEARED
Version table cleared.
.
:PROGRAM_SETVER_TABLE_ALREADY_EMPTY
Version table already empty.
.
:PROGRAM_SETVER_TABLE_ENTRY_REMOVED
Entry removed from version table.
.
:PROGRAM_SETVER_TABLE_ENTRY_NOT_FOUND
Entry not found in version table.
.
:PROGRAM_SETVER_TABLE_EMPTY
Version table is empty.
.
:PROGRAM_SETVER_GLOBAL
Global reported version
.
:PROGRAM_SETVER_BATCH_GLOBAL
rule for every executable
.
:PROGRAM_SETVER_BATCH_BY_FILE_NAME
rules for matching by file name only
.
:PROGRAM_SETVER_BATCH_BY_FILE_PATH
rules for matching by file name with path
.
:PROGRAM_TREE_HELP_LONG
Display directory tree in a graphical form.
Usage:
[color=light-green]tree[reset] [color=light-cyan][DIRECTORY][reset] [/a] \[/b] [/f] [/p] [/da] [/df] [/dh] [/o[color=white]ORDER[reset]]
Parameters:
[color=light-cyan]DIRECTORY[reset] name of the directory to display
[color=white]ORDER[reset] listing order, one of:
[color=white]n[reset] (by name, alphabetic),
[color=white]s[reset] (by size, smallest first),
[color=white]e[reset] (by extension, alphabetic),
[color=white]d[reset] (by date/time, oldest first),
with an optional [color=white]-[reset] prefix to reverse order
/a use only 7-bit ASCII characters
/b brief display, omit header and footer information
/f also display files
/p display one page a time, shorten output to fit screen width
/da display attributes
/df display size for files
/dh also display hidden and system files/directories
/o[color=white]ORDER[reset] order the list (see above)
Notes:
If [color=light-cyan]DIRECTORY[reset] is omitted, the current directory is used.
Examples:
[color=light-green]tree[reset] ; displays directory tree starting from current directory
[color=light-green]tree[reset] [color=light-cyan]C:[reset] /f ; displays C: drive content recursively, with files
.
:PROGRAM_TREE_DIRECTORY
Directory tree for volume %s
.
:PROGRAM_TREE_TOO_MANY_FILES_SUBDIRS
Too many files or subdirectories.
.
:PROGRAM_FMPDRV_HELP_LONG
Load or unload the built-in ReelMagic Full Motion Player driver.
Usage:
[color=light-green]fmpdrv[reset] (load the driver)
[color=light-green]fmpdrv[reset] /u (unload the driver)
Notes:
The "reelmagic = on" configuration setting loads the
driver on startup and prevents it from being unloaded.
.
:PROGRAM_FMPDRV_TITLE
ReelMagic Full Motion Player Driver (built-in) %hhu.%hhu
.
:PROGRAM_FMPDRV_LOADED
[reset][color=brown]Loaded at interrupt %xh[reset]
.
:PROGRAM_FMPDRV_LOAD_FAILED_ALREADY_LOADED
[reset][color=brown]Already loaded at interrupt %xh[reset]
.
:PROGRAM_FMPDRV_LOAD_FAILED_INT_CONFLICT
[reset][color=light-red]Not loaded: No free interrupts![reset]
.
:PROGRAM_FMPDRV_UNLOADED
[reset][color=brown]Driver unloaded[reset]
.
:PROGRAM_FMPDRV_UNLOAD_FAILED_NOT_LOADED
[reset][color=brown]Driver was not loaded[reset]
.
:PROGRAM_FMPDRV_UNLOAD_FAILED_BLOCKED
[reset][color=brown]Driver not unloaded: configured to stay resident[reset]
.
:AUTOEXEC_BAT_GENERATED
generated from configuration and command line
.
:AUTOEXEC_BAT_CONFIG_SECTION
from [autoexec] section
.
:SHELL_ILLEGAL_PATH
Illegal path.
.
:SHELL_ILLEGAL_FILE_NAME
Illegal filename.
.
:SHELL_ILLEGAL_SWITCH
Illegal switch: %s
.
:SHELL_ILLEGAL_SWITCH_COMBO
Illegal switch combination.
.
:SHELL_MISSING_PARAMETER
Required parameter missing.
.
:SHELL_TOO_MANY_PARAMETERS
Too many parameters.
.
:SHELL_EXPECTED_FILE_NOT_DIR
Expected a file, not a directory.
.
:SHELL_SYNTAX_ERROR
Incorrect command syntax.
.
:SHELL_ACCESS_DENIED
Access denied - '%s'
.
:SHELL_FILE_CREATE_ERROR
File creation error - '%s'
.
:SHELL_FILE_OPEN_ERROR
File open error - '%s'
.
:SHELL_FILE_NOT_FOUND
File not found - '%s'
.
:SHELL_FILE_EXISTS
File '%s' already exists.
.
:SHELL_DIRECTORY_NOT_FOUND
Directory not found - '%s'
.
:SHELL_NO_SUBDIRS_TO_DISPLAY
No subdirectories to display.
.
:SHELL_NO_FILES_SUBDIRS_TO_DISPLAY
No files or subdirectories to display.
.
:SHELL_READ_ERROR
Error reading file - '%s'
.
:SHELL_WRITE_ERROR
Error writing file - '%s'
.
:SHELL_CMD_HELP
If you want a list of all supported commands, run [color=yellow]help /all[reset]
A short list of the most often used commands:
.
:SHELL_CMD_COMMAND_HELP_LONG
Start the DOSBox Staging command shell.
Usage:
[color=light-green]command[reset]
[color=light-green]command[reset] /c (or /init) [color=light-cyan]COMMAND[reset]
Parameters:
[color=light-cyan]COMMAND[reset] DOS command, game, or program to run
Notes:
- DOSBox Staging automatically starts a DOS command shell by invoking this
command with /init option when it starts, which shows the welcome banner.
- You can load a new instance of the command shell by running [color=light-green]command[reset].
- Adding a /c option along with [color=light-cyan]COMMAND[reset] allows this command to run the
specified command (optionally with parameters) and then exit automatically.
Examples:
[color=light-green]command[reset]
[color=light-green]command[reset] /c [color=light-cyan]echo[reset] [color=white]Hello world![reset]
[color=light-green]command[reset] /init [color=light-cyan]dir[reset]
.
:SHELL_CMD_ECHO_ON
Echo is on.
.
:SHELL_CMD_ECHO_OFF
Echo is off.
.
:SHELL_CMD_CHDIR_ERROR
Unable to change to: %s
.
:SHELL_CMD_CHDIR_HINT
Hint: To change to a different drive, run [color=yellow]%c:[reset]
.
:SHELL_CMD_CHDIR_HINT_2
Directory name is longer than 8 characters and/or contains spaces.
Try [color=yellow]cd %s[reset]
.
:SHELL_CMD_CHDIR_HINT_3
You are still on drive Z:; change to a mounted drive with [color=yellow]C:[reset].
.
:SHELL_CMD_DATE_HELP
Display or change the internal date.
.
:SHELL_CMD_DATE_ERROR
The specified date is not correct.
.
:SHELL_CMD_DATE_DAYS
3SunMonTueWedThuFriSat
.
:SHELL_CMD_DATE_NOW
Current date:
.
:SHELL_CMD_DATE_SETHLP
Run [color=yellow]date %s[reset] to change the current date.
.
:SHELL_CMD_DATE_HELP_LONG
Usage:
[color=light-green]date[reset] [/t]
[color=light-green]date[reset] /h
[color=light-green]date[reset] [color=light-cyan]DATE[reset]
Parameters:
[color=light-cyan]DATE[reset] new date to set to, in the format of [color=light-cyan]%s[reset]
Notes:
Running [color=light-green]date[reset] without an argument shows the current date, or a simple date
with the /t option. You can force a date synchronization with the host system
with the /h option, or manually specify a new date to set to.
Examples:
[color=light-green]date[reset]
[color=light-green]date[reset] /h
[color=light-green]date[reset] [color=light-cyan]%s[reset]
.
:SHELL_CMD_TIME_HELP
Display or change the internal time.
.
:SHELL_CMD_TIME_ERROR
The specified time is not correct.
.
:SHELL_CMD_TIME_NOW
Current time:
.
:SHELL_CMD_TIME_SETHLP
Run [color=yellow]time %s[reset] to change the current time.
.
:SHELL_CMD_TIME_HELP_LONG
Usage:
[color=light-green]time[reset] [/t]
[color=light-green]time[reset] /h
[color=light-green]time[reset] [color=light-cyan]TIME[reset]
Parameters:
[color=light-cyan]TIME[reset] new time to set to, in the format of [color=light-cyan]%s[reset]
Notes:
Running [color=light-green]time[reset] without an argument shows the current time, or a simple time
with the /t option. You can force a time synchronization with the host system
with the /h option, or manually specify a new time to set to.
Examples:
[color=light-green]time[reset]
[color=light-green]time[reset] /h
[color=light-green]time[reset] [color=light-cyan]%s[reset]
.
:SHELL_CMD_MKDIR_ERROR
Unable to make: %s.
.
:SHELL_CMD_RMDIR_ERROR
Unable to remove: %s.
.
:SHELL_CMD_DEL_ERROR
Unable to delete: %s.
.
:SHELL_CMD_SET_NOT_SET
Environment variable '%s' not defined.
.
:SHELL_CMD_SET_OUT_OF_SPACE
Not enough environment space left.
.
:SHELL_CMD_SET_OPTION_P_UNSUPPORTED
Option /P is not supported; please use the CHOICE command.
.
:SHELL_CMD_IF_EXIST_MISSING_FILENAME
IF EXIST: Missing filename.
.
:SHELL_CMD_IF_ERRORLEVEL_MISSING_NUMBER
IF ERRORLEVEL: Missing number.
.
:SHELL_CMD_IF_ERRORLEVEL_INVALID_NUMBER
IF ERRORLEVEL: Invalid number.
.
:SHELL_CMD_GOTO_MISSING_LABEL
No label supplied to GOTO command.
.
:SHELL_CMD_GOTO_LABEL_NOT_FOUND
GOTO: Label '%s' not found.
.
:SHELL_CMD_DUPLICATE_REDIRECTION
Duplicate redirection: %s
.
:SHELL_CMD_FAILED_PIPE
Failed to create/open a temporary file for piping. Check the %%TEMP%% variable.
.
:SHELL_CMD_DIR_VOLUME
Volume in drive %c is %s
.
:SHELL_CMD_DIR_INTRO
Directory of %s
.
:SHELL_CMD_DIR_BYTES_USED
%17d file(s) %21s bytes
.
:SHELL_CMD_DIR_BYTES_FREE
%17d dir(s) %21s bytes free
.
:SHELL_EXECUTE_DRIVE_NOT_FOUND
Drive %c does not exist!
You must [color=yellow]mount[reset] it first. Run [color=yellow]intro[reset] or [color=yellow]intro mount[reset] for more information.
.
:SHELL_EXECUTE_ILLEGAL_COMMAND
Illegal command: %s
.
:SHELL_CMD_PAUSE
Press any key to continue...
.
:SHELL_CMD_PAUSE_HELP
Wait for a keystroke to continue.
.
:SHELL_CMD_PAUSE_HELP_LONG
Usage:
[color=light-green]pause[reset]
Parameters:
This command has no parameters.
Notes:
This command is especially useful in batch programs to allow a user to
continue the batch program execution with a key press. The user can press
any key on the keyboard (except for certain control keys) to continue.
Examples:
[color=light-green]pause[reset]
.
:SHELL_CMD_COPY_FAILURE
Copy failure: %s.
.
:SHELL_CMD_COPY_SUCCESS
%d File(s) copied.
.
:SHELL_CMD_SUBST_NO_REMOVE
Unable to remove, drive not in use.
.
:SHELL_CMD_SUBST_FAILURE
SUBST failed, the target drive may already exist.
Note it is only possible to use SUBST on local drives.
.
:SHELL_STARTUP_BEGIN
[bgcolor=blue][color=white]╔════════════════════════════════════════════════════════════════════╗
║ [color=light-green]Welcome to DOSBox Staging %-40s[color=white] ║
║ ║
║ For a short introduction for new users type: [color=yellow]INTRO[color=white] ║
║ For supported shell commands type: [color=yellow]HELP[color=white] ║
║ ║
║ To adjust the emulated CPU speed, use [color=light-red]%s+F11[color=white] and [color=light-red]%s+F12[color=white].%s%s ║
║ To activate the keymapper [color=light-red]%s+F1[color=white].%s ║
║ For more information read the [color=light-cyan]README[color=white] file in the DOSBox directory. ║
║ ║
.
:SHELL_STARTUP_CGA
║ DOSBox supports Composite CGA mode. ║
║ Use [color=light-red]F12[color=white] to set composite output ON, OFF, or AUTO (default). ║
║ [color=light-red]F10[color=white] selects the CGA settings to change and [color=light-red](%s+)F11[color=white] changes it. ║
║ ║
.
:SHELL_STARTUP_CGA_MONO
║ Use [color=light-red]F11[color=white] to cycle through green, amber, white and paper-white mode, ║
║ and [color=light-red]%s+F11[color=white] to change contrast/brightness settings. ║
║ ║
.
:SHELL_STARTUP_HERC
║ Use [color=light-red]F11[color=white] to cycle through white, amber, and green monochrome color. ║
║ ║
.
:SHELL_STARTUP_DEBUG
║ Press [color=light-red]%s+Pause[color=white] to enter the debugger or start the exe with [color=yellow]DEBUG[color=white]. ║
║ ║
.
:SHELL_STARTUP_END
║ [color=yellow]https://www.dosbox-staging.org[color=white] ║
╚════════════════════════════════════════════════════════════════════╝[reset]
.
:SHELL_STARTUP_SUB
[color=light-green]dosbox-staging %s[reset]
.
:SHELL_CMD_CHDIR_HELP
Display or change the current directory.
.
:SHELL_CMD_CHDIR_HELP_LONG
Usage:
[color=light-green]cd[reset] [color=light-cyan]DIRECTORY[reset]
[color=light-green]chdir[reset] [color=light-cyan]DIRECTORY[reset]
Parameters:
[color=light-cyan]DIRECTORY[reset] name of the directory to change to
Notes:
Running [color=light-green]cd[reset] without an argument displays the current directory.
With [color=light-cyan]DIRECTORY[reset] the command only changes the directory, not the current drive.
Examples:
[color=light-green]cd[reset]
[color=light-green]cd[reset] [color=light-cyan]mydir[reset]
.
:SHELL_CMD_CLS_HELP
Clear the DOS screen.
.
:SHELL_CMD_CLS_HELP_LONG
Usage:
[color=light-green]cls[reset]
Parameters:
This command has no parameters.
Notes:
Running [color=light-green]cls[reset] clears all text on the DOS screen, except for the command
prompt (e.g., [color=white]Z:\>[reset] or [color=white]C:\GAMES>[reset]) on the top-left corner of the screen.
Examples:
[color=light-green]cls[reset]
.
:SHELL_CMD_DIR_HELP
Display a list of files and subdirectories in a directory.
.
:SHELL_CMD_DIR_HELP_LONG
Usage:
[color=light-green]dir[reset] [color=light-cyan][PATTERN][reset] [/w] \[/b] [/p] [ad] [a-d] [/o[color=white]ORDER[reset]]
Parameters:
[color=light-cyan]PATTERN[reset] either an exact filename or an inexact filename with wildcards, which
are the asterisk (*) and the question mark (?); a path can be
specified in the pattern to list contents in the specified directory
[color=white]ORDER[reset] listing order, including [color=white]n[reset] (by name, alphabetic), [color=white]s[reset] (by size,
smallest first), [color=white]e[reset] (by extension, alphabetic), and [color=white]d[reset] (by date/time,
oldest first), with an optional [color=white]-[reset] prefix to reverse order
/w list 5 files/directories in a row; /b list the names only
/o[color=white]ORDER[reset] order the list (see above); /p pause after each screen
/ad list all directories; /a-d list all files
Notes:
Running [color=light-green]dir[reset] without an argument lists all files and subdirectories in the
current directory, which is the same as [color=light-green]dir[reset] [color=light-cyan]*.*[reset].
Examples:
[color=light-green]dir[reset] [color=light-cyan][reset]
[color=light-green]dir[reset] [color=light-cyan]games.*[reset] /p
[color=light-green]dir[reset] [color=light-cyan]c:\games\*.exe[reset] /b /o[color=white]-d[reset]
.
:SHELL_CMD_ECHO_HELP
Display messages and enable/disable command echoing.
.
:SHELL_CMD_ECHO_HELP_LONG
Usage:
[color=light-green]echo[reset] [color=light-cyan][on|off][reset]
[color=light-green]echo[reset] [color=light-cyan][MESSAGE][reset]
Parameters:
[color=light-cyan]on|off[reset] turn on/off command echoing
[color=light-cyan]MESSAGE[reset] message to display
Notes:
- Running [color=light-green]echo[reset] without an argument shows the current on or off status.
- Echo is especially useful when writing or debugging batch files.
Examples:
[color=light-green]echo[reset] [color=light-cyan]off[reset]
[color=light-green]echo[reset] [color=light-cyan]Hello world![reset]
.
:SHELL_CMD_EXIT_HELP
Exit from the DOS shell.
.
:SHELL_CMD_EXIT_HELP_LONG
Usage:
[color=light-green]exit[reset]
Parameters:
This command has no parameters.
Notes:
If you start a DOS shell from a program, running [color=light-green]exit[reset] returns to the program.
If there is no DOS program running, the command quits from DOSBox Staging.
Examples:
[color=light-green]exit[reset]
.
:SHELL_CMD_EXIT_TOO_SOON
Preventing an early 'exit' call from terminating.
.
:SHELL_CMD_HELP_HELP
Display help information for DOS commands.
.
:SHELL_CMD_HELP_HELP_LONG
Usage:
[color=light-green]help[reset]
[color=light-green]help[reset] /a[ll]
[color=light-green]help[reset] [color=light-cyan]COMMAND[reset]
Parameters:
[color=light-cyan]COMMAND[reset] name of an internal DOS command, such as [color=light-cyan]dir[reset]
Notes:
- Running [color=light-green]help[reset] without an argument displays a DOS command list.
- You can view a full list of internal commands with the /a or /all option.
- Instead of [color=light-green]help[reset] [color=light-cyan]COMMAND[reset], you can also get command help with [color=light-cyan]COMMAND[reset] /?.
Examples:
[color=light-green]help[reset] [color=light-cyan]dir[reset]
[color=light-green]help[reset] /all
.
:SHELL_CMD_MKDIR_HELP
Create a directory.
.
:SHELL_CMD_MKDIR_HELP_LONG
Usage:
[color=light-green]md[reset] [color=light-cyan]DIRECTORY[reset]
[color=light-green]mkdir[reset] [color=light-cyan]DIRECTORY[reset]
Parameters:
[color=light-cyan]DIRECTORY[reset] exact name of the directory to create
Notes:
- The directory must not exist yet.
- You can specify a path where the directory will be created.
Examples:
[color=light-green]md[reset] [color=light-cyan]newdir[reset]
[color=light-green]md[reset] [color=light-cyan]c:\games\dir[reset]
.
:SHELL_CMD_RMDIR_HELP
Remove a directory.
.
:SHELL_CMD_RMDIR_HELP_LONG
Usage:
[color=light-green]rd[reset] [color=light-cyan]DIRECTORY[reset]
[color=light-green]rmdir[reset] [color=light-cyan]DIRECTORY[reset]
Parameters:
[color=light-cyan]DIRECTORY[reset] name of the directory to remove
Notes:
The directory must be empty, with no files or subdirectories.
Examples:
[color=light-green]rd[reset] [color=light-cyan]emptydir[reset]
.
:SHELL_CMD_SET_HELP
Display or change environment variables.
.
:SHELL_CMD_SET_HELP_LONG
Usage:
[color=light-green]set[reset]
[color=light-green]set[reset] [color=white]VARIABLE[reset]=[color=light-cyan][STRING][reset]
Parameters:
[color=white]VARIABLE[reset] name of the environment variable
[color=light-cyan]STRING[reset] series of characters to assign to the variable
Notes:
- Assigning an empty string to the variable removes the variable.
- The command without a parameter displays current environment variables.
Examples:
[color=light-green]set[reset]
[color=light-green]set[reset] [color=white]name[reset]=[color=light-cyan]value[reset]
.
:SHELL_CMD_IF_HELP
Perform conditional processing in batch programs.
.
:SHELL_CMD_IF_HELP_LONG
Usage:
[color=light-green]if[reset] [color=light-magenta][not][reset] [color=light-cyan]errorlevel[reset] [color=white]NUMBER[reset] COMMAND
[color=light-green]if[reset] [color=light-magenta][not][reset] [color=white]STR1==STR2[reset] COMMAND
[color=light-green]if[reset] [color=light-magenta][not][reset] [color=light-cyan]exist[reset] [color=white]FILE[reset] COMMAND
Parameters:
[color=white]NUMBER[reset] positive integer less or equal to the desired value
[color=white]STR1==STR2[reset] compare two text strings (case-sensitive)
[color=white]FILE[reset] exact filename to check for existence
COMMAND DOS command or program to run, optionally with parameters
Notes:
- The COMMAND is run if any of the three conditions in the usage are met.
- If [color=light-magenta]not[reset] is specified, then the command runs only with the false condition.
- The [color=light-cyan]errorlevel[reset] condition is useful for checking if a programs ran correctly.
- If either [color=white]STR1[reset] or [color=white]STR2[reset] may be empty, you can enclose them in quotes (").
Examples:
[color=light-green]if[reset] [color=light-cyan]errorlevel[reset] [color=white]2[reset] dir
[color=light-green]if[reset] [color=white]"%%myvar%%"=="mystring"[reset] echo Hello world!
[color=light-green]if[reset] [color=light-magenta]not[reset] [color=light-cyan]exist[reset] [color=white]file.txt[reset] exit
.
:SHELL_CMD_GOTO_HELP
Jump to a labeled line in a batch program.
.
:SHELL_CMD_GOTO_HELP_LONG
Usage:
[color=light-green]goto[reset] [color=light-cyan]LABEL[reset]
Parameters:
[color=light-cyan]LABEL[reset] text string used in the batch program as a label
Notes:
- A label is on a line by itself, beginning with a colon (:).
- The label must be unique, and can be anywhere within the batch program.
Examples:
[color=light-green]goto[reset] [color=light-cyan]mylabel[reset]
.
:SHELL_CMD_SHIFT_HELP
Left-shift command-line parameters in a batch program.
.
:SHELL_CMD_SHIFT_HELP_LONG
Usage:
[color=light-green]shift[reset]
Parameters:
This command has no parameters.
Notes:
This command allows a DOS batch program to accept more than 9 parameters.
Running [color=light-green]shift[reset] left-shifts the batch program variable %%1 to %%0, %%2 to %%1, etc.
Examples:
[color=light-green]shift[reset]
.
:SHELL_CMD_TYPE_HELP
Display the contents of a text file.
.
:SHELL_CMD_TYPE_HELP_LONG
Usage:
[color=light-green]type[reset] [color=light-cyan]FILE[reset]
Parameters:
[color=light-cyan]FILE[reset] name of the file to display
Notes:
- The filename must be exact, optionally with a path.
- This command is only for viewing text files, not binary files.
Examples:
[color=light-green]type[reset] [color=light-cyan]text.txt[reset]
[color=light-green]type[reset] [color=light-cyan]c:\dos\readme.txt[reset]
.
:SHELL_CMD_REM_HELP
Add comments in a batch program.
.
:SHELL_CMD_REM_HELP_LONG
Usage:
[color=light-green]rem[reset] [color=light-cyan]COMMENT[reset]
Parameters:
[color=light-cyan]COMMENT[reset] any comment you want to add
Notes:
- Adding comments to a batch program can make it easier to understand.
- You can also temporarily comment out some commands with this command.
Examples:
[color=light-green]rem[reset] [color=light-cyan]This is my test batch program.[reset]
.
:SHELL_CMD_NO_WILD
This is a simple version of the command, no wildcards allowed!
.
:SHELL_CMD_RENAME_HELP
Rename one or more files.
.
:SHELL_CMD_RENAME_HELP_LONG
Usage:
[color=light-green]ren[reset] [color=white]SOURCE[reset] [color=light-cyan]DESTINATION[reset]
[color=light-green]rename[reset] [color=white]SOURCE[reset] [color=light-cyan]DESTINATION[reset]
Parameters:
[color=white]SOURCE[reset] name of the file to rename
[color=light-cyan]DESTINATION[reset] new name for the renamed file
Notes:
- The source filename must be exact, optionally with a path.
- The destination filename must be exact without a path.
Examples:
[color=light-green]ren[reset] [color=white]oldname[reset] [color=light-cyan]newname[reset]
[color=light-green]ren[reset] [color=white]c:\dos\file.txt[reset] [color=light-cyan]f.txt[reset]
.
:SHELL_CMD_DELETE_HELP
Remove one or more files.
.
:SHELL_CMD_DELETE_HELP_LONG
Usage:
[color=light-green]del[reset] [color=light-cyan]PATTERN[reset]
[color=light-green]erase[reset] [color=light-cyan]PATTERN[reset]
Parameters:
[color=light-cyan]PATTERN[reset] either an exact filename (such as [color=light-cyan]file.txt[reset]) or an inexact filename
using one or more wildcards, which are the asterisk (*) representing
any sequence of one or more characters, and the question mark (?)
representing any single character, such as [color=light-cyan]*.bat[reset] and [color=light-cyan]c?.txt[reset].
Warning:
Be careful when using a pattern with wildcards, especially [color=light-cyan]*.*[reset], as all files
matching the pattern will be deleted.
Examples:
[color=light-green]del[reset] [color=light-cyan]test.bat[reset]
[color=light-green]del[reset] [color=light-cyan]c*.*[reset]
[color=light-green]del[reset] [color=light-cyan]a?b.c*[reset]
.
:SHELL_CMD_COPY_HELP
Copy one or more files.
.
:SHELL_CMD_COPY_HELP_LONG
Usage:
[color=light-green]copy[reset] [color=white]SOURCE[reset] [color=light-cyan][DESTINATION][reset]
[color=light-green]copy[reset] [color=white]SOURCE1+SOURCE2[+...][reset] [color=light-cyan][DESTINATION][reset]
Parameters:
[color=white]SOURCE[reset] either an exact filename or an inexact filename with wildcards,
which are the asterisk (*) and the question mark (?)
[color=light-cyan]DESTINATION[reset] exact filename or directory, not containing any wildcards
Notes:
- The [color=white]+[reset] operator combines multiple source files provided to a single file.
- [color=light-cyan]DESTINATION[reset] is optional: if omitted, files are copied to the current path.
Examples:
[color=light-green]copy[reset] [color=white]source.bat[reset] [color=light-cyan]new.bat[reset]
[color=light-green]copy[reset] [color=white]file1.txt+file2.txt[reset] [color=light-cyan]file3.txt[reset]
[color=light-green]copy[reset] [color=white]..\c*.*[reset]
.
:SHELL_CMD_CALL_HELP
Start a batch program from within another batch program.
.
:SHELL_CMD_CALL_HELP_LONG
Usage:
[color=light-green]call[reset] [color=white]BATCH[reset] [color=light-cyan][PARAMETERS][reset]
Parameters:
[color=white]BATCH[reset] batch program to launch
[color=light-cyan]PARAMETERS[reset] optional parameters for the batch program
Notes:
After calling another batch program, the original batch program will resume
running after the other batch program ends.
Examples:
[color=light-green]call[reset] [color=white]mybatch.bat[reset]
[color=light-green]call[reset] [color=white]file.bat[reset] [color=light-cyan]Hello world![reset]
.
:SHELL_CMD_SUBST_HELP
Assign an internal directory to a drive.
.
:SHELL_CMD_SUBST_HELP_LONG
Usage:
[color=light-green]subst[reset] [color=white]DRIVE[reset] [color=light-cyan]PATH[reset]
[color=light-green]subst[reset] [color=white]DRIVE[reset] /d
Parameters:
[color=white]DRIVE[reset] drive to which you want to assign a path
[color=light-cyan]PATH[reset] mounted DOS path you want to assign to
Notes:
- The path must be on a drive mounted by the [color=light-green]mount[reset] command.
- You can remove an assigned drive with the /d option.
Examples:
[color=light-green]subst[reset] [color=white]d:[reset] [color=light-cyan]c:\games[reset]
[color=light-green]subst[reset] [color=white]e:[reset] [color=light-cyan]/d[reset]
.
:SHELL_CMD_LOADHIGH_HELP
Load a DOS program into upper memory.
.
:SHELL_CMD_LOADHIGH_HELP_LONG
Usage:
[color=light-green]lh[reset] [color=light-cyan]PROGRAM[reset] [color=white][PARAMETERS][reset]
[color=light-green]loadhigh[reset] [color=light-cyan]PROGRAM[reset] [color=white][PARAMETERS][reset]
Parameters:
[color=light-cyan]PROGRAM[reset] DOS TSR program to load, optionally with parameters
Notes:
This command intends to save the conventional memory by loading specified DOS
TSR programs into upper memory if possible. Such programs may be required for
some DOS games; XMS and UMB memory must be enabled (xms=true and umb=true).
Not all DOS TSR programs can be loaded into upper memory with this command.
Examples:
[color=light-green]lh[reset] [color=light-cyan]tsrapp[reset] [color=white]args[reset]
.
:SHELL_CMD_ATTRIB_HELP
Display or change file attributes.
.
:SHELL_CMD_ATTRIB_HELP_LONG
Usage:
[color=light-green]attrib[reset] [color=white][ATTRIBUTES][reset] [color=light-cyan]PATTERN[reset] [/S]
Parameters:
[color=white]ATTRIBUTES[reset] attributes to apply, including one or more of the following:
[color=white]+R[reset], [color=white]-R[reset], [color=white]+A[reset], [color=white]-A[reset], [color=white]+S[reset], [color=white]-S[reset], [color=white]+H[reset], [color=white]-H[reset]
where: R = Read-only, A = Archive, S = System, H = Hidden
[color=light-cyan]PATTERN[reset] either an exact filename or an inexact filename with wildcards,
which are the asterisk (*) and the question mark (?), or an exact
name of a directory
Notes:
- Multiple attributes can be specified in the command, separated by spaces.
- If not specified, the command shows the current file/directory attributes.
Examples:
[color=light-green]attrib[reset] [color=light-cyan]file.txt[reset]
[color=light-green]attrib[reset] [color=white]+R[reset] [color=white]-A[reset] [color=light-cyan]*.txt[reset]
.
:SHELL_CMD_ATTRIB_GET_ERROR
Unable to get attributes: %s
.
:SHELL_CMD_ATTRIB_SET_ERROR
Unable to set attributes: %s
.
:SHELL_CMD_CHOICE_HELP
Wait for a keypress and set an ERRORLEVEL value.
.
:SHELL_CMD_CHOICE_HELP_LONG
Usage:
[color=light-green]choice[reset] [color=light-cyan][TEXT][reset]
[color=light-green]choice[reset] /c[:][color=white]CHOICES[reset] /n /s /t[:][color=white]c[reset],[color=light-magenta]nn[reset] [color=light-cyan][TEXT][reset]
Parameters:
[color=light-cyan]TEXT[reset] text to display as a prompt, or empty
/c[:][color=white]CHOICES[reset] specify allowable keys, which default to [color=white]yn[reset]
/n do not display the choices at end of prompt
/s enable case-sensitive choices to be selected
/t[:][color=white]c[reset],[color=light-magenta]nn[reset] choose [color=white]c[reset] by default after [color=light-magenta]nn[reset] seconds
Notes:
This command sets an ERRORLEVEL value starting from 1 according to the
allowable keys specified in /c option, and the user input can then be checked
with the [color=light-green]if[reset] command. With /n option only the specified text will be displayed,
but not the actual choices (such as the default [color=white][Y,N]?[reset]) in the end.
Examples:
[color=light-green]choice[reset] /t:[color=white]y[reset],[color=light-magenta]2[reset] [color=light-cyan]Continue[reset]
[color=light-green]choice[reset] /c:[color=white]abc[reset] /s [color=light-cyan]Type the letter a, b, or c[reset]
.
:SHELL_CMD_CHOICE_EOF
[color=light-red]Choice failed[reset]: the input stream ended without a valid choice.
.
:SHELL_CMD_CHOICE_ABORTED
[color=yellow]Choice aborted.[reset]
.
:SHELL_CMD_PATH_HELP
Display or set a search path for executable files.
.
:SHELL_CMD_PATH_HELP_LONG
Usage:
[color=light-green]path[reset]
[color=light-green]path[reset] [color=light-cyan][[DRIVE:]PATH[;...]][reset]
Parameters:
[color=light-cyan][[DRIVE:]PATH[;...]][reset] path(s) containing a drive and directory
Notes:
- More than one path can be specified, separated by a semi-colon (;).
- Parameter with only a semi-colon (;) clears all search path settings.
- The path can also be set using the [color=light-green]set[reset] command, e.g. [color=light-green]set[reset] [color=white]path[reset]=[color=light-cyan]Z:\[reset]
Examples:
[color=light-green]path[reset]
[color=light-green]path[reset] [color=light-cyan]Z:\;C:\DOS[reset]
.
:SHELL_CMD_VER_HELP
Display the DOS version.
.
:SHELL_CMD_VER_HELP_LONG
Usage:
[color=light-green]ver[reset]
Notes:
- The DOS version can be set in the configuration file under the [dos]
section, using the 'ver = [color=light-cyan]VERSION[reset]' setting.
- The DOS version reported to applications can be changed using the [color=light-green]setver[reset]
command.
- The old '[color=light-green]ver[reset] [color=white]set[reset] [color=light-cyan]VERSION[reset]' syntax to change the DOS version is deprecated.
Examples:
[color=light-green]ver[reset]
.
:SHELL_CMD_VER_VER
DOSBox Staging version %s
DOS version %d.%02d
.
:SHELL_CMD_VER_INVALID
The specified DOS version is not correct.
.
:SHELL_CMD_VOL_HELP
Display the disk volume and serial number, if they exist.
.
:SHELL_CMD_VOL_HELP_LONG
Usage:
[color=light-green]vol[reset] [color=light-cyan][DRIVE:][reset]
Parameters:
[color=light-cyan]DRIVE[reset] drive letter followed by a colon
Notes:
Running [color=light-green]vol[reset] without an argument uses the current drive.
Examples:
[color=light-green]vol[reset]
[color=light-green]vol[reset] [color=light-cyan]c:[reset]
.
:SHELL_CMD_VOL_OUTPUT
Volume in drive %c is %s
Volume Serial Number is %04X-%04X
.
:SHELL_CMD_MOVE_HELP
Move files and rename files and directories.
.
:SHELL_CMD_MOVE_HELP_LONG
Usage:
[color=light-green]move[reset] [color=white]FILENAME1[,FILENAME2,...][reset] [color=light-cyan]DESTINATION[reset]
[color=light-green]move[reset] [color=white]DIRECTORY1[reset] [color=light-cyan]DIRECTORY2[reset]
Parameters:
[color=white]FILENAME[reset] either an exact filename or an inexact filename with wildcards,
which are the asterisk (*) and the question mark (?);
multiple, comma-separated, filenames can be provided
[color=white]DIRECTORY[reset] exact directory name, not containing any wildcards
[color=light-cyan]DESTINATION[reset] exact filename or directory, not containing any wildcards
Notes:
- If multiple source files are specified, [color=light-cyan]DESTINATION[reset] must be a directory.
If not, one will be created for you.
- If a single source file is specified, it will overwrite [color=light-cyan]DESTINATION[reset].
Examples:
[color=light-green]move[reset] [color=white]source.bat[reset] [color=light-cyan]new.bat[reset]
[color=light-green]move[reset] [color=white]file1.txt,file2.txt[reset] [color=light-cyan]mydir[reset]
.
:SHELL_CMD_MOVE_MULTIPLE_TO_SINGLE
Cannot move multiple files to a single file.
.
:SHELL_CMD_FOR_HELP
Run a specified command for each string in a set.
.
:SHELL_CMD_FOR_HELP_LONG
Usage:
[color=light-green]for[reset] [color=white]%VAR[reset] [color=light-cyan]in[reset] [color=white](SET)[reset] [color=light-cyan]do[reset] [color=white]COMMAND[reset]
Parameters:
[color=white]%VAR[reset] single character representing a variable, prefixed by a '%'
[color=light-cyan]in[reset] case-insensitive keyword
[color=white](SET)[reset] set of strings to replace [color=white]%VAR[reset] instances in [color=white]COMMAND[reset]
[color=light-cyan]do[reset] case-insensitive keyword
[color=white]COMMAND[reset] command to repeat for each string in [color=white](SET)[reset]
Notes:
- In batch files, [color=white]%VAR[reset] must be written as [color=white]%%VAR[reset] (two percent signs) instead.
- Strings in [color=white](SET)[reset] may be separated by any valid DOS separator.
- Any string in [color=white](SET)[reset] containing wildcards (* or ?) will expand to
the set of matching files in the current directory.
- Using another [color=light-green]for[reset] command as [color=white]COMMAND[reset] is not permitted.
Examples:
[color=light-green]for[reset] [color=white]%C[reset] [color=light-cyan]in[reset] [color=white](ONE TWO)[reset] [color=light-cyan]do[reset] [color=white]MKDIR[reset] [color=white]%C[reset]
[color=light-green]for[reset] [color=white]%D[reset] [color=light-cyan]in[reset] [color=white](*.TXT)[reset] [color=light-cyan]do[reset] [color=white]ECHO[reset] [color=white]%D[reset]
.
:HELP_UTIL_CATEGORY_DOSBOX
DOSBox Commands
.
:HELP_UTIL_CATEGORY_FILE
File/Directory Commands
.
:HELP_UTIL_CATEGORY_BATCH
Batch File Commands
.
:HELP_UTIL_CATEGORY_MISC
Miscellaneous Commands
.
:HELP_UTIL_CATEGORY_UNKNOWN
Unknown Command
.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment