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