home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / FOG / FOGSCAN / FOGSCAN.DOC < prev    next >
Text File  |  2000-06-30  |  24KB  |  541 lines
  1.  
  2.         FOGSCAN.DOC                                               PAGE 1
  3.  
  4.  
  5.  
  6.  
  7.                 FOGSCAN, Version 3.07 (DOS), Version 2.3x (CP/M)
  8.  
  9.                     FOG LIBRARY AND PUBLICATION INDEX SCANNER
  10.  
  11.                                 brought to you by 
  12.                      Fog International Computer User's Group
  13.  
  14.  
  15.                 Contents:  Changes from Previous Versions
  16.                            Files 
  17.                            Hardware and system requirements 
  18.                            General Description  
  19.                            Getting Started
  20.                            Using Search
  21.                            On-Line Help
  22.                            Printing
  23.                            Color on DOS Machines
  24.                            Poorly Compatible DOS Machines
  25.                            Rebuilding DOS version index files  
  26.                            Pretty CP/M version
  27.                            Color on Commodore 128
  28.                            Using command line parameters
  29.                            Miscellaneous Information 
  30.                            Running on a BBS
  31.                            Setting up the DOS version
  32.                            Setting up the CP/M version
  33.  
  34.              Files  
  35.  
  36.                   FOGSCANC.COM (CP/M 80 program) 
  37.                   FOGSCAND.EXE (DOS program) 
  38.                   FOGSCAN.DOC  (this file)
  39.                   SETFGSCD.EXE (DOS program to set up FOGSCAND.EXE)
  40.                   SETFGSCC.COM (CP/M program to set up FOGSCANC.COM)
  41.                   ORDRFORM.DOC (disk order/membership application form).
  42.  
  43.                   FogScan uses one or more data files.  Each data file
  44.                   has a name which begins with "Fog" and ends in ".DTA".
  45.                   The DOS version uses optional index files; their names 
  46.                   end in ".IDX" and ".IXP".  If the index files are 
  47.                   missing, the DOS version of FogScan can reconstruct 
  48.                   them, provided your system has enough memory.  Because 
  49.                   of memory and disk size limitations, the CP/M version 
  50.                   cannot use the index files at all.
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.         (c) Claude Ostyn -- 9/16/89
  61.  
  62.         FOGSCAN.DOC                                               PAGE 2
  63.  
  64.  
  65.              Changes from Previous Versions
  66.  
  67.              DOS Version:  The DOS version now features indexed search, the 
  68.                            ability to reconstruct missing data file indexes, 
  69.                            and much faster approximate spelling search when 
  70.                            the index files are missing.  The new DOS version 
  71.                            also allows you to print a single item, the whole 
  72.                            file, the disk summaries only, or tagged items 
  73.                            only.  Special thanks to Steve Brammer.  Hercules 
  74.                            monochrome adaptors should now show highlighting.
  75.     
  76.              CP/M Version: The CP/M version now performs OR searches 
  77.                            correctly (thank you Alan B).  The setup program 
  78.                            now sets it up correctly to run on Osborne and 
  79.                            similar machines;  the setup program can now also 
  80.                            set up FogScan to run on Commodore 128 in color 
  81.                            without patching or requiring a special version.
  82.  
  83.                            Version 2.38 of the full CP/M program handles 
  84.                            formatting and display of publication index files 
  85.                            as well as library data.  It is otherwise identical 
  86.                            to version 2.34 and it uses the same setup program.  
  87.  
  88.              Harware and System Requirements
  89.  
  90.                   DOS Version:     IBM PC, XT, AT, PS/2 or close
  91.                   (FOGSCAND.EXE)   compatible with at least 256K RAM, 
  92.                                    any display card.  
  93.                                    PC-DOS or MS-DOS 2.1x or above.
  94.  
  95.                   CP/M version:    Z80 compatible CP/M system.
  96.                   (FOGSCANC.COM)   48K TPA minimum. CP/M 2.2 or 3.x
  97.  
  98.                   (FGSCNBBS.COM)   A special trimmed version which only
  99.                                    requires a 43.25K TPA is available to
  100.                                    CP/M BBS SysOps directly from Fog.
  101.  
  102.  
  103.              General Description
  104.  
  105.                   The disk libraries of Fog contain thousands of files on 
  106.                   several hundred disks.  Since the library is constantly 
  107.                   being updated, searching through a printed catalog for 
  108.                   the kind of file you are interested in can be like looking 
  109.                   for a needle in a haystack.
  110.  
  111.                   FOGSCAND.EXE and FOGSCANC.COM are the PC-DOS and CP/M 
  112.                   versions of FogScan, a program which allows you to 
  113.                   browse and search the on-line Fog library guides.
  114.  
  115.                   FogScan also allows you to browse and search the Fog 
  116.                   publication indexes for FOGLIGHT and FOGHORN. 
  117.  
  118.  
  119.  
  120.         (c) Claude Ostyn -- 9/16/89
  121.  
  122.         FOGSCAN.DOC                                               PAGE 3
  123.  
  124.  
  125.              Getting Started
  126.  
  127.                   FogScan uses the FOG-xxxx.DTA data files compiled and 
  128.                   regularly updated by Fog.  There are data files for the 
  129.                   DOS and CP/M libraries, and for FOGLIGHT and FOGHORN.  
  130.                   The same data files work with the DOS and the CP/M 
  131.                   versions of the program. 
  132.  
  133.                   Depending on whether you are running DOS or CP/M, type
  134.                   FOGSCAND or FOGSCANC at the system prompt.  If no data 
  135.                   file is found in the current drive and path when you 
  136.                   start the program, you will be prompted for a path in 
  137.                   which to find them. 
  138.  
  139.                   When you start FogScan, you first see the Fog copyright 
  140.                   notice.  If there is more than one Fog data file on the 
  141.                   default drive, you get to choose from a list.  If there 
  142.                   is only one, FogScan opens it directly.  If there is 
  143.                   none, FogScan asks you to specify a drive or path.
  144.  
  145.                   In the DOS version only, if the optional index files 
  146.                   are bad or rmissing, FogScan offers to rebuild them.  
  147.                   This takes a while, and you don't have to do it now.
  148.          
  149.                   You can change files while FogScan is running.  
  150.                   However, if the data files are on different disks, you 
  151.                   should use the "Change File" command in the FogScan 
  152.                   main menu when you change disks, otherwise FogScan may 
  153.                   get very confused.  
  154.  
  155.  
  156.              Using Search
  157.  
  158.                   With FogScan, you can search for specific items by name, 
  159.                   for disks by number, or locate all the shareware 
  160.                   programs.  When looking at a publication index, you can 
  161.                   search by author, by title or by issue.  You can also 
  162.                   look for multiple keywords.  Anything in the item name 
  163.                   or description can act as a keyword.  For instance, if 
  164.                   you look for "Edit", FogScan will show you every item 
  165.                   where the string "Edit" appears.  Case does not matter, 
  166.                   so it will find "QEDIT" as well as "editor".
  167.  
  168.                   If FogScan allows you to search for multiple keywords 
  169.                   with "AND" or "OR" operators.  For instance, if you 
  170.                   look for "This or That", FogScan will find every record 
  171.                   that contains either "This" or "That".  If you look for 
  172.                   "This and That", FogScan will find only the records 
  173.                   that contain both "This" and "That".  You can use up to 
  174.                   five keywords with either "or" or "and" between them; 
  175.                   you cannot mix "or" and "and" in the same search, 
  176.                   though.  If you do not specify an operator, "and" is 
  177.                   assumed.
  178.  
  179.  
  180.         (c) Claude Ostyn -- 9/16/89
  181.  
  182.         FOGSCAN.DOC                                               PAGE 4
  183.  
  184.  
  185.  
  186.              Searching in the DOS version.
  187.  
  188.                   In the DOS version, you can even look for items if you 
  189.                   are not sure how they are spelled.  For instance, you 
  190.                   can look for "PCRite" and it will find "PC-Write".  
  191.                   This kind of search is quite a bit slower than a normal 
  192.                   search.  To search for misspelled items, just type a 
  193.                   space then the word "please" (without the quotes) after 
  194.                   the name of the item you are looking for.  
  195.                   Unfortunately for CP/M users, there is not enough 
  196.                   memory in CP/M systems to allow this kind of search.
  197.  
  198.                   Another feature of the DOS version is indexed search.  
  199.                   If the correct index files were found with the data 
  200.                   file, you see "(Indexed)" in the top window of the 
  201.                   FogScan screen.  FogScan always searches the index 
  202.                   first.  When searching the index, FogScan looks only at 
  203.                   the beginning of the words.  Every word in the file is 
  204.                   indexed, except words such as "the" or "when".  If it 
  205.                   does not find anything in the index, FogScan asks you 
  206.                   whether to look harder.  When FogScan looks harder, it 
  207.                   ignores the index, and the search works exactly as 
  208.                   described in the "Using Search" section above.
  209.  
  210.  
  211.              On-line Help
  212.  
  213.                   Context-sensitive on-line help is available.  In the 
  214.                   DOS version, it is available at any time by pressing 
  215.                   F1.  In the CP/M version, it is available in every 
  216.                   menu.  You cannot do any damage by running the program, 
  217.                   so the easiest way to find out how it works is to 
  218.                   simply fire it up, play with various commands, and ask 
  219.                   for help if you get stumped.
  220.  
  221.  
  222.              Printing
  223.  
  224.                   To print an item while you are looking at it, hold down 
  225.                   the Ctrl key and press P.  FogScan will advance the 
  226.                   paper automatically when the items you print that way 
  227.                   reach the bottom of the page.  To print the whole file, 
  228.                   hold down the Ctrl key and press A.  FogScan assumes 
  229.                   that you have continuous feed paper or a laser printer.
  230.                   Printing is not available if you are running FogScan 
  231.                   through a bulletin board system.
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.         (c) Claude Ostyn -- 9/16/89
  241.  
  242.         FOGSCAN.DOC                                               PAGE 5
  243.  
  244.  
  245.              Tagging
  246.  
  247.                   This facility is available in the DOS version only, and 
  248.                   only for the library data files.  When any library item 
  249.                   is displayed, you can tag the disk number for that item 
  250.                   by just pressing the T key.  A star will appear next to 
  251.                   the disk name to indicate that it is tagged.  You can 
  252.                   remove the tag by pressing U.  Many disks contain more 
  253.                   than one item, but only entire disks get tagged, so you 
  254.                   may see the tag indicator on items other than those you 
  255.                   had tagged directly.  To view a list of the tagged 
  256.                   items, press F8.  The tags do not disappear if you 
  257.                   change to another file.  When you exit FogScan, you 
  258.                   will be asked if you want to print an order form.  If 
  259.                   you answer yes, a list of all the tagged disks will 
  260.                   then be printed along with the form. 
  261.  
  262.  
  263.              Color on DOS Machines.
  264.  
  265.                   The DOS version runs in color with color video 
  266.                   adapters, and in monochrome with monochrome video 
  267.                   adapters.  If you have a color video adapter but only a 
  268.                   composite (one-color) monitor, or if you are using a 
  269.                   laptop, the color effects will look pretty bad;  some 
  270.                   screens may even be unreadable.  If you have this 
  271.                   problem, use SETFGSCD.EXE to set up FogScan so it will 
  272.                   always come up in monochrome.
  273.  
  274.                   If you don't want to modify your copy of FogScan but 
  275.                   you want it to run in monochrome, be sure to put the 
  276.                   statement "MODE BW80" in your AUTOEXEC.BAT file, or to 
  277.                   type "MODE BW80" at the DOS prompt before running 
  278.                   FOGSCAND.  MODE.COM is a DOS program which you should 
  279.                   have on your system diskette.  Another way is to call 
  280.                   FogScan with the parameter "BW".  FogScan will then run 
  281.                   in monochrome mode.
  282.  
  283.  
  284.              Poorly Compatible MS-DOS Machines
  285.  
  286.                   Some MS-DOS "compatibles" are not very compatible, and 
  287.                   will not run FOGSCAND correctly.  There is very little 
  288.                   we can do about that, because developing a "generic" 
  289.                   MS-DOS version would be quite expensive.  In BBS mode, 
  290.                   FOGSCAND should run on any DOS machine.  See "Using 
  291.                   command lines parameters", below, for info on how to 
  292.                   run FogScan in BBS mode or on not very compatible MS-
  293.                   DOS systems.  If your machine can run CP/M programs, 
  294.                   you can also try to run the CP/M version.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.         (c) Claude Ostyn -- 9/16/89
  301.  
  302.         FOGSCAN.DOC                                               PAGE 6
  303.  
  304.  
  305.              Rebuilding DOS Version Index files (DOS version only)
  306.  
  307.                   When the index files that go with a data file are 
  308.                   missing , or if the index files don't match the 
  309.                   contents of the data file, FogScan offers to rebuild 
  310.                   the index files at the time you choose the data file.  
  311.                   Depending on the speed of your machine, this process 
  312.                   can take up to 40 minutes for a large data file.  You 
  313.                   also need considerable room on the disk which already 
  314.                   contains the data file (typically 100 Kbytes or so).  
  315.                   The DOS date stamp of the index files may be different 
  316.                   from the DOS date stamp of the data file.  That's OK.
  317.  
  318.                   Important note:  You do *not* need the index files to 
  319.                   run FogScan, but searches are much faster with the 
  320.                   index files.  Also, if you have less than 384K of RAM, 
  321.                   the index rebuilding may fail for lack of memory.
  322.  
  323.           
  324.              Pretty CP/M version
  325.  
  326.                   The CP/M version of FogScan can run full-screen 
  327.                   (without scrolling, and with highlighting when 
  328.                   available) on any computer which can emulate an Osborne 
  329.                   or ADM3-A terminal.  Just add the keyword 'CUTE' on the 
  330.                   command line at the CP/M prompt.  You can also use 
  331.                   SETFGSCC.COM to set up your copy of FogScan so it will 
  332.                   always come up in this mode automatically.
  333.  
  334.  
  335.              Color on Commodore 128
  336.  
  337.                   You can use the SETFGSCC.COM to set up your copy of 
  338.                   FOGSCANC.COM to run in color on a Commodore 128 with a 
  339.                   color monitor.  Just answer "Yes" when the appropriate 
  340.                   question comes up.
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.         (c) Claude Ostyn -- 9/16/89
  361.  
  362.         FOGSCAN.DOC                                               PAGE 7
  363.  
  364.  
  365.              Using Command Line Parameters:
  366.  
  367.                   Optional command line parameters can be used in any
  368.                   order when you start FogScan. They are:
  369.  
  370.                   * Screen width (a number from 52 to 80). Default is 80.
  371.  
  372.                   * A path to locate the data files. Must contain at
  373.                     least one drive descriptor with a colon. Default is
  374.                     the current drive (and directory in DOS version).
  375.  
  376.                   * The string 'BBS' to run the browser in BBS mode. In
  377.                     this mode, a CR is required after every command, ^K
  378.                     is used to interrupt the search (search interrupt is
  379.                     not available in the DOS BBS version), and the header
  380.                     is not displayed. Printing is disabled and is not
  381.                     mentioned in the on-line help in BBS mode.
  382.  
  383.                   * DOS users can also use the parameter 'BW' to force
  384.                     FogScan to run in black and white on a color video 
  385.                     adapter, or the parameter 'MSDOS' to run FogScan in 
  386.                     'plain vanilla' MSDOS mode.
  387.  
  388.                   * CP/M users can use the parameter 'CUTE' to make 
  389.                     FogScan run in full-screen mode on an Osborne or ADM-
  390.                     3A compatible terminal. 
  391.  
  392.                   Examples of command line parameter usage:
  393.  
  394.                             A>fogscan 52 B:
  395.  
  396.                     Use 52-column screen width and look for library files
  397.                     on drive B.
  398.  
  399.                             A>fogscan C:\Downloads\Fogstuff\
  400.  
  401.                     Look for the data file(s) in specified drive and
  402.                     subdirectory. \ at the end of the path is optional.
  403.  
  404.                     The CP/M version does not understand subdirectories.
  405.  
  406.                            A>fogscan bw
  407.  
  408.                     Run the program in black and white (applicable only
  409.                     on DOS machines with a color video adapter).
  410.  
  411.                             A>fogscan BBS F12:
  412.  
  413.                     Run the program in BBS mode (i.e. with input/output
  414.                     redirection enabled) and look for data file(s) on
  415.                     drive F, user area 12 (user areas are a CP/M feature
  416.                     only).
  417.  
  418.  
  419.  
  420.         (c) Claude Ostyn -- 9/16/89
  421.  
  422.         FOGSCAN.DOC                                               PAGE 8
  423.  
  424.  
  425.                             A>fogscan cute 52 
  426.  
  427.                     Run the "plain vanila", unpatched CP/M version of 
  428.                     FogScan on an Osborne 1 with 52-column screen, taking 
  429.                     advantage of screen highlighting.
  430.  
  431.  
  432.              Miscellaneous Information
  433.  
  434.                   FogScan was written in Turbo Pascal by Claude Ostyn.  
  435.                   The CP/M version is compiled with Turbo Pascal 3.0, and 
  436.                   the DOS version is compiled with Turbo Pascal 5.0.  
  437.                   FogScan is a copyrighted program which you can 
  438.                   distribute and share with others as long as you do not 
  439.                   modify it, you do not charge any fee beyond a 
  440.                   reasonable duplication and media cost of up to $10, and 
  441.                   you distribute ALL the files together, including this 
  442.                   documentation file and the data files.  
  443.  
  444.  
  445.              Running on a BBS
  446.  
  447.                   Both the CP/M and the DOS versions of the program can
  448.                   run on a bulletin board if the board software allows it 
  449.                   to execute a .COM or .EXE program and to redirect 
  450.                   normal console input and output to the remote terminal.  
  451.                   The new DOS version fixes several problems with BBS 
  452.                   use that caused previous versions to crash.
  453.  
  454.  
  455.                   The behavior of FogScan is a little different when it 
  456.                   runs in bulletin board mode.  For instance, you have to 
  457.                   confirm menu choices by pressing <Return>.
  458.  
  459.                   If you have a CP/M BBS system and FOGSCANC.COM is too 
  460.                   large to run on it, contact the Fog office for a copy 
  461.                   of FGSCNBBS.COM.  FGSCNBBS.COM only requires 43.25K of 
  462.                   TPA and does not have pretty video or printing.  It is 
  463.                   otherwise full-featured, with support for library data 
  464.                   files as well as publication index files and all the 
  465.                   normal search and browsing facilities of the full CP/M 
  466.                   version.  SETFGSCC.COM will also correctly set up the 
  467.                   default drive/user path and default screen witdth for 
  468.                   FGSCNBBS.COM.  Just be sure that FOGSCANC.COM is not on 
  469.                   the default drive when you run SETFGSCC.
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.         (c) Claude Ostyn -- 9/16/89
  481.  
  482.         FOGSCAN.DOC                                               PAGE 9
  483.  
  484.  
  485.              Setting up the DOS version
  486.  
  487.                   Unlike earlier versions of FOGSCAN, this version now 
  488.                   comes with a setup program which makes patching a 
  489.                   breeze.
  490.  
  491.                   You can set up the default path for the data files, 
  492.                   whether or not to run in BBS mode, the screen width for 
  493.                   BBS mode, whether or not to use color, and whether or 
  494.                   not to allow printing. 
  495.  
  496.                   To set up your copy of FOGSCAND.EXE, you need:
  497.                   - Your copy of FOGSCAND.EXE, which MUST be named 
  498.                     FOGSCAND.EXE or FOGSCAN.EXE.  No other name will 
  499.                     work.
  500.                   - SETFGSCD.EXE 
  501.                   - A disk with at least 80Kbytes free.
  502.                  
  503.                   Make sure that FOGSCAND.EXE is in the default path and 
  504.                   call up SETFGSCD.EXE.  The setup program will read 
  505.                   FOGSCAND.EXE, show you what the setup options are, and 
  506.                   prompt you for changes.  Note that the options may be 
  507.                   different depending on whether you choose to run in BBS 
  508.                   mode or not.  You will be able to review the changes 
  509.                   before saving the modified copy.  You will also be able 
  510.                   to cancel without making any changes.
  511.  
  512.  
  513.              Setting up the CP/M version
  514.  
  515.                   FogScan now comes with a setup program which makes 
  516.                   patching a breeze.  You can set up the default path for 
  517.                   the data files, whether or not to run in BBS mode, 
  518.                   whether or not to use full-screen video effects, 
  519.                   whether or not to set up for a Commodore 128, the 
  520.                   screen width, and whether or not to allow printing. 
  521.  
  522.                   To set up your copy of FOGSCAND.EXE, you need:
  523.  
  524.                   - Your copy of FOGSCANC.COM, which MUST be named 
  525.                     FOGSCANC.COM, FOGSCAN.COM or FGSCNBBS.COM.  No 
  526.                     other name will work.  This copy must be on a disk
  527.                     with at least 34 Kbytes free.
  528.                   - SETFGSCC.COM 
  529.                  
  530.                   Make sure that FOGSCANC.COM is in the default drive and 
  531.                   call up SETFGSCC.EXE.  The setup program will read 
  532.                   FOGSCANC.COM, show you what the setup options are, and 
  533.                   prompt you for changes.  Note that the options may be 
  534.                   different depending on whether you choose to run in BBS 
  535.                   mode or not.  You will be able to review the changes 
  536.                   before saving the modified copy.  You will also be able 
  537.                   to cancel without making any changes.
  538.  
  539.  
  540.         (c) Claude Ostyn -- 9/16/89
  541.