home *** CD-ROM | disk | FTP | other *** search
/ Share Gallery 1 / share_gal_1.zip / share_gal_1 / UT / UT189.ZIP / PATH-MAN.ZIP / PATH-MAN.DOC < prev    next >
Text File  |  1991-05-24  |  14KB  |  335 lines
  1.  
  2.  
  3.    Ç    ────────────────────────────────────────────
  4.  Ç ┼┐────────────────────────────────────────────   
  5. ╔╬╗ ┴                                               
  6. ╨║╨ ┐                                               
  7. ╔╩╗ ┴                                               
  8. ╨ ╨                                                 
  9.  
  10.  
  11.  
  12. ▒▒▒▒▒▒▒▒▄    ▒▒▄   ▒▒▒▒▒▒▒▒▄ ▒▒▄   ▒▒▄         ▒▒▄   ▒▒▄    ▒▒▄    ▒▒▄   ▒▒▄
  13. ▒▒█▀▀▀▒▒█   ▒▒▒▒▄     ▒▒█▀▀▀ ▒▒█   ▒▒█         ▒▒▒▄ ▒▒▒█   ▒▒▒▒▄   ▒▒▒▄  ▒▒█
  14. ▒▒▒▒▒▒▒▒█  ▒▒█▀▒▒▄    ▒▒█    ▒▒▒▒▒▒▒▒█ ▒▒▒▒▒▒▄ ▒▒▒█ ▒▒▒█  ▒▒█▀▒▒▄  ▒▒█▒▒▄▒▒█
  15. ▒▒█▀▀▀▀▀▀  ▒▒▒▒▒▒█    ▒▒█    ▒▒█▀▀▀▒▒█  ▀▀▀▀▀▀ ▒▒█▒▒▄▒▒█  ▒▒▒▒▒▒█  ▒▒█ ▀▒▒▒█
  16. ▒▒█       ▒▒█▀▀▀▒▒▄   ▒▒█    ▒▒█   ▒▒█         ▒▒█▒▒█▒▒█ ▒▒█▀▀▀▒▒▄ ▒▒█   ▒▒█
  17.  ▀▀        ▀▀    ▀▀    ▀▀     ▀▀    ▀▀          ▀▀ ▀▀ ▀▀  ▀▀    ▀▀  ▀▀    ▀▀
  18.  
  19.  
  20. Welcome to PATH-MAN, a utility program to deter-
  21. mine if a file is located on a PATH directory!
  22.  
  23. PATH-MAN is a utility that searches the directory path elements of the
  24. PATH statement for a given file. The search file name may include DOS
  25. wildcard characters. The ERRORLEVEL variable is set, based on the
  26. results of this search, to allow more user friendly batch files - a graceful exit
  27. can be made when needed data files or programs are missing. Optionally,
  28. the path element on which the search file is located may be displayed. 
  29.  
  30.  
  31. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  32.  
  33. P A T H - M A N   U T I L I T Y   M A N U A L
  34.  
  35. PATH-MAN Version 1.10
  36.  
  37. Released    May 24, 1991
  38. ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  39. Copyright (C) 1991
  40. by Micrometric 
  41. All rights reserved. 
  42.  
  43. PATH-MAN is distributed as SHAREWARE and, as such, may be copied
  44. and shared on a private non-commercial basis with others in its unmodified
  45. form. Liability is limited to replacing the software for registered users.
  46. There is no liability for any damage or loss caused by this software, directly
  47. or indirectly. 
  48.  
  49.      ┌───────┐                                                 
  50. ┌────┴──┐    │                                                 
  51. │  ┌────┴──┐ │                                                 
  52. │  │       │ │   Member, Association of Shareware Professionals
  53. │  │   o   ├─┘                                                 
  54. └──┤   │   │                                                   
  55.    └───────┘                                                   
  56.  
  57. Please send comments, manual corrections and enhancement suggestions to:
  58.  
  59.  
  60.                David Groome 
  61.                Micrometric 
  62.                98 Dade Avenue 
  63.                Sarasota, FL  34232 
  64.  
  65.                Voice/FAX (813) 377-2515 
  66.  
  67.  
  68.  
  69.                    REGISTRATION SERIAL NUMBER
  70. ┌──────────────────────────────────────────────────────────┐
  71. │                                                          │
  72. │                                                          │
  73. │                                                          │
  74. │                                                          │
  75. │                                                          │
  76. │                                                          │
  77. │                                                          │
  78. │                                                          │
  79. │                                                          │
  80. │                                                          │
  81. └──────────────────────────────────────────────────────────┘
  82.  
  83.  
  84.  
  85. PKZIP, PKUNZIP and PKSFX are trademarks of PKWARE, Inc.
  86. MS-DOS is a registered trademark of the Microsoft Corporation. 
  87. IBM PC, XT, AT and PC-DOS are registered trademarks of the IBM Corporation.
  88. TABLE OF CONTENTS
  89.  
  90.  
  91. INTRODUCTION. . . . . . . . . . . . . . . . . . . . .   5
  92.     Major Features. . . . . . . . . . . . . . . . . .   5
  93.     System Requirements . . . . . . . . . . . . . . .   5
  94.     Manual Format . . . . . . . . . . . . . . . . . .   5
  95.         Page layout . . . . . . . . . . . . . . . . .   5
  96.         Brackets and parentheses. . . . . . . . . . .   6
  97.         Computer key conventions. . . . . . . . . . .   6
  98.         Action steps. . . . . . . . . . . . . . . . .   6
  99.         ■■■■-MAN programs . . . . . . . . . . . . . .   6
  100.         Shareware distributed documentation manual. .   6
  101.     Shareware . . . . . . . . . . . . . . . . . . . .   7
  102.  
  103. INSTALLING THE SYSTEM   . . . . . . . . . . . . . . .   9
  104.  
  105. RUNNING PATH-MAN  . . . . . . . . . . . . . . . . . .  11
  106.     FileName. . . . . . . . . . . . . . . . . . . . .  11
  107.     Option. . . . . . . . . . . . . . . . . . . . . .  11
  108.     Operation . . . . . . . . . . . . . . . . . . . .  12
  109.     ERRORLEVEL. . . . . . . . . . . . . . . . . . . .  12
  110.     Shareware message . . . . . . . . . . . . . . . .  12
  111.     Examples. . . . . . . . . . . . . . . . . . . . .  13
  112.  
  113. INTRODUCTION
  114.  
  115. PATH-MAN is a utility that searches the directory path elements of the
  116. PATH statement for a given file. The search file name may include DOS
  117. wildcard characters. The ERRORLEVEL variable is set, based on the
  118. results of this search, to allow more user friendly batch files - a graceful exit
  119. can be made when needed data files or programs are missing. Optionally,
  120. the path element on which the search file is located may be displayed. 
  121.  
  122. Major Features  
  123.  
  124. ■   Searches the directory path elements of the current PATH statement
  125.     for a given file.
  126. ■   Sets the ERRORLEVEL variable, based on the results of this search,
  127.     to allow more user friendly batch files - a graceful exit can be made
  128.     when needed data files or programs are missing.
  129. ■   Optional display of the first path element on which the search file
  130.     name is found.
  131. ■   DOS wildcard characters of * and ? may be used in the search file
  132.     name.
  133. ■   Small size and fast operation.
  134.  
  135. System Requirements  
  136.  
  137. PATH-MAN will run on an IBM PC, XT, AT or true compatibles. It has
  138. been tested with PC-DOS/MS-DOS operating systems, version 3.0 through
  139. version 5.0.
  140.  
  141. Manual Format  
  142.  
  143. This manual is divided into several introductory chapters followed by chap-
  144. ters for operating PATH-MAN. The format of these chapters and the infor-
  145. mation presented therein has been standardized using the following conven-
  146. tions.
  147.  
  148. Page layout - Each page has a header detailing the chapter and the pro-
  149. gram version covered. A footer displays the manual page number. Brackets and parentheses - Brackets, [...], are used in the manual and in the
  150. help screens to specify what should be entered in response to the current
  151. prompt. If a character string is to be entered, the type of character is not-
  152. ed, such as ALPHA, NUMERIC, ANY, etc. Parentheses, (..), are used for
  153. comments.
  154.  
  155. Computer key conventions - Keys specified in the manual text that are not
  156. in entry brackets are shown as reversed, such as ■ESCAPE■. All key referenc-
  157. es are in capital letters for clarity.
  158.  
  159. Action steps - Some procedures may require selection from a menu of op-
  160. tions, inputting data or following a sequence of steps. Most manual sections
  161. will first give an overview of the function or task under discussion and then
  162. detail the various action operating procedures. In order to make this manu-
  163. al easier to use a symbol, ■ , marks the beginning of each of these action
  164. operating procedures.
  165.  
  166. ■■■■-MAN programs - The general group of shareware programs by Mic-
  167. rometric is referred to by the name ■■■■-MAN. It may also be used in
  168. reference to a specific program in that group.
  169.  
  170. Shareware distributed documentation manual - The documentation file in-
  171. cluded on the shareware distribution diskette contains the same information
  172. as the printed and bound manual supplied as part of registration with three
  173. exceptions, the result of the word processor, formatting and printer used.
  174. The first is that the page headers and footers are NOT present in the
  175. shareware version (If LASR-MAN is used to print the documentation, use
  176. of its page header option will supply the page numbers). The second is that
  177. all of the control display characters (ASCII 1-31) and the reverse print
  178. keyboard codes are NOT shown properly. Finally, bolding, underlining and
  179. special symbols are NOT present. Shareware  
  180.  
  181. PATH-MAN is being distributed as SHAREWARE. The SHAREWARE
  182. concept allows users to examine a program on a trial basis at no (or mini-
  183. mal) charge before purchasing it. In addition, by decreasing marketing costs,
  184. professional quality software may be distributed for a fraction of the cost
  185. of a comparable commercial product.  Regardless of whether you register
  186. the program, please help distribute PATH-MAN by sharing unmodified
  187. copies of it and its files with others. If you find PATH-MAN of value, you
  188. must register your program use. This will provide you with: 
  189.  
  190.     *   A 7" x 8 1/2" printed and bound manual. 
  191.     *   PATH-MAN phone or mail support for one year. 
  192.     *   Notification of the next PATH-MAN release. 
  193.     *   Sincere thanks for your support of the SHAREWARE concept. 
  194.  
  195. Program Registration . . . . . . . . . . . . . . . . . .$10. 
  196. Latest Version Diskette. . . . . . . . . . . . . . . . .$10. 
  197. Package (All the above). . . . . . . . . . . . . . . . .$15. 
  198.  
  199. ADDRESS:    Micrometric 
  200.             98 Dade Avenue 
  201.             Sarasota, FL  34232 
  202. PHONE:      Voice/FAX (813) 377-2515 
  203.  
  204. For ease in program registration, the INST-MAN program may be used to
  205. generate an order form. 
  206.  
  207. This program is produced by a member of the Association of Shareware
  208. Professionals (ASP). ASP wants to make sure that the shareware principal
  209. works for you. If you are unable to resolve a shareware-related problem
  210. with an ASP member by contacting the member directly, ASP may be able
  211. to help. The ASP Ombudsman can help you resolve a dispute or problem
  212. with an ASP member, but does not provide technical support for members'
  213. products. Please write to the ASP Ombudsman at 545 Grover Road, Musk-
  214. egon, MI 49442-9427, or send a Compuserve message via easyplex to ASP
  215. Ombudsman 70007,3536. 
  216. INSTALLING THE SYSTEM  
  217.  
  218. For the procedures to install PATH-MAN and to print this documentation,
  219. see the README file on the shareware distribution diskette.
  220.  
  221.  
  222.     FOR PROPER OPERATION, ALL REQUIRED PATH-MAN
  223.     FILES *MUST* BE PLACED ON PATH REFERENCED SUB-
  224.     DIRECTORIES!
  225.  
  226. RUNNING PATH-MAN 
  227.  
  228. The syntax to execute the PATH-MAN utility program is: 
  229.  
  230.     PATH-MAN FileName[option]
  231.  
  232. A space MUST be present after the program name and before the
  233. FileName parameter. A space MUST NOT be placed between the
  234. FileName and the option, if it is present.
  235.  
  236. FileName  
  237.  
  238. The file name to be found follows the standard DOS conventions, with a
  239. maximum of eight characters for the file name and three characters for the
  240. extension with a '.' separator. The DOS wildcard characters of ? and * may
  241. be used. If no extension is specified, the match will only be on name with
  242. all extension matching.
  243.  
  244. Option  
  245.  
  246. If the FileName is followed by a '?' character, the program will display the
  247. search results. If a matching file is found, a message with the path of the
  248. FIRST matching file is displayed. If no matching file is found, a message
  249. with the FileName searched for is displayed. In both cases the ERROR-
  250. LEVEL value is also displayed.
  251.  
  252. NOTE:   A '?' at the end of the FileName[option] is always treated as an
  253.         option rather that a DOS wildcard '?'. Operation  
  254.  
  255. PATH-MAN searches the path directory elements referenced in the PATH
  256. statement in the order in which they appear. For example, with the PATH
  257. statement -
  258.  
  259.     PATH=[D1:Path1][D2:Path2][...]
  260.  
  261. the path element D1:Path1 is searched first followed by D2:Path2. If a
  262. match is found, the search is terminated and the ERRORLEVEL variable
  263. is set.
  264.  
  265. ERRORLEVEL  
  266.  
  267. The ERRORLEVEL variable is set based on the results of the search for
  268. FileName. 
  269.  
  270. If a match to FileName is found on any of the path directory elements of
  271. the PATH statement, ERRORLEVEL is set to the ordinal number of the
  272. Dx:Pathx path on which the file is found. This number may range from one
  273. to the number of elements in the PATH statement.
  274.  
  275. If PATH-MAN is not present or FileName is NOT found on any of the
  276. path directory elements of the PATH statement, ERRORLEVEL is set to
  277. 0.
  278.  
  279. NOTE:   PATH-MAN's use of the ERRORLEVEL variable is the inverse
  280.         of many (if not most) programs: a zero ERRORLEVEL is bad
  281.         and a non-zero value is good. The main reasons for this is to as-
  282.         sure that PATH-MAN.COM is present and allow the path element
  283.         number to be passed to the batch file.
  284.  
  285. Shareware message  
  286.  
  287. A shareware message may be randomly displayed at the end of PATH-
  288. MAN. Pressing any key will exit the program. By registering your use of
  289. PATH-MAN, you will be able to use the registration serial number to
  290. suppress this shareware message display. Examples  
  291.  
  292. For the purpose of these examples, assume that only files PATH-MAN.CO-
  293. M, XYZ.COM and ABC.COM are on PATH directories.
  294.  
  295. Batch file code segment examples -
  296.  
  297.     File found -
  298.             ...
  299.             PATH-MAN ABC.COM
  300.                [errorlevel set to 1]
  301.             IF ERRORLEVEL 1 GOTO RUN
  302.             ECHO PROGRAM ABC.COM IS MISSING!
  303.             GOTO EXIT
  304.             ...
  305.             :RUN
  306.                [batch file branches to this point]
  307.             ...
  308.             :EXIT
  309.  
  310.  
  311.     File not found -
  312.             ...
  313.             PATH-MAN CBA.COM
  314.                [errorlevel set to 0]
  315.             IF ERRORLEVEL 1 GOTO RUN
  316.                [batch file continues here]
  317.             ECHO PROGRAM CBA.COM IS MISSING!
  318.             GOTO EXIT
  319.             ...
  320.             :EXIT
  321.  
  322. Command line code examples -
  323.  
  324.             For -             PATH-MAN XYZ.COM?
  325.             a display of -    Found═[path]\XYZ.COM
  326.                               ERRORLEVEL═1
  327.  
  328.             For -             PATH-MAN XYZ.*?
  329.             a display of -    Found═[path]\XYZ.COM
  330.                               ERRORLEVEL═1
  331.  
  332.             For -             PATH-MAN XYZ.A*?
  333.             a display of -    Not Found═XYZ.A*
  334.                               ERRORLEVEL═1
  335.