home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / util2 / sd60.lzh / SDR.DOC < prev    next >
Text File  |  1989-01-06  |  32KB  |  650 lines

  1. ------------------------------------------------------------------------
  2.  
  3.        SDR: IBM-PC Resident Sorted Directory Utility V6.0
  4.  
  5.         Copyright (C) 1986-89 By John F. Stetson
  6.  
  7.               All Rights Reserved
  8.  
  9. ------------------------------------------------------------------------
  10.  
  11.     Contents
  12.  
  13. ------------------------------------------------------------------------
  14.  
  15. 1.0    INTRODUCTION
  16. 1.1    Program Requirements
  17. 1.2    Design Philosophy
  18.  
  19. 2.0    PROGRAM USAGE
  20. 2.1    Installation
  21. 2.2    Activation
  22. 2.3    Execution
  23. 2.4    Termination
  24. 2.5    Removal
  25.  
  26. 3.0    APPENDICES
  27. 3.1    Switch Differences
  28. 3.2    Configuration
  29. 3.3    Error Messages
  30.  
  31. ------------------------------------------------------------------------
  32.  
  33. 1.1    Program Requirements
  34.  
  35. ------------------------------------------------------------------------
  36.  
  37. SDR.COM is a memory resident  sorted  directory  utility  program  which
  38. operates on IBM-PC compatible computer systems using the IBM  PC-DOS  or
  39. Microsoft MS-DOS Operating System Version 2.0 or higher.
  40.  
  41. SD.COM is the non-memory resident version of the  program.    Since  the
  42. capabilities  and  command  syntax  of    the  two  programs are virtually
  43. identical, only the differences and additional capabilities  of  SDR.COM
  44. are  covered  in  this    document.  It is recommended that the user first
  45. become familiar with the use of SD.COM before using SDR.COM.   The  bulk
  46. of  the  command syntax for SDR.COM is therefore covered in the document
  47. for SD.COM.
  48.  
  49. This version of the program  requires  about  16Kb  of    disk  space  and
  50. about 24-68Kb of memory during    execution,  depending  on  the    size  of
  51. the directory, file and screen buffers configured by the user.    With the
  52. default buffer sizes, the program uses about 32Kb of system memory.
  53.  
  54. Support is provided for IBM-PC    compatible  MDA, CGA, MCGA, EGA, and VGA
  55. video adaptors and monitors.
  56.  
  57. ------------------------------------------------------------------------
  58.  
  59. 1.2    Design Philosophy
  60.  
  61. ------------------------------------------------------------------------
  62.  
  63. As is the case for SD.COM, SDR.COM provides more  information  than  the
  64. resident  DOS DIR command about the files on a disk, and allows the user
  65. to select, sort, format, and display the information  in  a  variety  of
  66. ways.     This is accomplished by specifying a pattern name to select the
  67. desired files and by  specifying  any  of  a  variety  of  command  line
  68. "switches"  which  allow you to modify the behavior of the program.  The
  69. switch names have been designed using letters, as much as  possible,  so
  70. that  it  is easier to associate the function of a switch with its name.
  71. In addition, the default switch values have  been  carefully  chosen  to
  72. reflect their most common use.
  73.  
  74. The advantage of a memory resident program is that it is  almost  always
  75. available for use, regardless of the other program(s) currently running.
  76. Otherwise, it would be necessary to either exit the current program  and
  77. return to the  DOS system command prompt in order to run the program, or
  78. use the "shell" facility that some programs  provide  to  execute  other
  79. programs  and  then regain control.  Since not all programs provide this
  80. capability, having your frequently used  utilities  in    memory    resident
  81. form  greatly increases their availability.  In addition, execution of a
  82. memory resident program is virtually instantaneous, since the program is
  83. only loaded from disk once.
  84.  
  85. The primary disadvantage  of  a  memory  resident  program  is    that  it
  86. consumes  system  memory  which  would otherwise be available to execute
  87. other programs.  Most memory resident programs are loaded once at system
  88. boot time  and    remain    in  memory  permanently.  Well    designed  memory
  89. resident programs are carefully written to minimize the amount of memory
  90. they use, and allow the user to configure the program to achieve a  good
  91. balance between functionality and  memory  consumption.    Another  more
  92. subtle disadvantage is that most  non-trivial  memory resident    programs
  93. must employ a variety of techniques to work around  the  limitations  in
  94. the DOS operating system and the IBM-PC BIOS.  Since there is not yet  a
  95. universally accepted standard for what these techniques should be, there
  96. is  no guarantee that any one memory resident program will be compatible
  97. with another, or even with other non-memory resident programs.
  98.  
  99. However, enough of  a  standard  has  emerged  to  write  useful  memory
  100. resident  programs, and the benefits of frequently used programs greatly
  101. outweigh the occasional incompatibilities for most users.  This  program
  102. has been designed in such a way as to try and maximize its compatibility
  103. with   other   programs.    However,  there  is   no   guarantee    that
  104. incompatibilities  will  not  arise  with a specific program.  When this
  105. occurs, a good strategy to follow is to try to simplify the  environment
  106. as  much  as  possible;  remove  other memory resident programs one at a
  107. time, or try changing the order in which they are loaded.
  108.  
  109. ------------------------------------------------------------------------
  110.  
  111. 2.1    Installation
  112.  
  113. ------------------------------------------------------------------------
  114.  
  115. Unlike non-memory resident programs, SDR is normally only executed once,
  116. immediately  after the operating system is booted.  This is best done by
  117. placing  the  command  "SDR"  in  the  AUTOEXEC.BAT  file    which    is
  118. automatically executed by DOS after boot-up.  As mentioned above, it may
  119. be necessary to experiment with different  loading  orders  of    multiple
  120. Terminate-and-Stay-Resident  programs.    In general, the more complex TSR
  121. type programs (such  as  BORLAND's  SideKick)  should  be  loaded  after
  122. simpler TSR  programs.    Like  most  TSR  programs, SDR    should    only  be
  123. installed at the top DOS command level, not from inside another program.
  124.  
  125. There are two SDR DOS command line switches  (/q and /z)  which  may  be
  126. specified at installation time.  A third switch (/r) is used  to  remove
  127. the program from memory and is described below.  These    switches  should
  128. not be confused with those used once you have activated the program  and
  129. are operating inside it.  The help screen displayed in response  to  the
  130. /? switch (inside SDR) flags these switches with an (*) character  as  a
  131. reminder that they are to be used on the DOS (not the SDR) command line.
  132.  
  133. The /q switch requests    "quiet"  installation  mode.  Normally,  if  the
  134. installation is successful, SDR will display a message in a box  showing
  135. the total amount of memory it is using and the activation key  sequence.
  136. This message cannot be suppressed by redirecting it  to  the  DOS  "NUL"
  137. device, since it is not displayed using  standard  DOS    video  services.
  138. Specifying the /q switch will prevent the message from being  displayed.
  139.  
  140. Similarly, the /z switch causes suppression of the message box which  is
  141. normally displayed when the program is activated by pressing the hot key
  142. sequence.  See the sections below  for    additional  information.  As  an
  143. example, you can install SDR and suppress both message boxes as follows:
  144.  
  145. D>SDR /Q/Z
  146.  
  147. Although it is rather unlikely, installation of SDR can  be  denied  for
  148. the following reasons:
  149.  
  150. 1) DOS 2.0 or later is required.
  151.  
  152. 2) The program has already been loaded into memory.
  153.  
  154. 3) The directory or file buffer sizes requested are out of bounds.   The
  155.    program was incorrectly  patched - this can't happen if the available
  156.    configuration program (SDC) is used.
  157.  
  158. 4) There is insufficient system memory available for the resident  code,
  159.    data, directory and file buffers.
  160.  
  161. 5) The program is unable to release memory it no longer needs.
  162.  
  163. 6) The program is unable to allocate memory for the screen buffer.
  164.  
  165. ------------------------------------------------------------------------
  166.  
  167. 2.2    Activation
  168.  
  169. ------------------------------------------------------------------------
  170.  
  171. Since the program is "memory resident", it is  available  for  use  even
  172. though another program is currently running. The program is activated by
  173. pressing the activation or "hot" key combination. The default activation
  174. key combination is CTRL-ESC (while holding down the CTRL key, press  the
  175. ESC key at the same time).  These key combinations can be changed  using
  176. the configuration program so as not to conflict with their possible  use
  177. by other programs.
  178.  
  179. Although the program will usually be able to  "go active"  or  "pop up",
  180. there are a few situations where this is not possible (or desirable!):
  181.  
  182. 1) If the program is already active.  Pressing the activation key  while
  183.    inside the  program is sometimes used to exit a TSR program.  Since a
  184.    different key (ESC) is used for this purpose  in  SDR,  this  is  not
  185.    allowed.
  186.  
  187. 2) If Disk I/O is in progress.    Although not recommended,  you may  find
  188.    that you can safely pop up SDR in the middle of reading or writing to
  189.    a disk.  At other times, the request may be denied.    This is  due  to
  190.    the need to serialize access to non-reentrant code in the PC BIOS.
  191.  
  192. 3) If the current video mode is  either  40  column  text  or  graphics.
  193.    Since SDR  requires    the  full  width of the screen in 80 column text
  194.    mode, it will decline to  activate  if  the    current  video    mode  is
  195.    incompatible with these requirements.  The primary programs which use
  196.    these video modes are BASIC programs.
  197.  
  198. 4) If a multitasking environment such as Microsoft Windows  or    DESQview
  199.    is currently being used.  Since these  environments    involve  complex
  200.    memory management functions, you should use SD rather than  SDR.  You
  201.    CAN use SDR with Windows/386 if you install it while inside Windows.
  202.  
  203. In the situations above, the activation request will be acknowledged  by
  204. an  audible  tone  or "beep", so that there is no doubt that the request
  205. was declined.  However, there is another situation where the program may
  206. not  appear  to activate.  Some programs or commands may perform certain
  207. long-running functions which do  not  provide  an  opportunity    for  TSR
  208. programs  to  activate.    A simple example is the TYPE command.  If you
  209. type a large file and press the activation key during  the  output,  the
  210. program  will  probably  not  go active and the audible tone will not be
  211. generated.  However, when the command ends,  either  normally  or  by  a
  212. CTRL-BREAK  interrupt,    SDR  will  activate.    Some TSR programs simply
  213. refuse to activate in this situation.
  214.  
  215. Another similar situation can occur when  one  TSR  program  is  already
  216. active    and refuses to allow a second TSR program to even "see" its hot-
  217. key sequence.  This is a characteristic of  "ill-behaved"  TSR  programs
  218. which  are  all too common.  Yet another scenario occurs when SDR "pops-
  219. up" over another TSR program but appears to be "dead".  Sometimes simply
  220. pressing  a  few  keys    will cause the "deadly embrace" to end, although
  221. these keys may be passed back to the previously invoked program.
  222.  
  223. Since SDR dynamically determines  the  video  configuration, this  means
  224. that  you can install it using one kind of video monitor and activate it
  225. from another kind.  You can switch between MDA,  CGA,  and  EGA  or  VGA
  226. monitors at will and SDR will adapt its operation to the monitor in use.
  227.  
  228. ------------------------------------------------------------------------
  229.  
  230. 2.3    Execution
  231.  
  232. ------------------------------------------------------------------------
  233.  
  234. After the activation key is accepted, the program "goes active" or "pops
  235. up".    At this point, the top few lines of the screen are cleared and a
  236. box with several lines of information is displayed.  A prompt appears on
  237. the screen line below the box.    Once you are familiar with the operation
  238. of the program, you may wish to use the SDR DOS command line  /z  switch
  239. to eliminate the box in  order    to  save  screen  space.  The  following
  240. options are now available:
  241.  
  242. 1) Enter a valid command line.    See below for details.
  243.  
  244. 2) Press the RETURN key to display the current directory.
  245.  
  246. 3) Enter /? to display command help information.
  247.  
  248. 4) Press ESC or CTRL-C to return to the suspended program.
  249.  
  250. The complete form of the command line is:
  251.  
  252. D:\path> [/switches] [drive][path][filespec] [/switches]
  253.  
  254. The prompt string consists of the current drive letter, followed by  the
  255. current  directory  path for the drive, followed by the prompt character
  256. (which may be configured).  The SDR prompt may appear alarmingly similar
  257. to  your  DOS  system prompt; the DOS command: PROMPT $P$G generates the
  258. same type of prompt string.  To avoid confusion, SDR allows  the  prompt
  259. character  to  be  changed,  and  the  default    is  a graphics character
  260. different from the usual (>) character.
  261.  
  262. The rest of the command line  parameters  (drive,  path,  filespec,  and
  263. switches)  are    just  like those accepted by the SD.COM program.  Please
  264. refer to the documentation for SD for details.
  265.  
  266. The command line must be terminated by the  RETURN  or    ENTER  key.  The
  267. Backspace key may be  used  to remove previously typed characters on the
  268. command line.  Since SDR must avoid the use of DOS console  services  in
  269. resident code, utilities like PCED, CED, and DOSEDIT which allow editing
  270. the DOS command line will unfortunately not function inside SDR.
  271.  
  272. After the output of the current command is displayed, the prompt  string
  273. is  redisplayed.   This allows you to enter as many commands as  desired
  274. before returning to the  suspended  program.   Keep  in  mind  that  the
  275. program which was in control when the activation key was pressed is in a
  276. suspended state; this implies that you will not  wish  to  activate  SDR
  277. (even  though  it is allowed) when executing a time-critical program.  A
  278. good example of this is a modem communication program which  is  in  the
  279. middle of a file transfer with a remote system.
  280.  
  281. To see SDR in operation, try the following example:
  282.  
  283. 1) Execute the BASIC language interpreter with the command: BASICA
  284.  
  285. 2) Enter the following BASIC command: FOR I=1 TO 999 : ? I,SQR(I) : NEXT
  286.  
  287. 3) Press RETURN and wait until the screen fills
  288.  
  289. 4) Press the SDR activation keys: CTRL-ESC
  290.  
  291. 5) Press RETURN several times to display the directory
  292.  
  293. 6) Press ESC to return to the BASIC program
  294.  
  295. 7) Notice that the program picks up where it left off
  296.  
  297. 8) Press CTRL-BREAK to terminate the BASIC program
  298.  
  299. Unlike most programs, you can't type ahead while the program is running.
  300. This is due to the need to monitor the keyboard in order  to  pause  the
  301. screen output.    If you wish to begin typing a new command, simply  press
  302. ESCAPE (preferred) or Control-C to  immediately  terminate  the  output,
  303. and then type the next command.
  304.  
  305. Console output may be paused by typing any other character  and  may  be
  306. restarted in two different ways.  If RETURN is    pressed,  screen  output
  307. resumes until the either the screen fills or  the  output  finishes.  If
  308. any other character is typed, only a single line  of  additional  screen
  309. output is displayed.  This allows you to easily  control  the  displayed
  310. output so as to minimize the loss of existing screen data by  scrolling.
  311. The recommended single line scroll keys are the Space Bar or Down Arrow.
  312.  
  313. ------------------------------------------------------------------------
  314.  
  315. 2.4    Termination
  316.  
  317. ------------------------------------------------------------------------
  318.  
  319. The only way to exit from SDR to the suspended program    is  by    pressing
  320. the  ESC or CTRL-C key from the SDR command prompt.  Pressing CTRL-BREAK
  321. will not exit from SDR and will appear to be ignored, but the  interrupt
  322. may be seen by the suspended program when SDR is exited normally.
  323.  
  324. If the ESC key is used to exit from SDR, the console screen is    restored
  325. to  its original state, and the cursor position and size are restored to
  326. their original state when the original program was suspended.
  327.  
  328. If the CTRL-C key is used to exit from SDR and the original screen  line
  329. containing  the  cursor  before  SDR was activated is still visible, the
  330. cursor is restored  to    its  original  state,  but  the  screen  is  NOT
  331. restored.   A divider line is displayed over the last SDR prompt line to
  332. clearly separate the original and subsequent screen output.  The  reason
  333. for  this  behavior is to allow you to retain output generated by SDR in
  334. order to be able to refer  to  it  when  you  return  to  the  suspended
  335. program.  Once the original cursor line is overwritten, either by screen
  336. output, scrolling, or clearing the screen, CTRL-C will cause the  entire
  337. screen    to  be    restored,  just like ESC.  Therefore, if you plan to use
  338. this feature, you will want to position  the  cursor  as  close  to  the
  339. bottom    of  the screen as possible before activating SDR.  Once you have
  340. referred to the SDR output, you may wish to perform  an  action  in  the
  341. suspended  program  which  will  cause    the  screen  to be rewritten, in
  342. order to avoid confusion and to resynchronize the display.
  343.  
  344. ------------------------------------------------------------------------
  345.  
  346. 2.5    Removal
  347.  
  348. ------------------------------------------------------------------------
  349.  
  350. SDR prevents the user from loading multiple copies of itself in order to
  351. avoid wasting memory.  It can be removed from memory by running it again
  352. with the /r command line switch specified.  This  is  helpful  when  the
  353. program is being configured for different screen colors, etc.  in  order
  354. to avoid a system reboot to load a new copy of the program.  It can also
  355. be useful if the need arises to release as much memory as  possible  for
  356. some other purpose.
  357.  
  358. Although it is rather unlikely, removal of SDR can  be    denied    for  the
  359. following reasons:
  360.  
  361. 1) The program is not already loaded in memory.
  362.  
  363. 2) Interrupt vectors previously saved and changed by  the  program  have
  364.    been subsequently altered by another program.
  365.  
  366. 3) The program is unable to release memory it no longer needs.
  367.  
  368. SDR will decline to remove itself from    memory    if  it    determines  that
  369. another TSR program has stolen    one  of  the  interrupt vectors which it
  370. saves and then changes.  In this case, you must remove the other program
  371. from memory before you can remove SDR.    A good example is when BORLAND's
  372. SideKick utility is used with SDR.  In this case, install SDR first  and
  373. SideKick second.  You must remove SideKick first, and SDR  second.  This
  374. is necessary since SideKick constantly monitors the interrupt vectors it
  375. steals and if it detects that another program has stolen them, it steals
  376. them back again!
  377.  
  378. Although a few TSR programs provide a means of    deinstalling  themselves
  379. from  memory  (such  as  SDR),    most do not.  However, there are several
  380. utilities available which provide this capability.  MARK and RELEASE  by
  381. TurboPower  Software  and  INSTALL and REMOVE by PC Magazine are readily
  382. available on many bulletin boards.   These  programs  require  that  you
  383. execute  a  special program before installing a TSR program, and another
  384. program when you wish to remove the TSR program.  They    work  by  saving
  385. information about the state of the Interrupt Vector Table and DOS Memory
  386. Control Blocks so that this information can  be  subsequently  restored,
  387. thus effectively removing the TSR program.
  388.  
  389. There are also several utility programs available which display  all  of
  390. the currently loaded TSR programs, along with  information  on    how much
  391. memory they use, which interrupts they "steal", etc.  By observing which
  392. interrupts are stolen by each TSR program, it is possible  to  determine
  393. which programs are likely to conflict with each other.
  394.  
  395. If you use one of these programs to display  the  currently  loaded  TSR
  396. programs, you may notice that  some  are  identified  by  their  program
  397. names and some are not.  Starting with    DOS  V3, the  path  and  program
  398. name used to execute a program are stored  in  the  program  environment
  399. memory block.  It is  generally  considered  good  practice  for  a  TSR
  400. program to release this environment block  (usually less than 100 bytes)
  401. at the time it is installed, and SDR does this.  A side effect    of  this
  402. action is that    programs  which  scan  the  memory  control  blocks  and
  403. display information about TSR programs cannot obtain the program name.
  404.  
  405. When any TSR program is removed from memory  and  it  is  not  the  last
  406. loaded TSR program, a gap in memory will result  from  the  creation  of
  407. the resulting free memory block.  DOS  will  not  normally  be    able  to
  408. use this memory unless all TSR programs  above    it  are  first    removed.
  409. This implies that TSR programs should always be removed in the    opposite
  410. order in which they were installed, in order  to  maximize  the  use  of
  411. available memory for other programs.
  412.  
  413. ------------------------------------------------------------------------
  414.  
  415. 3.1    Switch Differences
  416.  
  417. ------------------------------------------------------------------------
  418.  
  419. Although most of the command line switches function the same in  SDR  as
  420. they do in SD, there are differences due to the operating environment.
  421.  
  422. Although the /e switch may still be used to clear the screen before  the
  423. execution  of an individual command, using the SDC program to turn  this
  424. switch ON as a default will cause the entire screen to be  cleared  each
  425. time  SDR  "pops-up", but not automatically for each subsequent command.
  426.  
  427. The Environment Size, TSR Memory, and System Memory Used and Free values
  428. displayed by the /i switch reflect the system memory at  the  time  just
  429. after SDR was installed and may be incorrect if other TSR programs  have
  430. been subsequently loaded.  SDR will not be able to read the Boot  Sector
  431. for drives above C: when it is activated from  the  DOS  command  prompt
  432. (rather than when inside most other programs).    In this  case,    some  of
  433. the disk parameter values will appear as NONE or zeros.
  434.  
  435. The /q switch requests "quiet" installation of SDR when specified on the
  436. DOS command line as described above.  When used inside SDR, it functions
  437. just as it does in SD to generate "quick" output without user prompts.
  438.  
  439. The /r switch is normally used in SD to allow the program output  to  be
  440. redirected to a file or to the printer. Since this function is performed
  441. by the DOS command interpreter, it is  not  available  inside  a  memory
  442. resident program.  The /r switch is used to remove SDR from memory (when
  443. specified on the DOS command line to execute SDR), and is ignored  if it
  444. is specified on the command line inside SDR.
  445.  
  446. The /w switch resets the screen to 25 lines after the execution  of  the
  447. current command in SDR, NOT when SDR returns to the suspended program.
  448.  
  449. The /z switch is normally used in SD to cause the screen to be saved and
  450. restored.  When specified on the SDR DOS command line, it suppresses the
  451. activation message box.  If you often use the CTRL-C key  to  exit  from
  452. SDR, you may wish to specify /z when installing SDR  so  that  you  have
  453. more room to use on the screen.  The /z  switch  is  ignored  if  it  is
  454. specified on the command line inside SDR.
  455.  
  456. The SD /$ switch, which is designed to facilitate the  operation  of  SD
  457. when it is executed inside a DOS Batch file, is not implemented in SDR.
  458.  
  459. The EGA and VGA switches (/25, /35, /43, /50) should be used cautiously.
  460. If you use an EGA or VGA video adaptor and wish  to  use  more    than  25
  461. screen lines, make sure you select screen buffer type 2 (8000 bytes)  in
  462. the configuration program.  Otherwise, only the first 25  lines  of  the
  463. original screen will be restored.  Even so, it is recommended  that  you
  464. reset the screen to its original size before returning to  the suspended
  465. program, unless it is known to be able to tolerate this kind of  dynamic
  466. video mode switching.
  467.  
  468. It should be kept in mind that SDR has several restrictions placed on it
  469. which do not apply to the simpler  operating  environment  of  SD.  Even
  470. though SDR can be activated from the DOS command prompt, you may  prefer
  471. to use SD in this situation for the following reasons:
  472.  
  473. 1) Previous screen output is more readily visible.
  474.  
  475. 2) More directories and files can be processed.
  476.  
  477. 3) Output may be redirected to a file or device.
  478.  
  479. 4) Full disk parameter information for drives above
  480.    C: is available when requested by the /i switch.
  481.  
  482. SDR should therefore not be viewed as a total replacement for SD, but as
  483. a supplementary program which is available in more environments.
  484.  
  485. ------------------------------------------------------------------------
  486.  
  487. 3.2    Configuration
  488.  
  489. ------------------------------------------------------------------------
  490.  
  491. The SDR program may be configured (using SDC) or  patched  (using DEBUG)
  492. to change the various program defaults to  those  you  prefer.    The  SDC
  493. program is preferred over DEBUG since it is much easier and safer to use
  494. and allows you to decide which combination of screen colors you  prefer.
  495. It also allows you to first configure the SD  program  for  the  default
  496. switches and screen colors you prefer and to then transfer these  values
  497. to the SDR program, without having to leave the  configuration    program.
  498. You will then only have to configure the options  which  are  unique  to
  499. SDR.  Run the DEMO2.BAT file to see some examples of the SDC program.
  500.  
  501. If you are using DEBUG, you will need to refer    to  the  section  titled
  502. Patch Area Format in the SD.DOC file to obtain the necessary offsets and
  503. data values.
  504.  
  505. Activation Key Specification
  506.  
  507. Great care should be taken  in    selecting  the    activation  or    hot  key
  508. sequence.  It must be unique enough that it will never be needed for any
  509. other purpose by any program you normally use.    This usually means  that
  510. an ALT or CTRL key combination is the best choice.
  511.  
  512. For PC-AT style keyboards, the SysReq key cannot be used as  a    hot  key
  513. since it is processed differently from    the  other  standard  keys.  The
  514. new keys on enhanced 101 key keyboards such as F11 and F12  also  cannot
  515. be used since they are processed differently by the ROM BIOS.
  516.  
  517. Hot Key Control Codes (select any combination from 0-15)
  518.  
  519. 1 = Right Shift Key   4 = Ctrl Key
  520. 2 = Left Shift Key    8 = Alt Key
  521.  
  522. The default hot key control code is 4 (CTRL).
  523.  
  524. Hot Key Scan Codes (select any value from 0-255)
  525.  
  526. Escape         = 01     Home       = 71  Shift F1-F10      =  84- 93
  527. 1234567890-= = 02-13  Up Arrow       = 72  Ctrl  F1-F10      =  94-103
  528. Back Space   = 14     Page Up       = 73  Alt   F1-F10      = 104-113
  529. Tab         = 15     Left Arrow   = 75  Ctrl PrtSc      = 114
  530. QWERTYUIOP[] = 16-27  Right Arrow  = 77  Ctrl Left Arrow  = 115
  531. Enter         = 28     Keypad +       = 78  Ctrl Right Arrow = 116
  532. ASDFGHJKL;'` = 30-41  End          = 79  Ctrl End         = 117
  533. \ZXCVBNM,./  = 43-53  Down Arrow   = 80  Ctrl PgDn      = 118
  534. *         = 55     Page Down    = 81  Ctrl Home      = 119
  535. Space         = 57     Insert       = 82  Alt 1234567890-= = 120-131
  536. F1-F10         = 59-68  Delete       = 83  Ctrl Pgup      = 132
  537.  
  538. The default hot key scan code is 1 (ESC).
  539.  
  540. Hot Key String
  541.  
  542. You may enter a character string of from 1 to 16 characters  which  will
  543. be displayed as part of the program's installation message as a reminder
  544. of the hot key sequence. The default hot key string is CTRL-ESCAPE Keys.
  545. If you use DEBUG, make sure that the  string  is  padded  with    trailing
  546. spaces through the 16th character,  if    necessary,  and  that  the  next
  547. character is a NULL (hexadecimal 00).
  548.  
  549. Prompt Character Specification
  550.  
  551. The default prompt character (code 26, a graphics  right  arrow  symbol)
  552. was chosen to be different from, but similar to the standard DOS command
  553. line prompt character.    You may change it to any  standard  or    extended
  554. ASCII character from 0-255.
  555.  
  556. SDR Memory Usage
  557.  
  558. Dir Buffer    Minimum     Default     Maximum
  559. ----------    -------     -------     -------
  560. Bytes            512        1024        4096
  561. Dirs             32          64         256
  562.  
  563. File Buffer    Minimum     Default     Maximum
  564. -----------    -------     -------     -------
  565. Bytes           2560       10240       40960
  566. Files            102         409        1638
  567. ARC Files         88         353        1412
  568.  
  569. Memory Usage    Minimum     Default     Maximum
  570. ------------    -------     -------     -------
  571. Code & Data      16928       16928       16928
  572. Dir Buffer        512        1024        4096
  573. File Buffer       2560       10240       40960
  574. Screen Buffer       4000        4000        8000
  575. Total          24000       32192       69984
  576.  
  577. Buffer Size Specifications
  578.  
  579. The choice of the directory and file buffer size values is  based  on  a
  580. trade-off  between minimizing the amount of memory used and allowing for
  581. a reasonable number of directories  and  files.  Each  directory  buffer
  582. entry uses a variable number of bytes from 4 to  70,  depending  on  the
  583. length of the directory  name.    For  the  purposes  of    performing  some
  584. calculations, we will assume an average  directory  name  length  of  13
  585. characters, or 16 bytes per directory buffer  entry.  Each  file  buffer
  586. entry uses 25 bytes per file or 29 bytes for files inside ARC files.
  587.  
  588. The default buffer sizes are 1024 bytes for about 64  directory  entries
  589. and 10240 bytes for about 409 files/directory  or  353    files/ARC  file.
  590. The directory buffer is only  used  when  processing  global directories
  591. with the /g switch.  Its size may range from  512  to  4096  bytes.  The
  592. file buffer is always used and contains all of the file and subdirectory
  593. names for an individual directory or ARC file.    Its size may range  from
  594. 2560 to 40960 bytes.  The size of the resident code and  data  excluding
  595. these two buffers is currently about 16928 bytes.  The    buffer    used  to
  596. save the screen may be configured for either 4000  or  8000  bytes.  You
  597. can therefore configure the program to use as little as  about    24Kb  of
  598. memory or as much as about 68Kb.
  599.  
  600. The total memory used not including the screen buffer must be less  than
  601. 64Kb.  This limit is strictly enforced; you  will  receive  the  "Memory
  602. error" message when installing SDR if the total configured  memory  size
  603. exceeds this.  If you attempt  to  exceed  the    configured  buffer  size
  604. limits when running the program, you will receive the "Too many dirs" or
  605. "Too many files" message, and the resulting output will be incomplete.
  606.  
  607. The default screen buffer size is 4000 bytes.  This  is  sufficient  for
  608. either a Monochrome or CGA equipped PC.  However, if you use an  EGA  or
  609. VGA monitor and sometimes use more than 25 lines on the screen, you  may
  610. wish to configure an 8000 byte screen buffer to allow for up to 50 lines
  611. of 80 characters.  Failure to do this will result in only the  first  25
  612. screen lines being restored.
  613.  
  614. ------------------------------------------------------------------------
  615.  
  616. 3.3    Error Messages
  617.  
  618. ------------------------------------------------------------------------
  619.  
  620. The following error messages are displayed and system return  codes  set
  621. for various conditions which may arise.  An audible tone is generated to
  622. alert the user of severe errors.  The return codes may be  tested  using
  623. the standard DOS IF ERRORLEVEL statement in a .BAT file.
  624.  
  625. No matching files (directory may be empty)
  626. Bad switch (use /? for help information)
  627. Bad drive (doesn't exist or syntax error)
  628. Bad path (doesn't exist or syntax error)
  629. Bad filespec (syntax error)
  630. Bad date (too large or syntax error)
  631. Too many dirs (buffer limit exceeded for /g)
  632. Too many files (buffer limit exceeded)
  633. Disk error (floppy disk may not be in drive)
  634.  
  635. 0 - Removed (in response to /r switch)
  636. 1 - Already loaded (can't reload unless removed)
  637. 2 - Not loaded (can't remove unless loaded)
  638. 3 - Can't remove (interrupt vectors changed)
  639. 4 - Memory error (insufficient or (de)allocation problem)
  640.  
  641. ------------------------------------------------------------------------
  642.  
  643. IBM and PC-DOS are trademarks of IBM Corporation.
  644. MICROSOFT and MS-DOS are trademarks of Microsoft Corporation.
  645. DESQview is a trademark of Quarterdeck Office Systems.
  646. SideKick is a trademark of BORLAND International Corporation.
  647. ARC is a trademark of SEA Corporation.
  648.  
  649. ------------------------------------------------------------------------
  650.