xref: /titanic_53/usr/src/tools/opensolaris/README.opensolaris.tmpl (revision 4e5b757fbcf21077677360be274461dcd9064106)
1*4e5b757fSkupfer		     OpenSolaris Buildable Source
2*4e5b757fSkupfer		%Z%%M%	%I%	%E% SMI
3*4e5b757fSkupfer
4*4e5b757fSkupferNote: if this is your first OpenSolaris installation, please see the
5*4e5b757fSkupfercurrently known issues section below to see the minimum build of
6*4e5b757fSkupferSolaris Express - Community Release required to build and install
7*4e5b757fSkupferOpenSolaris.  Either an initial install or an upgrade will work,
8*4e5b757fSkupferprovided you use the "Entire Distribution" metacluster.
9*4e5b757fSkupfer
10*4e5b757fSkupferThis delivery of the Buildable Source consists of 4 or 5 pieces:
11*4e5b757fSkupfer
12*4e5b757fSkupfer1. encumbered binaries tarball (on-closed-bins-DATE.PLATFORM.tar.bz2)
13*4e5b757fSkupfer2. compiler (Sun Studio 11 is the preferred compiler, and it is free
14*4e5b757fSkupfer   for OpenSolaris community members.  You can also use gcc; more on
15*4e5b757fSkupfer   that below.)
16*4e5b757fSkupfer3. ON build tools package (SUNWonbld-DATE.PLATFORM.tar.bz2)
17*4e5b757fSkupfer4. Pre-built BFU archives (on-bfu-DATE.PLATFORM.tar.bz2)
18*4e5b757fSkupfer5. source tarball (on-src-DATE.tar.bz2; numbered builds only)
19*4e5b757fSkupfer
20*4e5b757fSkupferIf you just want to install the pre-built archives, you'll need the ON
21*4e5b757fSkupferbuild tools and the BFU archives.  The tar file will unpack the
22*4e5b757fSkupferarchives into archives-DATE/PLATFORM/ (e.g.,
23*4e5b757fSkupferarchives-20050612/i386/).  You should review Section A
24*4e5b757fSkupfer(changes since the last delivery) and Section B (known issues) before
25*4e5b757fSkupferfollowing the BFU instructions in the Developer's Reference
26*4e5b757fSkupfer(http://www.opensolaris.org/os/community/onnv/devref_toc/).
27*4e5b757fSkupfer
28*4e5b757fSkupferIf you want to build from source, you will need the source, compiler,
29*4e5b757fSkupferON tools, and "extras" tools.  The encumbered binaries tarball contains
30*4e5b757fSkupfercomplete binaries (libraries, kernel modules, commands) that are
31*4e5b757fSkupfercompatible with the source.  These are binaries that cannot be built
32*4e5b757fSkupferusing only the source tarball for one reason or another.  If you wish
33*4e5b757fSkupferto build the kernel (or some portion of it), or if you wish to build a
34*4e5b757fSkupfercomplete set of installable archives, you will want the encumbered
35*4e5b757fSkupferbinaries.
36*4e5b757fSkupfer
37*4e5b757fSkupferCurrently, to obtain source, you can either download the
38*4e5b757fSkupferon-src-DATE.tar.bz2 tarball if you are downloading a build-synchronised
39*4e5b757fSkupferdelivery.  Or, you can checkout from the Mercurial repository at
40*4e5b757fSkupfer(please see instructions at: http://opensolaris.org/os/project/onnv/)
41*4e5b757fSkupfer
42*4e5b757fSkupferThe buildable source contains the source for our high key-strength
43*4e5b757fSkupfercrypto, known as the Encryption Kit (SUNWcry, SUNWcryr, SUNWcryptoint).
44*4e5b757fSkupferPlease note that certain countries restrict the redistribtuion of
45*4e5b757fSkupferhigh key-strength crypto.  If you live in one of these countries,
46*4e5b757fSkupferit is your responsibility to ensure that you are complying with your
47*4e5b757fSkupfercountry's laws in this area.
48*4e5b757fSkupfer
49*4e5b757fSkupferFor general questions on the buildable source, please ask on the
50*4e5b757fSkupferOpenSolaris Help discussion list (opensolaris-help <at> opensolaris
51*4e5b757fSkupfer<dot> org).  For detailed comments about the code, please use
52*4e5b757fSkupferOpenSolaris Code discussion list.  Please note that the mailing lists
53*4e5b757fSkupferare configured to only allow posts via the web forum interface or from
54*4e5b757fSkupferlist subscribers.
55*4e5b757fSkupfer
56*4e5b757fSkupfer
57*4e5b757fSkupferCurrently Known Issues
58*4e5b757fSkupfer----------------------
59*4e5b757fSkupfer	These were some of the major known issues at the time of this
60*4e5b757fSkupferdelivery.  The most recent list is available on the OpenSolaris.org
61*4e5b757fSkupferwebsite in the Nevada community at:
62*4e5b757fSkupferhttp://opensolaris.org/os/community/onnv/known_issues/
63*4e5b757fSkupfer
64*4e5b757fSkupfer<!-- #include http://opensolaris.org/os/community/onnv/known_issues -->
65*4e5b757fSkupfer
66*4e5b757fSkupfer
67*4e5b757fSkupferInstalling from Source
68*4e5b757fSkupfer----------------------
69*4e5b757fSkupfer
70*4e5b757fSkupfer<!-- #include http://opensolaris.org/os/community/onnv/install_quickstart -->
71