home *** CD-ROM | disk | FTP | other *** search
/ PC Home 44 / PC_Home_Issue_44.iso / image / pfinish / disk2 / hpscaner.do_ / hpscaner.bin
Encoding:
Text File  |  1993-07-28  |  12.7 KB  |  327 lines
  1. HP ScanJet Driver (generic)
  2. Copyright (C) 1993 WordStar Atlanta Technology Center, Inc.
  3. All rights reserved.
  4.  
  5.  
  6. INTRODUCTION
  7. ============
  8. The ZSoft MS-DOS scanner driver provides the means for ZSoft MS-DOS and 
  9. MS-Windows scanning applications to use a wide variety of scanners through 
  10. a common interface.
  11.  
  12.  
  13. LOADING THE DRIVER
  14. ==================
  15. In order for the scanning application to use the scanner driver, it must be 
  16. loaded before the application is run. The scanner driver may be loaded in one 
  17. of two ways -- using the device driver method, or the TSR method.
  18.  
  19. If you are using MS-DOS 5.0 or higher, or are using a 386 memory manager 
  20. program such as 386MAX or QEMM, the scanner driver may be loaded into upper
  21. memory.
  22.  
  23. The Device Driver Method
  24. ------------------------
  25. The device driver method of loading has the advantage of requiring the least 
  26. amount of DOS memory to load. However, with care, the TSR method can be as 
  27. efficient as the device driver method for all practical purposes. The device 
  28. driver method does not have the advantage of being able to unload from memory 
  29. when not needed. This is of no consequence in many system configurations, but 
  30. may be important for other setups that may scan only on rare occasions.
  31.  
  32. The device driver load method is accomplished by adding a line to your 
  33. CONFIG.SYS file of the form:
  34.  
  35.     DEVICE=<path><driver> <command line parameters>
  36.  
  37. <path> is the complete path to the scanner driver, or may be omitted if the 
  38. driver is in the root directory of the disk drive that boots your system.
  39. <driver> is the name of the scanner driver itself. <command line parameters> 
  40. are options that may be needed, depending on your system configuration. See 
  41. the section on COMMAND LINE PARAMETERS to see if you need to use any of them.
  42.  
  43. An example line in CONFIG.SYS might look like:
  44.  
  45.     DEVICE=C:\PHOTO\HPSCANER.EXE /Q
  46.  
  47. The TSR Method
  48. --------------
  49. The TSR method of loading the scanner driver gives you the flexibility to 
  50. load and unload it as needed. When it is loaded as a TSR, it operates in the 
  51. same way as it would if it were loaded as a device driver, but can be removed 
  52. from memory at a later time if desired. Loading the scanner driver from a BAT 
  53. file is perfectly acceptable. The TSR method must be used with care, as there 
  54. are several caveats.
  55.  
  56. Do not attempt to load the driver while in a DOS shell from another 
  57. application. This also applies to DOS windows and shells while running 
  58. Microsoft Windows.
  59.  
  60. In order for the driver to be unloaded, it must be the last TSR program run. 
  61. Normally, this is the case if you load the driver and immediately run the 
  62. scanning application.
  63.  
  64. If there are many DOS environment variables at the time the scanner driver 
  65. is loaded, a copy of those variables is saved in memory along with the driver. 
  66. On some systems, this could be several hundred bytes. This extra memory is 
  67. released if the driver is successfully unloaded at a later time. If the 
  68. scanner driver is being loaded in AUTOEXEC.BAT, try to loading it as the last 
  69. TSR program, but before any SET commands.
  70.  
  71. The TSR load method is accomplished by executing a DOS command, either from 
  72. the DOS prompt or from a batch file, of the form:
  73.  
  74.     <path><driver> <command line parameters>
  75.  
  76. <path> is the complete path to the scanner driver, or may be omitted if the 
  77. driver is in the current directory or in a directory specified by your PATH
  78. variable. <driver> is the name of the scanner driver itself. <command line 
  79. parameters> are options that may be needed, depending on your system 
  80. configuration. See the section on COMMAND LINE PARAMETERS to see if you need 
  81. to use any of them.
  82.  
  83. An example DOS command line might look like:
  84.  
  85.     HPSCANER.EXE /Q
  86.  
  87.  
  88. LOW-LEVEL I/O DRIVER
  89. ====================
  90. The scanner driver communicates with the adapter hardware through a low-level 
  91. I/O driver. This I/O driver must be loaded by adding a line to your CONFIG.SYS 
  92. file before the scanner driver is loaded. The I/O driver entry in CONFIG.SYS 
  93. should look like one of the following:
  94.  
  95.     CONFIG.SYS ENTRY          HARDWARE CONFIGURATION
  96.     ----------------          ----------------------
  97.     device=SJDRIVER.SYS       ScanJet or ScanJet Plus
  98.     device=SJII.SYS           ScanJet IIc or ScanJet IIp
  99.  
  100. depending on which hardware configuration is appropriate for your system. For
  101. example, loading the I/O driver and the scanner driver in CONFIG.SYS might 
  102. look like:
  103.  
  104. device=c:\photo\sjii.sys
  105. device=c:\photo\HPSCANER.EXE /Q
  106.  
  107.  
  108. COMMAND LINE PARAMETERS
  109. =======================
  110. You may also need to add one or more command line parameters to the command 
  111. used to load the scanner driver, depending on your system configuration. These
  112. parameters apply to both the device driver and TSR load methods, except /U 
  113. which applies only to the TSR load method.
  114.  
  115. The following list is displayed by the scanner driver, if the /? or /H command 
  116. line parameters are used, which displays all of the command line parameters 
  117. supported.
  118.  
  119.     
  120.     ZSoft MS-DOS Scanner Driver Version 6.10    
  121.     Copyright (c) WordStar Atlanta Technology Center, Inc. 1991-1993.
  122.     All rights reserved.
  123.     
  124.     Valid parameters:
  125.     
  126.     /Cx    = application Code (1-4)
  127.     /H     = display this Help text
  128.     /?     = display this help text
  129.     /Q     = load Quiet, without initializing scanner
  130.     /Rs    = Resolution strategy (/RH=High, /RM=Medium, /RL=Low)
  131.     /T     = perform diagnostic Testing
  132.     /U     = Unload driver
  133.     /V     = Verbose messages and status displays
  134.  
  135.  
  136. /C
  137. --
  138. The application code provides a method of identifying the application that is
  139. being used with the scanner driver to maximize scanner functionality. This 
  140. parameter is not required for Revision 6 compliant applications. If the 
  141. parameter is omitted, the application will still work, but may be missing some 
  142. features.
  143.  
  144. The codes are:
  145.  
  146.     /C1 = PC Paintbrush Plus (DOS)
  147.     /C2 = PC Paintbrush Plus (Windows)
  148.     /C3 = PC Paintbrush IV Plus (DOS)
  149.     /C4 = Publisher's Paintbrush (Windows)
  150.  
  151. Applications not listed (i.e. PhotoFinish, PC Paintbrush 5+, and UltraFAX) do 
  152. not need an application code parameter.
  153.  
  154. /Q
  155. --
  156. Allows the loading of the scanner driver regardless of the scanner status.
  157. Normally, the scanner driver will attempt to communicate with the scanner 
  158. when the driver loads, mainly for the purpose of identifying the scanner. 
  159. The advantage is that the driver will not load if the scanner identification 
  160. fails, and the application will disable its scanning functions. In some cases, 
  161. subsequent initialization of the scanner by applications may be faster. The 
  162. disadvantage is that the scanner must be powered up every time you boot your 
  163. machine (assuming you load the driver in either CONFIG.SYS or AUTOEXEC.BAT). 
  164. If you don't want to have to leave your scanner turned on, using /Q will 
  165. allow the driver to load without any communication with the scanner.
  166.  
  167. /R
  168. --
  169. The scanner possibly supports more resolutions than an application can 
  170. handle. The /R command allows the user to specify emphasis on low, medium, 
  171. or high resolutions. The actual results vary with the scanner and the 
  172. application. /RL is for lower resolutions, /RM is for medium resolutions, and 
  173. /RH is for high resolutions. The default is to provide evenly spaced 
  174. resolutions from its lowest to its highest. This command applies mostly to 
  175. "older" applications that handle 6 resolutions or fewer.
  176.  
  177. /T
  178. --
  179. The test parameter is provided as a diagnostic aid for the end user (and
  180. support people). Using this parameter will tell the driver to attempt
  181. communication with the scanner hardware and report on its success. This will
  182. aid the user in determining if the scanner hardware and driver settings are
  183. properly matched or if there are any conflicts.
  184.  
  185. An optional argument may be supplied to choose specific tests. Is this 
  186. argument is omitted, all tests will be performed.
  187.  
  188.   ARG  DESCRIPTION
  189.   ---  -----------
  190.    1   Test the scanner lamp.
  191.    2   Test the scanner element positioner.
  192.    3   Perform all of the above tests (default).
  193.    4   Don't perform any of the above tests.
  194.  
  195. /U
  196. --
  197. The unload command will remove the scanner driver from memory, thus freeing
  198. memory space for other applications. The scanner driver can only be removed
  199. if it was loaded using the TSR method, and was the last TSR loaded. See the
  200. section on The TSR Method for more information.
  201.  
  202. /V
  203. --
  204. By default the scanner driver will load and display a copyright notice and the 
  205. amount of memory occupied. If you would like the current settings of the 
  206. driver displayed as well, the /V parameter should be specified.
  207.  
  208.  
  209. ERROR AND STATUS MESSAGES
  210. =========================
  211. The following is a list of messages that the driver can display when it is 
  212. loaded or run.
  213.  
  214. Loaded driver found.
  215.  
  216.     This message is displayed when the scanner driver is already loaded and an
  217.     attempt is made to re-load the driver.  This message will be followed by a
  218.     display of the currently loaded driver settings.
  219.  
  220. The scanner driver has been removed from memory.
  221.  
  222.     This message is displayed when the /U parameter is specified to unload
  223.     the scanner driver (TSR mode only).
  224.  
  225. Invalid parameter "?"
  226.  
  227.     This message is displayed when the scanner driver finds a command line
  228.     parameter the driver does not support or recognize.
  229.  
  230. Old format scanner driver currently loaded.
  231. Remove scanner driver from CONFIG.SYS and reboot.
  232.  
  233.     This message is displayed when the user attempts to load a scanner driver 
  234.     "over" an old format scanner driver. Remove the old scanner driver from 
  235.     CONFIG.SYS and try again.
  236.  
  237. Not enough memory (need another xxxx bytes).
  238.  
  239.     There is not enough free DOS memory to load the driver.
  240.  
  241. Driver not loaded.
  242.  
  243.     This message is displayed along with the error messages listed above to
  244.     inform the user that the scanner driver has not been loaded.
  245.  
  246. Cannot UNload driver loaded from CONFIG.SYS.
  247. Can only UNload TSR driver (loaded from DOS).
  248.  
  249.     This message is displayed when the user specifies the /U parameter and the
  250.     scanner driver was not loaded using the TSR method.  The scanner driver 
  251.     can only be unloaded if it has been loaded as a TSR, and was the last TSR 
  252.     loaded. See the section on The TSR Method for more information.
  253.  
  254.  
  255. Invalid application code.
  256.  
  257.     This message is displayed when the user specifies an invalid value for the 
  258.     /C parameter.
  259.  
  260. Invalid resolution strategy.
  261.  
  262.     This message is displayed when the user specifies an invalid value for the 
  263.     /R parameter.
  264.  
  265. Driver loaded, using <x> bytes of DOS memory, <y> bytes free.
  266.  
  267.     This message is displayed when the scanner driver is loaded into memory 
  268.     and informs the user of the amount of memory used by the driver.
  269.  
  270. Testing scanner hardware...
  271. Scanner identified as: HP ScanJet Model xxxxx
  272.    Firmware date code: xxxx (mmm dd, yyyy)
  273.       Document Feeder: Present
  274.       Document Feeder: Not present
  275.             Lamp Test: Passed.
  276.             Lamp Test: Failed.
  277.       Positioner Test: Passed.
  278.       Positioner Test: Failed.
  279. Scanner hardware test: Passed.
  280. Scanner hardware test: Failed.
  281.  
  282.     These messages are displayed when the /T parameter is included on the 
  283.     command line.
  284.  
  285. Initializing Scanner...
  286.  
  287.     This message is displayed while the driver is initializing the scanner.
  288.     If the /Q parameter is used, this message will not display.
  289.  
  290. Supporting: HP ScanJet Model xxxxx
  291.  
  292.     Indicates that the scanner has been identified by the driver during load.
  293.     If the /Q parameter is used, this message will not display.
  294.  
  295. Helper driver not loaded. Add one of the following:
  296.  
  297.   DEVICE=SJDRIVER.SYS  (for ScanJet interface)
  298.   DEVICE=SJII.SYS   (for ScanJet II interface)
  299.  
  300. to your CONFIG.SYS and reboot.
  301.  
  302.     Indicates that the required low-level I/O driver is not present. Follow
  303.     the instructions.
  304.  
  305. Cannot initialize scanner. Try turning the scanner off, then back on.
  306.  
  307.     For some reason, the scanner hardware and the adapter cannot communicate.
  308.  
  309.  
  310. MS-DOS ERRORLEVEL EXIT CODES
  311. ============================
  312. ZSoft MS-DOS scanner drivers set the DOS ERRORLEVEL value after they have 
  313. run. If desired, a batch file can test the errorlevel to determine the 
  314. success or failure of the driver load command, and take appropriate action.
  315.  
  316. CODE  MEANING
  317. ----  -------
  318.  0    Driver loaded successfully.
  319.  1    Old format scanner driver currently loaded.
  320.  2    Attempt to unload when the driver was not previously loaded.
  321.  3    Cannot UNload driver loaded from CONFIG.SYS.
  322.  4    Invalid command argument.
  323.  5    Initialization failure. Could be due to a hardware problem, or possibly 
  324.       a missing low-level I/O driver.
  325.  6    Not enough memory to load.
  326.  7    Test function failed.
  327.