From b74026cfb1b99782c0208d3b5cf15d09b7226acb Mon Sep 17 00:00:00 2001 From: Eric Auer Date: Mon, 31 Mar 2008 22:44:55 +0000 Subject: [PATCH] Added Geraldo (changelog) and Fritz (config.txt) to contrib.txt Updated config.txt: verbose, readable, up to date, plain ASCII. git-svn-id: https://svn.code.sf.net/p/freedos/svn/kernel/trunk@1363 6ac86273-5f31-0410-b378-82cca8765d1b --- docs/config.txt | 243 ++++++++++++++++++++++++++++++++--------------- docs/contrib.txt | 10 +- 2 files changed, 172 insertions(+), 81 deletions(-) diff --git a/docs/config.txt b/docs/config.txt index f018954..dc7c7ed 100644 --- a/docs/config.txt +++ b/docs/config.txt @@ -2,6 +2,7 @@ Title: Config.sys Options Configuring your DOS system for use: ------------------------------------ + When booting DOS, you will find it only supports a subset of the devices available on many computers. To support additional devices and advanced features, device specific driver and @@ -29,24 +30,39 @@ Set extended Control-C/Control-Break checking to on [default] or off. When set to on, the kernel will perform the check (and invoke current handler if pressed) prior to most int 21h calls. When set to off, the kernel only performs the check on I/O calls using standard streams. -e.g. break=off +Example: break=off BUFFERS BUFFERSHIGH -Usage: buffers=nn[,n] where nn is in range 1-99 & n is in range 1-8 +Usage: buffers=nn[,m] where nn is in range 1-99 & m is in range 1-8 Memory buffers used by the kernel; primary[,secondary] The secondary buffer option is available for compatibility with -other DOS kernels, but is ignored by the FreeDOS kernel. -e.g. buffers=20 +other DOS kernels, but is ignored by the FreeDOS kernel. In MS DOS, +a secondary buffer can used to read-ahead data. FreeDOS does not do +this. Buffers are stored in HMA by FreeDOS, unless you select nn to +allocate more buffers than fit in HMA. If nn is smaller, unused HMA +space will be used for further buffers until something else allocates +the HMA space for something else. Even then, at least nn buffers will +always be available. You can set nn to a negative value to disable +the use of unused HMA space: BUFFERS=-10 only uses 10 buffers, further +free space in the HMA will just stay unused. +Example: buffers=20 COUNTRY Usage: country=nnn[,[mmm][,[d:][path]file]] -Only limited country=nnn support is presently available. -Enables/sets international features of DOS +Enables/sets international features of DOS by selecting a country +code and (only with the unstable / devel kernel) optionally also +a codepage and country file. The stable kernel only uses the nnn +value. For full support, use the unstable / devel kernel. You also +need a COUNTRY.SYS file for the latter, while the former ignores the +filename argument and only sets date/time/number formats, using values +compiled into the kernel for a few common countries. It does not set +sort order and upper/lower case translation tables. NLSFUNC can only +be used with the unstable kernel. nnn is country code (001==US) mmm is code page (437 is default, 850 is updated form, 1252 for Windows) [drive][path]file specifies file with country specific data -e.g. country=001,850,C:\FDOS\BIN\COUNTRY.SYS +Example: country=001,850,C:\FDOS\BIN\COUNTRY.SYS DEVICE Usage: device=[d:][path]file [options] @@ -54,7 +70,7 @@ Load the device driver specified by d:path\file (into conventional [low 640KB] memory). The options are for the driver itself; refer to documentation that came with your particular device for supported options and their usage. -e.g. device=himem.sys +Example: device=himem.sys DEVICEHIGH Usage: devicehigh=[d:][path]file [options] @@ -65,9 +81,9 @@ Note: The order you load devices may have a large impact on amount of free memory available. In general try to load large (in memory usage) programs into high memory first. Important: You should have a high memory manager such as FDXMS or -Himem installed (prior device=FDXMS.SYS or device=HIMEM.SYS) before +HIMEM installed (prior device=FDXMS.SYS or device=HIMEM.SYS) before using this option. -e.g. devicehigh=atapicdd.sys /D:FDCD0001 +Example: devicehigh=xcdrom.sys /D:FDCD0001 DOS Usage: dos=high|low,umb|noumb @@ -77,23 +93,23 @@ upper memory blocks in with normal memory or not. Note: only one set need be given, ie dos=high and dos=noumb are ok. Important: if you specify dos=high[,umb|noumb] then you must also load a high memory manager (first), ie FDXMS or HIMEM -e.g. dos=high,umb -or dos=low,noumb +Example: dos=high,umb +Example: dos=low,noumb DOSDATA Usage: dosdata=umb Try to load kernel data into Upper Memory Blocks; effectively -same as using the HIGH variant of kernel parameters, +same as using the [name]HIGH variant of kernel parameters, such as fileshigh, lastdrivehigh, and stackshigh (does not effect drivers loaded using device= or install=). -e.g. dosdata=umb +Example: dosdata=umb ECHO Usage: ECHO Message to be displayed to user. ECHO displays (echos) its arguments to the console during config.sys processing when device drivers are loaded (when DEVICE= lines are executed). -e.g. +Example: ECHO loading driver 1 device=Driver1.sys ECHO driver1 successfully loaded @@ -103,15 +119,17 @@ Usage: EECHO Message with ANSI Escape Sequence EECHO allows for echo-ing ANSI Escape Sequences (redefines keyboard input for example). Use a dollar sign ($) to represent the ANSI Escape character. Note: requires an -ansi driver loaded prior to use. +ANSI driver like NANSI loaded prior to use. +Example: EECHO feeling $[33;44;1m blue :-) FCBS Usage: fcbs=nnn where nnn is in range 1-255 Sets the number of File Control Blocks to reserve room for. As file control blocks have been replaced by file handles -(see files) most applications will not need this value adjusted. -e.g. fcbs=4 +(see files) and FreeDOS dynamically simulates FCBS from the +handle data as needed, nnn is simply ignored by FreeDOS. +Example: fcbs=4 FILES FILESHIGH @@ -123,7 +141,7 @@ Note: there are other restrictions, so a given program may not be able to actually open this many A good number is 20, though some programs suggest/require 30, 40, or even 255 -e.g. files=20 +Example: files=20 IDLEHALT Usage: idlehalt=n @@ -150,11 +168,11 @@ load TSR (terminate and stay resident) programs with a minimal environment block. The options are for the program itself; refer to documentation that came with your particular software for supported options and usage. -e.g. install=nansi.com +Example: install=nansi.com KEYBUF Usage: keybuf=n[,m] -where n is in 0xac-0xde or 0x106-0x1de range and m is <= 0x200 +where n is in 0xac-0xde or 0x106-0x1de range and m is max 0x200 Relocate keyboard buffer from the default location at 0x40:0x1e-0x3e to 0x40:n-m. The buffer must be more than 32 bytes and must not touch offsets 0x100-0x105. @@ -168,29 +186,87 @@ LASTDRIVE LASTDRIVEHIGH Usage: lastdrive=x where x is last drive letter available for use; A-Z -e.g. lastdrive=z +Example: lastdrive=z + +MENU +Usage: menu [text] +where text is the text you want to be shown while running +config.sys. Menu displays a menu while running config.sys. +Use menudefault to set a time delayed default option. +Lines that begin with 1? will only be processed if the user +presses 1. Lines beginning with 23? will be loaded if the +user presses either 2 or 3. Options other than 0 can only +be selected if at least one "numbers?" line actually uses +them, as shown in the example below. +Example: + menu Please Select Configuration: + menu + menu Option 0 basic stuff only + menu Option 1 CD-ROM + menu Option 2 TROUSERS + menu Option 3 CD-ROM and TROUSERS + 0?echo you selected option 0 + 13?device=xcdrom.sys /D:FDCD0001 + 23?install=trousers.com + +MENUCOLOR +Usage: menucolor foreground[,background] +Use Menucolor before the menu config command, to create a +full screen menu which supports the arrow cursor keys. +The following colors can be used for foreground and background: +0=Black; 1=Blue; 2=Green; 3=Cyan; 4=Red; 5=Magenta; +6=Brown; 7=Light Gray +The following colors can only be used for the foreground: +8=Dark Gray; 9=Light Blue; 10=Light Green; 11=Light Cyan; +12=Light Red; 13=Light Magenta; 14=Yellow; 15=White. +If you do not use MENUCOLOR, the menu will not be full +screen, so some of the BIOS, bootloader and kernel init +messages (list of drives, version info...) stays visible. +To change the colour to white text on blue, use the following: +Example: menucolor 15,1 + +MENUDEFAULT +Usage: menudefault=defaultoption,delay +where delay is the delay time in seconds and defaultoption is the +used standard option if the delay time is over. Menudefault sets +a time delayed default option for a config.sys menu: If no key +has been pressed during [delay] seconds, the default choice is +activated. Pressing a key stops the countdown, the kernel will +wait infinitely for the user to make a selection. Note that some +virtual machines like Bochs can have broken (too fast) timing. +Example: menudefault=0,5 NUMLOCK Usage: numlock=on|off Set the keyboard number lock to on or off. -e.g. numlock=off +Example: numlock=off REM Usage: rem Your remarks! This provides the ability to place comments within the configuration file. The text following the rem until the end of the line is -reached are ignored. This may also be used to temporarily disable -loading a particular device or other option. +reached is ignored. This may also be used to temporarily disable +loading a particular device or other option. A synonym for REM is +the semicolon, see the examples. +Example: REM DOS=HIGH,UMB +Example: ;DOS=HIGH,UMB SCREEN Usage: screen=xx Switches into videomode xxx (INT10/11xx/000) -where xx should be 0x11 for 28 lines or 0x12 for 43/50 (EGA/VGA) lines +where xx should be 0x11 for 8x14 font (28 lines VGA, 25 lines EGA) +or 0x12 for 8x8 font (43 lines EGA, 50 lines VGA) or 0x14 for the +default VGA font (25 lines VGA). Some newer graphics cards may not +have 8x14 fonts in the BIOS. In that case, a driver can be loaded +to load a suitable font in RAM, but SCREEN=0x11 should not be used. +If xx is less than 15 (0x0f), it is treated as screen mode number, +for example 1 for CGA 40x25 color text or 7 for monochrome text. +Example: SCREEN=0x12 SET Usage: set ENVVAR=value Sets the environment variable to provided value. -e.g. set HOME=C:\home\me +Example: set HOME=C:\home\me SHELL SHELLHIGH @@ -201,15 +277,18 @@ shell option, you can get command.com to process a differently named file (such as FDAUTO.BAT for coexisting with another DOS using different configuration options) or run a completely different command interpreter such as 4DOS or a (unix) sh variant. -e.g. shell=C:\COMMAND.COM /E:256 /P +Example: shell=C:\4DOS.COM /E:256 /P +Example: SHELL=C:\FDOS\bin\command.com C:\FDOS\bin /E:1024 /P=C:\fdauto.bat STACKS STACKSHIGH -Usage: stacks=nn,nnn +Usage: stacks=nn,mmm where nn is in range 0,8-64 and nnn is in range 32-512 -Changes number of stacks available -nn is number of different stacks and nnn is size in bytes of each one -e.g. stacks=16,256 +Changes number and size of hardware interrupt stacks available +nn is number of different stacks and mmm is size in bytes of each one +In some cases you can use "stacks=0,0" to use only standard stacks +instead of letting DOS allocate extra stacks for hardware interrupts. +Example: stacks=16,256 SWITCHAR Usage: switchar=c @@ -217,28 +296,35 @@ Sets the default switchar to character c. Where c is a single character that is used to indicate a command line parameter is an option switch. The default is a forward slash (/). Note: This simply sets the value returned by a get switchar query, it will not effect programs that use -hardcoded switch characters. -e.g. switchar=- +hardcoded switch characters. The switch character is the sign used to +mark options, for example the "/" in "DIR /w". Good values: "/" and "-". +Example: switchar=- SWITCHES Usage: switches=/E[:xxx] /F /K /N /W Adjusts boot time processing behaviour. -/F skips the delay checking for F5/F8 keystroke before processing config.sys - [equivalent to setting kernel config option skipconfigseconds = 0] -/N disables F5/F8 support [equivalent to kernel config skipconfigseconds = -1] -(note: with /F a well timed F5/F8 still works, whereas /N completely disables) -/K forces treating of keyboard as 86 key keyboard -/E enables moving of EBDA (Extended BIOS Data Area), optionally a size in KB - may be specified [xxx, in range of 48-1024] -/W disables Windows 3.0 from loading WINA20.386 from the root directory (used - when \WINA20.386 is moved into a subdirectory, a device line with proper - path must be added to Microsoft (R) Windows' SYSTEM.INI [386Enhanced] - section.) --- Unsupported, though may be ignored for compatibility. +/E enables moving of EBDA (Extended BIOS Data Area), optionally a + size in kilobytes may be specified [xxx, in range of 48-1024] +/F skips the delay checking for F5/F8 keystroke before processing + config.sys [equivalent to SYS CONFIG skipconfigseconds=0] + F5 and F8 are only processed if pressed before DOS boots but + after the keyboard is set up - right moment is easy to miss. +/K forces treating of keyboard as 86 key keyboard, not 102/105 key. + Might be useful with BIOSes or drivers which have no or broken + handling for 102/105 key keyboards. +/N disables F5/F8 support [equivalent to kernel config (SYS CONFIG, + run SYS CONFIG /? for explanations) skipconfigseconds=-1] + F5 (skip config) and F8 (single step config.sys) are ignored. +/W is NOT supported in FreeDOS. This option in MS DOS would set a flag + for Windows 3.0 to skip loading wina20.386 from the root directory. VERSION Usage: version=x.y -FreeDOS specific command to specify what DOS version to report. -e.g. version=6.2 +FreeDOS specific command to specify what DOS version to report. For +a kernel with FAT32 support, 7.10 is a good choice. Otherwise, 5.0 +and 6.22 are common values. FreeCOM command.com "ver /r" displays +both the reported and the FreeDOS internal version numbers. +Example: version=6.22 @@ -251,14 +337,14 @@ normal '?' - ALWAYS ask if a single line shall be executed FILES=20 - ?DEVICE=MyNetWorkDriver.sys + DEVICE?=MyNetWorkDriver.sys '!' - NEVER ask if a single line shall be executed, even if single stepping !FILES=20 !DOS=HIGH,UMB !BUFFERS=30 - DEVICE=MyNetWorkDriver.sys + !DEVICE=MyNetWorkDriver.sys configuration management - you may compose several configurations, @@ -267,19 +353,20 @@ using following special commands: MENU MENU select your configuration MENU -MENU use (0) for basic configuration MENU use (1) for CDROM operation MENU use (2) for NETWORK configuration +MENU use (3) to load neither CDROM nor NETWORK drivers MENU -MENUDEFAULT=0,1 ( configuration 0, wait 1 second) +MENUDEFAULT=3,60 (configuration 3, wait 60 seconds) - -1? rem CDROM +rem CDROM 1? device=CDROM.SYS -2? rem NETWORK +rem NETWORK 2? device=MyNetworkDriver.SYS +rem Menu items can only be selected if at least one line uses them: +3? echo Basic configuration selected Although this is different than MSDOS menuing possibilities, it allows for selecting from multiple options during bootup while @@ -317,7 +404,7 @@ thus my config.sys now looks like !buffers=30 !screen=0x12 !lastdrive=z -!shellhigh=a:\command.com /p /e:512 /MSG +!shell=\command.com /p /e:512 /MSG MENU MENU 0 - SoftIce+HIMEM+Network (default) @@ -334,7 +421,7 @@ MENUDEFAULT=0,0 0?device=c:\ntclient\ifshlp.sys -DEVICE=ATAPICDD.SYS /D:MSCD000 +DEVICE=xcdrom.sys /D:MSCD000 Full Screen Menus (thanks to Rune Espeseth) @@ -353,37 +440,39 @@ buffers=20 REM *** The Menu *** MENU -MENU ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ» -MENU º My Menu - FreeDOS rules! º -MENU ÌÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹ -MENU º º -MENU º 1. Test with border º -MENU º º -MENU º 2. Another test... º -MENU º º -MENU º 3. Third choice º -MENU º º -MENU º 4. Fourth choice. º -MENU º º -MENU ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ +MENU *-------------------------------------------------------* +MENU ! My Menu - FreeDOS rules! ! +MENU *-------------------------------------------------------* +MENU ! ! +MENU ! 1. Test with border ! +MENU ! ! +MENU ! 2. Another test... ! +MENU ! ! +MENU ! 3. Third choice ! +MENU ! ! +MENU ! 4. Fourth choice. ! +MENU ! ! +MENU *-------------------------------------------------------* MENU MENUDEFAULT=1,10 ( configuration 1, wait 10 seconds) -1? REM 1st choice -1? ECHO You selected menu #1 +REM 1st choice +1?ECHO You selected menu #1 -2? REM 2nd choice -2? ECHO You selected menu #2 +REM 2nd choice +2?ECHO You selected menu #2 -3? REM 3rd choice -3? ECHO You selected menu #3 +REM 3rd choice +3?ECHO You selected menu #3 -4? REM 4th choice -4? ECHO You selected menu #4 +REM 4th choice +4?ECHO You selected menu #4 2002-11-28 - Tom Ehlert 2003-07-15 - Bernd Blaauw 2003-09-18 - Bart Oldeman 2004-07-24 - Jeremy Davis +... +2008-22-01 - Fritz Mueller / Eric Auer diff --git a/docs/contrib.txt b/docs/contrib.txt index 7b9a0be..564e5bb 100644 --- a/docs/contrib.txt +++ b/docs/contrib.txt @@ -1,6 +1,6 @@ These are the known contributors of the FreeDOS kernel. If you have -contributed in any way to the kernel, but are not on this list, -please email the current kernel maintainer so we can add you to the list! +contributed in any way to the kernel, but are not on this list, please +email the current kernel maintainer so we can add you to the list! Thanks to all the following for contributing to the FreeDOS kernel: @@ -14,6 +14,8 @@ Eduardo Casino (casino_e@terra.es) Eric Auer (eric@coli.uni-sb.de) Eric Biederman (ebiederm+eric@ccr.net) Eric Luttmann (ecl@users.sourceforge.net) +Fritz Mueller (fritz.mueller@mail.com) +Geraldo Netto (geraldonetto@gmail.com) Helmut Fritsch (helmut.fritsch@gcd-hs.de) James Tabor (jimtabor@infohwy.com) Jason Hood (jadoxa@yahoo.com.au) @@ -38,5 +40,5 @@ At this place we should also thank Ralf Brown for his interrupt list. It is a truely invaluable resource for us. And last, but not least, a big thanks to Pasquale J. Villani -(patv@iop.com), who was the original author of DOS-C, in which the -FreeDOS kernel was based. +(patv@iop.com), who is the original author of DOS-C, on which +the FreeDOS kernel is based.