REF REFFILES Andrew Law, April 1987
Updated A.Sloman August 1990
COPYRIGHT University of Sussex 1993. All Rights Reserved.
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
<<<<<<<<<<<<<<<<<<<<< >>>>>>>>>>>>>>>>>>>>>>
<<<<<<<<<<<<<<<<<<<<< POPLOG REF FILES >>>>>>>>>>>>>>>>>>>>>>
<<<<<<<<<<<<<<<<<<<<< >>>>>>>>>>>>>>>>>>>>>>
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
REF files provide reference-level documentation on the central Poplog
mechanisms and faculties such as text itemisation, compilation, arrays
and records, input-output facilites, etc, and also information about the
Pop-11 compiler, the core Poplog facilities for supporting Prolog, and
the built in editor Ved. There are separate REF files for LISP and for
the Poplog X Windows interface, as described below.
CONTENTS - (Use <ENTER> g to access required sections)
1 Introduction
2 doc_index Directories
3 Related HELP Files
4 REF File List
5 See Also
---------------
1 Introduction
---------------
The core Poplog REF files reside in the directory:
$usepop/pop/ref
There are also specific REF files available from LISP, not listed below,
in the directory
$usepop/pop/lisp/ref
System information about Prolog and Poplog ML is to be found in their
HELP files, in
$usepop/pop/plog/help
and
$usepop/pop/pml/help
There are also several REF files, also not listed below, dealing with
the Poplog facilities for interacting with the X Windows system. These
files are to be found in
$usepop/pop/x/pop/ref
X users may get a list of the available REF files by using the Ved
command:
<ENTER> ref xpopindex
(For a more complete overview of Poplog directories see DOC * SYSSPEC
------------------------
2 doc_index Directories
------------------------
The standard Poplog REF directories include a subdirectory named
"doc_index". These contain files that form an index to the REFdirectory.
The index files are created by LIB * MKREFINDEX. For further details,
see HELP * MKREFINDEX
---------------------
3 Related HELP Files
---------------------
Related files in $usepop/pop/help include:
HELP * REF
How to invoke REF files
HELP * DOCUMENTATION
How to find other sources of on-line documentation
HELP * HELPFILES
Overview of HELP files
HELP * MKREFINDEX
Describes LIB * MKREFINDEX, a utility for indexing REF files
----------------
4 REF File List
----------------
REF * INDEX
List of REF files.
REF * ARRAYS
Arrays and array procedures. (See also HELP * ARRAYS.)
REF * ASYNC
Describes asynchronous traps and signals in Poplog.
REF * CHARIO
Character stream input and output. (See also HELP * IO.)
REF * DATA
General data procedures and datatypes. (See also
HELP * PROGRAMMING.)
REF * DEFSTRUCT
Pop-11 syntax for defining and accessing structures.
$usepop/pop/ref/doc_index
This is not a ref file, as explained above.
REF * DOCUMENTATION
The Poplog online documentation system.
REF * ENVIRONMENT_VARIABLES (Unix only)
Environment variables defined by the Poplog system.
REF * EXCEPTION
Poplog exception (error and warning) handling. (See also
HELP * MISHAP, HELP * PROGRAMMING.)
REF * EXTERNAL
Loading & calling external procedures from Poplog. (See also
HELP * EXTERNAL, * PROGRAMMING.)
REF * EXTERNAL_DATA
Using external data structures in Poplog.
REF * FASTPROCS
Fast procedures (See also HELP * FASTPROCS, LIB * SLOWPROCS.)
REF * FLAVOURS
The flavours object oriented language. (See also
HELP * FLAVOURS.)
REF * IDENT
Identifiers (constants and variables).
REF * INTVEC
Signed integer vectors (See also REF * DATA, REF * VECTORS
REF * STRINGS, and HELP * PROGRAMMING.)
REF * ITEMISE
Itemisation and lexical syntax. See also REF * POPCOMPILE
REF * KEYS
Information on classes and keys. (See also
HELP * PROGRAMMING, HELP * CLASSES, HELP * DATASTRUCTURES.)
REF * LIBRARY
Poplog library mechanisms, including autoloading.
REF * LISTS
Lists and pairs (see also HELP * LISTS).
REF * LOGICAL_NAMES (VMS only)
Logical names defined by the Poplog system.
REF * MISHAP_CODES
Some error messages include a "code" abbreviating the
message. This file includes full explanations and cross-
references to relevant information about the error. (See
also HELP * MISHAP.)
REF * NEWC_DEC
Procedures concerned with the "new" interface to externally
loaded C programs. See HELP * NEWC_DEC for more details.
REF * NUMBERS
Number data types and numerical procedures. (See also
HELP * NUMBERS.)
REF * OBSOLETE
Obsolete features still supported for backwards
compatibility.
REF * ODBC
Describes the Pop-11 version of Microsoft's ODBC (Open
DataBase Connectivity) interface.
REF * POPCOMPILE
Pop-11 compiler procedures.
$usepop/pop/ref/popindex.*
These files (which really should be in another place) are
used by the * POPINDEX and * VED_SOURCEFILE mechanisms.
REF * POPSYNTAX
Pop-11 syntax in diagram form.
REF * PRINT
Printing procedures, etc. (See also HELP * IO, HELP * PRINT
REF * PROCEDURE
The nature of procedures and closures, list of predicates
operating on procedures (See also HELP * PROGRAMMING
HELP * DEFINE
REF * PROCESS
The Poplog "process" mechanism. (See also HELP * PROCESS.)
REF * PROGLIST
The input stream used in Poplog by many system modules,
including the Pop-11 compiler. (See also REF * ITEMISE
REF * CHARIO, HELP * PROGRAMMING.)
REF * PROLOG
Procedures that support the Prolog system in Poplog.
REF * PROPS
Properties (association tables). (See also
HELP * PROPERTIES.)
REF * RECORDS
The reference and boolean data types. (See also
HELP * RECORDS.)
REF * REFFILES
This file.
REF * REFFORM
Describes the format of REF files, explains the conventions
used to indicate the types of arguments and results of
procedures, and provides some Ved utilities to help creation
of REF files in the proper format.
REF * SECTIONS
Sections (hierarchies of permanent identifiers). (See also
HELP * SECTIONS.)
REF * SOCKETS (Unix Only)
Describes the Pop-11 interface to Unix sockets.
REF * STACK
The Pop-11 stack and procedures for operating on it. (See
also HELP * STACK, TEACH * STACK.)
REF * STRINGS
Strings. (See also HELP * STRINGS.)
REF * SUBSYSTEM
Describes mechanisms for handling sub-systems like Prolog,
Pop-11, Lisp, ML and switching conveniently between them.
REF * SYNTAX
Information on Pop-11 syntax words. (See also
HELP * PROGRAMMING.)
REF * SYSIO
Device Input & Output procedures, including pipes and
mailboxes.
REF * SYSTEM
Various Poplog system control procedures, including starting
up, interrupts, saving and restoring saved images, etc.
REF * SYSUTIL
Operating System utility procedures.
REF * TIMES
Date and Time and Timer procedures.
REF * VECTORS
Standard full vectors (see also HELP * VECTORS).
REF * VED
Overview of REF files about the Poplog editor, Ved.
REF * VEDCOMMS
Summary of Ved <ENTER> commands.
REF * VEDPROCS
Summary of Ved system procedures.
REF * VEDTERMINALS
Summary of Ved terminal types and terminal initialisation
procedures.
REF * VEDVARS
Summary of Ved's global control variables.
REF * VMCODE
The Poplog Virtual Machine. (See also TEACH * VM.)
REF * WORDS
Words and the Poplog dictionary mechanism.
REF * WVED
Variables and procedures associated with Windowed Ved, i.e.
XVed.
-----------
5 See Also
-----------
HELP * HELPFILES
An overview of Pop-11 HELP documentation.
TEACH * TEACHFILES
An overview of Pop-11 TEACH documentation.
PLOGHELP * HELPFILES
An overview of Prolog HELP documentation.
PLOGTEACH * TEACHFILES
An overview of Prolog TEACH documentation.
+-+ C.all/ref/reffiles
+-+ Copyright University of Sussex 1991. All rights reserved.