home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD1.mdf / pascal / utility / crossref / pxref / pxref.txt < prev    next >
Encoding:
Text File  |  1988-08-25  |  7.1 KB  |  173 lines
  1.  
  2.  
  3.                                      PXREF
  4.                          Pascal Cross Reference Program
  5.  
  6.                                   Version 1.0
  7.  
  8.                             (c) 1988 Robert Webster
  9.  
  10.  
  11.  
  12.                                   INTRODUCTION
  13.  
  14.      This program generates a listing of a pascal program and a cross
  15.      reference listing of the variables, procedures & functions, built-in
  16.      procedures, and key words.
  17.  
  18.      The listing can be output to disk, printer ports, or serial ports.
  19.      Any section of the output can be enabled or disabled.  In addition,
  20.      only symbols with a single reference can output to help find
  21.      unreferenced variables in a program.
  22.  
  23.      The program defaults can be set in a setup file.  Settings can be
  24.      overridden with command line parameters.  File names can be specified
  25.      on the command line for batch operation, or can be entered when the
  26.      program is run.
  27.  
  28.      This program is compatible with both Turbo Pascal files and Microsoft
  29.      Pascal.  It can be tailored for other Pascals by creating a file of
  30.      reserved words and a file of built-in procedures for the particular
  31.      compiler.
  32.  
  33.      Two versions of the PXREF are available - one for MSDOS, and one for
  34.      OS/2 protected mode.
  35.  
  36.                                  RUNNING PXREF
  37.  
  38.      To run the program, enter PXREF.  The complete syntax is:
  39.  
  40.        PXREF [infile] [listfile] [options]
  41.  
  42.      Infile is the Pascal file name.  If this file name is not included on
  43.      the command line, you will be asked for it and the listing file name.
  44.      A file extension of .PAS is assumed if none is given.
  45.  
  46.      Listfile is the listing file name.  To output to a printer, enter
  47.      LPT1:, COM1:, etc.  If the list file is omitted and the input file
  48.      name is given, the input file name with the extension .LST is used for
  49.      the list file.
  50.  
  51.      Options:
  52.  
  53.      /BUILTIN or /B - Output a list of built-in functions and procedures
  54.          referenced in the program.
  55.  
  56.      /NOBUILTIN or /NB - Do NOT output a list of built-in functions and
  57.          procedures referenced in the program.  This is ordinarily the
  58.          program default.  It may be specified to override the default
  59.          file.
  60.  
  61.      /RESERVED or /R - Output a list of reserved words referenced in the
  62.          program.
  63.  
  64.      /NORESERVED or /NR - Do NOT output a list of reserved words referenced
  65.          in the program.  This is ordinarily the program default.  It may
  66.          be specified to override the default file.
  67.  
  68.      /LIST or /L - Output a program listing along with the cross reference
  69.          listing.
  70.  
  71.      /NOLIST or /NL - Do NOT output a program listing.  This is ordinarily
  72.          the program default.  It may be specified to override the default
  73.          file.
  74.  
  75.      /UNREF - Output only those symbols with a single reference in the
  76.          cross reference listing.  This helps find unreferenced variables.
  77.  
  78.      /NOUNREF - Output all referenced symbols in the cross reference
  79.          listing.  This is ordinarily the program default.  It may be
  80.          specified to override the default file.
  81.  
  82.      /PRINT or /P - Output page headings and page feed characters in the
  83.          listing if it is sent to a disk file.  (The page headings and page
  84.          feed characters are always output if the listing is sent to LPT1:,
  85.          COM1:, etc.)
  86.  
  87.      /NOPRINT or /NP - Do NOT page headings and page feed characters in the
  88.          listing if it is sent to a disk file.  (The page headings and page
  89.          feed characters are always output if the listing is sent to LPT1:,
  90.          COM1:, etc.)  This is ordinarily the program default.  It may be
  91.          specified to override the default file.
  92.  
  93.      /WIDE or /W - Use a line length of 132 columns.
  94.  
  95.      /NOWIDE or /NW - Use a line length of 80 columns.  This is ordinarily
  96.          the program default.  It may be specified to override the default
  97.          file.
  98.  
  99.      /MS - Source file is Microsoft Pascal.
  100.  
  101.      /TP - Source file is Turbo Pascal.
  102.  
  103.      /LL=nn - Specify the line length in columns.  nn = number of columns.
  104.          /LL=80 does the same thing as /NOWIDE.  /LL=132 does the same
  105.          thing as /WIDE.
  106.  
  107.      /PL=nn - Specify the page length in lines.  nn = number of lines.
  108.  
  109.  
  110.                                 THE DEFAULT FILE
  111.  
  112.      Program defaults may be specified in the file PXREF.DAT.  To do this,
  113.      edit the file and put any of the above parameters in the file.  There
  114.      can be more than one parameters on each line, and there can be more
  115.      than one line of parameters.
  116.  
  117.      For example, to set up the program for Turbo Pascal and a wide
  118.      carriage printer, you could put the following in the file PXREF.DAT:
  119.  
  120.          /TP
  121.          /WIDE
  122.  
  123.  
  124.  
  125.                                CUSTOMIZING PXREF
  126.  
  127.      PXREF uses two files - one containing lists of key words and another
  128.      containing a list of built-in procedures.  The is one set of these
  129.      files for Microsoft Pascal and one set for Turbo Pascal:
  130.  
  131.          MSRESERV.DAT - Microsoft Pascal reserved words.
  132.          MSBUILT.DAT - Microsoft Pascal built-in procedures and functions.
  133.  
  134.          TPRESERV.DAT - Turbo Pascal reserved words.
  135.          TPBUILT.DAT - Turbo Pascal built-in procedures and functions.
  136.  
  137.      The files used depends on the /MS or /TP parameter in the default file
  138.      or the command line.  To configure this program for another Pascal
  139.      compiler, change one set of the files to contain the appropriate
  140.      symbols used by the new compiler.
  141.  
  142.  
  143.  
  144.                               PROGRAM LIMITATIONS
  145.  
  146.      This program can handle a maximum of 3000 variables and 20000
  147.      references.  This is probably enough for any module that can be
  148.      compiled by the Microsoft or the Turbo Pascal compilers.
  149.  
  150.  
  151.  
  152.                            LICENSE AND LEGAL GARBAGE
  153.  
  154.  
  155.      This program is licensed STRICTLY "AS IS", without any warranty for
  156.      its performance, accuracy, or freedom from error, or results generated
  157.      through its use, including, but not limited to, any implied warranties
  158.      or warranties of merchantability or fitness for a particular purpose.
  159.      You assume the entire risk as to the results and performance of the
  160.      program.  I do not warrant that the program will meet your
  161.      requirements or operate without interruption or error.
  162.  
  163.      If you like this program, please support the shareware concept and
  164.      send $10,000 to:
  165.  
  166.                                  Robert Webster
  167.                                287 Cottonwood Rd.
  168.                                 Pryor, OK 74361
  169.                                  (918) 825-7205
  170.  
  171.      If you don't think it's THAT good, I'd take $25.  For that, I'll let
  172.      you know when and how to get upgrades.  If you use this program for
  173.      commercial use, then the $25 is required.  Please let me know how to
  174.      improve this program.
  175.  
  176.      This program can be distributed freely as long as it is distributed
  177.      intact and unmodified in the original distribution archive file, and
  178.      as long as it's not sold.
  179.