README
1
2 * R E A D M E *
3
4 Cbrowser is a C/C++ source code indexing, querying and browsing tool
5 Copyright (C) 2000 B. Christopher Felaco
6
7 This program is free software; you can redistribute it and/or
8 modify it under the terms of the GNU General Public License
9 as published by the Free Software Foundation; either version 2
10 of the License, or (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20
21 For more information about Cbrowser and it's author see:
22 URL:http://cbrowser.sourceforge.net/
23
24 Feel free to contact me at URL:mailto:cfelaco@users.sourceforge.net with
25 enhancements or suggestions.
26
27 ----------------------------------------------------------------------------
28
29 Megawidgets
30
31 Portions of this software are part of the Megawidget package
32
33 Copyright 1995-1997 Jeffrey Hobbs
34 and
35 Copyright 1997 Jeffrey Hobbs, CADIX International
36
37 Licensing information can be obtained at:
38
39 URL:http://www.cs.uoregon.edu/research/tcl/script/tkcon/docs/license.terms
40
41 For more information and how to get the rest of the package see
42
43 URL:http://www.cs.uoregon.edu/research/tcl/script/widget/
44
45 ----------------------------------------------------------------------------
46
47 Installation
48
49 Cbrowser is composed of a small number of Tcl source code files. These
50 files should be placed into a single directory along with the supplied
51 tclIndex file. The main entry script, "cbrowser", will determine where it
52 resides at run-time and automatically load the other files as needed.
53
54 The simplest installation is to copy all files into /usr/local/bin or some
55 other common directory that is in your executable search path. Give the
56 main module "cbrowser" execute permission and start it up.
57
58 Another option is to store all of the files in a subdirectory such as
59 /usr/local/cbrowser-x.x/ and make a symbolic link
60 /usr/local/bin/cbrowser -> /usr/local/cbrowser-x.x/cbrowser
61 The application will follow the link to the proper directory and the support
62 files will be properly loaded.
63
64 Another option is to keep cbrowser in a separate directory from the support
65 files. In this case you will need to add the directory where the support
66 files reside to the TCL_PACKAGE_PATH environment variable. Be sure to
67 include the tclIndex file in the common directory.
68
69 ----------------------------------------------------------------------------
70
71 Usage
72
73 The whole point of cbrowser is that it simplifies usage of source code
74 querying tools, therefore it is designed to be self-explanatory. There is
75 some basic online help available to supplement anything that isn't
76 intuitively obvious.
77
78 You will need either cscope or cs. These tools are obtained separately.
79
80 cscope: URL:http://cscope.sourceforge.net/
81 cs: URL:http://cantor.informatik.rwth-aachen.de/~michael/projects/cs.html
82
83 ----------------------------------------------------------------------------
84
85Local Variables:
86mode: indented-text
87End:
88