home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / s / syread03.zip / DOCUMENT.LST < prev    next >
File List  |  1992-03-03  |  19KB  |  390 lines

  1.  
  2.         ╔═══════════════════════════════════════════════════════════╗
  3.         ║    S Y N E R G Y   A L L F I L E S   R E A D E R  v0.2ß   ║
  4.         ║       a utility for Searchlight BBS sysops and users      ║
  5.         ║                      Copyright(c) 1992                    ║
  6.         ║                  Synergy Computer Systems                 ║
  7.         ║                    Cocoa Beach, Florida                   ║
  8.         ╚═══════════════════════════════════════════════════════════╝
  9.  
  10.  
  11.  
  12.  
  13. SLDIR Directory Listing for 2-24-92                     [SLDIR ? for Help]
  14.  /│\                                                                /│\
  15.   └── Geez, it would sure be nice to be             and what about ──┘
  16.       able to automatically change "SLDIR"          this little fiasco?
  17.       to the name of your BBS, no?                  Believe it or not,
  18.                                                     I had a new user, who
  19.                                                     B.T.W. was also new to
  20.       Well, there is just one more thing            computing, downloaded
  21.       I dislike about SLDIR.EXE . . .               my allfiles list and a
  22.       WHAT IS A SEARCHING?????                      copy of LIST.COM. The
  23.       It comes from the heart of the file           next day he asked me WHY
  24.       system of Searchlight and is used             the help doesn't work!
  25.       generically for the "Zippy" and "New"
  26.   ┌── file scans.
  27.  \│/
  28. Searching INTRO
  29.  
  30.      This is not meant to knock Frank in any way, in fact it's about my only
  31. real(?) complaint about Searchlight.  Okay, on with the demo . . .
  32.  
  33.   ┌── Something you will need to know.
  34.  \│/
  35. NOTE:  .LST is the required extension for allfiles lists to be processed/read
  36.         by this package ie . . .
  37.  
  38.        SLDIR -INCLUDE 99 > SYNERGY.LST
  39.  
  40.     As you must have figured out by now, we are about to solve these problems,
  41. but with NO, I repeat NO annoying "Register Me" notices plugged in for a
  42. replacement.
  43.  
  44. Searching REGISTER
  45.  
  46.     <grin> I couldn't resist, no, you don't HAVE TO register this package,
  47. it is not crippled in any way, nor does it have a built-in time bomb.  At the
  48. time of this publication, my BBS was/is down due to financial problems, (am I
  49. getting to you yet?) so tech support will be by mail only for unregistered
  50. users (though I doubt you will need any).  Same goes for bug reports (sorry,
  51. and thank you for reporting them).
  52.  
  53. NOTE:  To distribute SYNERGY.EXE with your allfiles list you MUST read and
  54.        adhere to the usage agreement at the end of this document.  Allowing
  55.        users to download SYNERGY.EXE is an admission of acceptance of the
  56.        above stated usage agreement.  Failure to adhere to the conditions
  57.        of distribution set forth in the above stated usage agreement shall
  58.        be considered a violation of Federal Copyright Laws and punishable
  59.        by the full extent of the law.
  60.  
  61. What you get for registering:
  62.  
  63. 1) Customizable Colors.
  64. 2) All required files will use your BBS name (8 letters max) for their prefix.
  65. 3) Your BBS name and phone number on the top function bar.
  66. 4) Your BBS name on various dialog boxes throughout the program.
  67. 6) Enhanced MAKEIDX.EXE - directory descriptions, command line switches, more!
  68. 5) Free upgrades as they become available.
  69. 6) The phone number of my favorite BBS.
  70. 7) My undying gratitude (and cat if you want it!).
  71.  
  72. Searching GET REAL
  73.  
  74.      Okay enough of the sales pitch, and now, onward . . .
  75. If you have already tried using the "Jump" command, you found it didn't work,
  76. that is because the required file (SYNERGY.IDX, in the UNREGISTERED version)
  77. needs to be created by MAKEIDX.EXE, which also modifies the .LST file.  So,
  78. the next logical step is to run MAKEIDX, as soon as you press <Esc> my batch
  79. file will take control, rename a couple of files included in this package, run
  80. MAKEIDX then return you to this program to see the changes.
  81. AT THAT TIME: Press <J> and select MAKEIDX.  Press <Esc> now!
  82.  
  83. Searching MAKEIDX
  84.  
  85.      Okay, so I lied,  as you can see, you can change the colors (big deal).
  86. The MAKEIDX is designed to run from inside a batch file (no user input
  87. required) so that you can run it during any event than that runs SLDIR,
  88. whether that event is a BBS maintenance event, a door for custom "User Level"
  89. Lists or from DOS.  While SYNERGY.EXE is intended to freely distribute to your
  90. users, MAKEIDX.EXE is NOT to be distributed with your BBS Allfiles list, it
  91. is for the sole use of the host BBS system.  The unregistered MAKEIDX.EXE
  92. requires a configuration file (MAKEIDX.CFG - optional with Enhanced MAKEIDX)
  93. to set colors and know what strings to look for and append.  the format of
  94. MAKEIDX.CFG is as follows:
  95.  
  96. ;3                 <-- Main Text Color.
  97. ;0                 <-- Main Background Color.
  98. ;15                <-- Message Text Color.
  99. ;1                 <-- Message Background Color.
  100. ;Your BBS Name     <-- Replacement string for "SLDIR" (max 15 characters).
  101. ;Synergy           <-- Legal DOS prefix for the .IDX and .LST files.
  102. ;Searching         <-- Original directory prefix string (max 15 characters).
  103. ;Directory         <-- Replacement string for dir prefix (max 15 characters).
  104. ;(407) 555-1212    <-- Your BBS Phone number.
  105.  
  106. Searching COLORS
  107.  
  108.      Lines 1 through 4, legal values for colors:
  109.     ┌────────────────┐       ┌───────────────────┐
  110.     │   Background   │       │    Text Colors    │
  111.     ├────────────────┤       ├───────────────────┤
  112.     │ Black      = 0 │       │ Background Colors │
  113.     │ Blue       = 1 │       │ DarkGray     =  8 │
  114.     │ Green      = 2 │       │ LightBlue    =  9 │
  115.     │ Cyan       = 3 │       │ LightGreen   = 10 │
  116.     │ Red        = 4 │       │ LightCyan    = 11 │
  117.     │ Magenta    = 5 │       │ LightRed     = 12 │
  118.     │ Brown      = 6 │       │ LightMagenta = 13 │
  119.     │ LightGray  = 7 │       │ Yellow       = 14 │
  120.     └────────────────┘       │ White        = 15 │
  121.                              └───────────────────┘
  122.  
  123. Searching STRINGS
  124.  
  125.      Lines 5 through 8 provide the required information to first scan  the
  126. ????????.LST file, then create the ????????.IDX file and finally append the
  127. ????????.LST file for use with the ????????.IDX file in SYNERGY.EXE Reader.
  128.  
  129. NOTE:  though SYNERGY.EXE may be renamed to your liking, and MAKEIDX will
  130.        append any .LST file with a legal DOS prefix (defined in MAKEIDX.CFG),
  131.        SYNERGY.EXE (UNREGISTERED) will ONLY read/use the file names SYNERGY.LST
  132.        and SYNERGY.IDX
  133.  
  134. The MAKEIDX utility processes the .CFG file one character at a time, counting
  135. each space, if there is more than one space in a row it is interpreted as the
  136. end of the string, records that value, then goes to the next line.  All
  137. strings are limited to 15 characters long (EXCEPT for line 6, which is
  138. limited to 8 characters) and may be any ASCII character in the decimal range
  139. of 32 to 254 (see the ASCII table in your DOS manual), though I recommend using
  140. the range of 32 to 126 (keyboard characters) due to lack of support for higher
  141. characters with some printers.
  142.  
  143. Line 5  should contain the name of your BBS (less "BBS" - MAKEIDX adds " BBS"
  144.         to the end of this string.  This string replaces the string segment
  145.         "SLDIR" on the first line after the SLDIR.TXT insert (see SLDIR.DOC,
  146.         included in SLDIR.ZIP, for more information on SLDIR.TXT).  This line
  147.         is also passed to the .IDX file for use by the end-user registered
  148.         version of SYNERGY.EXE (allows the home viewer to retain/switch
  149.         between multiple .LST and .IDX files from different BBS' from within
  150.         the reader.
  151.  
  152. NOTE:   if the SLDIR string does not exist, then this string will be
  153.         ignored while processing the .LST file.
  154.  
  155. Line 6  is the prefix name of the .LST file to be processed and the .IDX file
  156.         to be created.
  157.  
  158. Line 7  is the string that MAKEIDX will look for in the .LST file (prior to
  159.         appending) that signifies "This line is a directory name!".  It should
  160.         include all characters up to, but not including any directory name.
  161.         Though I have not tested this with allfiles lists created by utilities
  162.         other than SLDIR, I added this feature in hopes that this package would
  163.         work with most any BBS.
  164.  
  165. Line 8  is the string that you wish to replace line 7 with in the appended
  166.         .LST file. if you wish for the appended version of .LST to retain
  167.         the old directory prefix (line 7) then this line should duplicate
  168.         line 7.
  169.  
  170. Line 9  is the phone number of your BBS.  This line is tagged on to the end
  171.         of the appended SLDIR line and replaces "[SLDIR ? for Help]".  This
  172.         line is  also added to the .IDX file for use by the end-user registered
  173.         version of SYNERGY.EXE (where it will be placed on the top line along
  174.         with the name of your BBS).
  175.  
  176. NOTE:   In the Registered BBS version your BBS name and phone number is
  177.         hard coded into the program.
  178.  
  179. Searching SYNERGY
  180.  
  181.     The reader itself, is rather cut and dry, self explanatory, easy to use,
  182. user friendly, (Keep it simple, stupid) etc . . .
  183.  
  184.  
  185. Searching KEYS
  186.  
  187.     The cursor keys ( Up/Down arrows, PageUp/PageDown, and the Home/End Keys)
  188. are the primary scroll control keys:
  189.  
  190. Up Arrow   takes you up (back) one line.
  191. Down Arrow takes you down (forward) one line.
  192. <PageUp>   takes you up (back) one page.
  193. <PageDown> takes you down (forward) one page.
  194. <Home>     takes you to the beginning of the file.
  195. <End>      takes you to the end of the file.
  196.  
  197. In addition to these primary scroll control keys you have a few more:
  198.  
  199. <Alt-P>     Estimates how many sheets of paper will be required to print the
  200.             the .LST file, then gives you the option to quit or print the
  201.             .LST file from line 1 to the end, giving you control over LPT1
  202.             or LPT2.  Should printer failure occur, you are given the option
  203.             to abort the printing attempt or fix the problem and continue
  204.             printing.
  205.  
  206. <J>         By pressing <J> a pop-up dialog box with a scrollable selection
  207.             bar will appear.  Pressing <Esc> will abort the jump process,
  208.             pressing enter will move you directly to the highlighted dir.
  209.  
  210. <S>        The search function will search only forward from your position in
  211.            the file.  When you press <S> a dialog box will pop-up, the cursor
  212.            will turn on, and you will be asked to enter your search argument
  213.            you will then have the option of whether you want to do a case
  214.            sensitive search or if you want to ignore case.
  215.  
  216. Searching FUTURE
  217.  
  218.     Future development of this package will depend greatly on your support and
  219. feedback.  The next release will contain greatly enhanced search routines.
  220. mouse support, .PCX (or like image file) login/off BBS adds, and TSR off-line
  221. file tagging are planned for the near future.
  222.  
  223. Searching BUG/IDEA
  224.  
  225.     Should you run across a bug or have an idea for something you would like to
  226. see added to this program please write me at:
  227.  
  228.           Ron Ryan
  229.           Synergy Computer Systems
  230.           524 S. Atlantic Ave. #3
  231.           Cocoa Beach, Florida, 32931
  232.  
  233. Searching PACKING
  234.  
  235.                    ╔══════════════╗
  236.                    ║ Packing List ║
  237.                    ╚══════════════╝
  238.       README   1ST ................ Instructions for DEMO.BAT.
  239.       DEMO     BAT ................ Demonstration Batch for MAKEIDX & SYNERGY.
  240.       GO       BAT ................ Simply "Type readme.1st"
  241.       LN       EXE ................ Sends a line-feed inside batch files.
  242.       MAKEIDX  EXE ................ Utility to make .IDX files and append
  243.                                     .LST files.
  244.       SYNERGY  EXE ................ Main program - Synergy Allfiles Reader.
  245.       ORDER    FRM ................ BBS Registration/Order form.
  246.       DOCUMENT LST ................ This document.
  247.       SYNERGY  SAM ................ Sample Allfiles list used by Demo.
  248.       MAKEIDX  SAM ................ Sample .CFG file used with SYNERGY.SAM
  249.                                     by demo.
  250.       FILEVENT ZIP ................ Batch file packet for filelist by event.
  251.       FILDOR10 ZIP ................ A batch allfiles door - works much like
  252.                                     an "Off-Line" echo reader - it allows you
  253.                                     to select a download protocol, makes
  254.                                     a custom allfiles list per users "file
  255.                                     access level", zips up the packet, then
  256.                                     initiates the download.
  257.  
  258. Searching USAGE
  259.  
  260.     ╔═════════════════╗
  261.     ║ Usage Agreement ║
  262.     ╚═════════════════╝
  263.  
  264.     To distribute SYNERGY.EXE with your allfiles list you MUST read and
  265. adhere to this usage agreement.  Allowing users to download SYNERGY.EXE
  266. is an admission of acceptance of this usage agreement.  Failure to adhere
  267. to the conditions of distribution set forth herein shall be considered a
  268. violation of Federal Copyright Laws and punishable by the full extent of
  269. the law.
  270.  
  271.     CONDITIONS OF DISTRIBUTION.
  272.  
  273. 1)  MAKEIDX.EXE may not be distributed with your allfiles list.  It will,
  274.     in fact, corrupt the .IDX file if it is run with a .LST file more than
  275.     once.
  276.  
  277. 2)  You may freely distribute the shareware version of SYNERGY.EXE  with your
  278.     allfiles list if your BBS is a non-commercial BBS and you include all the
  279.     files as stated in paragraph 4 with the download package.  If any of the
  280.     following apply to your BBS it is to be considered a commercial BBS and
  281.     you must contact Synergy Computer Systems for a special licensing
  282.     agreement:
  283.          a.  BBS is not open to the general public.
  284.          b.  BBS is operated from place of business.
  285.          c.  BBS charges a mandatory subscription fee for continued access.
  286.          d.  BBS charges money for download time.
  287.          e.  BBS' primary function is a marketing tool.
  288.          f.  BBS' primary function is a promotional tool.
  289.          g.  BBS operates as a tech-support board for any commercial products
  290.              other than shareware software.
  291.  
  292. 3)  The following files must be included in an unmodified form with any
  293.     download packet that contains SYNERGY.EXE and your allfiles list:
  294.          a.  SYNERGY.IDX as created by the MAKEIDX.EXE utility.
  295.          b.  SYNERGY.LST as appended by the MAKEIDX.EXE utility.
  296.          c.  SYNERGY.DOC - The end user documentation/registration form.
  297.                            (Packed in "FILDOR10.ZIP")
  298.  
  299. 4)  The following files from this archive must be excluded from any download
  300.     packet that contains SYNERGY.EXE and your allfiles list:
  301.          a.  README.1ST
  302.          b.  DEMO.BAT
  303.          c.  GO.BAT
  304.          d.  MAKEIDX.EXE
  305.          e.  ORDER.FRM
  306.          f.  DOCUMENT.LST
  307.          g.  SYNERGY.SAM
  308.          h.  MAKEIDX.SAM
  309.          i.  FILEVENT.ZIP
  310.          j.  FILDOR10.ZIP
  311.  
  312. 5)  Paragraphs 4 and 5 do not exclude your right to include any additional
  313.     files in your allfiles download packet.
  314.  
  315. 6)  Paragraphs 4 and 5 do not exclude your right to distribute .LST and/or
  316.     .IDX files appended/created by MAKEIDX.EXE without SYNERGY.EXE.
  317.  
  318. 7)  The entire shareware Synergy Allfiles Reader archive, in an unmodified
  319.     form, must be made available for download by visiting sysops.
  320.  
  321. 8)  SYNERGY.EXE and all accompanying files, as declared in the "Packing List"
  322.     section of this document, are copyrighted material, and may not be modified
  323.     in any way without the express written consent of Synergy Computer Systems.
  324.     The sole exception to this paragraph is the renaming of SYNERGY.EXE to
  325.     be included in your allfiles download packet to any name you so desire.
  326.     The renaming of SYNERGY.EXE, in no way, exempts you from adhering to the
  327.     conditions of distribution set herein.
  328.  
  329. 9)  Non-profit organizations such as computer user groups and educational
  330.     institutions may be entitled to FREE registration.  Contact Synergy
  331.     Computer Systems on your official letterhead stating your dues if
  332.     applicable and IRS status with a completed order form for more
  333.     information.
  334.  
  335. 10) Under no circumstances shall any party charge any money for any of the
  336.     files listed in the "Packing List" section of this document beyond pre-
  337.     set on-line charges or nominal distribution fees for mailing/diskettes.
  338.     Any shareware distributor that distributes this package must clearly
  339.     notify any said purchaser that they are not purchasing registration.
  340.  
  341. 11) Non-BBS usage of this package will be considered a violation of Federal
  342.     copyright laws.  Should you have a desire to use this package for a non-BBS
  343.     purpose contact Synergy Computer Systems for licensing and customized
  344.     versions for your application.
  345.  
  346. End of distribution agreement.
  347.  
  348. Searching VERSIONS
  349.  
  350.     There are three versions of the Synergy Allfiles reader available:
  351.  
  352.     1)  This version (the shareware version) as described herein.
  353.  
  354.     2)  The Registered BBS Version.  Cost $20 - Includes:
  355.            a.  Customized SYNERGY.EXE
  356.                  1.  Replacement of "Synergy" with your BBS name throughout
  357.                      the program.
  358.                  2.  Your BBS phone number on the top status bar.
  359.                  3.  Optional: Your color schem hardcoded into the program -
  360.                      will ignore the .IDX color directives.
  361.            b.  Unlimited distribution for non-comercial BBS' as described
  362.                in paragraph 2 of the usage agreement.
  363.            c.  Exemptions from paragraphs 3 and 7 of the usage agreement.
  364.            d.  Enhanced MAKEIDX.EXE
  365.                  1. Your BBS defaults hardcoded into the .EXE file.
  366.                  2. The .CFG file is optional - only required to override
  367.                     hardcoded defaults.
  368.                  3. Uses DISCRIPT.DIR - a standard ASCII file that contains
  369.                     directory discriptions up to 50 characters long.  These
  370.                     discriptions are added to the directory name string in
  371.                     the .LST file during the append process.
  372.            e.  All distribution files use your BBS name, or your choice of
  373.                abriviation for thier eight-letter DOS prefix (.EXE,.LST,&.IDX).
  374.            f.  Free upgrades.
  375.  
  376.     3) The Registered End User Version.  Cost $20 - Includes:
  377.            a.  Single site, single user license.
  378.            b.  Unlimited .IDX & .LST file handling -  added command <B>, when
  379.                called a pop-up dialog box, much the same as the "Jump"
  380.                command, appears that allows you to choose the BBS list you wish
  381.                to view.  Once selected, the predefined BBS colors for the
  382.                selected BBS take over, the name and phone number of the board
  383.                are placed on the top status bar.
  384.            c.  Special utility, much like MAKEIDX.EXE except it requires
  385.                user input of file names and strings to modify most any BBS'
  386.                list for use with SYNERGYE.EXE
  387.            d.  Free upgrades.
  388.  
  389.  
  390.