head	1.5;
access;
symbols;
locks; strict;
comment	@# @;


1.5
date	94.03.17.22.19.44;	author marc;	state Exp;
branches;
next	1.4;

1.4
date	94.03.03.09.56.09;	author aoki;	state Exp;
branches;
next	1.3;

1.3
date	93.02.17.02.00.26;	author marc;	state Exp;
branches;
next	1.2;

1.2
date	90.07.30.15.58.55;	author kemnitz;	state Exp;
branches;
next	1.1;

1.1
date	90.07.30.13.24.09;	author kemnitz;	state Exp;
branches;
next	;


desc
@Notes on the documentation files
@


1.5
log
@checkin for 4.2 release - 4.2 updates
@
text
@Directories:

    implementation/

	Implementation notes - as current as we can make them.

    papers/

        Technical reports about POSTGRES.  Some current, most not.

    postgres.faq

	Frequently asked questions about POSTGRES.

    postgres-setup.me

	Installation instructions.

    old_releasenotes/

	Old release notes.  For historical interest.
	(current release notes are in file release4.2.me)

    useful/

	Useful documents from outside.

    user_manual

File Name Conventions:

<name>.me  - Standard TROFF file using -me macros.  This is all we use.
             These files may include calls to deqn, dtbl, and ideal.

<name>.grn - Same as above, but with embedded GRN pictures.  PostScript 
	     dumps are distributed for the convienence of those who do 
	     not have access to GRN (a GREMLIN preprocessor for TROFF).

<name>.doc - Flat ASCII files - just send directly to your line printer.

<name>.ps  - PostScript files - these may be sent directly to your 
             PostScript laser printer.
@


1.4
log
@update
@
text
@d19 1
a19 1
    release_notes/
d22 1
@


1.3
log
@warn that cobntents of this directory may be dated
@
text
@d1 3
a3 5
**** THIS DIRECTORY WAS NOT UPDATED FOR RELEASE 4.1 - IT IS EXACTLY
**** AS IT WAS FOR RELEASE 4.0.1.  THE USER MANUAL, RELEASE NOTES,
**** AND INSTALLATION GUIDE (postgres-setup.me) HAVE BEEN MOVED TO
**** THE DIRECTORY "../doc" AND IS MORE CURRENT.  FOR THE NEXT RELEASE
**** WE PLAN A TOTAL OVERHAUL ON THE DOCUMENTATION.
d5 1
a5 1
Directories:
d9 1
a9 3
        Technical reports about Postgres

    implementation/
d11 1
a11 2
        bufmgr.doc        - buffer manager
        amiint.doc      - "backend" program protocol
d13 1
a13 2
        executor/*      - old executor implementation notes
        planner/*       - old planner implementation notes
d15 1
a15 1
    psdump/
d17 1
a17 6
        Postscript dump of papers using illustrations.  You will need to use
        these if you do not have GRN.  If these do not work or you do not have a
        Postscript printer, use the "eatgrn" script in place of GRN in the
        print scripts - this will get rid of the GRN data and allow you to
        print these files without the illustrations.  The Postscript versions
        of these files are printed on an Apple Laserwriter.
d19 1
a19 1
    tutorials/
d21 1
a21 1
        Postgres tutorials
d23 1
a23 3
To print these files, use the print script in this directory.
Set the PRINTER="-P <printer>" variable to the name of your site's printer,
or you may use 
d25 1
a25 1
% print -P <printer> filename
d27 1
a27 2
Papers with pictures in them are available in Postscript format in the
directory psdump.
d31 1
a31 1
<name>.me  - Standard TROFF file using me macros.  This is all we use.
d34 3
a36 3
<name>.grn - Same as above, but with embedded GRN pictures.  Postscript dumps
             are distributed for the convienence of those who do not have
             access to GRN (a GREMLIN preprocessor for TROFF).
d40 2
a41 2
<name>.ps  - Postscript files - these should be sent directly to your line
			 printer IF it is a laser printer.
@


1.2
log
@Added stuff about postscript output.
@
text
@d1 6
@


1.1
log
@Initial revision
@
text
@d47 3
@
