summaryrefslogtreecommitdiff
path: root/man/man1/icon.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/man1/icon.1')
-rw-r--r--man/man1/icon.176
1 files changed, 76 insertions, 0 deletions
diff --git a/man/man1/icon.1 b/man/man1/icon.1
new file mode 100644
index 0000000..1562816
--- /dev/null
+++ b/man/man1/icon.1
@@ -0,0 +1,76 @@
+.TH ICON 1 "9 August 2005" "University of Arizona"
+.SH NAME
+icon \- execute Icon program
+.SH SYNOPSIS
+\fBicon\fP sourcefile [ arg ... ]
+.br
+\fBicon \-P\fP 'program' [ arg ... ]
+.SH DESCRIPTION
+.I Icon
+is a simple interface for executing programs written
+in the Icon programming language.
+The source code is translated and linked,
+then executed with the given list of arguments.
+.PP
+Without
+.BR \-P ,
+a single source file is read;
+its name must be given exactly
+and need not end in
+.BR .icn .
+A sourcefile name of
+.B \-
+reads the source code from standard input.
+.PP
+With
+.BR \-P ,
+a small program can be embedded within a larger shell script.
+In this case the
+.I program
+argument is a complete Icon program, typically given as a
+multi-line quoted string.
+.PP
+Translation and linking is silent, suppressing progress messages,
+and undeclared identifiers are diagnosed.
+This mirrors the behavior of the
+.I icont
+command when run with
+.B \-s
+and
+.B \-u
+options.
+.PP
+An Icon source file can be made directly executable
+by setting the appropriate permission bits and
+beginning it with a shell header.
+If the first line of the file is
+.in +.5i
+.B #!/usr/bin/env icon
+.in
+then
+.I icon
+is found on the command search path
+and called to process the program upon execution.
+.SH ENVIRONMENT
+The environment variables described under
+.IR icont (1)
+can also be used with the
+.I icon
+command.
+Normally, none of these are needed.
+.SH SEE ALSO
+.BR icont (1),
+the full-featured interface supporting separate compilation,
+multiple source files, and other features.
+.LP
+.IR "The Icon Programming Language" .
+Griswold and Griswold,
+Peer-to-Peer, third edition, 1996.
+.LP
+.IR "Graphics Programming in Icon" .
+Griswold, Jeffery, and Townsend,
+Peer-to-Peer, 1998.
+.LP
+.IR "Version 9.4.3 of Icon" .
+.br
+http://www.cs.arizona.edu/icon/v943.