Portable Bookshelf Distributions

Please note the following tools are not up-to-date. Please refer to SWAGKit for an updated grok, layoutplus, and lsedit.

Listed below are a number of distributions for the PBS toolkit, which are used for creating Software Landscapes and Bookshelves. The documentation for the Toolkit is available here. Many of the tools don't need to be executed directly, however, the documentation for some of the major "behind the scenes" tools is available here.

Your first choice for download should be a full PBS toolkit. There are also distributions for the individual tools, which are useful for updates.

In the cases of cfx, fbgen, lslayout and lsadjust, the source distribution will give you the source C program for the tool along with a "make" file to compile the tool. In the case of grok, which is written in Object Oriented Turing, you can only download a binary executable file. In the case of lsedit, which is written in Java, you can download the Java classes bytecode.

Please note that these tools are at the "research level", created to demonstrate concepts; we make no promises about their practicality in your particular situation.

Instructions for unpacking source or UNIX binary distributions:

Binary distributions create and unpack into the directory: pbs
Source distributions create and unpack into the directory: pbs_src

Steps:

• Click on a distribution.
• When prompted, select to download to the directory which will contain pbs and/or pbs_src.
• Wait for download to complete.
• From command (shell) prompt:
  • gunzip DIST.tar.gz where DIST is the distribution you downloaded
  • tar xf DIST.tar
    On some systems these can be combined in one step:
  • tar xzf DIST.tar.gz

Instructions for unpacking WIN32 binary distributions:

Steps:

• Click on a distribution.
• When prompted, select to download to the root of the c: drive (c:\)
• Wait for download to complete
• From command (shell) prompt enter the following:
  • c:
  • cd \
  • unzip pbs-win32.zip
    or
    pkunzip -d pbs-win32.zip
    or
    Use another unzip utility which retains the directory structure within the .zip file.

Using PBS:

In the directory you unzip PBS will be the directory pbs, which contains the PBS distribution (binaries, scripts, and data files).

Creating a bookshelf requires these three steps:

• Setup your shell for running PBS
• Run pbs_init to initialize a Bookshelf
• Run pbs_build to build and populate a Bookshelf

See the README in the directory pbs for information specific to a particular release.

PBS Full Toolkit Binary Distributions

These are the full toolkit distributions which include all binaries, scripts, java classes, and examples. Each distribution is for a particular target machine platform.

• Linux (x86) (approx 9.3 MB compressed - expands to 20 MB) - v5.0
  pbs-linux.tar.gz - Last update: Apr. 30, 2001
  

• Sun SOLARIS (approx 9.5 MB compressed - expands to 20 MB) - v4.0
  pbs-solaris.tar.gz - Last update: Nov. 23, 1998
  

• Windows 95/98/NT (approx 7.5 MB compressed - expands to 14 MB) - v4.1
  pbs-win32.zip - Last update: Dec. 4, 1998
  

PBS Individual Tool Distributions

• cfx: C Fact Extractor. Parses C programs to generate fact tables.

  Available files:

  • Documentation
  • Source code
  • Binary distributions for:
    • Sun Solaris.

• fbgen: Fact Base Generator. Converts the fact tables created by cfx into an sequence of RSF tuples.

  Available files:

  • Documentation
  • Source code

• grok: Fact Manipulator. This is a "calculator" for relations, which reads facts, such as those created by fbgen, and manipulates these to compute new facts. Also included are the latest grok scripts.

  Available files:

  • Documentation
  • Binary distributions for:
    • Sun SolarisOutdated. Please refer to SWAGKit for the latest release

    NOTE: The grok tool is currently distributed only in binary form.

• grok scripts: Instructions interpreted by grok. There are a number of standard manipulations of facts that have been canned as a set of grok scripts. These do things such as: induce function and variable level relations up to the file level, induce relations on up to the subsystem level, and split up the facts into individual fact bases for each subsystem.

  The grok scripts are an area of active research and work, and are being updated frequently. Be sure to always keep your grok and grok scripts up to date. The same scripts are included with the grok binary distribution.

  Available files:

  • Documentation
  • Current PBS grok scripts.

• lslayout and lsadjust: Layout tools for Landscape Diagrams.
  • lslayout: Layout generator for Landscape Diagrams

    Generates the position and size of boxes so a Landscape can be drawn for facts such as those created by fbgen and manipulated by grok. Generates .lyt files, which are in the form of TA attributes.

  • lsadjust: Adjuster for Landscape Diagrams.

    Re-layouts a Landscape using layout information from a previous version of the same software subsystem.

    This is useful when you already have a nice layout for a Landscape and a slightly changed new version of the same software is released.

  Available files:

  • Documentation for lslayout
  • Documentation for lsadjust
  • Source code for both tools

• lsedit: Editor (and Viewer) for Landscape Diagrams. Using facts (tuples) describing a software systems and attributes telling how to layout a diagram, lsedit displays a Software Landscape. The lsedit tool is written in Java and uses Java's AWT.

  Available files:

  • Java classes bytecode

holt@uwaterloo.ca
pbs@swag.uwaterloo.ca

To PBS Home Page