INSTALL revision 12027 
112275Sgabeblack@google.comInstallation of the `QuickThreads' threads-building toolkit.
212275Sgabeblack@google.com
312275Sgabeblack@google.com* Notice
412275Sgabeblack@google.com
512275Sgabeblack@google.comQuickThreads -- Threads-building toolkit.
612275Sgabeblack@google.comCopyright (c) 1993 by David Keppel
712275Sgabeblack@google.com
812275Sgabeblack@google.comPermission to use, copy, modify and distribute this software and
912275Sgabeblack@google.comits documentation for any purpose and without fee is hereby
1012275Sgabeblack@google.comgranted, provided that the above copyright notice and this notice
1112275Sgabeblack@google.comappear in all copies.  This software is provided as a
1212275Sgabeblack@google.comproof-of-concept and for demonstration purposes; there is no
1312275Sgabeblack@google.comrepresentation about the suitability of this software for any
1412275Sgabeblack@google.compurpose.
1512275Sgabeblack@google.com
1612275Sgabeblack@google.com
1712275Sgabeblack@google.com* Configuration
1812275Sgabeblack@google.com
1912275Sgabeblack@google.comConfigure with
2012275Sgabeblack@google.com
2112275Sgabeblack@google.com	./config *machtype*
2212275Sgabeblack@google.com
2312275Sgabeblack@google.comwhere "*machtype*" is one of the supported target machines.  As of
2412275Sgabeblack@google.comOctober 1994, the supported machines (targets) are:
2512275Sgabeblack@google.com
2612275Sgabeblack@google.com	axp --	All Digital Equipment Corporation AXP (DEC Alpha)
2712275Sgabeblack@google.com		processors, compile with GNU CC
2812275Sgabeblack@google.com	axp-osf1 -- AXP running OSF 1.x
2912275Sgabeblack@google.com	axp-osf2 -- AXP running OSF 2.x
3012275Sgabeblack@google.com	hppa -- HP's PA-RISC 1.1 processor
3112275Sgabeblack@google.com	hppa-cnx-spp -- Convex SPP (PA-RISC 1.1 processor)
3212275Sgabeblack@google.com	iX86 --	80386, 80486, and 80586-compatible processors
3312275Sgabeblack@google.com		See notes below for OS/2.
3412275Sgabeblack@google.com	iX86-ss -- 'iX86 for assemblers that use slash-slash ('//')
3512287Sgabeblack@google.com		comments.
3612275Sgabeblack@google.com	ksr1 --	All KSR processors
37	m88k --	All members of the Motorola 88000 family
38	mips --	MIPS R2000 and R3000 processors
39	mips-irix5 -- Irix 5.xx (use `mips' for Irix 4.xx)
40	sparc-os1 -- V8-compliant SPARC processors using compilers
41		that prefix labels (e.g. "foo" appears as "_foo")
42		Includes Solaris 1 (SunOS 4.X).
43	sparc-os2 -- V8-compliant SPARC processors using compilers
44		that do not prefix labels.  Includes Solaris 2.
45	vax --	All VAX processors
46
47In addition, the target `clean' will deconfigure QuickThreads.
48
49Note that a given machine target may not work on all instances of that
50machine because e.g., the assembler syntax varies from machine to
51machine.
52
53Note also that additions to a processor family may require a new
54target.  So, for example, the `vax' target might not work for all
55future VAX processors if, say, new VAX processors are introduced and
56they use separate floating-point registers.
57
58For OS/2, change `ranlib' to `ar -s', `configure' to `configure.cmd'
59(or was that `config' to `config.cmd'?), and replace the soft links
60(`ln -s') with plain copies.
61
62
63* Build
64
65To build the QuickThreads library, first configure (see above) then
66type `make libqt.a' in the top-level directory.
67
68To build the demonstration threads package, SimpleThreads, type
69`make libstp.a' in the top-level directory.
70
71To build an executable ``stress-test'' and measurement program, type
72`make run' in the top-level directory.  Run `time/raw' to run the
73stress tests.
74
75
76* Installation
77
78Build the QuickThreads library (see above) and then copy `libqt.a' to
79the installation library directory (e.g., /usr/local/lib) and `qt.h'
80and `qtmd.h' to the installation include directory (e.g.,
81/usr/local/include).
82