Return to tr84-12 CVS log

Up to [CSRG BSD Unix] / 43BSD / contrib / icon / docs

Annotation of 43BSD/contrib/icon/docs/tr84-12, revision 1.1

1.1     ! root        1: .so tmac.tr
        !             2: .DA "August 16, 1984"
        !             3: .TR 84-12
        !             4: .Gr
        !             5: .TL
        !             6: The Icon Program Library; Version 5.9
        !             7: .AU
        !             8: Compiled by Ralph E. Griswold
        !             9: .AE
        !            10: .tr *\(**
        !            11: .LP
        !            12: .af PN i
        !            13: .LP
        !            14: .ce 1
        !            15: \f3Preface\fR
        !            16: .sp
        !            17: .PP
        !            18: The Icon program library consists of Icon programs, procedures, C
        !            19: functions, and support material.
        !            20: The library is distributed as part of the Version 5.9 Icon system [1-4].
        !            21: .PP
        !            22: The format of the library mimics the \*U Programmer's Manual [5].
        !            23: .Un
        !            24: Section 1 contains application programs. Section 2 contains
        !            25: collections of Icon procedures.
        !            26: C functions, which can be used to augment the repertoire of built-in Icon functions,
        !            27: are contained in Section 3.
        !            28: Sections 4 and 5 are reserved for future use. Section 6 contains
        !            29: demonstration programs and games. Section 7 contains
        !            30: miscellaneous material, while Icon program library maintenance information
        !            31: is included in Section 8. See the table of contents for details.
        !            32: .NH 1
        !            33: Using the Library
        !            34: .PP
        !            35: See \fIi-hier(7)\fR for the structure of the Icon system.
        !            36: The program material in the library is
        !            37: divided into three components.
        !            38: Two of the components consists of Icon source code. The third consists
        !            39: of C source code.
        !            40: The prefix \fIi-\fR is used to identif programs in the library that are
        !            41: related to Icon program development.
        !            42: Some procedures in the Icon program library depend on the inclusion of
        !            43: optional extensions to Icon [4] or on particular UNIX environments. Such
        !            44: dependencies are note in the \fIREQUIREMENTS\fR sections of the manual
        !            45: pages.
        !            46: .SH
        !            47: Application Programs and Games
        !            48: .PP
        !            49: The programs in Sections 1 and 6 are on a par with programs in the
        !            50: corresponding sections of the UNIX manual.
        !            51: The fact that the programs
        !            52: in the Icon library are written in Icon is irrelevant to the user;
        !            53: Icon application programs and games can be moved to a local
        !            54: library without modification.
        !            55: .SH
        !            56: Procedures
        !            57: .PP
        !            58: The procedures in Section 2 can be linked into an Icon program in
        !            59: two ways: by specifying them with their \*M.u1\fR suffix on
        !            60: the \fIicont(1)\fR command line when the program is translated [6],
        !            61: or by including an appropriate link directive in the program itself [3].
        !            62: See the library manual page for \fIi-hier(7)\fR for the path that is needed.
        !            63: .PP
        !            64: Some procedures have global symbols in addition to the procedures names
        !            65: themselves. There is, therefore, the possibility of collisions between
        !            66: names in user programs and names in the library procedures.
        !            67: .SH
        !            68: C Functions
        !            69: .PP
        !            70: C functions can be added to the built-in repertoire of Icon by building
        !            71: a personalized interpreter [7]. Alternatively, they can be incorporated
        !            72: into Icon directly [8].
        !            73: Some of the C functions require the loading of libraries. Check the
        !            74: library manual pages on specific functions.
        !            75: .NH
        !            76: The UNIX Manual Versus the Library Manual
        !            77: .PP
        !            78: Library manual pages, as included in this report, are slightly
        !            79: different from UNIX manual pages in their head and foot formats.
        !            80: See \fIlman(8)\fR for the production of such manual pages.
        !            81: Library manual pages with head and foot formats in the style of
        !            82: the UNIX manual can be obtained as described in \fIuman(8)\fR.
        !            83: .PP
        !            84: Reference to manual pages that are not in the library, such as \fIed(1)\fR,
        !            85: apply to the UNIX manual.
        !            86: .NH
        !            87: Bug Reports and Submissions of New Material
        !            88: .PP
        !            89: Bug reports
        !            90: should be mailed to
        !            91: .DS
        !            92: .ft R
        !            93: Icon Project
        !            94: Department of Computer Science
        !            95: The University of Arizona
        !            96: Tucson, Arizona   85721
        !            97: U.S.A.
        !            98: .DE
        !            99: or send electronic mail to
        !           100: .Nt
        !           101: .PP
        !           102: New material for the library is welcome, although the final decision on inclusion
        !           103: in the Icon library is at the discretion of the Icon Project. Submissions should
        !           104: be sent in machine-readable form,
        !           105: including  documentation, either on \fItar\fR-format magnetic
        !           106: tape or via electronic mail.
        !           107: .SH
        !           108: Acknowledgements
        !           109: .PP
        !           110: Several persons have contributed material to the Icon program
        !           111: library, as noted by the attributions on the manual pages.
        !           112: In order to make program material easier to read, contributions
        !           113: have been reformatted to provide a degree of uniformity. Program
        !           114: layout therefore does not necessarily reflect the author's preference.
        !           115: .PP
        !           116: In addition to contributing material to the library, Tom Hicks, Bill
        !           117: Mitchell, and Steve Wampler have made numerous helpful suggestions
        !           118: about the library and its documentation.
        !           119: .SH
        !           120: References
        !           121: .IP 1.
        !           122: Griswold, Ralph E. and Madge T. Griswold. \fIThe Icon Programming
        !           123: Language\fR. Prentice-Hall, Inc., Englewood Cliffs, New Jersey.
        !           124: 1983.
        !           125: .IP 2.
        !           126: Griswold, Ralph E., Robert K. McConeghy, and William H. Mitchell.
        !           127: \fIVersion 5.9 of Icon\fR.
        !           128: Technical report, Department of Computer Science, The University of
        !           129: Arizona. August 1984.
        !           130: .IP 3.
        !           131: Griswold, Ralph E., Robert K. McConeghy, and William H. Mitchell.
        !           132: \fIExtensions to Version 5 of the Icon Programming Language\fR.
        !           133: Technical Report TR 84-10a, Department of Computer Science, The
        !           134: University of Arizona. August 1984.
        !           135: .IP 4.
        !           136: Griswold, Ralph E. and William H. Mitchell.
        !           137: \fIInstallation and Maintenance Guide for Version 5.9 of Icon\fR.
        !           138: Technical Report TR 84-13, Department of Computer Science, The
        !           139: University of Arizona, Tucson, Arizona. August 1984.
        !           140: .IP 5.
        !           141: \fIUNIX Programmer's Manual; Seventh Edition, Volume 1\fR. Bell Laboratories,
        !           142: Murray Hill, New Jersey. 1979.
        !           143: .IP 6.
        !           144: Griswold, Ralph E. and William H. Mitchell. \fIICONT(1)\fR,
        !           145: manual page for \fIUNIX Programmer's Manual\fR, Department of
        !           146: Computer Science, The University of Arizona. August 1984.
        !           147: .IP 7.
        !           148: Griswold, Ralph E., Robert K. McConeghy, and William H. Mitchell.
        !           149: \fIPersonalized Interpreters for Icon\fR. Technical Report TR 84-14,
        !           150: Department of Computer Science, The University of Arizona. August 1984.
        !           151: .IP 8.
        !           152: Griswold, Ralph E., Robert K. McConeghy, and William H. Mitchell.
        !           153: \fIA Tour Through the C Implementation of Icon; Version 5.9\fR.
        !           154: Technical Report TR 84-11, Department of Computer Science,
        !           155: The University of Arizona. August 1984.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.