summaryrefslogtreecommitdiff
path: root/man/man1/icont.1
blob: 703d59992059da7e3a5d2f51056f10f60d2350d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
.TH ICONT 1 "9 August 2005" "University of Arizona"
.SH NAME
icont \- translate Icon program
.SH SYNOPSIS
\fBicont\fP [ option ... ] file ... [ \fB\-x\fP arg ... ]
.SH DESCRIPTION
Icont translates and links programs written in the Icon language.
Translation produces \fIucode\fP files, suffixed \fB.u1\fP and \fB.u2\fP,
which are linked to produce executable files.
Icon executables are shell scripts containing binary data; this data is
interpreted by \fBiconx\fP, which must be present at execution time.
.PP
File names ending in \fB.icn\fP are Icon source files;
the \fB.icn\fP suffix may be omitted from command arguments.
An argument of \fB\-\fP reads from standard input.
A name ending in \fB.u\fP, \fB.u1\fP, or \fB.u2\fP selects both files
of a ucode pair.
The specified files are combined to produce a single program,
which is named by removing the suffix from the first input file.
.PP
An argument of \fB\-x\fP may appear \fIafter\fP the file arguments
to execute the linked program.
Any subsequent arguments are passed to the program.
.PP
Ucode files produced by translation are normally deleted after linking.
If the \fB\-c\fP option is given, processing stops after translation
and the ucode files are left behind.
A directory of such files functions as a linkable library.
.SH OPTIONS
The following options are recognized by \fIicont\fP:
.TP 4
\fB\-c\fP
Stop after producing ucode files.
.TP
\fB\-f s\fP
Enable full string invocation by preserving unreferenced procedures
during linking.
.TP
\fB\-o \fIfile\fP
Write the executable program to the specified file.
.TP
\fB\-s\fP
Suppress informative messages during translation and linking.
.TP
\fB\-t\fP
Activate runtime tracing by
arranging for \fB&trace\fP to have an initial value of \-1
upon execution.
.TP
\fB\-u\fP
Diagnose undeclared identifiers.
.TP
\fB\-v \fIi\fP
Set verbosity level of informative messages to \fIi\fB.
.TP
\fB\-E\fP
Direct the results of preprocessing to standard output and inhibit
further processing.
.TP
\fB\-N\fP
Don't embed \fBiconx\fP path in executable file.
.TP
\fB\-V\fP
Announce version and configuration information on standard error.
.SH "TRANSLATION ENVIRONMENT"
Two environment variables control file search paths during
translation and linking.
These variables contain blank- or colon-separated lists of directories
to be searched after the current directory
and before the standard library.
.TP 4
\fBIPATH\fP
Directories to search for for ucode files
specified in \fBlink\fP directives and on the command line.
.TP 4
\fBLPATH\fP
Directories to search for source files
specified in preprocessor \fB$include\fP directives.
.SH "EXECUTION ENVIRONMENT"
Several environment variables control the execution of an Icon program.
Values in parentheses are the default values.
.TP 4
\fBBLKSIZE\fP (500000)
The initial size, in bytes, of the allocated block region.
.TP
\fBCOEXPSIZE\fP (2000)
The size, in words, of each co-expression stack.
.TP
\fBICONCORE\fP
If set, a core dump is produced for error termination.
.TP 4
\fBICONX\fP
The location of \fBiconx\fP, the icon interpreter,
overriding the value built into the executable by \fBicont\fP.
Not required if the configuration is unchanged since build time
or if \fBiconx\fP is in the same directory as the executable.
.TP
\fBMSTKSIZE\fP (10000)
The size, in words, of the main interpreter stack for \fBicont\fP.
.TP
\fBNOERRBUF\fP
By default, \fB&errout\fP is buffered.  If this variable is set, \fB&errout\fP
is not buffered.
.TP
\fBQLSIZE\fP (5000)
The size, in bytes, of the region used for pointers
to strings during garbage collection.
.TP
\fBSTRSIZE\fP (500000)
The initial size, in bytes, of the string space.
.TP
\fBTRACE\fP
The initial value of \fB&trace\fP.
If this variable has a value, it overrides the translation-time
\fB\-t\fP
option.
.SH SEE ALSO
\fBicon\fP(1), a simpler command interface
for embedding Icon programs in scripts.
.LP
\fIThe Icon Programming Language\fP.
.br
Griswold and Griswold, Peer-to-Peer, third edition, 1996.
.br
http://www.cs.arizona.edu/icon/lb3.htm.
.LP
\fIGraphics Programming in Icon\fP.
.br
Griswold, Jeffery, and Townsend, Peer-to-Peer, 1998.
.br
http://www.cs.arizona.edu/icon/gb/index.htm.
.LP
\fIVersion 9.5.0 of Icon\fP.
.br
http://www.cs.arizona.edu/icon/v950.
.SH "CAVEATS"
.LP
Icon executables are not self-sufficient, but require the \fBiconx\fP
interpreter.
When distributing an Icon program in executable form, include a copy
of \fBiconx\fP in the same directory.