Add proper per-file copyright notices/licenses and top-level license.
[bluesky.git] / TBBT / trace_init / INSTALL
1 # $Id: INSTALL,v 1.4 2003/07/28 14:27:16 ellard Exp $\r
2 \r
3 NFSSCAN INSTALLATION INSTRUCTIONS\r
4 \r
5 This is version 0.10a of nfsscan, dated 7/25/2003.\r
6 \r
7 THIS IS A PRELIMINARY RELEASE OF NEW SOFTWARE:\r
8 \r
9 - THE COMMANDLINE FORMATS MAY EVOLVE RAPIDLY OVER THE NEXT SEVERAL\r
10         RELEASES.\r
11 \r
12 - DEBUGGING MESSAGES AND WARNINGS MAY APPEAR ON STDERR.  MOST OF THESE\r
13         ARE MEANINGLESS, BUT IF YOU ENCOUNTER A PROBLEM WITH THE\r
14         PROGRAM PLEASE INCLUDE THEM IN YOUR BUG REPORT.\r
15  \r
16 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\r
17 \r
18 System Requirements:\r
19 \r
20         - You must have PERL 5 (5.005 or later) installed in order to\r
21                 use any of these tools.  (None of these tools have\r
22                 been tested with PERL 6 or later.)\r
23 \r
24         - If you plan to use ns_quickview, make sure that gnuplot is\r
25                 installed on your system.\r
26                 \r
27                 ns_quickview has been tested with gnuplot 3.7 and\r
28                 should work with later versions.  If you have problems\r
29                 with ns_quickview, please include any diagnostics\r
30                 messages from gnuplot and the version of gnuplot with\r
31                 your bug report.\r
32 \r
33                 If gnuplot is not in your path, you must edit\r
34                 ns_quickview to set GNUPLOT_PATH to the appropriate\r
35                 path after step 2 in the installation instructions.\r
36 \r
37 Installation:\r
38 \r
39 1.  Un-tar the distribution into an empty directory.\r
40 \r
41 2.  Edit the first line of nfsscan and ns_* to point to wherever your\r
42         favorite version of PERL 5 is installed.  If you don't like\r
43         looking at debugging messages, remove the -w from the\r
44         invocation of PERL.\r
45 \r
46 3.  Make sure that nfsscan and ns_* are executable and that\r
47         all the files are publically readable:\r
48 \r
49                 chmod 444 *\r
50                 chmod 555 nfsscan ns_*\r
51 \r
52 4.  Read NOTES.TXT for last-minute info or errata for this release,\r
53         and changes from previous releases.\r
54 \r
55 5.  Read nfsscan.txt and EXAMPLES for more information about how to\r
56         use the tools.\r
57 \r
58 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\r
59 \r
60 PLEASE report bugs, problems or suggestions for improvements to\r
61 ellard@eecs.harvard.edu.\r