XCircuit v2.1b8 (beta)
-----------------------------------------------------------------------------

An X11 drawing program [especially for circuit schematics]
(c) 2000 Tim Edwards  (see copyright notice in ./COPYRIGHT)
August 1993 -- November 2000
-----------------------------------------------------------------------------

Installation notes:

Imakefile
---------

1) All compile-time features are set from within Imakefile.  Be sure to
   reference Imakefile first if you have difficulties compiling.

2) Decide where you want xcircuit and its library files to reside, and
   set XCIRCUIT_LIB_DIR, XCIRCUIT_MAN_DIR, and XCIRCUIT_BIN_DIR accordingly.
   A typical path (which is the default) would be /usr/local/lib/xcircuit/.

3) It should not be necessary to change CC, CCOPTIONS, or CDEBUGFLAGS for
   Linux and IRIX systems, unless you encounter problems during compiling.
   
4) DEC Alpha systems:
   A) Add "-taso" to CCOPTIONS to get the compiler to make
      necessary changes to deal with 64-bit addressing.  It may
      also be necessary to add the "-D" flag.
   B) Set HAVE_UCHAR = -DHAVE_UCHAR to avoid typedef conflicts.

5) Anyone using xcircuit for drawing purposes only (no schematic capture
   wanted) may undefine SCHEMA in the Imakefile.  If you're not sure,
   leave it alone.

6) By default, the Imakefile assumes that your system has xpm (pixmaps); if
   you don't, or you get error messages about no include file "xpm.h" found,
   then delete the line "#define HAVE_XPM" from the Imakefile and recompile.
   The only thing you will be missing is the color icon.

Xcircuit should be made using the following commands:

   xmkmf
   make
   make install
   make install.man

The makefile should automatically install the application defaults
file "XCircuit.ad" (and "XSchema.ad", if you have chosen the schematic
capture package) in /usr/lib/X11/app-defaults/XCircuit.

The makefile should also automatically install the man page in
(depending on the Imake configuration) /usr/local/man/man1/xcircuit.1x.

If the program is extremely slow in rendering the screen or if the
system tends to swap during program execution, you may need to
undefine DO_BUFFER in the Imakefile.  Clean, no-flicker rendering
is made possible by drawing on a Pixmap and then doing a quick copy
from the Pixmap to the screen.  Depending on the default screen
depth (usually 8 or 16 bits) and the window size, the Pixmap can take
a MB of memory or more.  Systems with too little memory or systems
(like Intel-based computers) without a video card with Bit-BLT
(block transfers) can erase all the gains of graphics buffering.
Xcircuit will operate fine without buffering, but the screen will
flicker every time there is a refresh;  consequently, without
buffering the system is designed not to refresh as often, and there
will be more "pixel trash" on the screen.  It is expected that under
these conditions the user will simply use the space bar to refresh
the screen as needed.

-----------------------------------------------------------------------------

Extras:

   The file examples/.xcircuitrc shows how to make a home-directory file
to alter the behavior of xcircuit on startup.  It shows how to change the
color scheme, add new fonts, override the default libraries, and change
the editing behavior for polygons.

   Other files in the examples directory show how xcircuit can be
used to draw various things, from a simple circuit schematic
(vcoblock.ps) to an entire publishable-quality page of music 
(prelude.ps), plus an example of a fancy page border for slide
presentations.

   The files psfiles/signal.lps and psfiles/musiclib.lps are examples
of alternate or additional object libraries.  The library file lgf.lps
is used primarily by the lgf-to-ps conversion routines, but has some
different circuit objects in it.

   The file psfiles/fonttest.ps is a short PostScript program you can
use to get your printer to give you the names of all the built-in fonts
that it knows about, which is useful because if you add a font name to
xcircuit, the spelling has to be exactly correct or else the printer
won't recognize it.

-----------------------------------------------------------------------------

X Resources:

   The color scheme of xcircuit has a default setup, but accepts 
alternate color schemes using the following keywords which can be put
in the X Defaults (.Xdefaults, .Xresources) file:

   Resource name	    Description				Default
   -------------------      ----------------------------        -------
   xcircuit*foreground	    color of buttons and popups;	White
   xcircuit*background	    background of buttons & popups;	DarkSlateGray
   xcircuit.foreground	    drawing area foreground;		White
   xcircuit.background	    drawing area background;		Black
   xcircuit*gridcolor	    color of the grid lines;		Gray40
   xcircuit*snapcolor	    color of the snap-to points;	Red
   xcircuit*selectcolor	    color of a selected object;		Gold
   xcircuit*querycolor	    to differentiate multiple objects;  Turquoise
   xcircuit*axescolor	    color of the x, y axes;		NavajoWhite4
   xcircuit*offbuttoncolor  text color of an inoperable button; Gray70
   xcircuit*auxiliarycolor  text cursor and other things	Green
   xcircuit*barcolor	    color of panning bars		Tan

A secondary color scheme (for example, black-on-white) can be specified by
adding "2" to each of the above resource names.  For example:

   xcircuit*foreground2	    color of every object drawn;	Black
   xcircuit*background2	    screen background color;		White

Other resources accepted by xcircuit are:

   xcircuit*width	    width of the drawing area (pixels);	600
   xcircuit*height	    height of the drawing area;		500

Normally, you will want to put the defaults in /usr/lib/X11/app-defaults.
If you do not have root access, you will want to have them in your own
home .Xdefaults file.  If the file is not found by xcircuit, the program
will use its default color schemes, the main one being black-on-white,
and the alternate being white-on-dark-gray.

-----------------------------------------------------------------------------

Altering, Copying, and/or Redistributing XCircuit:

   XCircuit is distributed under a generous artistic license.  See the file
COPYRIGHT in the top-level directory for details.

-----------------------------------------------------------------------------

Online tutorial: See
     "http://bach.ece.jhu.edu/~tim/programs/xcircuit/tutorial.html"

Schematic capture tutorial: See
     "http://bach.ece.jhu.edu/~tim/programs/xcircuit/tutorial2.html"

-----------------------------------------------------------------------------

Contact address (check the website above for a current address):
		R. Timothy Edwards
		Mailstop 4-234
		Johns Hopkins University
		Applied Physics Laboratory
		11100 Johns Hopkins Road
		Laurel, MD 20723-6099

		Office Phone: (240) 228-4613
		FAX:	      (240) 228-7636

-----------------------------------------------------------------------------
