| 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> Icon Documentation Guide </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> Icon Documentation Guide </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/index.htm |
| 21 |
<BR> Last updated June 3, 2013</SMALL> |
| 22 |
|
| 23 |
|
| 24 |
<H2> Introduction </H2> |
| 25 |
|
| 26 |
<P> Icon is distributed with a small set of documentation pages: |
| 27 |
<UL> |
| 28 |
<LI> This documentation guide |
| 29 |
<LI> The <A href="icon.txt"><CODE>icon</CODE></A> |
| 30 |
and <A href="icont.txt"><CODE>icont</CODE></A> commands |
| 31 |
<LI> <A HREF=relnotes.htm> Release notes</A> |
| 32 |
<LI> <A HREF=macintosh.htm> Icon on Macintosh</A> |
| 33 |
<LI> <A HREF=cygwin.htm> Icon on Cygwin</A> |
| 34 |
<LI> <A HREF=faq.htm> Frequently asked questions</A> |
| 35 |
<LI> <A HREF=install.htm> Installation instructions</A> (for binary releases) |
| 36 |
<LI> <A HREF=build.htm> Build instructions</A> (for source releases) |
| 37 |
<LI> <A HREF=files.htm> File organization</A> |
| 38 |
<LI> <A HREF=port.htm> Porting instructions</A> |
| 39 |
<LI> <A HREF=cfuncs.htm> Loading C functions dynamically</A> |
| 40 |
<LI> <A HREF=extlvals.htm> External values</A> |
| 41 |
</UL> |
| 42 |
|
| 43 |
<P> This guide provides an overview of additional available information. |
| 44 |
Documents designated with IPD numbers are Icon Project Documents |
| 45 |
found at the Icon web site, |
| 46 |
<A HREF="http://www.cs.arizona.edu/icon/">www.cs.arizona.edu/icon</A>. |
| 47 |
|
| 48 |
|
| 49 |
<H2> Basic Documentation </H2> |
| 50 |
|
| 51 |
<P> The command-line interface to Icon is described by <CITE>man</CITE> pages. |
| 52 |
The <A HREF="icon.txt"><CODE>icon</CODE></A> command executes a program |
| 53 |
from a single source file and supports script usage. |
| 54 |
The more general <A HREF="icont.txt"><CODE>icont</CODE></A> command, |
| 55 |
modeled after <CITE>cc</CITE>, |
| 56 |
supports multiple files, separate compilation, and other features. |
| 57 |
|
| 58 |
<P> |
| 59 |
The Icon language is defined by |
| 60 |
<BLOCKQUOTE> |
| 61 |
<IMG SRC="lb80.jpg" ALT="[cover]" WIDTH=60 HEIGHT=80 ALIGN=LEFT> |
| 62 |
<CITE> The Icon Programming Language, Third Edition </CITE> |
| 63 |
<BR> Ralph E. Griswold and Madge T. Griswold |
| 64 |
<BR> Peer-to-Peer Communications, 1996, out of print |
| 65 |
<BR> ISBN 1-57398-001-3 |
| 66 |
<BR> Downloadable from |
| 67 |
<A HREF="http://www.cs.arizona.edu/icon/books.htm"> |
| 68 |
www.cs.arizona.edu/icon/books.htm</A> |
| 69 |
<BR CLEAR=ALL> |
| 70 |
</BLOCKQUOTE> |
| 71 |
|
| 72 |
<P> Some introductory material can be found on the web: |
| 73 |
<UL> |
| 74 |
<LI> Ralph Griswold's overview: |
| 75 |
<A HREF="http://www.cs.arizona.edu/icon/docs/ipd266.htm"> |
| 76 |
www.cs.arizona.edu/icon/docs/ipd266.htm</A> |
| 77 |
<LI> Dave Hanson's introduction: |
| 78 |
<A HREF="http://www.cs.arizona.edu/icon/intro.htm"> |
| 79 |
www.cs.arizona.edu/icon/intro.htm</A> |
| 80 |
<LI> Bill Mitchell's introduction and slides: |
| 81 |
<A HREF="http://www.mitchellsoftwareengineering.com/icon/"> |
| 82 |
www.mitchellsoftwareengineering.com/icon</A> |
| 83 |
<LI> John Shipman's tutorial: |
| 84 |
<A HREF="http://www.nmt.edu/tcc/help/lang/icon/"> |
| 85 |
www.nmt.edu/tcc/help/lang/icon</A> |
| 86 |
</UL> |
| 87 |
|
| 88 |
<P> |
| 89 |
The <CITE>Icon Programming Language Handbook</CITE>, |
| 90 |
by Thomas W. Christopher, is available on the web at |
| 91 |
<A HREF="http://www.tools-of-computing.com/tc/CS/iconprog.pdf"> |
| 92 |
www.tools-of-computing.com/tc/CS/iconprog.pdf</A>. |
| 93 |
The second edition of <CITE>Icon Programming for Humanists</CITE>, |
| 94 |
by Alan Corré, is available from |
| 95 |
<A HREF="http://unicon.org/books/">unicon.org/books</A>. |
| 96 |
|
| 97 |
|
| 98 |
|
| 99 |
<H2> Graphics </H2> |
| 100 |
|
| 101 |
<P> |
| 102 |
Icon's graphics facilities are defined by |
| 103 |
<BLOCKQUOTE> |
| 104 |
<IMG SRC="gb80.jpg" ALT="[cover]" WIDTH=60 HEIGHT=80 ALIGN=LEFT> |
| 105 |
<CITE> Graphics Programming in Icon </CITE> |
| 106 |
<BR> Ralph E. Griswold, Clinton L. Jeffery, and Gregg M. Townsend |
| 107 |
<BR> Peer-to-Peer Communications, 1998, out of print |
| 108 |
<BR> ISBN 1-57398-009-9 |
| 109 |
<BR> Downloadable from |
| 110 |
<A HREF="http://www.cs.arizona.edu/icon/books.htm"> |
| 111 |
www.cs.arizona.edu/icon/books.htm</A> |
| 112 |
<BR CLEAR=ALL> |
| 113 |
</BLOCKQUOTE> |
| 114 |
|
| 115 |
<P> Two older reports present an overview of Icon's graphics: |
| 116 |
<UL> |
| 117 |
<LI> IPD281, Graphics facilities for Icon, |
| 118 |
<A HREF="http://www.cs.arizona.edu/icon/docs/ipd281.htm"> |
| 119 |
www.cs.arizona.edu/icon/docs/ipd281.htm</A> |
| 120 |
<LI> IPD284, Visual interfaces for Icon programs, |
| 121 |
<A HREF="http://www.cs.arizona.edu/icon/docs/ipd284.htm"> |
| 122 |
www.cs.arizona.edu/icon/docs/ipd284.htm</A> |
| 123 |
</UL> |
| 124 |
|
| 125 |
|
| 126 |
<H2> Recent feature additions </H2> |
| 127 |
|
| 128 |
<P> A few minor features have been added since the publication |
| 129 |
of the Icon books: |
| 130 |
<UL> |
| 131 |
<LI> Execution profiling |
| 132 |
<LI> Scriptable source files |
| 133 |
<LI> Path searching improvements |
| 134 |
<LI> Reading directory contents |
| 135 |
<LI> Reading foreign text files |
| 136 |
<LI> <A HREF="extlvals.htm">External values</A> |
| 137 |
</UL> |
| 138 |
These features are more fully described in the |
| 139 |
<A HREF=relnotes.htm>release notes</A>. |
| 140 |
|
| 141 |
|
| 142 |
<H2> Program Library </H2> |
| 143 |
|
| 144 |
<P> Program library documentation is contained within the source code. |
| 145 |
Extracted documentation is available at |
| 146 |
<A HREF="http://www.cs.arizona.edu/icon/library/ipl.htm"> |
| 147 |
www.cs.arizona.edu/icon/library/ipl.htm</A>. |
| 148 |
|
| 149 |
|
| 150 |
<H2> Icon Internals </H2> |
| 151 |
|
| 152 |
<P> Icon's internals are detailed in |
| 153 |
<BLOCKQUOTE> |
| 154 |
<IMG SRC="ib80.jpg" ALT="[cover]" WIDTH=55 HEIGHT=80 ALIGN=LEFT> |
| 155 |
<CITE>The Implementation of the Icon Programming Language</CITE> |
| 156 |
<BR> Ralph E. Griswold and Madge T. Griswold |
| 157 |
<BR> Princeton University Press, 1986, out of print |
| 158 |
<BR> ISBN 0-691-08431-9 |
| 159 |
<BR> Downloadable from |
| 160 |
<A HREF="http://www.cs.arizona.edu/icon/books.htm"> |
| 161 |
www.cs.arizona.edu/icon/books.htm</A> |
| 162 |
<BR CLEAR=ALL> |
| 163 |
</BLOCKQUOTE> |
| 164 |
Although considerable changes have occurred since Version 6, |
| 165 |
described in the book, the basic structure is the same. |
| 166 |
Two technical reports describe subsequent changes: |
| 167 |
<UL> |
| 168 |
<LI>IPD112, Supplementary Information for Version 8, |
| 169 |
<A HREF="http://www.cs.arizona.edu/icon/docs/ipd112.htm"> |
| 170 |
http://www.cs.arizona.edu/icon/docs/ipd112.htm</A> |
| 171 |
<LI>IPD239, Supplementary Information for Version 9, |
| 172 |
<A HREF="http://www.cs.arizona.edu/icon/docs/ipd239.htm"> |
| 173 |
http://www.cs.arizona.edu/icon/docs/ipd239.htm</A> |
| 174 |
</UL> |
| 175 |
|
| 176 |
|
| 177 |
<P> Icon's run-time implementation language is described in IPD261, |
| 178 |
<A HREF="http://www.cs.arizona.edu/icon/ftp/doc/ipd261.pdf"> |
| 179 |
www.cs.arizona.edu/icon/ftp/doc/ipd261.pdf</A> (PDF). |
| 180 |
|
| 181 |
|
| 182 |
<H2> Technical Reports </H2> |
| 183 |
|
| 184 |
<P> The Icon web site provides a large number of technical reports, |
| 185 |
including "Icon Project Documents" designated by IPD numbers. |
| 186 |
The index is found at |
| 187 |
<A HREF="http://www.cs.arizona.edu/icon/docs/docs.htm"> |
| 188 |
www.cs.arizona.edu/icon/docs/docs.htm</A>. |
| 189 |
|
| 190 |
<P> Most of these reports are historical and |
| 191 |
many describe past research experiments. |
| 192 |
The reports cited above are among the most current, |
| 193 |
although they may not be completely correct with respect |
| 194 |
to Version 9.5. |
| 195 |
|
| 196 |
|
| 197 |
<H2> Other Sources </H2> |
| 198 |
|
| 199 |
<P> Other sources of documentation can be found in the |
| 200 |
<A HREF="faq.htm"> Icon FAQ </A> and on the Icon web site, |
| 201 |
<A HREF="http://www.cs.arizona.edu/icon/"> |
| 202 |
www.cs.arizona.edu/icon</A>. |
| 203 |
|
| 204 |
<HR> |
| 205 |
|
| 206 |
</BODY> |
| 207 |
</HTML> |