src/suifvbrowser/README.suifvbrowser

   1         SUIFVBROWSER: A GRAPHICAL BROWSER FOR SUIF FILES
   2         ================================================
   3
   4 This package is part of the SUIF compiler system.  It requires the
   5 basesuif, baseparsuif, and suifcallgraph packages to be installed
   6 before this package may be installed.  These packages are available by
   7 anonymous ftp from suif.stanford.edu:/pub/suif.
   8
   9 This package also requires TCL and TK.  If they aren't already
  10 installed on your system, you must obtain and install these packages
  11 before begining the installation of suifvbrowser.  Both packages are
  12 freely available.  This package requires at least version 7.4 of TCL
  13 and at least version 4.0 of TK.  Note that patches should be applied
  14 to both TCL and TK to bring them to patch level 2 to fix bugs that
  15 cause problems for vbrowser.  TCL and TK are available from various
  16 ftp sites on the network.  The SUIF anonymous ftp site also maintains
  17 copies of the TCL and TK distributions in the
  18 suif.stanford.edu:/pub/other_distributions directory.
  19
  20 NOTE for TK versions before 4.1: If you use a version of TK early than
  21 4.1, you must use the ``-DOLDER_THAN_TK4_1'' flag.  That's because TK
  22 version 4.1 has a slight interface change.  ``-DOLDER_THAN_TK4_1''
  23 enables code in the vbrowser that uses the pre-version 4.1 interface
  24 instead of the version 4.1 interface to TK.
  25
  26 Note that to install this package, tcl header files must be somewhere
  27 where they will be found by the C++ compiler.  If the tcl header files
  28 are in /usr/include or someplace else automatically searched by the
  29 C++ compiler, nothing more must be done.  If they're not in the
  30 default include search path, however, their location must be given to
  31 SUIF.  The TCL_INCLUDE_FLAGS variable is provided for this purpose.
  32 It will be passed to the C++ compiler on the command line for any
  33 programs that need TCL header files.  So, for example, if tcl.h is in
  34 /usr/local/include, you would set TCL_INCLUDE_FLAGS to
  35 "-I/usr/local/include".  If there are other include directories needed
  36 for X related things, you can include them here, too, and you can
  37 include ``-DOLDER_THAN_TK4_1'' here if you are using a version of TK
  38 older than version 4.1.
  39
  40 The ``visual_tcl_lib'' sub-package contains a library of tcl code used
  41 by the visual browser.  The ``visual'' and ``vsuif'' sub-packages
  42 contain C++ libraries used by the visual browser.  The ``vbrowser''
  43 sub-package contains the visual browser itself.
  44
  45 See the man page for vbrowser for information about how to run the
  46 visual browser.
  47
  48 NOTE for SunOS 4.x users: SunOS 4.x versions of printf(), fprintf(),
  49 etc. apparently don't support the ``%p'' directive.  So if you are
  50 using suifvbrowser on SunOS 4.x, you should change all uses of ``%p''
  51 with ``%x''.  If you don't, the vbrowser will run, but it will seg
  52 fault as soon as you try certain common actions.  You can apply the
  53 fix by running the following line in the visual, vsuif, and vbrowser
  54 subdirectories:
  55
  56     perl -i.bak -p -e "s/%p/%x/g" *.h *.cc
  57
  58 (thanks to jhbrown@ai.mit.edu (Jeremy H. Brown) for providing this
  59 work-around).