home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / DEMO510.ZIP / SLDIR3.INS / SLDIR.DOC next >
Text File  |  1999-01-25  |  7KB  |  168 lines
  1.  
  2. SLDIR  --  Searchlight BBS File Directory Lister
  3. Version 4.0, May 1994
  4.  
  5.  
  6. Updates
  7.   Version 3.5 includes the following new features:
  8.    o Automatic support for Searchlight 3.5 long file descriptions
  9.    o New '-S' switch to display short descriptions only
  10.    o New '-D' switch to obtain a list of directories rather than files
  11.    o New '#attrib' switch to specify security attributes to be excluded
  12.    o List summary showing number of files, directories & kilobytes
  13.  
  14.   Version 3.0 (March 1993) is a recompilation for distribution with
  15. Searchlight 3.0. No functional changes are added to the program.
  16.  
  17.   Version 2.15A (June 1991) adds indirect file list processing (@list)
  18. to the include and exclude command line parameters. For example, to obtain
  19. a list of files in directories which are specified in a text file called
  20. MAIN.DIR, give this command:
  21.  
  22.    SLDIR /@MAIN.DIR
  23.  
  24. If the indirect file is not in the current directory, give its full path.
  25.  
  26.  
  27. Description
  28.   This program reads one or more Searchlight BBS file directories and 
  29. prints an alphabetical list of the files to the standard output. Command 
  30. line options can be used to specify the directories to list, or specify 
  31. search strings. The result can be viewed on the screen, redirected to a 
  32. text file or the printer, or piped into another process.
  33.  
  34.  
  35. Syntax
  36.   The syntax for running SLDIR is as follows:
  37.  
  38.         SLDIR [access] [#attrib] [=string] [/dir] [-dir] [options]
  39.   <or>  SLDIR [/@list] [-@list]
  40.  
  41. All parameters are optional. If no parameters are given, the file 
  42. FILEDEF.SL2 is opened, and all directories contained within it are 
  43. displayed.  
  44.  
  45. If [access] is included, it should be a number from 0 to 255 specifying 
  46. that only directories with an access level less than or equal to the 
  47. specified number will be printed. For example, the command
  48.  
  49.   > SLDIR 100
  50.  
  51. will omit any directories with access levels of 101 or greater from the 
  52. final list.
  53.  
  54.  
  55. If [#attrib] is included, where 'attrib' is a list of security attributes
  56. from A to X, then any directories which have all the security attributes
  57. listed will be excluded from the listing. For example, the command
  58.  
  59.   > SLDIR #AFG
  60.  
  61. will omit from the listing any file directories which contain security
  62. attributes A, F and G.
  63.  
  64.  
  65. The [=string] option, if included, specifies a search string. Only files 
  66. which contain the search string in their filename or description are 
  67. printed. The search is case-insensitive. Example: use the following 
  68. command to list all files on your system with the word "Searchlight" in 
  69. their description:
  70.  
  71.   > SLDIR =SEARCHLIGHT
  72.  
  73.  
  74. The [/dir] option, where "dir" is the name of a directory, indicates that 
  75. ONLY the specified directory will be used in the listing. You can provide 
  76. multiple /dir arguments to list several directories. For example, to get a 
  77. quick look at your "UPLOADS" and "UTILS" directories from the command line, 
  78. you might type 
  79.  
  80.   > SLDIR /UPLOADS /UTILS
  81.  
  82.  
  83. If [-dir] is given, then the program will display all directories 
  84. EXCEPT the specified ones in the listing. For example, you want to list 
  85. your files, but omit the "PRIVATE" and "MAIL" directories from the list; 
  86. type 
  87.  
  88.   > SLDIR -PRIVATE -MAIL
  89.  
  90.  
  91. The [/@list] and [-@list] options allow you to specify an external list
  92. of directories to include or exclude. The list is stored in the text file
  93. specified (for example, if the text file is MAIN.DIR, specify /@MAIN.DIR
  94. or -@MAIN.DIR). The file should contain an ASCII list of directory names,
  95. one per line. Your DIR files used to specify private directory lists for 
  96. subboards can be used as-is with SLDIR.
  97.  
  98. If an access level parameter is used together with a "/" or "-" 
  99. parameter, the options will work together; only those directories which 
  100. meet the criteria of both parameters will be displayed. "/" and "-" type 
  101. parameters should not be used together on the same command line.
  102.  
  103.  
  104. Options -S may be included on any command line; if included, it specifies
  105. that only short single-line file descriptions should be included in the
  106. list (by default, the entire long description is included). For example,
  107.  
  108.   > SLDIR /PRIVATE -S
  109.  
  110. lists the contents of the specified directory, with only short descriptions.
  111.  
  112.  
  113. Finally, SLDIR includes a command which simply lists the available 
  114. directories instead of the files in each directory. To get a list of 
  115. directories, enter:
  116.  
  117.   > SLDIR -D
  118.  
  119. The list is formatted in a similar way as is presented in Searchlight BBS 
  120. (directory list command) and includes file totals for each directory.
  121.  
  122.  
  123. Totals
  124.   SLDIR displays a summary at the end of each listing, such as this one:
  125.  
  126.   Totals:   Directories    Files    Kilobytes
  127.                      6       192        18120
  128.  
  129. The summary shows the number of directories, files and kilobytes processed. 
  130. Note that if command line switches are used to limit the number of 
  131. directories listed, or if a search string is used, the totals reflect only 
  132. the directories and files actually listed.
  133.  
  134.  
  135. Useage
  136.   The primary use for SLDIR will be to generate text files containing 
  137. the directory listings of a system. Since SLDIR writes to standard 
  138. output, you can use the ">" redirection symbol to send your file list to 
  139. a file; for example, SLDIR 10 >ALLFILES.TXT. Using a batch file, you can 
  140. automate the process of generating a list, ARChiving it if desired, and 
  141. moving it to an upload/download directory for access by users. Put the 
  142. whole process onto your system as a nightly event, and your directory 
  143. file will be updated daily, automatically.
  144.  
  145.   SLDIR checks for a file called SLDIR.TXT in the default directory when 
  146. it runs. If SLDIR.TXT exists, the program reads it and echos the text to 
  147. standard output before the file listing. Thus, you can place a "header" 
  148. on your file list by placing your header text in a file called SLDIR.TXT 
  149. and making sure that file is in the current directory when you run SLDIR.
  150.  
  151.   There should be many other uses for SLDIR: besides giving fast, 
  152. convenient lists and searches of your BBS file directories from the 
  153. command line, SLDIR's output can be piped to or read by other programs 
  154. which need to read your directory list, without having to open and read 
  155. the binary ".SL2" files on your disk.
  156.  
  157.  
  158. Copyright 
  159.   This program is (c) Copyright 1994 Searchlight Software. You may use 
  160. this program for free if you are a registered owner of any version of 
  161. Searchlight BBS.
  162.  
  163.  
  164.                                                      F. LaRosa  3/28/91
  165.                                                         Update  9/12/93
  166. ------------------------------------------------------------------------
  167.  
  168.