home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD1.mdf / xbase / tools / xref / xref.doc < prev    next >
Encoding:
Text File  |  1992-03-20  |  9.3 KB  |  263 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                     ▀▀▀▀    ▀▀▀▀
  8.                       ▀▀▀  ▀▀▀
  9.                         ▀▀▀▀
  10.                          ▀▀  REF  -  Cross Reference Utility
  11.                         ▀▀▀▀               User Manual
  12.                       ▀▀▀  ▀▀▀             -----------
  13.                     ▀▀▀▀    ▀▀▀▀
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                                           Version 1.40f
  21.                                     copr 1990,91,92 Jim Lynch
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29. PURPOSE     XREF is a data dictionary utility to provide both
  30.             online and printed documentation of your DBF
  31.             databases and indexes.
  32.  
  33.             It also gives you the ability to add and update short
  34.             descriptions for each database field, an invaluable
  35.             documentation tool.
  36.  
  37.             With the cross reference function, you can examine
  38.             the relationships between the databases and indexes.
  39.  
  40.             XREF works with both NTX and NDX type indexes.
  41.  
  42.  
  43.  
  44. QUICK       Start the program from the DOS prompt with the
  45. START       following syntax:
  46.  
  47.                 XREF /p<path> /f<dbfmask> /i<indexmask> /d /h
  48.  
  49.  
  50.             <path>      is the drive:directory to search for
  51.                         DBF's and indexes; the default is the
  52.                         current directory.
  53.  
  54.             <dbfmask>   limits selection of DBF's to filenames
  55.                         matching the mask; the default is all
  56.                         DBF's.
  57.  
  58.             <indexmask> limits selection of indexes to filenames
  59.                         matching the mask; the default is all
  60.                         indexes.
  61.  
  62.             /d          specifies .NDX type indexes; the default
  63.                         is .NTX type indexes.
  64.  
  65.             /h          displays this syntax help.
  66.  
  67.  
  68.             All switches are optional, and can be entered in any
  69.             order, in either upper or lower case. For example, to
  70.             use all DBF's and NTX type indexes in current
  71.             directory, you would start the program without
  72.             switches:
  73.  
  74.                         XREF
  75.  
  76.  
  77.             To use NDX type indexes
  78.  
  79.                         XREF /d
  80.  
  81.  
  82.             To use DBF'S and NTX type indexes in the E:\MYDIR
  83.             path, and limit selection of DBF to those matching
  84.             the filespec CPI?????.DBF
  85.  
  86.                         XREF /pE:\MYDIR /fCPI
  87.  
  88.  
  89.             To use all DBF's and index matching the filespec
  90.             ???tst??.NTX in \DB directory
  91.  
  92.                 XREF /i???tst /p\DB
  93.  
  94.  
  95.  
  96. ACTIVE      PgUp             - Scrolls the window up 1 page.
  97. KEYS        PgDn             - Scrolls the window down 1 page.
  98.             Ctrl_PgUp        - Moves to first item in the window.
  99.             Ctrl_PgDn        - Moves to the last item in the window.
  100.  
  101.             Ctrl_Cursor      - Selects a new window.
  102.             Tab & Shift-Tab  -    "    "  "     "
  103.  
  104.             X                - Searches for Cross-References to
  105.                                the selected item. (see CROSS
  106.                                REFERENCES, below).
  107.  
  108.             SpaceBar         - Tags/Untags items for reports. Tagged
  109.                                items are marked with the √ character
  110.  
  111.             R                - Prints either the Database
  112.                                Structure Report or the Index
  113.                                Expression Report. First you must
  114.                                select which databases and/or
  115.                                indexes you wish to report on by
  116.                                tagging them by pressing Spacebar.
  117.  
  118.                                Reports can be send to the
  119.                                printer, or written to a file for
  120.                                later printing or offline viewing.
  121.  
  122.             E                - Edits the Field Description. This
  123.                                command is only active when you
  124.                                are in the STRUCTURE window.
  125.  
  126.             F1               - Pops up a help screen.
  127.  
  128.             Esc              - Quits to DOS.
  129.  
  130.  
  131.  
  132. CROSS       There are 3 selectable windows: DBF WINDOW, the list
  133. REFERENCES  of dbfs; INDEX WINDOW, the list of indexes; and
  134.             STRUCTURE WINDOW, which shows the structure of the
  135.             selected dbf.
  136.  
  137.             When cross-referencing is invoked, the result depends
  138.             on which window is active at the time, as follows:
  139.  
  140.  
  141.               Window      Cross Reference function
  142.               ---------   ---------------------------------------
  143.               DBF         ALL INDEXES are searched for a string
  144.                           matching any field in the SELECTED DBF.
  145.                           Any INDEX with a matching string is
  146.                           flagged with the  marker.
  147.  
  148.               INDEX       ALL DBFs are searched for a field
  149.                           contained in the SELECTED INDEX. Any
  150.                           DBF with a matching string is flagged
  151.                           with the  marker.
  152.  
  153.               STRUCTURE   ALL INDEXES are searched for a string
  154.                           matching the SELECTED FIELD. Any INDEX
  155.                           with a matching string is flagged with
  156.                           the  marker.
  157.  
  158.  
  159.             Note that a cross reference between an index and a
  160.             database does not necessarily indicate that the files
  161.             are associated; it only indicates that the index
  162.             expression contains, as a string, one or more of the
  163.             dbf fields.
  164.  
  165.  
  166. NETWORK     XREF is network aware, and can be used while your
  167.             databases and indexes are in use on other
  168.             workstations. Multiple workstations may also run
  169.             XREF at the same time.
  170.  
  171.  
  172. STRUCTURE   To display database structures and maintain field
  173. FILES       descriptions, XREF creates a "structure" file for
  174.             each of your DBFs. These files have the same name as
  175.             the DBF, and the extension ".STR"
  176.  
  177.             When XREF is started, it checks each DBF, and where
  178.             necessary creates or updates the "structure" file.
  179.             Each index is also read during program startup. In
  180.             this way the information displayed is always kept
  181.             current.
  182.  
  183.             The first time XREF is run for a particular
  184.             directory, these files have to be created from
  185.             scratch, and so program initialization will take
  186.             somewhat longer, depending on how many dbf's you
  187.             have, and the speed of your machine.
  188.  
  189.  
  190. TEMPORARY   Four temporary files are created by XREF, and are
  191. FILES       normally deleted before you quit. If an abnormal
  192.             termination occurs, these files may be left behind;
  193.             it is ok to delete them. They are $newstr.dbf,
  194.             $tmpstr.dbf, $tmp2str.ntx, and $tmpidx.ntx.
  195.  
  196.  
  197. LANGUAGE    XREF is written almost entirely in Clipper, with the
  198.             exception of two assembly language functions to
  199.             determine the current drive, and to report the
  200.             date/time stamp of files.
  201.  
  202.  
  203. FILES       XREF.EXE            - the only file needed to run XREF
  204. SUPPLIED    XREF.DOC            - this user manual
  205.             SUMMARY.DOC         - summary of the program
  206.             ORDER.DOC           - order form
  207.             UPDATE.DOC          - revision history
  208.  
  209.  
  210. SUPPORT:    I can be reached via modem in the following ways:
  211.  
  212.               FidoNet              1:278/627, NMH only.
  213.                                    conferences: Clipper, Dbase,
  214.                                      Shareware
  215.  
  216.               RelayNet (RIME)      conferences: Clipper, Dbase,
  217.                                      Shareware
  218.  
  219.               InterLink (ILink)    conferences: Clipper, Dbase,
  220.                                      Shareware
  221.  
  222.               Moondog BBS          main board, (718) 692-2498
  223.  
  224.               Compuserv            71210,2354
  225.  
  226.  
  227.             By U.S. mail:
  228.  
  229.                 P.O. Box 140192
  230.                 Staten Island, NY 10314
  231.  
  232.  
  233.  
  234. REGISTER    XREF is a Shareware program.
  235.  
  236.             You are free to copy and distribute XREF for
  237.             NONCOMMERCIAL use provided it is not modified in any
  238.             way, and this document accompanies the program.
  239.             Clubs, user groups and disk distributors may charge a
  240.             nominal fee for expenses and handling.
  241.  
  242.             Shareware isn't free; it is a distribution method
  243.             that gives you a chance to try software before buying
  244.             it. If you try a Shareware program and continue using
  245.             it, you are expected to register.
  246.  
  247.             The registration fee for XREF is $15.00 per copy,
  248.             which entitles you to lifetime technical support,
  249.             upgrade notices, and one free upgrade to the next
  250.             release. Registered copies also have the advertising
  251.             screen removed.
  252.  
  253.             To register, simply fill out the form in the separate
  254.             ORDER.DOC file.
  255.  
  256.  
  257. DISCLAIMER  The author makes no warranties, expressed or implied,
  258.             including, but not limited to, merchantability or
  259.             fitness for any particular purpose.  In no event
  260.             shall the author be liable for indirect or
  261.             consequential damages arising from the use of the
  262.             XREF.
  263.