home *** CD-ROM | disk | FTP | other *** search
/ Jason Aller Floppy Collection / 176.img / SLBBS76M.ZIP / SLDIR.ZIP / SLDIR.DOC
Text File  |  1989-04-11  |  5KB  |  110 lines
  1.  
  2. SLDIR                                                        Sept 1988
  3. Searchlight BBS File Directory Lister                     by F. LaRosa
  4.  
  5.    -----------------------------------------------------------------
  6.               (c) Copyright 1988 Searchlight Software.
  7.         This program may be used free of charge by registered
  8.                     SEARCHLIGHT BBS owners only.
  9.    -----------------------------------------------------------------
  10.  
  11.  
  12. Description
  13.   This program reads one or more Searchlight BBS file directories (as 
  14. defined in a FILEDIR.DEF or FILEn.DEF file) and prints an alphabetical 
  15. list of the files to the standard output. Command line options can be 
  16. used to specifiy the DEF file to open, to limit the listing to certain 
  17. directories within the DEF file, or to search for particular files. The 
  18. result can be viewed on the screen, redirected to a text file or the 
  19. printer, or piped into another process.  
  20.  
  21.  
  22. Syntax
  23.   The syntax for running SLDIR is as follows:
  24.  
  25. SLDIR [dirfile] [access] [=string] [/abc...] [-abc...]
  26.  
  27. All parameters are optional. If no parameters are given, the file 
  28. FILEDIR.DEF is opened, and all directories contained within it are 
  29. displayed.  
  30.  
  31. If [dirfile] is given, it specifies the path and filename to the DEF 
  32. file containing the Searchlight directory definitions (NOT the "DIR" 
  33. file). Don't include the ".DEF" extension, but do include the filename.  
  34.  
  35.  
  36. If [access] is included, it should be a number from 0 to 255 specifying 
  37. that only directories with an access level less than or equal to the 
  38. specified number will be printed. For example, the command
  39.  
  40.   > SLDIR 100
  41.  
  42. will omit any directories with access levels of 101 or greater from the 
  43. final list.
  44.  
  45.  
  46. The [=string] option, if included, specifies a search string. Only files 
  47. which contain the search string in their filename or description are 
  48. printed. The search is case-insensitive. Example: use the following 
  49. command to list all files on your system with the word "Searchlight" in 
  50. their description:
  51.  
  52.   > SLDIR =SEARCHLIGHT
  53.  
  54.  
  55. The [/abc...] option, where "abc..." is an arbitrary list of directory 
  56. letters from A to Z, indicates that ONLY the specified directories will 
  57. be used in the listing. For example, to get a quick look at your letter 
  58. "C" directory from the command line, you might type 
  59.  
  60.   > SLDIR /C
  61.  
  62.  
  63. If [-abc...] is given, then the program will display all directories 
  64. EXCEPT the specified ones in the listing. For example, you want to list 
  65. your files, but omit the "D" and "F" directories from the list; type
  66.  
  67.   > SLDIR -DF
  68.  
  69.  
  70. If an access level parameter is used together with a "/" or "-" 
  71. parameter, the options will work together; only those directories which 
  72. meet the criteria of both parameters will be displayed. "/" and "-" type 
  73. parameters should not be used together on the same command line.
  74.  
  75.  
  76.  
  77. Useage
  78.   The primary use for SLDIR will be to generate text files containing 
  79. the directory listings of a system. Since SLDIR writes to standard 
  80. output, you can use the ">" redirection symbol to send your file list to 
  81. a file; for example, SLDIR 10 >ALLFILES.TXT. Using a batch file, you can 
  82. automate the process of generating a list, ARChiving it if desired, and 
  83. moving it to an upload/download directory for access by users. Put the 
  84. whole process onto your system as a nightly event, and your directory 
  85. file will be updated daily, automatically.
  86.  
  87.   SLDIR checks for a file called SLDIR.TXT in the default directory when 
  88. it runs. If SLDIR.TXT exists, the program reads it and echos the text to 
  89. standard output before the file listing. Thus, you can place a "header" 
  90. on your file list by placing your header text in a file called SLDIR.TXT 
  91. and making sure that file is in the current directory when you run SLDIR.
  92.  
  93.   There should be many other uses for SLDIR: besides giving fast, 
  94. convenient lists and searches of your BBS file directories from the 
  95. command line, SLDIR's output can be piped to or read by other programs 
  96. which need to read your directory list, without having to open and read 
  97. the binary ".DIR" files on your disk.
  98.  
  99.  
  100. Copyright 
  101.   This program is (c) Copyright 1988 Searchlight Software. You may use 
  102. this program for free if you are a registered owner of any version of 
  103. Searchlight BBS. You may distribute this program in unmodified form.
  104.  
  105.  
  106.                                                      F. LaRosa 9/19/1988
  107. ------------------------------------------------------------------------
  108.  
  109.  
  110.