📄 index.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="Microsoft Word 97">
<META NAME="GENERATOR" CONTENT="Mozilla/4.5b1 [en] (Win98; I) [Netscape]">
<META NAME="Author" CONTENT="dd29">
<TITLE>Bunch User抯 Manual</TITLE>
</HEAD>
<BODY LINK="#0000FF">
<DIV ALIGN=right><FONT FACE="Arial,Helvetica"><FONT SIZE=-2>Back to the
<A HREF="../index.html">Bunch
Website</A></FONT></FONT></DIV>
<HR WIDTH="100%">
<H1>
<FONT FACE="Arial,Helvetica">Bunch - User抯 Manual</FONT></H1>
<H2>
<FONT FACE="Arial,Helvetica">Introduction</FONT></H2>
<FONT FACE="Arial,Helvetica">This document is the User抯 Manual for Bunch
Beta 1, a code-analysis tool produced by the Software Engineering Research
Group at the Department of Math & Computer Science of Drexel University.
The document describes the functionality of our tool from a User抯 viewpoint
and is meant both as a User Reference and as a help for those who approach
the tool for the first time. More information and documentation on Bunch,
and the research behind it, can be found at <A HREF="../index.html">Bunch's
site</A>.</FONT>
<H2>
<FONT FACE="Arial,Helvetica">Program Functionality</FONT></H2>
<FONT FACE="Arial,Helvetica">Bunch is a clustering tool intended to aid
the software developer and maintainer in understanding, verifying and maintaining
a source code base. To do this, Bunch lets the user evaluate the quality
of an application抯 modularization, by analyzing the source code graph.
Bunch relies solely on the information contained in a module dependency
file, considering nodes as program units or modules, such as files or classes,
and edges between the nodes as calls or relationships between those modules,
such as function calls or inheritance relationships. With this graph, Bunch
can find what a "good" clustering for the system is (thus helping when
documentation of the code is nonexistent or outdated), and it can also
use pre-defined clusters to measure or improve the quality of the system抯
clustering.</FONT>
<P><FONT FACE="Arial,Helvetica">To know more about the clustering process,
and what are the uses of Bunch, please consult the <A HREF="../publications/index.html">on-line
papers</A>.</FONT>
<H2>
<FONT FACE="Arial,Helvetica">Installation</FONT></H2>
<FONT FACE="Arial,Helvetica">Bunch is a Java application. As such, it requires
a Java Virtual Machine 1.1 or compatible to run. Bunch will run with JDK
1.1.6, and you will also need the Java Foundation Classes for JDK 1.1 (JFC,
a.k.a Swing). We have also tested Bunch with Microsoft抯 Java Virtual Machine,
jview, and while the algorithms run faster, you may encounter some problems.
You will also need a decompression tool such as WinZip 95 (for Windows
95) or GNU TAR/GZIP for UNIX environments.</FONT>
<H3>
<FONT FACE="Arial,Helvetica">Installation Steps</FONT></H3>
<H4>
<FONT FACE="Arial,Helvetica">Java Version Check</FONT></H4>
<FONT FACE="Arial,Helvetica">Check to have the JDK 1.1.6 (or greater),
this can be done by running:</FONT>
<P><FONT FACE="Arial,Helvetica"><FONT SIZE=-1>java 杤ersion</FONT></FONT>
<P><FONT FACE="Arial,Helvetica">Swing requires JDK 1.1.5 or greater. We
recommend that, before attempting to run Bunch, you download and install
the JDK and the last swing version from the <A HREF="http://www.javasoft.com/">JavaSoft
</A>site.</FONT>
<H4>
<FONT FACE="Arial,Helvetica">Java Classpath</FONT></H4>
<FONT FACE="Arial,Helvetica">To install bunch, just decompress the distribution
file into any directory (for example, c:\bunch -for windows- or /usr/bunch
-for UNIX-). Then add the JAR file (bunch.jar) that appears in that directory
to your <I>classpath</I>.</FONT>
<P><FONT FACE="Arial,Helvetica">For example, if your CLASSPATH was</FONT>
<P><FONT FACE="Arial,Helvetica"><FONT SIZE=-1>c:\jdk1.1.6\lib\classes.zip
(for Windows)</FONT></FONT>
<P><FONT FACE="Arial,Helvetica">or</FONT>
<P><FONT FACE="Arial,Helvetica"><FONT SIZE=-1>/usr/jdk1.1.6/lib/classes.zip
(for UNIX)</FONT></FONT>
<P><FONT FACE="Arial,Helvetica">assuming that you copied the Bunch JAR
file into c:\do (for windows) or /usr/do (for UNIX) you should run the
following command:</FONT>
<P><FONT FACE="Arial,Helvetica"><FONT SIZE=-1>set CLASSPATH=c:\bunch\bunch.jar;%CLASSPATH%
(for windows)</FONT></FONT>
<P><FONT FACE="Arial,Helvetica"><FONT SIZE=-1>or</FONT></FONT>
<P><FONT FACE="Arial,Helvetica"><FONT SIZE=-1>export CLASSPATH=/usr/bunch/bunch.jar:$CLASSPATH
(for UNIX)</FONT></FONT>
<H4>
<FONT FACE="Arial,Helvetica">Running Bunch</FONT></H4>
<FONT FACE="Arial,Helvetica"><FONT SIZE=-1>To run bunch, just type:</FONT></FONT>
<BLOCKQUOTE><FONT FACE="Arial,Helvetica"><FONT SIZE=-1>java bunch.Bunch</FONT></FONT></BLOCKQUOTE>
<H4>
<FONT FACE="Arial,Helvetica">Required Software</FONT></H4>
<FONT FACE="Arial,Helvetica">To run, Bunch requires:</FONT>
<UL>
<LI>
<FONT FACE="Arial,Helvetica">The Java Runtime Environtment or the Java
Development Kit.</FONT></LI>
<LI>
<FONT FACE="Arial,Helvetica">The Java Foundation Classes for JDK 1.1</FONT></LI>
</UL>
<FONT FACE="Arial,Helvetica">As of Beta 1, currently Bunch does not run
as an applet.</FONT>
<H2>
<FONT FACE="Arial,Helvetica">Using Bunch</FONT></H2>
<FONT FACE="Arial,Helvetica">Bunch has a very simple user interface: a
set of tabbed panes that contain all the information easily accessible,
without clobbering the screen with options that are rarely used. The following
is a screenshot of how Bunch appears after launched:</FONT>
<CENTER>
<P><IMG SRC="Image15.gif" HEIGHT=394 WIDTH=556></CENTER>
<BR>
<P><FONT FACE="Arial,Helvetica">As we can see in the picture, Bunch contains
two divisions on its window: "Options" where the user selects the options
that will be used to run a given action (or procedure) and the "Action"
portion, where the action to be executed is selected and run.</FONT>
<H3>
<FONT FACE="Arial,Helvetica">Clustering a graph</FONT></H3>
<FONT FACE="Arial,Helvetica">Clustering a graph requires the user to select:</FONT>
<UL>
<LI>
<FONT FACE="Arial,Helvetica">The graph dependency file</FONT></LI>
<LI>
<FONT FACE="Arial,Helvetica">A graph output file, and its format</FONT></LI>
<LI>
<FONT FACE="Arial,Helvetica">A clustering method</FONT></LI>
</UL>
<FONT FACE="Arial,Helvetica">The graph dependency file is selected by clicking
on the "Select⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -