
            Installation Notes for the AUIS-63L0-SRC Package



FORWARD

This is the second of several planned versions of "packages" of the
Andrew User Interface System (AUIS).  AUIS can be difficult to describe
fully since it encompasses such a large variety of applications and
uses.  In an effort to break this into something more manageable, both
in size and scope, I have created this particular package which is aimed
principally at people interested in SOURCE CODE DEVELOPMENT.

This package requires that you have already installed the AUIS Word
Processing package, auis63L0-wp.tgz.  Do not mix versions (for example,
L1 with L2), as this can result in surprising and undesirable behavior. 
This document assumes you have installed and are reasonably familiar
with the word processing incantation of ez.  This is just another
"personality" of ez - geared for the programmer.

Watch for a series of articles on AUIS to appear in the Linux Journal
beginning sometime the summer of 1994.

                                                            Terry Gliedt	
                                                              tpg@mr.net	


INSTALLATION

This packaged is distributed as a single tar file of approximately 0.8
MB which will expand to approximately 1.3 MB of ADDITIONAL disk space
over that required for the word processing package.  To install this
package, do the following as root:

    cd /
    tar xzf [path]/auis63L0-src.tgz
    /usr/andrew/etc/complete-setup src

This will add files to /usr/andrew that you created earlier with the -wp
package.

AUIS is highly tailorable for your personal needs and preferences.  To
get you started, I've done a great deal for you in this area.  I have
created a sample preferences in /usr/andrew. If you made no changes to
this for the word processing package, just do the following copy. 

    cp /usr/andrew/sample.preferences $HOME/preferences

If you made changes, you will need to "merge" (by hand) your changes
into this new preferences.  This would be a good time to learn about
ezdiff (enter "auishelp ezdiff" in your xterm).  This sample preferences
is aimed at folks with color displays.  If your system only supports
monochrome, you'll want to remove the color settings in "preferences"
right away.  Edit your preferences file and follow the comments.


SUPPORTED LANGUAGES

The following file extensions are recognized and will invoke a dynamic
object which is geared specifically for that language.

    .C  C++ source
    .cpp        C++ source
    .H  C++ includes
    .hpp        C++ includes
    .c  C source
    .ci C source
    .h  C includes
    .eh C includes
    .ih C includes
    .y  C source
    .eli        Lisp source
    .flames     Lisp source
    .lisp       Lisp source
    .a  Assembler source
    .tk TCL source
    .tcl        TCL source
    .m  Modula-2 source
    .m3 Modula-3 source
    .def        Modula definition
    .n  Ness macro source
    .p  Pascal source
    .pas        Pascal source
    .pascal     Pascal source


YOUR SECOND EZ SESSION

This assumes you already know your way around ez - because you have had
some experience with the word processing package.  Your principle tool
for source code development will be an editor named "ez".  Move to a
directory where you have some source (a Makefile and some .c/.h files)
and try out your "new" ez. 

    cp somefile.c somefile.c.save               # Always do a backup
    ez somefile.c
    Notice the colors. Different colors and fonts for various things.

    Select the menu Window->New Window  # Get 2nd window 
    Code in an "if" clause (with curly-braces).
    Notice what happens when you enter the trailing ")" and "}" ?

    Now select some part of your code (10-15 lines)
    Select the menu  Source Text->Redo Styles
    Your code is re-aligned. Maybe you like this, maybe not. If not,
    don't do this! 

    Your code will be flawless. This next part requires a compiler error
        so remove a semicolon somewhere
    Select  Make -> Start Compile
    The output from make is in the 2nd window
    Select the menu Make-> Next Error    to find your error
    Not only are you moved to the correct line, but the correct file too

    Check out the other menu items on the Make, Source Text and Tags menus.

Enter "auishelp srctext" in your xterm for help on editing source files.


CHANGELOG

Release auis62L2-src has the following changes:

    - Now based on AUIS 6.2.2 - which has only fixes to 6.2.

    - Adds bush - a simple file browser.

    - Adds c,h, C++, and H colorized templates

Release auis63L0-src has the following changes:

    - Now based on AUIS 6.3 - which has only fixes to 6.2.



SOME THINGS YOU MIGHT LIKE TO KNOW

This release was built on Slackware 1.2.0.



ON COLORS, TEMPLATES and HOW THINGS LOOK

Everyone wants to personalize their environment.  When dealing with
source views, you need to be a little careful.  There are several
inter-related areas that affect each other.  It makes tailoring these a
little tedious.  The areas you will be interested in are:

preferences settings  - AUIS has lots of options to control the
    details of how your source is automatically indented.  See the help
    text with "auishelp srctext" and try these out.  Each time you save
    a preferences setting, you need to start a new ez session to see its
    effect.

templates - When you edit a new (non-existent) source file, the file
    will be primed from a template.  To create your own template source,
    do the following:

        mkdir $HOME/tpls
        cp /usr/andrew/lib/tpls/c.tpl $HOME/tpls        # Copy default template
        setenv TEMPLATEPATH $HOME/tpls:/usr/andrew/lib/tpls     # csh/tcsh
        export TEMPLATEPATH="$HOME/tpls:/usr/andrew/lib/tpls"   # bash/ksh
        auishelp dogtags        # Read about what you are going to see
        ez $HOME/tpls/c.tpl
        Make your changes
        ez /tmp/newfile.c       # Edit new file to see what happened

colors in templates - The colors you choose for a template will be
    greatly affected by your background color. When you select a region,
    ATK "reverses" the colors, but the algorithm it uses isn't very
    predictable. So when you choose a color, check its "reverse" too.
    Sometimes you cannot see them!

color-coded keywords in styles - The source view understands the
    syntax of your language and recognizes certain words. You can
    control the attributes of these by the following:

        ez $HOME/tpls/c.tpl
        Select the menu File->Edit Styles       # Get style-editor
        Select <No Menu>                # Fields show up to right
        Select a field like "comment"   # See attributes for comments
        Click elsewhere to choose a new attribute (select "Bold" for instance)
        Move cursor back to other (c.tpl) window
        Select the menu ez->Save
        ez somefile.c           # Edit source file to see what happened


This should be enough to get you started.  There is quite a bit here,
but the paragraphs above point to the areas you may want to understand
better. 

