Subversion Repositories Kolibri OS

Rev

Rev 4954 | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. DOSBox v0.74-3 Manual (always use the latest version from www.dosbox.com)
  2.  
  3.  
  4.  
  5. =====
  6. NOTE:
  7. =====
  8.  
  9. While we are hoping that one day DOSBox will run all programs ever made for
  10. the PC, we are not there yet.
  11. At present, DOSBox running on a high-end machine will roughly be the equivalent
  12. of a Pentium I PC. DOSBox can be configured to run a wide range of DOS games,
  13. from CGA/Tandy/PCjr classics up to games from the Quake era.
  14.  
  15.  
  16.  
  17. ======
  18. INDEX:
  19. ======
  20.  
  21. 1. Quickstart
  22. 2. Start (FAQ)
  23. 3. Command Line Parameters
  24. 4. Internal Programs
  25. 5. Special Keys
  26. 6. Joystick/Gamepad
  27. 7. KeyMapper
  28. 8. Keyboard Layout
  29. 9. Serial Multiplayer feature
  30. 10. How to speed up/slow down DOSBox
  31. 11. Troubleshooting
  32. 12. DOSBox Status Window
  33. 13. The configuration (options) file
  34. 14. The language file
  35. 15. Building your own version of DOSBox
  36. 16. Special thanks
  37. 17. Contact
  38.  
  39.  
  40.  
  41. ==============
  42. 1. Quickstart:
  43. ==============
  44.  
  45. Type INTRO in DOSBox for a quick tour.
  46. It is essential that you get familiar with the idea of mounting, DOSBox does not
  47. automatically make any drive (or a part of it) accessible to the emulation. See
  48. the FAQ entry "How to start?" as well as the description of the MOUNT command
  49. (section 4: "Internal Programs"). If you have your game on a cdrom you may try
  50. this guide: https://www.vogons.org/viewtopic.php?t=8933
  51.  
  52.  
  53.  
  54. ===============
  55. 2. Start (FAQ):
  56. ===============
  57.  
  58. START:      How to start?
  59. AUTOMATION: Do I always have to type these "mount" commands?
  60. FULLSCREEN: How do I change to fullscreen?
  61. FULLSCREEN: My fullscreen is too large.
  62. CD-ROM:     My CD-ROM doesn't work.
  63. CD-ROM:     The game/application can't find its CD-ROM.
  64. MOUSE:      The mouse doesn't work.
  65. SOUND:      There is no sound.
  66. SOUND:      What sound hardware does DOSBox presently emulate?
  67. SOUND:      The sound stutters or sounds stretched/weird.
  68. KEYBOARD:   I can't type \ or : in DOSBox.
  69. KEYBOARD:   Right Shift and "\" doesn't work in DOSBox. (Windows only)
  70. KEYBOARD:   The keyboard lags.
  71. CONTROL:    The character/cursor/mouse pointer always moves into one direction!
  72. SPEED:      The game/application runs much too slow/too fast!
  73. CRASH:      The game/application does not run at all/crashes!
  74. CRASH:      DOSBox crashes on startup!
  75. GAME:       My Build game(Duke3D/Blood/Shadow Warrior) has problems.
  76. SAFETY:     Can DOSBox harm my computer?
  77. OPTIONS:    I would like to change DOSBox's options.
  78. HELP:       Great Manual, but I still don't get it.
  79.  
  80.  
  81.  
  82. START: How to start?
  83.     At the beginning you've got a Z:\> instead of a C:\> at the prompt.
  84.     You have to make your directories available as drives in DOSBox by using
  85.     the "mount" command. For example, in Windows "mount C D:\GAMES" will give
  86.     you a C drive in DOSBox which points to your Windows D:\GAMES directory
  87.     (that was created before). In Linux, "mount c /home/username" will give you
  88.     a C drive in DOSBox which points to /home/username in Linux.
  89.     To change to the drive mounted like above, type "C:". If everything went
  90.     fine, DOSBox will display the prompt "C:\>".
  91.  
  92.  
  93. AUTOMATION: Do I always have to type these commands?
  94.     In the DOSBox configuration file is an [autoexec] section. The commands
  95.     present there are run when DOSBox starts, so you can use this section
  96.     for the mounting. Look at Section 13: The configuration (options) file
  97.  
  98.  
  99. FULLSCREEN: How do I change to fullscreen?
  100.     Press alt-enter. Alternatively: Edit the configuration file of DOSBox and
  101.     change the option fullscreen=false to fullscreen=true. If fullscreen looks
  102.     wrong in your opinion: Play with the options: fullresolution, output and
  103.     aspect in the configuration file of DOSBox. To get back from fullscreen
  104.     mode: Press alt-enter again.
  105.  
  106.  
  107. FULLSCREEN: My fullscreen is too large.
  108.     This is can be a problem on Windows 10, if you have display scaling
  109.     set to a value above 100%. Windows in that case will resize the screen
  110.     on top of dosbox resizing the screen, which can happen for the output:
  111.     ddraw, opengl, openglnb, overlay. You can disable this Windows behaviour
  112.     by enabling a specific compatibility setting:
  113.  
  114.     - Right-click the DOSBox icon and select "Properties".
  115.     - Go to the "Compatibility" tab.
  116.     - Click on "Change high DPI settings".
  117.     - Tick "Override high DPI scaling behaviour" and set it to "Application".
  118.     - Apply the changes by clicking on "OK".
  119.  
  120.     Unfortunately, this compatibility option causes some side effects in
  121.     windowed mode, and in this case you will need to change the resolution
  122.     in the config/Options file for windowresolution (e.g. 1024x768).
  123.  
  124.     Alternatively, you can disable the display scaling and or use a lower
  125.     fullresolution value.
  126.  
  127. CD-ROM: My CD-ROM doesn't work.
  128.     To mount your CD-ROM in DOSBox you have to specify some additional options
  129.     when mounting the CD-ROM.
  130.     To enable CD-ROM support (includes MSCDEX) in Windows:
  131.       - mount d f:\ -t cdrom
  132.     in Linux:
  133.       - mount d /media/cdrom -t cdrom
  134.  
  135.     In some cases you might want to use a different CD-ROM interface,
  136.     for example if CD audio does not work:
  137.       To enable SDL-support (does not include low-level CD access!):
  138.         - mount d f:\ -t cdrom -usecd 0 -noioctl
  139.       To enable ioctl access using digital audio extraction for CD audio
  140.       (windows-only, useful for Vista):
  141.         - mount d f:\ -t cdrom -ioctl_dx
  142.       To enable ioctl access using MCI for CD audio (windows-only):
  143.         - mount d f:\ -t cdrom -ioctl_mci
  144.       To force ioctl-only access (windows-only):
  145.         - mount d f:\ -t cdrom -ioctl_dio
  146.       To enable low-level aspi-support (win98 with aspi-layer installed):
  147.         - mount d f:\ -t cdrom -aspi
  148.  
  149.     explanation: - d   driveletter you will get in DOSBox (d is the best,
  150.                           don't change it!)
  151.                  - f:\ location of CD-ROM on your PC. In most cases it will
  152.                           be d:\ or e:\
  153.                  - 0   The number of the CD-ROM drive, reported by "mount -cd"
  154.                           (note that this value is only needed when using SDL
  155.                           for CD audio, otherwise it is ignored)
  156.     See also the next question: The game/application can't find its CD-ROM.
  157.  
  158.  
  159. CD-ROM: The game/application can't find its CD-ROM.
  160.     Be sure to mount the CD-ROM with -t cdrom switch, this will enable the
  161.     MSCDEX interface required by DOS games to interface with CD-ROMs.
  162.     Also try adding the correct label (-label LABEL) to the mount command,
  163.     where LABEL is the CD-label (volume ID) of the CD-ROM.
  164.     Under Windows you can specify -ioctl, -aspi or -noioctl. Look at the
  165.     description of the mount command in Section 4: "Internal programs"
  166.     for their meaning and the
  167.     additional audio-CD related options -ioctl_dx, ioctl_mci, ioctl_dio.
  168.  
  169.     Try creating a CD-ROM image (preferably CUE/BIN pair) and use the
  170.     DOSBox's internal IMGMOUNT tool to mount the image (the CUE sheet).
  171.     This enables very good low-level CD-ROM support on any operating system.
  172.  
  173.  
  174. MOUSE: The mouse doesn't work.
  175.     Usually, DOSBox detects when a game uses mouse control. When you click on
  176.     the screen it should get locked (confined to the DOSBox window) and work.
  177.     With certain games, the DOSBox mouse detection doesn't work. In that case
  178.     you will have to lock the mouse manually by pressing CTRL-F10.
  179.  
  180.  
  181. SOUND: There is no sound.
  182.     Be sure that the sound is correctly configured in the game. This might be
  183.     done during the installation or with a setup/setsound utility that
  184.     accompanies the game. First see if an autodetection option is provided. If
  185.     there is none try selecting Soundblaster or Soundblaster 16 with the default
  186.     settings being "address=220 irq=7 dma=1" (sometimes highdma=5). You might
  187.     also want to select Sound Canvas/SCC/MPU-401/General MIDI/Wave Blaster
  188.     at "address=330 IRQ=2" as music device.
  189.     The parameters of the emulated sound cards can be changed in the DOSBox
  190.     configuration file.
  191.     If you still don't get any sound set the core to normal in DOSBox
  192.     configuration and use some lower fixed cycles value (like cycles=2000). Also
  193.     assure that your host operating sound does provide sound.
  194.     In certain cases it might be useful to use a different emulated sound device
  195.     like a soundblaster pro (sbtype=sbpro1 in the DOSBox configuration file) or
  196.     the gravis ultrasound (gus=true).
  197.  
  198.  
  199. SOUND: What sound hardware does DOSBox presently emulate?
  200.     DOSBox emulates several legacy sound devices:
  201.     - Internal PC speaker/Buzzer
  202.       This emulation includes both the tone generator and several forms of
  203.       digital sound output through the internal speaker.
  204.     - Creative CMS/Gameblaster
  205.       The is the first card released by Creative Labs(R).  The default
  206.       configuration places it on address 220. It is disabled as default.
  207.     - Tandy 3 voice
  208.       The emulation of this sound hardware is complete with the exception of
  209.       the noise channel. The noise channel is not very well documented and as
  210.       such is only a best guess as to the sound's accuracy. It is disabled as
  211.       default.
  212.     - Tandy DAC
  213.       Some games may require turning off sound blaster emulation (sbtype=none)
  214.       for better tandy DAC sound support. Don't forget to set the sbtype back to
  215.       sb16 if you don't use tandy sound.
  216.     - Adlib
  217.       This emulation is almost perfect and includes the Adlib's ability to
  218.       almost play digitized sound. Placed at address 220 (also on 388).
  219.     - SoundBlaster 16 / SoundBlaster Pro I & II / SoundBlaster I & II
  220.       By default DOSBox provides Soundblaster 16 level 16-bit stereo sound.
  221.       You can select a different SoundBlaster version in the configuration of
  222.       DOSBox. AWE32 music is not emulated as you can use MPU-401 instead
  223.       (see below).
  224.     - Disney Sound Source and Covox Speech Thing
  225.       Using the printer port, this sound device outputs digital sound only.
  226.       Placed at LPT1
  227.     - Gravis Ultrasound
  228.       The emulation of this hardware is nearly complete, though the MIDI
  229.       capabilities have been left out, since an MPU-401 has been emulated
  230.       in other code. For Gravis music you also have to install Gravis drivers
  231.       inside DOSBox. It is disabled as default.
  232.     - MPU-401
  233.       A MIDI passthrough interface is also emulated. This method of sound
  234.       output will only work when used with external device/emulator.
  235.       Every Windows XP/Vista/7 and MAC OS has got a default emulator compatible
  236.       with: Sound Canvas/SCC/General Standard/General MIDI/Wave Blaster.
  237.       A different device/emulator is needed for Roland LAPC/CM-32L/MT-32
  238.       compatibility.
  239.  
  240.  
  241. SOUND: The sound stutters or sounds stretched/weird.
  242.     You may be using too much CPU power to keep DOSBox running at the current
  243.     speed. You can lower the cycles, skip frames, reduce the sampling rate of
  244.     the respective sound device, increase the prebuffer. See section 13: "The
  245.     configuration (options) file"
  246.     If you are using cycles=max or =auto, then make sure that there is no
  247.     background processes interfering! (especially if they access the harddisk)
  248.     Also look at Section 10. "How to speed up/slow down DOSBox"
  249.  
  250.  
  251. KEYBOARD: I can't type \ or : in DOSBox.
  252.     This can happen in various cases, like your host keyboard layout does not
  253.     have a matching DOS layout representation (or it was not correctly
  254.     detected), or the key mapping is wrong.
  255.     Some possible fixes:
  256.       1. Use / instead, or ALT-58 for : and ALT-92 for \.
  257.       2. Change the DOS keyboard layout (see Section 8: Keyboard Layout).
  258.       3. Add the commands you want to execute to the [autoexec] section
  259.          of the DOSBox configuration file.
  260.       4. Open the DOSBox configuration file and change the usescancodes entry.
  261.       5. Switch the keyboard layout of your operating system.
  262.  
  263.     Note that if the host layout can not be identified, or keyboardlayout is
  264.     set to none in the DOSBox configuration file, the standard US layout is
  265.     used. In this configuration try the keys around "enter" for the key \
  266.     (backslash), and for the key : (colon) use shift and the keys between
  267.     "enter" and "L".
  268.  
  269.  
  270. KEYBOARD: Right Shift and "\" doesn't work in DOSBox. (Windows only)
  271.     This may happen if Windows thinks that you have more than one keyboard
  272.     connected to your PC when you use some remote control devices.
  273.     To verity this problem run cmd.exe, navigate to DOSBox program folder
  274.     and type:
  275.     set sdl_videodriver=windib
  276.     dosbox.exe
  277.     check whether keyboard started to work properly. As windib is slower it is
  278.     best to use one of the two solutions provided here:
  279.     https://www.vogons.org/viewtopic.php?t=24072
  280.  
  281.  
  282. KEYBOARD: The keyboard lags.
  283.     Lower the priority setting in the DOSBox configuration file, for example
  284.     set "priority=normal,normal". You might also want to try lowering the
  285.     cycles (use a fixed cycle amount to start with, like cycles=10000).
  286.  
  287.  
  288. CONTROL: The character/cursor/mouse pointer always moves into one direction!
  289.     See if it still happens if you disable the joystick emulation,
  290.     set joysticktype=none in the [joystick] section of your DOSBox
  291.     configuration file. Maybe also try unplugging any joystick/gamepad.
  292.     If you want to use the joystick in the game, try setting timed=false
  293.     and be sure to calibrate the joystick (both in your OS as well as
  294.     in the game or the game's setup program).
  295.  
  296.  
  297. SPEED: The game/application runs much too slow/too fast!
  298.     Look at the section 10: "How to speed up/slow down DOSBox" for more
  299.     information.
  300.  
  301.  
  302. CRASH: The game/application does not run at all/crashes!
  303.     Look at Section 11: Troubleshooting
  304.  
  305.  
  306. CRASH: DOSBox crashes on startup!.
  307.     Look at Section 11: Troubleshooting
  308.  
  309.  
  310. GAME: My Build game(Duke3D/Blood/Shadow Warrior) has problems.
  311.     First of all, try to find a port of the game. Those will offer a better
  312.     experience. To fix the graphics problem that occurs in DOSBox on higher
  313.     resolutions: Open the configuration file of DOSBox and search for
  314.     machine=svga_s3. Change svga_s3 to vesa_nolfb
  315.     Change memsize=16 to memsize=63
  316.  
  317.  
  318. SAFETY: Can DOSBox harm my computer?
  319.     DOSBox can not harm your computer more than any other resource demanding
  320.     program. Increasing the cycles does not overclock your real CPU.
  321.     Setting the cycles too high has a negative performance effect on the
  322.     software running inside DOSBox.
  323.  
  324.  
  325. OPTIONS: I would like to change DOSBox's options.
  326.     Look at Section 13. "The configuration (options) file"
  327.  
  328.  
  329. HELP: Great Manual, but I still don't get it.
  330.     For more questions read the rest of this Manual. You may also look at:
  331.     guides located at https://www.vogons.org/viewforum.php?f=53
  332.     the wiki of DOSBox https://www.dosbox.com/wiki/
  333.     the site/forum: https://www.dosbox.com
  334.  
  335.  
  336.  
  337. ===========================
  338. 3. Command Line Parameters:
  339. ===========================
  340.  
  341. An overview of the command line options you can give to DOSBox. Although
  342. in most cases it is easier to use DOSBox's configuration file instead.
  343. See: Section 13. "The configuration (options) file"
  344.  
  345. To be able to use Command Line Parameters:
  346. (Windows)  open cmd.exe or command.com or edit the shortcut to dosbox.exe
  347. (Linux)    use console
  348. (MAC OS X) start terminal.app and navigate to:
  349.            /applications/dosbox.app/contents/macos/dosbox
  350.  
  351. The options are valid for all operating systems unless noted in the option
  352. description:
  353.  
  354. dosbox [name] [-exit] [-c command] [-fullscreen] [-userconf]
  355.        [-conf congfigfilelocation] [-lang languagefilelocation]
  356.        [-machine machine type] [-noconsole] [-startmapper] [-noautoexec]
  357.        [-securemode] [-scaler scaler | -forcescaler scaler] [-version]
  358.        [-socket socket]
  359.        
  360. dosbox -version
  361. dosbox -editconf program
  362. dosbox -opencaptures program
  363. dosbox -printconf
  364. dosbox -eraseconf
  365. dosbox -erasemapper
  366.  
  367.   name
  368.         If "name" is a directory it will mount that as the C: drive.
  369.         If "name" is an executable it will mount the directory of "name"
  370.         as the C: drive and execute "name".
  371.  
  372.   -exit
  373.         DOSBox will close itself when the DOS application "name" ends.
  374.  
  375.   -c command
  376.         Runs the specified command before running "name". Multiple commands
  377.         can be specified. Each command should start with "-c" though.
  378.         A command can be: an Internal Program, a DOS command or an executable
  379.         on a mounted drive.
  380.  
  381.   -fullscreen
  382.         Starts DOSBox in fullscreen mode.
  383.  
  384.   -userconf
  385.         Start DOSBox with the users specific configuration file. Can be used
  386.         together with multiple -conf parameters, but -userconf will always be
  387.         loaded before them.
  388.  
  389.   -conf configfilelocation
  390.         Start DOSBox with the options specified in "configfilelocation".
  391.         Multiple -conf options may be present.
  392.         See Section 13 for more details.
  393.  
  394.   -lang languagefilelocation
  395.         Start DOSBox using the language specified in "languagefilelocation".
  396.         See Section 14 for more details.
  397.  
  398.   -machine machinetype
  399.         Setup DOSBox to emulate a specific type of machine. Valid choices are:
  400.         hercules, cga, ega, pcjr, tandy, svga_s3 (default) as well as
  401.         the additional svga chipsets listed in the DOSBox configuration file.
  402.         svga_s3 enables vesa emulation as well.
  403.         For some special vga effects the machinetype vgaonly can be used,
  404.         note that this disables svga capabilities and might be slower due to the
  405.         higher emulation precision.
  406.         The machinetype affects the video card and the available sound cards.
  407.  
  408.   -noconsole (Windows Only)
  409.         Start DOSBox without showing DOSBox Status Window (console).
  410.         Output will be redirected to stdout.txt and stderr.txt
  411.  
  412.   -startmapper
  413.         Enter the keymapper directly on startup. Useful for people with
  414.         keyboard problems.
  415.  
  416.   -noautoexec
  417.         Skips the [autoexec] section of the loaded configuration file.
  418.  
  419.   -securemode
  420.         Same as -noautoexec, but adds config.com -securemode at the
  421.         bottom of AUTOEXEC.BAT (which in turn disables any changes to how
  422.         the drives are mounted inside DOSBox).
  423.  
  424.   -scaler scaler
  425.         Uses the scaler specified by "scaler". See the DOSBox configuration file
  426.         for the available scalers.
  427.  
  428.   -forcescaler scaler
  429.         Similar to the -scaler parameter, but tries to force usage of
  430.         the specified scaler even if it might not fit.
  431.  
  432.   -version
  433.         output version information and exit. Useful for frontends.
  434.  
  435.   -editconf program
  436.         calls program with as first parameter the configuration file.
  437.         You can specify this command more than once. In this case it will
  438.         move to second program if the first one fails to start.
  439.  
  440.   -opencaptures program
  441.         calls program with as first parameter the location of the captures
  442.         folder.
  443.  
  444.   -printconf
  445.         prints the location of the default configuration file.
  446.  
  447.   -resetconf
  448.         removes the default configuration file.
  449.  
  450.   -resetmapper
  451.         removes the mapperfile used by the default clean configuration file.
  452.  
  453.   -socket
  454.         passes the socket number to the nullmodem emulation. See Section 9:
  455.         "Serial Multiplayer feature."
  456.  
  457. Note: If a name/command/configfilelocation/languagefilelocation contains
  458.      a space, put the whole name/command/configfilelocation/languagefilelocation
  459.      between quotes ("command or file name"). If you need to use quotes within
  460.      quotes (most likely with -c and mount):
  461.      Windows and OS/2 users can use single quotes inside the double quotes.
  462.      Other people should be able to use escaped double quotes inside the
  463.      double quotes.
  464.      Windows: -c "mount c 'c:\My folder with DOS games\'"
  465.      Linux: -c "mount c \"/tmp/name with space\""
  466.  
  467. A rather unusual example, just to demonstrate what you can do (Windows):
  468. dosbox D:\folder\file.exe -c "MOUNT Y H:\MyFolder"
  469.   This mounts D:\folder as C:\ and runs file.exe.
  470.   Before it does that, it will first mount H:\MyFolder as the Y drive.
  471.  
  472. In Windows, you can also drag directories/files onto the DOSBox executable.
  473.  
  474.  
  475.  
  476. =====================
  477. 4. Internal Programs:
  478. =====================
  479.  
  480. DOSBox supports most of the DOS commands found in command.com.
  481. To get a list of the internal commands type "HELP" at the prompt.
  482.  
  483. In addition, the following commands are available:
  484.  
  485. MOUNT "Emulated Drive letter" "Real Drive or Directory"
  486.       [-t type] [-aspi] [-ioctl] [-noioctl] [-usecd number] [-size drivesize]
  487.       [-label drivelabel] [-freesize size_in_mb]
  488.       [-freesize size_in_kb (floppies)]
  489. MOUNT -cd
  490. MOUNT -u "Emulated Drive letter"
  491.  
  492.   Program to mount local directories as drives inside DOSBox.
  493.  
  494.   "Emulated Drive letter"
  495.         The driveletter inside DOSBox (for example C).
  496.  
  497.   "Real Drive letter (usually for CD-ROMs in Windows) or Directory"
  498.         The local directory you want accessible inside DOSBox.
  499.  
  500.   -t type
  501.         Type of the mounted directory.
  502.         Supported are: dir (default), floppy, cdrom.
  503.  
  504.   -size drivesize
  505.         (experts only)
  506.         Sets the size of the drive, where drivesize is of the form
  507.         "bps,spc,tcl,fcl":
  508.            bps: bytes per sector, by default 512 for regular drives and
  509.                 2048 for CD-ROM drives
  510.            spc: sectors per cluster, usually between 1 and 127
  511.            tcl: total clusters, between 1 and 65534
  512.            fcl: total free clusters, between 1 and tcl
  513.  
  514.   -freesize size_in_mb | size_in_kb
  515.         Sets the amount of free space available on a drive
  516.         in megabytes (regular drives) or kilobytes (floppy drives).
  517.         This is a simpler version of -size.
  518.  
  519.   -label drivelabel
  520.         Sets the name of the drive to "drivelabel". Needed on some systems
  521.         if the CD-ROM label isn't read correctly (useful when a program
  522.         can't find its CD-ROM). If you don't specify a label
  523.         and no lowlevel support is selected (that is omitting the -usecd #
  524.         and/or -aspi parameters, or specifying -noioctl):
  525.           For Windows: label is extracted from "Real Drive".
  526.           For Linux: label is set to NO_LABEL.
  527.  
  528.         If you do specify a label, this label will be kept as long as the drive
  529.         is mounted. It will not be updated !!
  530.  
  531.   -aspi
  532.         Forces use of the aspi layer. Only valid if mounting a CD-ROM under
  533.         Windows systems with an ASPI-Layer.
  534.  
  535.   -ioctl (automatic selection of the CD audio interface)
  536.   -ioctl_dx (digital audio extraction used for CD audio)
  537.   -ioctl_dio (ioctl calls used for CD audio)
  538.   -ioctl_mci (MCI used for CD audio)
  539.         Forces use of ioctl commands. Only valid if mounting a CD-ROM under
  540.         a Windows OS which support them (Win2000/XP/NT).
  541.         The various choices only differ in the way CD audio is handled,
  542.         preferably -ioctl_dio is used (lowest workload), but this might not
  543.         work on all systems, so -ioctl_dx (or -ioctl_mci) can be used.
  544.  
  545.   -noioctl
  546.         Forces use of the SDL CD-ROM layer. Valid on all systems.
  547.  
  548.   -usecd number
  549.         Valid on all systems, under windows the -noioctl switch has to be
  550.         present to make use of the -usecd switch.
  551.         Enables to select the drive that should be used by SDL. Use this if
  552.         the wrong or no CD-ROM drive is mounted while using the SDL CD-ROM
  553.         interface. "number" can be found by "MOUNT -cd".
  554.  
  555.   -cd
  556.         Displays all CD-ROM drives detected by SDL, and their numbers.
  557.         See the information at the -usecd entry above.
  558.  
  559.   -u
  560.         Removes the mount. Doesn't work for Z:\.
  561.  
  562.   Note: It's possible to mount a local directory as CD-ROM drive,
  563.         but hardware support is then missing.
  564.  
  565.   Basically MOUNT allows you to connect real hardware to DOSBox's emulated PC.
  566.   So MOUNT C C:\GAMES tells DOSBox to use your C:\GAMES directory as drive C:
  567.   in DOSBox. MOUNT C E:\SomeFolder tells DOSBox to use your E:\SomeFolder
  568.   directory as drive C: in DOSBox.
  569.  
  570.   Mounting your entire C drive with MOUNT C C:\ is NOT recommended! The same
  571.   is true for mounting the root of any other drive, except for CD-ROMs (due to
  572.   their read-only nature).
  573.   Otherwise if you or DOSBox make a mistake you may lose all your files.
  574.   Also never mount a "Windows" or "Program Files" folders or their subfolders
  575.   in Windows Vista/7 as DOSBox may not work correctly, or will stop working
  576.   correctly later. It is recommended to keep all your dos applications/games
  577.   in a simple folder (for example c:\dosgames) and mount that.
  578.  
  579.   You should always install your game inside DOSBox.
  580.   So if you have the game on CD you always (even after installation!)
  581.   have to mount both: folder as a harddisk drive and a CD-ROM.
  582.   HardDisk should always be mounted as c
  583.     CD-ROM should always be mounted as d
  584.     Floppy should always be mounted as a (or b)
  585.  
  586.   Basic MOUNT Examples for normal usage (Windows):
  587.  
  588.    1. To mount a folder as a harddisk drive:
  589.           mount c d:\dosgames
  590.  
  591.    3. To mount your CD-ROM drive E as CD-ROM drive D in DOSBox:
  592.           mount d e:\ -t cdrom
  593.  
  594.    2. To mount your drive a: as a floppy:
  595.           mount a a:\ -t floppy
  596.  
  597.   Advanced MOUNT examples (Windows):
  598.  
  599.    4. To mount a hard disk drive with ~870 mb free diskspace (simple version):
  600.           mount c d:\dosgames -freesize 870
  601.  
  602.    5. To mount a drive with ~870 mb free diskspace (experts only, full control):
  603.           mount c d:\dosgames -size 512,127,16513,13500
  604.  
  605.    1. To mount c:\dosgames\floppy as a floppy:
  606.           mount a c:\dosgames\floppy -t floppy
  607.  
  608.  
  609.   Other MOUNT examples:
  610.  
  611.    3. To mount system CD-ROM drive at mountpoint /media/cdrom as CD-ROM drive D
  612.       in DOSBox:
  613.           mount d /media/cdrom -t cdrom -usecd 0
  614.  
  615.    6. To mount /home/user/dosgames as drive C in DOSBox:
  616.           mount c /home/user/dosgames
  617.  
  618.    7. To mount the directory where DOSBox was started as C in DOSBox:
  619.           mount c .
  620.           (note the . which represents the directory where DOSBox was started,
  621.           on Windows Vista/7 don't use this if you installed DOSBox
  622.           to your "Program Files" folder)
  623.  
  624.   If you want to mount a CD image or floppy image, check IMGMOUNT.
  625.   MOUNT also works with images but only if you use external program,
  626.   for example (both are free):
  627.   - Daemon Tools Lite (for CD images),
  628.   - Virtual Floppy Drive (for floppy images).
  629.   Although IMGMOUNT can give better compatibility.
  630.  
  631.  
  632. MEM
  633.   Program to display the amount and type of free memory.
  634.  
  635.  
  636. VER
  637. VER set major_version [minor_version]
  638.   Display the current DOSBox version and reported DOS version
  639.   (parameterless usage).
  640.   Change the reported DOS version with the "set" parameter,
  641.   for example: "VER set 6 22" to have DOSBox report DOS 6.22 as version number.
  642.  
  643.  
  644. CONFIG -writeconf filelocation
  645. CONFIG -writelang filelocation
  646. CONFIG -securemode
  647. CONFIG -set "section property=value"
  648. CONFIG -get "section property"
  649.  
  650.   CONFIG can be used to change or query various settings of DOSBox
  651.   during runtime. It can save the current settings and language strings to
  652.   disk. Information about all possible sections and properties can
  653.   be found in Section 13: "The configuration (options) file".
  654.  
  655.   -writeconf filelocation
  656.      Write the current configuration settings to a file in a specified location.
  657.     "filelocation" is located on the local drive, not a mounted drive in DOSBox.
  658.      The configuration file controls various settings of DOSBox:
  659.      the amount of emulated memory, the emulated sound cards and many more
  660.      things. It allows access to AUTOEXEC.BAT as well.
  661.      See Section 13: "The configuration (options) file" for more information.
  662.  
  663.   -writelang filelocation
  664.      Write the current language settings to a file in a specified location.
  665.      "filelocation" is located on the local drive, not a mounted drive
  666.      in DOSBox. The language file controls all visible output of the internal
  667.      commands and the internal DOS.
  668.      See Section 14: "The Language File" for more information.
  669.  
  670.   -securemode
  671.      Switches DOSBox to a more secure mode. In this mode the internal
  672.      commands MOUNT, IMGMOUNT and BOOT won't work. It's not possible either
  673.      to create a new configfile or languagefile in this mode.
  674.      (Warning: you can only undo this mode by restarting DOSBox.)
  675.  
  676.   -set "section property=value"
  677.      CONFIG will attempt to set the property to new value.
  678.      Currently CONFIG can not report whether the command succeeded or not.
  679.  
  680.   -get "section property"
  681.      The current value of the property is reported and stored in the
  682.      environment variable %CONFIG%. This can be used to store the value
  683.      when using batch files.
  684.  
  685.   Both "-set" and "-get" work from batch files and can be used to set up your
  686.   own preferences for each game. Although it may be easier to use separate
  687.   DOSBox's configuration files for each game instead.
  688.  
  689.   Examples:
  690.     1. To create a configuration file in your c:\dosgames directory:
  691.         config -writeconf c:\dosgames\dosbox.conf
  692.     2. To set the cpu cycles to 10000:
  693.         config -set "cpu cycles=10000"
  694.     3. To turn ems memory emulation off:
  695.         config -set "dos ems=off"
  696.     4. To check which cpu core is being used.
  697.         config -get "cpu core"
  698.  
  699.  
  700. LOADFIX [-size] [program] [program-parameters]
  701. LOADFIX -f
  702.   Program to reduce the amount of available conventional memory.
  703.   Useful for old programs which don't expect much memory to be free.
  704.  
  705.   -size
  706.         number of kilobytes to "eat up", default = 64kb
  707.  
  708.   -f
  709.         frees all previously allocated memory
  710.  
  711.   Examples:
  712.     1. To start mm2.exe and allocate 64kb memory
  713.        (mm2 will have 64 kb less available):
  714.        loadfix mm2
  715.     2. To start mm2.exe and allocate 32kb memory:
  716.        loadfix -32 mm2
  717.     3. To free previous allocated memory:
  718.        loadfix -f
  719.  
  720.  
  721. RESCAN
  722.   Make DOSBox reread the directory structure. Useful if you changed something
  723.   on a mounted drive outside of DOSBox. (CTRL - F4 does this as well!)
  724.  
  725.  
  726. MIXER
  727.   Makes DOSBox display its current volume settings.
  728.   Here's how you can change them:
  729.  
  730.   mixer channel left:right [/NOSHOW] [/LISTMIDI]
  731.  
  732.   channel
  733.      Can be one of the following: MASTER, DISNEY, SPKR, GUS, SB, FM [, CDAUDIO].
  734.      CDAUDIO is only available if a CD-ROM interface with volume control is
  735.      enabled (CD image, ioctl_dx).
  736.  
  737.   left:right
  738.      The volume levels in percentages. If you put a D in front it will be
  739.      in decibel (Example: mixer gus d-10).
  740.  
  741.   /NOSHOW
  742.      Prevents DOSBox from showing the result if you set one
  743.      of the volume levels.
  744.  
  745.   /LISTMIDI
  746.      In Windows lists the available midi devices on your PC. To select a device
  747.      other than the Windows default midi-mapper, change the line 'midiconfig='
  748.      in the [midi] section of the configuration file to 'midiconfig=id', where
  749.      'id' is the number for the device as listed by LISTMIDI. eg. midiconfig=2
  750.  
  751.      In Linux this option doesn't work, but you get similar results by using
  752.      'pmidi -l' in console. Then change the line 'midiconfig=' to
  753.      'midiconfig=port', where 'port' is the port for the device as listed by
  754.      'pmidi -l'. eg. midiconfig=128:0
  755.  
  756.  
  757. IMGMOUNT
  758.   A utility to mount disk images and CD-ROM images in DOSBox.
  759.  
  760.   IMGMOUNT DRIVE [imagefile] -t [image_type] -fs [image_format]
  761.             -size [sectorsbytesize, sectorsperhead, heads, cylinders]
  762.   IMGMOUNT DRIVE [imagefile1 imagefile2 .. imagefileN] -t cdrom -fs iso
  763.  
  764.   imagefile
  765.       Location of the image file to mount in DOSBox. The location can be
  766.       on a mounted drive inside DOSBox, or on your real disk. It is possible
  767.       to mount CD-ROM images (ISOs or CUE/BIN or CUE/IMG) too.
  768.       If you need CD swapping capabilities, specify all images in succession
  769.       (see the next entry).
  770.       CUE/BIN pairs and cue/img are the preferred CD-ROM image types as they can
  771.       store audio tracks compared to ISOs (which are data-only). For
  772.       the CUE/BIN mounting always specify the CUE sheet.
  773.  
  774.   imagefile1 imagefile2 .. imagefileN
  775.       Location of the image files to mount in DOSBox. Specifying a number
  776.       of image files is only allowed for CD-ROM images.
  777.       The CD's can be swapped with CTRL-F4 at any time.
  778.       This is required for games which use multiple CD-ROMs and require the CD
  779.       to be switched during the gameplay at some point.
  780.  
  781.   -t
  782.       The following are valid image types:
  783.         floppy: Specifies a floppy image. DOSBox will automatically identify
  784.                 the disk geometry (360K, 1.2MB, 720K, 1.44MB, etc).
  785.         cdrom:  Specifies a CD-ROM image. The geometry is automatic and
  786.                 set for this size. This can be an iso or a cue/bin pair or
  787.                 a cue/img pair.
  788.         hdd:    Specifies a harddrive image. The proper CHS geometry must be set
  789.                 for this to work.
  790.  
  791.   -fs
  792.       The following are valid file system formats:
  793.         iso:  Specifies the ISO 9660 CD-ROM format.
  794.         fat:  Specifies that the image uses the FAT file system. DOSBox will
  795.               attempt to mount this image as a drive in DOSBox and make
  796.               the files available from inside DOSBox.
  797.         none: DOSBox will make no attempt to read the file system on the disk.
  798.               This is useful if you need to format it or if you want to boot
  799.               the disk using the BOOT command. When using the "none"
  800.               filesystem, you must specify the drive number (2 or 3,
  801.               where 2 = master, 3 = slave) rather than a drive letter.
  802.               For example, to mount a 70MB image as the slave drive device,
  803.               you would type (without the quotes):
  804.                 "imgmount 3 d:\test.img -size 512,63,16,142 -fs none"
  805.                 Compare this with a mount to be able to access the drive
  806.                 within DOSBox, which would read as:
  807.                 "imgmount e: d:\test.img -size 512,63,16,142"
  808.  
  809.   -size
  810.      The Cylinders, Heads and Sectors of the drive.
  811.      Required to mount hard drive images.
  812.  
  813.   An example how to mount CD-ROM images (in Linux):
  814.     1. imgmount d /tmp/cdimage1.cue /tmp/cdimage2.cue -t cdrom
  815.   or (which also works):
  816.     2a. mount c /tmp
  817.     2b. imgmount d c:\cdimage1.cue c:\cdimage2.cue -t cdrom
  818.   (in Windows):
  819.     imgmount d f:\img\CD1.cue f:\img\CD2.cue f:\img\CD3.cue -t cdrom
  820.     imgmount d "g:\img\7th Guest CD1.cue" "g:\img\7th Guest CD2.cue" -t cdrom
  821.   Don't forget that you can also use MOUNT with images, but only if you use
  822.   external program, for example (both are free):
  823.   - Daemon Tools Lite (for CD images),
  824.   - Virtual Floppy Drive (for floppy images).
  825.   Although IMGMOUNT can give better compatibility.
  826.  
  827.  
  828. BOOT
  829.   Boot will start floppy images or hard disk images independent of
  830.   the operating system emulation offered by DOSBox. This will allow you to
  831.   play booter floppies or boot other operating systems inside DOSBox.
  832.   If the target emulated system is PCjr (machine=pcjr) the boot command
  833.   can be used to load PCjr cartridges (.jrc).
  834.  
  835.   BOOT [diskimg1.img diskimg2.img .. diskimgN.img] [-l driveletter]
  836.   BOOT [cart.jrc]  (PCjr only)
  837.  
  838.   diskimg1.img diskimg2.img .. diskimgN.img
  839.      This can be any number of floppy disk images one wants mounted after
  840.      DOSBox boots the specified drive letter.
  841.      To swap between images, hit CTRL-F4 to change from the current disk
  842.      to the next disk in the list. The list will loop back from the last
  843.      disk image to the beginning.
  844.  
  845.   [-l driveletter]
  846.      This parameter allows you to specify the drive to boot from.
  847.      The default is the A drive, the floppy drive. You can also boot
  848.      a hard drive image mounted as master by specifying "-l C"
  849.      without the quotes, or the drive as slave by specifying "-l D"
  850.  
  851.    cart.jrc (PCjr only)
  852.      When emulation of a PCjr is enabled, cartridges can be loaded with
  853.      the BOOT command. Support is still limited.
  854.  
  855.  
  856. IPX
  857.  
  858.   You need to enable IPX networking in the configuration file of DOSBox.
  859.  
  860.   All of the IPX networking is managed through the internal DOSBox program
  861.   IPXNET. For help on the IPX networking from inside DOSBox, type
  862.   "IPXNET HELP" (without quotes) and the program will list the commands
  863.   and relevant documentation.
  864.  
  865.   With regard to actually setting up a network, one system needs to be
  866.   the server. To set this up, type "IPXNET STARTSERVER" (without the quotes)
  867.   in a DOSBox session. The server DOSBox session will automatically add
  868.   itself to the virtual IPX network. For every additional computer that
  869.   should be part of the virtual IPX network, you'll need to type
  870.   "IPXNET CONNECT <computer host name or IP>".
  871.   For example, if your server is at bob.dosbox.com, you would type
  872.   "IPXNET CONNECT bob.dosbox.com" on every non-server system.
  873.  
  874.   To play games that need Netbios a file named NETBIOS.EXE from Novell is
  875.   needed. Establish the IPX connection as explained above, then run
  876.   "netbios.exe".
  877.  
  878.   The following is an IPXNET command reference:
  879.  
  880.   IPXNET CONNECT
  881.  
  882.      IPXNET CONNECT opens a connection to an IPX tunneling server
  883.      running on another DOSBox session. The "address" parameter specifies
  884.      the IP address or host name of the server computer. You can also
  885.      specify the UDP port to use. By default IPXNET uses port 213 - the
  886.      assigned IANA port for IPX tunneling - for its connection.
  887.  
  888.      The syntax for IPXNET CONNECT is:
  889.      IPXNET CONNECT address <port>
  890.  
  891.   IPXNET DISCONNECT
  892.  
  893.      IPXNET DISCONNECT closes the connection to the IPX tunneling server.
  894.  
  895.      The syntax for IPXNET DISCONNECT is:
  896.      IPXNET DISCONNECT
  897.  
  898.   IPXNET STARTSERVER
  899.  
  900.      IPXNET STARTSERVER starts an IPX tunneling server on this DOSBox
  901.      session. By default, the server will accept connections on UDP port
  902.      213, though this can be changed. Once the server is started, DOSBox
  903.      will automatically start a client connection to the IPX tunneling server.
  904.  
  905.      The syntax for IPXNET STARTSERVER is:
  906.      IPXNET STARTSERVER <port>
  907.  
  908.      If the server is behind a router, UDP port <port> needs to be forwarded
  909.      to that computer.
  910.  
  911.      On Linux/Unix-based systems port numbers smaller than 1023 can only be
  912.      used with root privileges. Use ports greater than 1023 on those systems.
  913.  
  914.   IPXNET STOPSERVER
  915.  
  916.      IPXNET STOPSERVER stops the IPX tunneling server running on this DOSBox
  917.      session. Care should be taken to ensure that all other connections have
  918.      terminated as well, since stopping the server may cause lockups on other
  919.      machines that are still using the IPX tunneling server.
  920.  
  921.      The syntax for IPXNET STOPSERVER is:
  922.      IPXNET STOPSERVER
  923.  
  924.   IPXNET PING
  925.  
  926.      IPXNET PING broadcasts a ping request through the IPX tunneled network.
  927.      In response, all other connected computers will respond to the ping
  928.      and report the time it took to receive and send the ping message.
  929.  
  930.      The syntax for IPXNET PING is:
  931.      IPXNET PING
  932.  
  933.   IPXNET STATUS
  934.  
  935.      IPXNET STATUS reports the current state of this DOSBox session's
  936.      IPX tunneling network. For a list of all computers connected to the
  937.      network use the IPXNET PING command.
  938.  
  939.      The syntax for IPXNET STATUS is:
  940.      IPXNET STATUS
  941.  
  942.  
  943. KEYB [keyboardlayoutcode [codepage [codepagefile]]]
  944.  
  945.   Change the keyboard layout. For detailed information about keyboard layouts
  946.   please see Section 8: "Keyboard Layout"
  947.  
  948.   [keyboardlayoutcode] is a string consisting of five or less characters,
  949.      examples are PL214 (Polish typists) or PL457 (Polish programmers).
  950.      It specifies the keyboard layout to be used.
  951.      The list of all layouts built into DOSBox is here:
  952.      https://www.vogons.org/viewtopic.php?t=21824
  953.  
  954.   [codepage] is the number of the codepage to be used. The keyboard layout
  955.      has to provide support for the specified codepage, otherwise the layout
  956.      loading will fail.
  957.      If no codepage is specified, an appropriate codepage for the requested
  958.      layout is chosen automatically.
  959.  
  960.   [codepagefile] can be used to load codepages that are yet not compiled
  961.      into DOSBox. This is only needed when DOSBox does not find the codepage.
  962.      If no codepagefile is specified, but you place all ten ega.cpx files
  963.      (from FreeDOS) in the DOSBox program folder, an appropriate codepagefile
  964.      for the requested layout/codepage is chosen automatically.
  965.  
  966.   Examples:
  967.     1. To load the polish typist keys layout (automatically uses codepage 852):
  968.          keyb pl214
  969.     2. To load one of russian keyboard layouts with codepage 866:
  970.          keyb ru441 866
  971.        In order to type russian characters press ALT+RIGHT-SHIFT.
  972.     3. To load one of french keyboard layouts with codepage 850 (where the
  973.        codepage is defined in EGACPI.DAT):
  974.          keyb fr189 850 EGACPI.DAT
  975.     4. To load codepage 858 (without a keyboard layout):
  976.          keyb none 858
  977.        This can be used to change the codepage for the FreeDOS keyb2 utility.
  978.     5. To display the current codepage and, if loaded, the keyboard layout:
  979.          keyb
  980.  
  981.  
  982.  
  983. For more information use the /? command line switch with the programs.
  984.  
  985.  
  986.  
  987. ================
  988. 5. Special Keys:
  989. ================
  990.  
  991. ALT-ENTER     Switch to full screen and back.
  992. ALT-PAUSE     Pause emulation (hit ALT-PAUSE again to continue).
  993. CTRL-F1       Start the keymapper.
  994. CTRL-F4       Change between mounted floppy/CD images. Update directory cache
  995.               for all drives.
  996. CTRL-ALT-F5   Start/Stop creating a movie of the screen. (avi video capturing)
  997. CTRL-F5       Save a screenshot. (PNG format)
  998. CTRL-F6       Start/Stop recording sound output to a wave file.
  999. CTRL-ALT-F7   Start/Stop recording of OPL commands. (DRO format)
  1000. CTRL-ALT-F8   Start/Stop the recording of raw MIDI commands.
  1001. CTRL-F7       Decrease frameskip.
  1002. CTRL-F8       Increase frameskip.
  1003. CTRL-F9       Kill DOSBox.
  1004. CTRL-F10      Capture/Release the mouse.
  1005. CTRL-F11      Slow down emulation (Decrease DOSBox Cycles).
  1006. CTRL-F12      Speed up emulation (Increase DOSBox Cycles)*.
  1007. ALT-F12       Unlock speed (turbo button/fast forward)**.
  1008. F11, ALT-F11  (machine=cga) change tint in NTSC output modes***
  1009. F11           (machine=hercules) cycle through amber, green, white colouring***
  1010.  
  1011. *NOTE: Once you increase your DOSBox cycles beyond your computer CPU resources,
  1012.        it will produce the same effect as slowing down the emulation.
  1013.        This maximum will vary from computer to computer.
  1014.  
  1015. **NOTE: You need free CPU resources for this (the more you have, the faster
  1016.         it goes), so it won't work at all with cycles=max or a too high amount
  1017.         of fixed cycles. You have to keep the keys pressed for it to work!
  1018.  
  1019. ***NOTE: These keys won't work if you saved a mapper file earlier with
  1020.          a different machine type. So either reassign them or reset the mapper.
  1021.  
  1022. These are the default keybindings. They can be changed in the keymapper
  1023. (see Section 7: KeyMapper).
  1024.  
  1025. In MAC OS you can try using cmd(applekey) together with Ctrl if the key doesn't
  1026. work eg. cmd-ctrl-F1, but some keys may still need remapping (in Linux too).
  1027.  
  1028. Saved/recorded files can be found in:
  1029.    (Windows)    "Start/WinLogo Menu"->"All Programs"->"DOSBox-0.74-3"->Extras
  1030.    (Linux)      ~/.dosbox/capture
  1031.    (MAC OS X)   "~/Library/Preferences/capture"
  1032. This can be changed in the DOSBox configuration file.
  1033.  
  1034.  
  1035.  
  1036. ====================
  1037. 6. Joystick/Gamepad:
  1038. ====================
  1039.  
  1040. The standard joystick port in DOS supports a maximum of 4 axes and 4 buttons.
  1041. For more, different modifications of that configuration were used.
  1042.  
  1043. To force DOSBox to use a different type of emulated joystick/gamepad, the entry
  1044. "joysticktype" in the [joystick] section of the DOSBox configuration file can
  1045. be used.
  1046.  
  1047. none  - disables controller support.
  1048. auto  - (default) autodetects whether you have one or two controllers connected:
  1049.           if you have one - '4axis' setting is used,
  1050.           if you have two - '2axis' setting is used.
  1051. 2axis - If you have two controllers connected, each will emulate a joystick
  1052.         with 2 axes and 2 buttons. If you have only one controller connected,
  1053.         it will emulate a joystick with only 2 axis and 2 buttons.
  1054. 4axis - supports only first controller, emulates a joystick
  1055.         with 4 axis and 4 buttons or a gamepad with 2axis and 6 buttons.
  1056. 4axis_2 - supports only second controller.
  1057. fcs   - supports only first controller, emulates ThrustMaster
  1058.         Flight Control System, with 3-axes, 4 buttons and 1 hat.
  1059. ch    - supports only first controller, emulates CH Flightstick,
  1060.         with 4-axes, 6 buttons and 1 hat, but you cannot press more
  1061.         than one button at the same time.
  1062.  
  1063. You also have to configure controller properly inside the game.
  1064.  
  1065. It is important to remember that if you saved the mapperfile without joystick
  1066.  
  1067. connected, or with a different joystick setting, your new setting will
  1068. not work
  1069. properly,
  1070. or not work at all, until you reset DOSBox's mapperfile.
  1071.  
  1072.  
  1073. If controller is working properly outside DOSBox, but doesn't calibrate properly
  1074. inside DOSBox, try different 'timed' setting in DOSBox's configuration file.
  1075.  
  1076.  
  1077.  
  1078. =============
  1079. 7. KeyMapper:
  1080. =============
  1081.  
  1082. You start the DOSBox mapper either with CTRL-F1 (see section 5. Special Keys)
  1083. or -startmapper (see Section 3. Command Line Parameters).
  1084. You are presented with a virtual keyboard and a virtual joystick.
  1085.  
  1086. These virtual devices correspond to the keys and events DOSBox will
  1087. report to the DOS applications. If you click on a button with your mouse,
  1088. you can see in the lower left corner with which event it is associated
  1089. (EVENT) and to what events it is currently bound.
  1090.  
  1091. Event: EVENT
  1092. BIND: BIND (the real key/button/axis you push with your finger/hand)
  1093.  
  1094.                                     Add   Del
  1095. mod1  hold                                Next
  1096. mod2
  1097. mod3
  1098.  
  1099.  
  1100. EVENT
  1101.     The key or joystick axis/button/hat DOSBox will report to DOS applications.
  1102.     (the event that will happen during the game, (eg. shooting/jumping/walking)
  1103. BIND
  1104.     The key on your real keyboard or the axis/button/hat on your real
  1105.     joystick(s) (as reported by SDL), which is connected to the EVENT.
  1106. mod1,2,3
  1107.     Modifiers. These are keys you need to have to be pressed while pressing
  1108.     BIND. mod1 = CTRL and mod2 = ALT. These are generally only used when you
  1109.     want to change the special keys of DOSBox.
  1110. Add
  1111.     Add a new BIND to this EVENT. Basically add a key from your keyboard or an
  1112.     event from the joystick (button press, axis/hat movement) which will
  1113.     produce the EVENT in DOSBox.
  1114. Del
  1115.     Delete the BIND to this EVENT. If an EVENT has no BINDS, then it is not
  1116.     possible to trigger this event in DOSBox (that is there's no way to type
  1117.     the key or use the respective action of the joystick).
  1118. Next
  1119.     Go through the list of bindings which map to this EVENT.
  1120.  
  1121.  
  1122. Example:
  1123. Q1. You want to have the X on your keyboard to type a Z in DOSBox.
  1124.     A. Click on the Z on the keyboard mapper. Click "Add".
  1125.        Now press the X key on your keyboard.
  1126.  
  1127. Q2. If you click "Next" a couple of times, you will notice that the Z on your
  1128.     keyboard also produces an Z in DOSBox.
  1129.     A. Therefore select the Z again, and click "Next" until you have the Z on
  1130.        your keyboard. Now click "Del".
  1131.  
  1132. Q3. If you try it out in DOSBox, you will notice that pressing X makes ZX
  1133.     appear.
  1134.      A. The X on your keyboard is still mapped to the X as well! Click on
  1135.         the X in the keyboard mapper and search with "Next" until you find the
  1136.         mapped key X. Click "Del".
  1137.  
  1138.  
  1139. Examples about remapping the joystick:
  1140.   You have a joystick attached, it is working fine under DOSBox and you
  1141.   want to play some keyboard-only game with the joystick (it is assumed
  1142.   that the game is controlled by the arrows on the keyboard):
  1143.     1. Start the mapper, then click on one of the left keyboard arrow.
  1144.        EVENT should be key_left. Now click on Add and move your joystick
  1145.        in the respective direction, this should add an event to the BIND.
  1146.     2. Repeat the above for the missing three directions, additionally
  1147.        the buttons of the joystick can be remapped as well (fire/jump).
  1148.     3. Click on Save, then on Exit and test it with some game.
  1149.  
  1150.   You want to swap the y-axis of the joystick because some flightsim uses
  1151.   the up/down joystick movement in a way you don't like, and it is not
  1152.   configurable in the game itself:
  1153.     1. Start the mapper and click on Y- in the first joystick field.
  1154.        EVENT should be jaxis_0_1-.
  1155.     2. Click on Del to remove the current binding, then click Add and move
  1156.        your joystick downwards. A new bind should be created.
  1157.     3. Repeat this for Y+, save the layout and finally test it with some game.
  1158.  
  1159.   If you want to remap anything to your d-pad/hat you will have to change
  1160.   'joysticktype=auto' to 'joysticktype=fcs' in configuration file. Maybe this
  1161.   will be improved in the next dosbox version.
  1162.  
  1163.  
  1164. If you change the default mapping, you can save your changes by clicking on
  1165. "Save". DOSBox will save the mapping to a location specified in
  1166. the configuration file (the mapperfile= entry). At startup, DOSBox will load
  1167. your mapperfile, if it is present in the DOSBox configuration file.
  1168.  
  1169.  
  1170.  
  1171. ===================
  1172. 8. Keyboard Layout:
  1173. ===================
  1174.  
  1175. To switch to a different keyboard layout, either the entry "keyboardlayout"
  1176. in the [dos] section of the DOSBox configuration file can be used, or the
  1177. internal DOSBox program keyb.com (Section 4: Internal Programs)
  1178. Both accept DOS conforming language codes (see below),
  1179. but only by using keyb.com a custom codepage can be specified.
  1180.  
  1181. The default keyboardlayout=auto currently works under windows only. The language
  1182. is chosen according to the OS language, but the keyboard layout is not detected.
  1183.  
  1184. Layout switching
  1185.   DOSBox supports a number of keyboard layouts and codepages by default,
  1186.   in this case just the layout identifier needs to be specified (like
  1187.   keyboardlayout=PL214 in the DOSBox configuration file, or using "keyb PL214"
  1188.   at the DOSBox command prompt). The list of all layouts built into DOSBox is
  1189.   here: https://www.vogons.org/viewtopic.php?t=21824
  1190.  
  1191.   Some keyboard layouts (for example layout GK319 codepage 869 and layout RU441
  1192.   codepage 808) have support for dual layouts that can be accessed by pressing
  1193.   LeftALT+RrightSHIFT for one layout and LeftALT+LeftSHIFT for the other.
  1194.   Some keyboard layouts (for example layout LT456 codepage 771) have support
  1195.   for three layouts, third can be accessed by pressing LeftALT+LeftCTRL
  1196.  
  1197. Supported external files
  1198.   The FreeDOS .kl files are supported (FreeDOS keyb2 keyboard layoutfiles) as
  1199.   well as the FreeDOS keyboard.sys/keybrd2.sys/keybrd3.sys libraries which
  1200.   consist of all available .kl files.
  1201.   See http://www.freedos.org/ for precompiled keyboard layouts if
  1202.   the DOSBox-integrated layouts don't work for some reason, or if updated or
  1203.   new layouts become available.
  1204.  
  1205.   Both .CPI (MS-DOS and compatible codepage files) and .CPX (FreeDOS
  1206.   UPX-compressed codepage files) can be used. Some codepages are compiled
  1207.   into DOSBox, so it is mostly not needed to care about external codepage
  1208.   files. If you need a different (or custom) codepage file, copy it into
  1209.   the directory of the DOSBox so it is accessible for DOSBox.
  1210.   If you place all ten ega.cpx files (from FreeDOS) in DOSBox folder,
  1211.   an appropriate codepagefile for the requested layout/codepage is
  1212.   chosen automatically.
  1213.  
  1214.   Additional layouts can be added by copying the corresponding .kl file into
  1215.   the directory of the DOSBox configuration file and using the first part of
  1216.   the filename as language code.
  1217.   Example: For the file UZ.KL (keyboard layout for Uzbekistan) specify
  1218.            "keyboardlayout=uz" in the DOSBox configuration file.
  1219.   The integration of keyboard layout packages (like keybrd2.sys) works similar.
  1220.  
  1221. Note that the keyboard layout allows foreign characters to be entered, but
  1222. there is NO support for them in filenames. Try to avoid them both inside
  1223. DOSBox as well as in files on your host operating system that are accessible
  1224. by DOSBox.
  1225.  
  1226.  
  1227.  
  1228. ==============================
  1229. 9. Serial Multiplayer feature:
  1230. ==============================
  1231.  
  1232. DOSBox can emulate a serial nullmodem cable over network and internet.
  1233. It can be configured through the [serialports] section in the DOSBox
  1234. configuration file.
  1235.  
  1236. To create a nullmodem connection, one side needs to act as the server and
  1237. one as the client.
  1238.  
  1239. The server needs to be set up in the DOSBox configuration file like this:
  1240.    serial1=nullmodem
  1241.  
  1242. The client:
  1243.    serial1=nullmodem server:<IP or name of the server>
  1244.  
  1245. Now start your game and choose nullmodem / serial cable / already connected
  1246. as multiplayer method on COM1. Set the same baudrate on both computers.
  1247.  
  1248. Furthermore, additional parameters can be specified to control the behavior
  1249. of the nullmodem connection. These are all parameters:
  1250.  
  1251.  * port:         - TCP port number. Default: 23
  1252.  * rxdelay:      - how long (milliseconds) to delay received data if the
  1253.                    interface is not ready. Increase this value if you encounter
  1254.                    overrun errors in the DOSBox Status Window. Default: 100
  1255.  * txdelay:      - how long to gather data before sending a packet. Default: 12
  1256.                    (reduces Network overhead)
  1257.  * server:       - This nullmodem will be a client connecting to the specified
  1258.                    server. (No server argument: be a server.)
  1259.  * transparent:1 - Only send the serial data, no RTS/DTR handshake. Use this
  1260.                    when connecting to anything other than a nullmodem.
  1261.  * telnet:1      - Interpret Telnet data from the remote site. Automatically
  1262.                    sets transparent.
  1263.  * usedtr:1      - The connection will not be established until DTR is switched
  1264.                    on by the DOS program. Useful for modem terminals.
  1265.                    Automatically sets transparent.
  1266.  * inhsocket:1   - Use a socket passed to DOSBox by command line. Automatically
  1267.                    sets transparent. (Socket Inheritance: It is used for
  1268.                    playing old DOS door games on new BBS software.)
  1269.  
  1270. Example: Be a server listening on TCP port 5000.
  1271.    serial1=nullmodem server:<IP or name of the server> port:5000 rxdelay:1000
  1272.  
  1273.  
  1274.  
  1275. =====================================
  1276. 10. How to speed up/slow down DOSBox:
  1277. =====================================
  1278.  
  1279. DOSBox emulates the CPU, the sound and graphic cards, and other peripherals
  1280. of a PC, all at the same time. The speed of an emulated DOS application
  1281. depends on how many instructions can be emulated, which is adjustable
  1282. (number of cycles).
  1283.  
  1284. CPU Cycles (speed up/slow down)
  1285.   By default (cycles=auto) DOSBox tries to detect whether a game needs to
  1286.   be run with as many instructions emulated per time interval as possible
  1287.   (cycles=max, sometimes this results in game working too fast or unstable),
  1288.   or whether to use fixed amount of cycles (cycles=3000, sometimes this results
  1289.   in game working too slow or too fast). But you can always manually force
  1290.   a different setting in the DOSBox's configuration file.
  1291.  
  1292.   You can force the slow or fast behavior by setting a fixed amount of cycles
  1293.   in the DOSBox's configuration file. If you for example set cycles=10000, then
  1294.   DOSBox window will display a line "Cpu Speed: fixed 10000 cycles" at the top.
  1295.   In this mode you can reduce the amount of cycles even more by hitting CTRL-F11
  1296.   (you can go as low as you want) or raise it by hitting CTRL-F12 as much as you
  1297.   want, but you will be limited by the power of one core of your computer's CPU.
  1298.   You can see how much free time your real CPU's cores have by looking at
  1299.   the Task Manager in Windows 2000/XP/Vista/7 and the System Monitor
  1300.   in Windows 95/98/ME. Once 100% of the power of your computer's real CPU's one
  1301.   core is used, there is no further way to speed up DOSBox (it will actually
  1302.   start to slow down), unless you reduce the load generated by the non-CPU parts
  1303.   of DOSBox. DOSBox can use only one core of your CPU, so If you have
  1304.   for example a CPU with 4 cores, DOSBox will not be able to use the power
  1305.   of three other cores.
  1306.  
  1307.   You can also force the fast behavior by setting cycles=max in the DOSBox
  1308.   configuration file. The DOSBox window will display a line
  1309.   "Cpu Speed: max 100% cycles" at the top then. This time you won't have to care
  1310.   how much free time your real CPU's cores have, because DOSBox will always use
  1311.   100% of your real CPU's one core. In this mode you can reduce the amount
  1312.   of your real CPU's core usage by CTRL-F11 or raise it with CTRL-F12.
  1313.  
  1314. CPU Core (speed up)
  1315.   On x86 architectures you can try to force the usage of a dynamically
  1316.   recompiling core (set core=dynamic in the DOSBox configuration file).
  1317.   This usually gives better results if the auto detection (core=auto) fails.
  1318.   It is best accompanied by cycles=max. But you may also try using it with
  1319.   high amounts of cycles (for example 20000 or more). Note that there might be
  1320.   games that work worse/crash with the dynamic core (so save your game often),
  1321.   or do not work at all!
  1322.  
  1323. Graphics emulation (speed up)
  1324.   VGA emulation is a demanding part of DOSBox in terms of actual CPU usage.
  1325.   Increase the number of frames skipped (in increments of one) by pressing
  1326.   CTRL-F8. Your CPU usage should decrease when using a fixed cycle setting,
  1327.   and you will be able to increase cycles with CTRL-F12.
  1328.   You can repeat this until the game runs fast enough for you.
  1329.   Please note that this is a trade-off: you lose in fluidity of video what
  1330.   you gain in speed.
  1331.  
  1332. Sound emulation (speed up)
  1333.   You can also try to disable the sound through the setup utility of the game
  1334.   to reduce load on your CPU further. Setting nosound=true in DOSBox's
  1335.   configuration does NOT disable the emulation of sound devices, just
  1336.   the output of sound will be disabled.
  1337.  
  1338. Also try to close every program but DOSBox to reserve as much resources
  1339. as possible for DOSBox.
  1340.  
  1341.  
  1342. Advanced cycles configuration:
  1343. The cycles=auto and cycles=max settings can be parameterized to have
  1344. different startup defaults. The syntax is
  1345.   cycles=auto ["realmode default"] ["protected mode default"%]
  1346.               [limit "cycle limit"]
  1347.   cycles=max ["protected mode default"%] [limit "cycle limit"]
  1348. Example:
  1349.   cycles=auto 5000 80% limit 20000
  1350.   will use cycles=5000 for real mode games, 80% CPU throttling for
  1351.   protected mode games along with a hard cycle limit of 20000
  1352.  
  1353.  
  1354.  
  1355. ====================
  1356. 11. Troubleshooting:
  1357. ====================
  1358.  
  1359. General tip:
  1360.   Check messages in DOSBox Status Window. See section 12. "DOSBox Status Window"
  1361.  
  1362. DOSBox crashes right after starting it:
  1363.   - use different values for the output= entry in your DOSBox
  1364.     configuration file
  1365.   - try to update your graphics card driver and DirectX
  1366.   - (Linux) set the environment variable SDL_AUDIODRIVER to alsa or oss.
  1367.  
  1368. Running a certain game closes DOSBox, crashes with some message or hangs:
  1369.   - see if it works with a default DOSBox installation
  1370.     (unmodified configuration file)
  1371.   - try it with sound disabled (use the sound configuration
  1372.     program that comes with the game, additionally you can
  1373.     set sbtype=none and gus=false in the DOSBox configuration file)
  1374.   - change some entries of the DOSBox configuration file, especially try:
  1375.       core=normal
  1376.       fixed cycles (for example cycles=10000)
  1377.       ems=false
  1378.       xms=false
  1379.     or combinations of the above settings,
  1380.     similar the machine settings that control the emulated chipset and
  1381.     functionality:
  1382.       machine=vesa_nolfb
  1383.     or
  1384.       machine=vgaonly
  1385.   - use loadfix before starting the game
  1386.  
  1387. The game exits to the DOSBox prompt with some error message:
  1388.   - read the error message closely and try to locate the error
  1389.   - try the hints at the above sections
  1390.   - mount differently as some games are picky about the locations,
  1391.     for example if you used "mount d d:\oldgames\game" try
  1392.     "mount c d:\oldgames\game" and "mount c d:\oldgames"
  1393.   - if the game requires a CD-ROM be sure you used "-t cdrom" when
  1394.     mounting and try different additional parameters (the ioctl,
  1395.     usecd and label switches, see the appropriate section)
  1396.   - check the file permissions of the game files (remove read-only
  1397.     attributes, add write permissions etc.)
  1398.   - try reinstalling the game within DOSBox
  1399.  
  1400.  
  1401.  
  1402. =========================
  1403. 12. DOSBox Status Window:
  1404. =========================
  1405.  
  1406. DOSBox's Staus window contains many useful information about your currant
  1407. configuration, your actions in DOSBox, errors that happened and more.
  1408. Whenever you have any problem with DOSBox check these messages.
  1409.  
  1410. To start DOSBox Status Window:
  1411.   (Windows)  Status Window is being started together with main DOSBox window.
  1412.   (Linux)    You may have to start DOSBox from a console to see Status Window.
  1413.   (MAC OS X) Right click on DOSBox.app, choose "Show Package Contents"->
  1414.              ->enter "Contents"->enter "MacOS"->run "DOSBox"
  1415.  
  1416.  
  1417.  
  1418. =====================================
  1419. 13. The configuration (options) file:
  1420. =====================================
  1421.  
  1422. The configuration file is automatically created the first time you run DOSBox.
  1423. The file can be found in:
  1424.    (Windows)  "Start/WinLogo Menu"->"All Programs"->"DOSBox-0.74-3"->Options
  1425.    (Linux)    ~/.dosbox/dosbox-0.74-3.conf
  1426.    (MAC OS X) "~/Library/Preferences/DOSBox 0.74-3 Preferences"
  1427. The file is divided into several sections. Each section starts with a
  1428. [section name] line. The settings are the property=value lines where value can
  1429. be altered to customize DOSBox.
  1430. # and % indicate comment-lines.
  1431.  
  1432.  
  1433. An extra configuration file can be generated by CONFIG.COM, which can be found
  1434. on the internal DOSBox Z: drive when you start up DOSBox. Look in the Section 4:
  1435. "Internal programs" for usage of CONFIG.COM. You can start DOSBox with
  1436. the -conf switch to load the generated file and use its settings.
  1437.  
  1438. DOSBox will load configuration files that are specified with -conf. If none were
  1439. specified, it will try to load "dosbox.conf" from the local directory.
  1440. If there is none, DOSBox will load the user configuration file.
  1441. This file will be created if it doesn't exist.
  1442.  
  1443. Important!: In Windows Vista/7 the configuration file won't work correctly
  1444. if it is located in "Windows" or "Program Files" folder or their subfolders,
  1445. or directly on c:\, so the best place for storing extra configuration files is
  1446. for example: C:\oldgames
  1447.  
  1448.  
  1449.  
  1450. ======================
  1451. 14. The Language File:
  1452. ======================
  1453.  
  1454. A language file can be generated by CONFIG.COM, which can be found on the
  1455. internal DOSBox Z: drive when you start up DOSBox. Look in the Section 4:
  1456. "Internal programs" for usage of CONFIG.COM.
  1457. Read the language file, and you will hopefully understand how to change it.
  1458. Start DOSBox with the -lang switch to use your new language file.
  1459. Alternatively, you can setup the filename in the configuration file
  1460. in the [dosbox] section. There's a language= entry that can be changed with
  1461. the filelocation.
  1462.  
  1463.  
  1464.  
  1465. ========================================
  1466. 15. Building your own version of DOSBox:
  1467. ========================================
  1468.  
  1469. Download the source.
  1470. Check the INSTALL in the source distribution.
  1471.  
  1472.  
  1473.  
  1474. ===================
  1475. 16. Special thanks:
  1476. ===================
  1477.  
  1478. See the THANKS file.
  1479.  
  1480.  
  1481.  
  1482. ============
  1483. 17. Contact:
  1484. ============
  1485.  
  1486. See the site:
  1487. https://www.dosbox.com
  1488. for an email address (The Crew-page).
  1489.  
  1490.  
  1491.