home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / progm / xref.zip / XREF.DOC < prev    next >
Text File  |  1990-09-15  |  13KB  |  360 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                     ▀▀▀▀    ▀▀▀▀
  10.                       ▀▀▀  ▀▀▀
  11.                         ▀▀▀▀
  12.                          ▀▀  REF  -  Cross Reference Utility
  13.                         ▀▀▀▀               User Manual
  14.                       ▀▀▀  ▀▀▀             -----------
  15.                     ▀▀▀▀    ▀▀▀▀
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.                                           Version 1.40
  23.                                     copyright 1990, Jim Lynch
  24.  
  25.  
  26.  
  27. PURPOSE     XREF is a data dictionary utility to provide both
  28.             online and printed documentation of your DBF
  29.             databases and indexes.
  30.  
  31.             It also gives you the ability to add and update short
  32.             descriptions for each database field, an invaluable
  33.             documentation tool.
  34.  
  35.             With the cross reference function, you can examine
  36.             the relationships between the databases and indexes.
  37.  
  38.             XREF works with both NTX and NDX type indexes.
  39.  
  40.  
  41. QUICK       Start the program from the DOS prompt with the
  42. START       following syntax:
  43.  
  44.                 XREF /p<path> /f<dbfmask> /i<indexmask> /d /h
  45.  
  46.  
  47.             <path>      is the drive:directory to search for
  48.                         DBF's and indexes; the default is the
  49.                         current directory.
  50.  
  51.             <dbfmask>   limits selection of DBF's to filenames
  52.                         matching the mask; the default is all
  53.                         DBF's.
  54.  
  55.             <indexmask> limits selection of indexes to filenames
  56.                         matching the mask; the default is all
  57.                         indexes.
  58.  
  59.             /d          specifies .NDX type indexes; the default
  60.                         is .NTX type indexes.
  61.  
  62.             /h          displays this syntax help.
  63.  
  64.  
  65.             All switches are optional, and can be entered in any
  66.             order, in either upper or lower case. For example, to
  67.             use all DBF's and NTX type indexes in current
  68.             directory, you would start the program without
  69.             switches:
  70.  
  71.                         XREF
  72.  
  73.  
  74.             To use NDX type indexes
  75.  
  76.                         XREF /d
  77.  
  78.  
  79.             To use DBF'S and NTX type indexes in the E:\MYDIR
  80.             path, and limit selection of DBF to those matching
  81.             the filespec CPI?????.DBF
  82.  
  83.                         XREF /pE:\MYDIR /fCPI
  84.  
  85.  
  86.             To use all DBF's and index matching the filespec
  87.             ???tst??.NTX in \DB directory
  88.  
  89.                 XREF /i???tst /p\DB
  90.  
  91.  
  92.  
  93.  
  94. ACTIVE      PgUp             - Scrolls the window up 1 page.
  95. KEYS        PgDn             - Scrolls the window down 1 page.
  96.             Ctrl_PgUp        - Moves to first item in the window.
  97.             Ctrl_PgDn        - Moves to the last item in the window.
  98.  
  99.             Ctrl_Cursor      - Selects a new window.
  100.             Tab & Shift-Tab  -    "    "  "     "
  101.  
  102.             X                - Searches for Cross-References to
  103.                                the selected item. (see CROSS
  104.                                REFERENCES, below).
  105.  
  106.             SpaceBar         - Tags/Untags items for reports. Tagged
  107.                                items are marked with the √ character
  108.  
  109.             R                - Prints either the Database
  110.                                Structure Report or the Index
  111.                                Expression Report. First you must
  112.                                select which databases and/or
  113.                                indexes you wish to report on by
  114.                                tagging them by pressing Spacebar.
  115.  
  116.                                Reports can be send to the
  117.                                printer, or written to a file for
  118.                                later printing or offline viewing.
  119.  
  120.             E                - Edits the Field Description. This
  121.                                command is only active when you
  122.                                are in the STRUCTURE window.
  123.  
  124.             F1               - Pops up a help screen.
  125.  
  126.             Esc              - Quits to DOS.
  127.  
  128.  
  129.  
  130. CROSS       There are 3 selectable windows: DBF WINDOW, the list
  131. REFERENCES  of dbfs; INDEX WINDOW, the list of indexes; and
  132.             STRUCTURE WINDOW, which shows the structure of the
  133.             selected dbf.
  134.  
  135.             When cross-referencing is invoked, the result depends
  136.             on which window is active at the time, as follows:
  137.  
  138.  
  139.               Window      Cross Reference function
  140.               ---------   ---------------------------------------
  141.               DBF         ALL INDEXES are searched for a string
  142.                           matching any field in the SELECTED DBF.
  143.                           Any INDEX with a matching string is
  144.                           flagged with the  marker.
  145.  
  146.               INDEX       ALL DBFs are searched for a field
  147.                           contained in the SELECTED INDEX. Any
  148.                           DBF with a matching string is flagged
  149.                           with the  marker.
  150.  
  151.               STRUCTURE   ALL INDEXES are searched for a string
  152.                           matching the SELECTED FIELD. Any INDEX
  153.                           with a matching string is flagged with
  154.                           the  marker.
  155.  
  156.  
  157.             Note that a cross reference between an index and a
  158.             database does not necessarily indicate that the files
  159.             are associated; it only indicates that the index
  160.             expression contains, as a string, one or more of the
  161.             dbf fields.
  162.  
  163.  
  164. NETWORK     XREF is network aware, and can be used while your
  165.             databases and indexes are in use on other
  166.             workstations. Mutilple workstations may also run
  167.             XREF at the same time.
  168.  
  169.  
  170. STRUCTURE   To display database structures and maintain field
  171. FILES       descriptions, XREF creates a "structure" file for
  172.             each of your DBFs. These files have the same name as
  173.             the DBF, and the extension ".STR"
  174.  
  175.             When XREF is started, it checks each DBF, and where
  176.             necessary creates or updates the "structure" file.
  177.             Each index is also read during program startup. In
  178.             this way the information displayed is always kept
  179.             current.
  180.  
  181.             The first time XREF is run for a particular
  182.             directory, these files have to be created from
  183.             scratch, and so program initialization will take
  184.             somewhat longer, depending on how many dbf's you
  185.             have, and the speed of your machine.
  186.  
  187.  
  188. TEMPORARY   Four temporary files are created by XREF, and are
  189. FILES       normally deleted before you quit. If an abnormal
  190.             termination occurs, these files may be left behind;
  191.             it is ok to delete them. They are $newstr.dbf,
  192.             $tmpstr.dbf, $tmp2str.ntx, and $tmpidx.ntx.
  193.  
  194.  
  195. LANGUAGE    XREF is written almost entirely in Clipper, with the
  196.             exception of two assembly language functions to
  197.             determine the current drive, and to report the
  198.             date/time stamp of files.
  199.  
  200.  
  201. FILES       XREF.EXE
  202. SUPPLIED:   XREF.DOC
  203.             ABSTRACT.TXT
  204.             ORDER.DOC
  205.  
  206.  
  207. SUPPORT:    I can be reached via modem in the following ways:
  208.  
  209.               FidoNet              netmail 1:107/6000.2
  210.                                    conferences: Clipper, Dbase,
  211.                                      Shareware
  212.  
  213.               RelayNet (RIME)      conferences: Clipper, Dbase,
  214.                                      Shareware
  215.  
  216.               InterLink (ILink)    conferences: Clipper, Dbase,
  217.                                      Shareware
  218.  
  219.               Moondog BBS          main board, (718) 692-2498
  220.  
  221.               Compuserv            71210,2354
  222.  
  223.  
  224.             By U.S. mail:
  225.  
  226.                 P.O. Box 140192
  227.                 Staten Island, NY 10314
  228.  
  229.  
  230. REVISION    4/10/90 - v1.00 original release
  231. HISTORY:
  232.             6/02/90 - v1.10
  233.                     - added ability to maintain a field
  234.                       description for dbf fields
  235.  
  236.                     - added ability to specify path from the
  237.                       command line
  238.  
  239.                     - added help screen
  240.  
  241.                     - enhanced appearance
  242.  
  243.                     - fixed incorrect index window ID's
  244.  
  245.             6/20/90 - v1.20
  246.                     - added report function
  247.  
  248.             8/16/90 - v1.30
  249.                     - added /f and /i switches to limit indexes and
  250.                       dbf's displayed
  251.  
  252.                     - tags for reports and tags for cross
  253.                       references can now be on the screen at the
  254.                       same time
  255.  
  256.             9/15/90 - v1.40
  257.                     - startup time reduced by removing unnecessary
  258.                       rebuilding of .STR files
  259.  
  260.                     - put help in movable, resizeable window
  261.  
  262.  
  263. REGISTER    XREF is a Shareware program.
  264.  
  265.             You are free to copy and distribute XREF for
  266.             NONCOMMERCIAL use provided it is not modified in any
  267.             way, and this document accompanies the program.
  268.             Clubs, user groups and disk distributors may charge a
  269.             nominal fee not to exceed $6 for expenses and
  270.             handling.
  271.  
  272.             Shareware isn't free; it is a distribution method
  273.             that gives you a chance to try software before buying
  274.             it. If you try a Shareware program and continue using
  275.             it, you are expected to register.
  276.  
  277.             The registration fee for XREF is $15.00 per copy,
  278.             which entitles you to lifetime technical support,
  279.             upgrade notices, and one free upgrade to the next
  280.             release. Registered copies also have the advertising
  281.             screen removed.
  282.  
  283.             To register, simply fill out the form below, or in
  284.             the seperate ORDER.DOC file.
  285.  
  286.  
  287. OTHER       Also available is HDBCALC, a memory-resident
  288. PRODUCTS    programmer's calculator that performs math and logical
  289.             operations in Hex, Decimal and Binary. I also plan to
  290.             release a Clipper function library sometime in the
  291.             future.
  292.  
  293. DISCLAIMER  The author makes no warranties, expressed or implied,
  294.             including, but not limited to, merchantability or
  295.             fitness for any particular purpose.  In no event
  296.             shall the author be liable for indirect or
  297.             consequential damages arising from the use of the
  298.             XREF.
  299.  
  300.  
  301.  
  302.    XREF version 1.40                 Order Form and Software License
  303.    ---------------------------------------------------------------------
  304.  
  305.    Use this form to register XREF. Purchase orders are also accepted.
  306.    Each copy purchased entitles you to exclusive use of XREF on a single
  307.    computer. On local area networks, for each copy purchased, only one
  308.    copy of XREF may be in use at any given time.
  309.  
  310.    Registration also entitles you to lifetime technical support, notices
  311.    of upgrades, and one free upgrade to the next release. Registered
  312.    copies also have the advertising screen removed.
  313.  
  314.    Site Licenses for ten or more users are also available; please
  315.    contact the author.  Make checks payable to:
  316.  
  317.        Jim Lynch
  318.        P.O. Box 140192
  319.        Staten Island, NY 10314
  320.        USA
  321.  
  322.  
  323.    *************************** PLEASE PRINT ***************************
  324.  
  325.  
  326.  
  327.     ___ copies  @ $15 ea.....................................   $______
  328.  
  329.  
  330.  
  331.        Name____________________________________________________________
  332.  
  333.     Company____________________________________________________________
  334.  
  335.     Address____________________________________________________________
  336.  
  337.            ____________________________________________________________
  338.  
  339.       Phone____________________________________________________________
  340.  
  341.  
  342.     Where did you obtain XREF?  (Please check one)
  343.  
  344.  
  345.                      BBS_____    Catalog_____     Other?____
  346.  
  347.  
  348.     Catalogue or BBS Name______________________________________________
  349.  
  350.  
  351.     Comments___________________________________________________________
  352.  
  353.              __________________________________________________________
  354.  
  355.              __________________________________________________________
  356.  
  357.              __________________________________________________________
  358.  
  359.  
  360.