home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / DEMO510.ZIP / AUTIL.INS / AUTIL.DOC next >
Text File  |  1999-01-25  |  7KB  |  168 lines
  1.  
  2. Searchlight Alias Maintenance Utility
  3. -------------------------------------
  4. Alias maintenance utility (AUTIL.EXE) is a command line driven program for 
  5. use with Searchlight 3.5A and later releases. It provides three main 
  6. functions related to the use of alias names:
  7.  
  8.   - An alphabetical list of all alias names in use on your system;
  9.   - An alphabetical list of user names and their corresponding aliases;
  10.   - A cross-reference utility to detect and fix inconsistencies between
  11.     the USER.SL2 and ALIAS.SL2 files.
  12.  
  13. The syntax for using AUTIL.EXE is:
  14.  
  15. AUTIL [A|U|X] [/Y|/N]
  16.   A = List contents of ALIAS.SL2 file
  17.   U = List alias names in USER.SL2 file
  18.   X = Cross-reference User & Alias files
  19.  /Y = Fix cross-reference errors without asking
  20.  /N = Do not fix cross-reference errors
  21.  
  22. To understand the difference between the two types of listings, and the need 
  23. for the cross-reference utility, an understanding of how Searchlight stores 
  24. alias names is needed. When you use the Options command in Searchlight, 
  25. alias names appear on-screen as though they were simply another item of data 
  26. associated with a particular user record. In fact, though there is an alias 
  27. name field associated with each user record, there is also a separate file 
  28. called ALIAS.SL2 that holds a list of all the alias names in use on your 
  29. system. The ALIAS.SL2 and USER.SL2 files work together to provide support 
  30. for alias names.
  31.  
  32. The A option to AUTIL.EXE provides a listing of the contents of your 
  33. ALIAS.SL2 file; in other words, a listing of all the alias names that are in 
  34. use on your system, along with the corresponding real names. For example, if 
  35. you type:
  36.  
  37.   AUTIL A
  38.  
  39. You will see a list similar to this one:
  40.  
  41. Alias Name                   Real Name
  42.  BATMAN ..................... BRUCE WAYNE
  43.  CAPTAIN CRUNCH ............. MOLLY JONES
  44.  DARK AVENGER ............... SHELLY SMITH
  45.  GREAT PUMPKIN .............. LIONEL RICHARDS
  46.  POPEYE ..................... GEOFF BECKMAN
  47.  THE VAULTKEEPER ............ JIM BARRY
  48.  
  49.    6 names were listed.
  50.  
  51. The left column contains all of the alias names in use on your system, in 
  52. alphabetical order. The right column contains the real name to which each 
  53. alias belongs.
  54.  
  55. When you use the U option with AUTIL.EXE, you generate the opposite listing: 
  56. real names on the left, and alias names on the right. For example, if you 
  57. enter "AUTIL U", you will see a listing such as:
  58.  
  59. Real Name                    Alias Name
  60.  BRUCE WAYNE ................ BATMAN
  61.  GEOFF BECKMAN .............. POPEYE
  62.  JIM BARRY .................. THE VAULTKEEPER
  63.  LIONEL RICHARDS ............ GREAT PUMPKIN
  64.  MOLLY JONES ................ CAPTAIN CRUNCH
  65.  SHELLY SMITH ............... DARK AVENGER
  66.  
  67.    6 names were listed.
  68.  
  69. This list contains the same information as the prior list, except that it is 
  70. sorted by real name rather than alias name. (In fact, this is really just a 
  71. list of your USER.SL2 file, except that only those users who have alias 
  72. names on file are shown).
  73.  
  74. You can use standard DOS redirection symbols to pipe either list to a text 
  75. file, printer or other device. For example:
  76.  
  77.   AUTIL A >PRN
  78.   AUTIL U >ALIAS.TXT
  79.  
  80.  
  81. Alias Cross Reference
  82. ---------------------
  83. Searchlight always updates both the USER.SL2 and ALIAS.SL2 files whenever 
  84. you add, change or remove an alias name from a user's account, or delete a 
  85. user account. In this way, the alias and user files are always kept "in 
  86. sync" with one another.
  87.  
  88. However, it is occasionally possible for user and alias files to become 
  89. inconsistent with one another. Problems that can arise include duplication 
  90. of alias names; alias names that are the same as real names; or entries in 
  91. the alias file that do not match the corresponding information in the user 
  92. file. In many cases, these problems result in the inability to look up or 
  93. send mail to an alias name, and "lost" mail (because the mail is routed to 
  94. the wrong mailbox). There are a number of ways that such inconsistencies 
  95. can be created: 
  96.  
  97.   o If your USER.SL2 or ALIAS.SL2 file is physically damaged, some records
  98.     may be lost from one file but not the other.
  99.  
  100.   o If you restore a back-up of your USER.SL2 or ALIAS.SL2 file without 
  101.     restoring both files simultaneously, changes made since the backup
  102.     will be lost.
  103.  
  104.   o During the beta test period for Searchlight 3.5A, bugs in the software
  105.     may have resulted in inconsistent files. For example, the Rename 
  106.     function in the 3.5A beta release did not update the alias file 
  107.     properly.
  108.  
  109.   o Third-party programs may improperly update alias name data, especially
  110.     programs that were released before Searchlight 3.5A.
  111.  
  112. To detect and repair these problems, the alias utility offers a cross-
  113. reference function. To activate it, enter:
  114.  
  115.   AUTIL X
  116.  
  117. Both the USER.SL2 file and ALIAS.SL2 file are scanned for logic errors. 
  118. Typical errors that might appear include the following:
  119.  
  120.   o Alias names that are the same as real names
  121.   o Real names that are the same as alias names
  122.   o ALIAS.SL2 records that do not match the corresponding USER.SL2 record
  123.   o Invalid alias names
  124.  
  125. When such errors are found, a message is printed and you are given the 
  126. option to fix the error. For example:
  127.  
  128.  Real Name : SYSOP
  129. Alias Name : THE TERMINATOR
  130.     Source : USER.SL2 File
  131. This alias name is also in use as another person's real name.
  132. Do you want to repair this problem (Y/N/Quit)? 
  133.  
  134. In this case, it was found that the alias name "THE TERMINATOR" is actually 
  135. another person's real name. Because Searchlight requires all alias names to 
  136. be distinct from real names, this situation is an error. If you type Y at 
  137. the prompt, the alias utility will try to fix the problem.
  138.  
  139. In general, the alias utility fixes problems by attempting to update the 
  140. USER.SL2 and ALIAS.SL2 files to get them back in sync. If that is not 
  141. possible (because of duplicate names, for example), then it deletes the 
  142. offending alias name. In the example shown above, the problem would be fixed 
  143. by removing the SYSOP's alias name, and deleting the corresponding record 
  144. from the ALIAS.SL2 file. Note that while the alias utility may update, 
  145. create or delete records from the ALIAS.SL2 file to fix a problem, it never 
  146. adds or deletes real user names from your USER.SL2 file.
  147.  
  148. If you wish to run the cross-reference utility without the "Do you want to 
  149. repair this problem" prompts, you can add a /Y or /N switch to the command 
  150. line. If you use /Y, then all problems are fixed automatically. If you use 
  151. /N, then no problems are fixed. For example, this command will scan and 
  152. repair all problems without asking:
  153.  
  154.   AUTIL X /Y
  155.  
  156. You may wish to make back up copies of your USER.SL2 and ALIAS.SL2 files
  157. before running this command, in case you need to go back to the old files
  158. for any reason.
  159.  
  160. It is important to note that the cross-reference function only looks for 
  161. high-level problems, like name duplication. It doesn't check the low-level 
  162. binary tree structure of the alias or user files. Low level problems 
  163. typcially cause runtime errors or lock-ups when listing the contents of the 
  164. user or alias files; if such a problem exists, correct it by running the 
  165. User/Balance command from within Searchlight before you run the alias cross-
  166. reference utility.
  167.  
  168.