]> andersk Git - splint.git/blame - install.html
Added install.html to CVS.
[splint.git] / install.html
CommitLineData
eb6e1838 1<html>
2<head>
3<link rel="stylesheet" type="text/css" href="http://www.splint.org/splint.css" title="style1">
4<title>Splint - Source Code Installation</title>
5</head>
6<body>
7<!--#include virtual="header.html"-->
8
9<body>
10<center><h2>
11Source Code Installation
12</h2></center>
13<p>
14
15<p>
16Splint should compile effortlessly on standard Unix systems, and with
17a bit of effort on non-Unix platforms. If you produce a port for a
18non-Unix platform, please let <a
19href="mailto:splint@cs.virginia.edu"><em>splint@cs.virginia.edu</em></a>
20know. <p>
21
22<p>
23To build Splint you need:
24<ul>
25<li> a (hopefully ANSI-conforming) C compiler. GNU <tt>gcc</tt> is recommended,
26but most modern C compilers should work.
27<li> <tt>make</tt>, the GNU make utility. If you don't have <tt>make</tt> installed on your system, download it from <tt>ftp.gnu.org</tt>.
28<li> standard Unix tools: <tt>gzip</tt>, <tt>tar</tt>
29</ul>
30
31<p>
32Instructions:
33<ol>
34
35<li>
36Download
37<a href="http://www.splint.org/downloads/splint-3.0.1.1.src.tgz"><em>http://www.splint.org/downloads/splint-3.0.1.1.src.tgz</em></a>.
38
39</a> (the latest stable release).
40<p>
41Copy this package to the directory where you want to build Spint. When
42the tar file is extracted, it will create a splint-3.0.1.1 subdirectory.
43<p>
44<li><tt>tar xzf splint-3.0.1.1.src.tgz</tt> (extract files from the archive)
45<p>
46<li><tt>cd splint-3.0.1.1</tt> (enter the extracted directory)
47<p>
48<li><tt>configure</tt>
49 <blockquote>
50 This will create a Makefile with settings for your system. Use
51 <tt>configure --prefix=<em>directory</em></tt> if you want to install
52 Splint in prefix directory <em>directory</em>.
53</blockquote>
54<p>
55<li><tt>make</tt>
56<blockquote>
57GNU's make utility is required; it may be named
58<tt>gmake</tt> or <tt>gnumake</tt> on your system.
59 It is best to do this in an emacs shell or a buffered terminal,
60 so you can scroll through the output.
61<p>
62This builds Splint. While it is building, subscribe to the
63lclint-announce mailing list by sending a message to <a
64href="mailto:majordomo@virginia.edu"><em>majordomo@virginia.edu</em></a>
65containing the body:
66<pre>
67 subscribe lclint-announce
68 </pre>
69<p>
70If the build was successful, it then runs the test
71suite. You should see:
72<blockquote>
73<pre>
74Testing splint 3.0.1.1...
75
76Version Info:
77Splint 3.0.1.1 --- 08 Jan 2002
78
79Maintainer: splint-bug@cs.virginia.edu
80
81<em>... (about 100 lines of test output elided)</em>
82
83Checking manual...
84Checking tests2.2...
85Checking tests2.4...
86Checking tests2.5...
87Checking db1...
88Checking db2...
89Checking db3...
90</pre>
91</blockquote>
92
93Examine the test output. If there are errors, send a bug report to <a
94href="mailto:splint-bug@cs.virginia.edu"><em>splint-bug@cs.virginia.edu</em></a>.
95</blockquote>
96<p>
97</ol>
98
99The remaining steps are only necessary ff you want to install the Splint
100binary and libraries in a different directory (set when you ran
101configure).
102<p>
103<blockquote>
104<ol start = 6>
105
106<li> <tt>make install</tt>
107
108<li>Set environment variables:
109<blockquote>
110<tt>LARCH_PATH</tt> - path to search for splint libraries and
111initializations files. If you are using the standard directories, this
112should be <tt>.:<em>base-directory</em>/splint-3.0.1/lib</tt>.
113<p>
114<tt>LCLIMPORTDIR</tt> - directory containing lcl imports files. If you are using
115the standard directories, this is <tt><em>base-directory</em>/splint-3.0.1/imports</tt>.
116</blockquote>
117Put the commands to set these variables (the actual commands will depend
118on the shell you are using) in one of your initialization dotfiles
119(usually <tt>~/.environment</tt>).
120<p>
121Set up your <tt>PATH</tt> to include the directory containing
122<tt>splint-3.0.1/bin/splint</tt>, or move the binary to a directory on
123your command path.
124<p>
125</blockquote>
126
127<p>
128<!--#include virtual="footer.html"-->
129
130
131
132
133
134
135
136
This page took 0.230242 seconds and 5 git commands to generate.