Debian Codegraph @

doc/build.htm

raw
1 <!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <HTML>
3 <HEAD>
4 <META NAME=viewport CONTENT="width=device-width, initial-scale=1">
5 <TITLE>Building Version 9.5 of Icon from Source</TITLE>
6 <LINK REL="STYLESHEET" TYPE="text/css" HREF="istyle.css">
7 <LINK REL="SHORTCUT ICON" HREF="shortcut.gif">
8 </HEAD>
9 <BODY>
10
11 <P><A HREF="http://www.cs.arizona.edu/icon/"> <IMG SRC="wwwcube.gif"
12 ALT="[Icon home]" WIDTH=128 HEIGHT=144 BORDER=0 ALIGN=RIGHT> </A>
13
14 <H1>Building Version 9.5 of Icon from Source</H1>
15
16 <P> Gregg M. Townsend
17 <BR> <SMALL> Department of Computer Science </SMALL>
18 <BR> <SMALL> The University of Arizona </SMALL>
19
20 <P> <SMALL> www.cs.arizona.edu/icon/uguide/build.htm
21 <BR> Last updated November 8, 2009 </SMALL>
22
23 <H2> Introduction </H2>
24
25 <P> These instructions explain how to build and install the source code of
26 <A HREF=relnotes.htm>Version 9.5 of Icon</A> under Unix.
27 For instructions on installing a binary release, see
28 <A HREF=install.htm>Installing Icon Binaries</A>.
29
30 <P> These instructions assume that you have unpacked the Icon
31 distribution file into a directory.
32 All commands are issued in that directory.
33
34 <H2> Configuring </H2>
35
36 <P> The Icon source package contains configurations for a variety of
37 Unix platforms.
38 Type <CODE>make Configure</CODE> to see the list of known configurations.
39 A status report for any system can be viewed by entering
40 <BLOCKQUOTE>
41 <CODE>make Status name=</CODE><VAR>name</VAR>
42 </BLOCKQUOTE>
43 Choose the configuration name that matches your system's
44 operating system, and be sure to note
45 any special considerations given in its status report.
46
47 <P><SMALL> (If your system is not among those listed, you will need to
48 port the code.
49 This is usually a fairly simple matter that involves copying an existing
50 configuration and editing it to match the target system.
51 See <A HREF=port.htm>Porting Icon</A>.)
52 </SMALL>
53
54 <P> Most Unix systems include the X11 window system; type
55 <BLOCKQUOTE>
56 <CODE>make X-Configure name=</CODE><VAR>name</VAR>
57 </BLOCKQUOTE>
58 to configure Icon with graphics.
59 If your computer does not have the X window system, type
60 <BLOCKQUOTE>
61 <CODE>make Configure name=</CODE><VAR>name</VAR>
62 </BLOCKQUOTE>
63 to configure Icon without graphics.
64
65 <P> Installation using any of the supplied configurations <EM>should</EM>
66 be routine, but some of those were contributed for systems we cannot test,
67 and it is possible that some minor tweaking may be required.
68 If so, or if you develop a new configuration, we'd like to hear about it
69 by e-mail to
70 <A HREF="mailto:[email protected]">[email protected]</A>.
71
72 <H2> Building </H2>
73
74 <P> After Configuring, type <CODE>make</CODE> to build the Icon system.
75 This single step builds:
76 <UL>
77 <LI> The Icon translator and interpreter
78 <LI> Program library procedures
79 <LI> VIB and other graphics utilities, if graphics are enabled
80 </UL>
81
82 <P> There may be a few warnings on some platforms, but there should be
83 no fatal errors.
84 If there are problems,
85 fix them in the <CODE>config/</CODE><VAR>platform</VAR>
86 directory and repeat the configuration step.
87
88 <H2> Testing </H2>
89
90 <P> To verify a successful build, type <CODE>make Test</CODE>.
91 This command compiles and executes a series of Icon programs,
92 comparing their outputs with a set of standard results.
93 A normal run concludes with the phrase "All tests passed."
94
95 <P> A successful graphics build can be confirmed by executing
96 <CODE>bin/colrbook</CODE>, the color book utility, with no arguments.
97 It should display a spectrum of colors along the left and a set
98 of recessed panes to the right.
99 Click anywhere on the spectrum to fill colors in the panes.
100 Click <CODE>QUIT</CODE> (in the upper left corner) to exit.
101
102 <H2> Installing </H2>
103
104 <P> Icon can be run directly from the location in which it was built.
105 To do this, simply add the <CODE>bin</CODE> directory to your shell's
106 search path.
107 See the man pages for <A HREF=icon.txt><CODE>icon</CODE></A>
108 and <A HREF=icont.txt><CODE>icont</CODE></A>
109 for instructions on building and running Icon programs.
110
111 <P> If you wish to install the binaries elsewhere,
112 choose a location for a directory dedicated to Icon &mdash;
113 for example, <CODE>/opt/icon</CODE> or <CODE>/usr/local/icon</CODE>.
114 If you are replacing an existing directory, delete the old one first.
115 Enter
116 <BLOCKQUOTE>
117 <CODE>make Install dest=</CODE><VAR>directory</VAR>
118 </BLOCKQUOTE>
119 to create <VAR>directory</VAR> and install Icon in its
120 <CODE>bin</CODE>, <CODE>lib</CODE>,
121 <CODE>doc</CODE>, and <CODE>man</CODE> subdirectories.
122 All files are created using the default permissions
123 <CITE>(umask)</CITE> of the current user.
124
125 <P> You can make symbolic links from other locations
126 to programs in the Icon <CODE>bin</CODE> directory.
127 For example, you can link
128 <CODE>/usr/local/bin/icon</CODE> to <CODE>/opt/icon/bin/icon</CODE>.
129 If you do this, link all of <CODE>icon</CODE>, <CODE>icont</CODE>,
130 <CODE>iconx</CODE>, and (if present) <CODE>vib</CODE>.
131
132 <P> If you'd like to bundle up a gzipped tar file of the binaries
133 created by the build process, enter <CODE>make Package</CODE>.
134 Such a package can be used to install binaries on other
135 systems of the same architecture.
136
137 <H2> Cleaning Up </H2>
138
139 <P> Type <CODE>make Clean</CODE> to remove intermediate files created
140 during the build process. This command preserves the contents of the
141 <CODE>bin</CODE> and <CODE>lib</CODE> directories, so the built system
142 remains functional.
143
144 <P> To restore everything to its original state, type <CODE>make Pure</CODE>.
145 This removes all the configuration information and newly built files.
146
147 <HR>
148
149 </BODY>
150 </HTML>