xref: /titanic_52/usr/src/tools/opensolaris/README.opensolaris.tmpl (revision 7a98501b9c3e4e2c566bc6542c4eccff1f757cf8)
14e5b757fSkupfer		     OpenSolaris Buildable Source
2*7a98501bSkupfer
3*7a98501bSkupfer#ident	"%Z%%M%	%I%	%E% SMI"
44e5b757fSkupfer
54e5b757fSkupferNote: if this is your first OpenSolaris installation, please see the
64e5b757fSkupfercurrently known issues section below to see the minimum build of
74e5b757fSkupferSolaris Express - Community Release required to build and install
84e5b757fSkupferOpenSolaris.  Either an initial install or an upgrade will work,
94e5b757fSkupferprovided you use the "Entire Distribution" metacluster.
104e5b757fSkupfer
114e5b757fSkupferThis delivery of the Buildable Source consists of 4 or 5 pieces:
124e5b757fSkupfer
134e5b757fSkupfer1. encumbered binaries tarball (on-closed-bins-DATE.PLATFORM.tar.bz2)
144e5b757fSkupfer2. compiler (Sun Studio 11 is the preferred compiler, and it is free
154e5b757fSkupfer   for OpenSolaris community members.  You can also use gcc; more on
164e5b757fSkupfer   that below.)
174e5b757fSkupfer3. ON build tools package (SUNWonbld-DATE.PLATFORM.tar.bz2)
184e5b757fSkupfer4. Pre-built BFU archives (on-bfu-DATE.PLATFORM.tar.bz2)
194e5b757fSkupfer5. source tarball (on-src-DATE.tar.bz2; numbered builds only)
204e5b757fSkupfer
214e5b757fSkupferIf you just want to install the pre-built archives, you'll need the ON
224e5b757fSkupferbuild tools and the BFU archives.  The tar file will unpack the
234e5b757fSkupferarchives into archives-DATE/PLATFORM/ (e.g.,
244e5b757fSkupferarchives-20050612/i386/).  You should review Section A
254e5b757fSkupfer(changes since the last delivery) and Section B (known issues) before
264e5b757fSkupferfollowing the BFU instructions in the Developer's Reference
274e5b757fSkupfer(http://www.opensolaris.org/os/community/onnv/devref_toc/).
284e5b757fSkupfer
294e5b757fSkupferIf you want to build from source, you will need the source, compiler,
304e5b757fSkupferON tools, and "extras" tools.  The encumbered binaries tarball contains
314e5b757fSkupfercomplete binaries (libraries, kernel modules, commands) that are
324e5b757fSkupfercompatible with the source.  These are binaries that cannot be built
334e5b757fSkupferusing only the source tarball for one reason or another.  If you wish
344e5b757fSkupferto build the kernel (or some portion of it), or if you wish to build a
354e5b757fSkupfercomplete set of installable archives, you will want the encumbered
364e5b757fSkupferbinaries.
374e5b757fSkupfer
384e5b757fSkupferCurrently, to obtain source, you can either download the
394e5b757fSkupferon-src-DATE.tar.bz2 tarball if you are downloading a build-synchronised
404e5b757fSkupferdelivery.  Or, you can checkout from the Mercurial repository at
414e5b757fSkupfer(please see instructions at: http://opensolaris.org/os/project/onnv/)
424e5b757fSkupfer
434e5b757fSkupferThe buildable source contains the source for our high key-strength
444e5b757fSkupfercrypto, known as the Encryption Kit (SUNWcry, SUNWcryr, SUNWcryptoint).
454e5b757fSkupferPlease note that certain countries restrict the redistribtuion of
464e5b757fSkupferhigh key-strength crypto.  If you live in one of these countries,
474e5b757fSkupferit is your responsibility to ensure that you are complying with your
484e5b757fSkupfercountry's laws in this area.
494e5b757fSkupfer
504e5b757fSkupferFor general questions on the buildable source, please ask on the
514e5b757fSkupferOpenSolaris Help discussion list (opensolaris-help <at> opensolaris
524e5b757fSkupfer<dot> org).  For detailed comments about the code, please use
534e5b757fSkupferOpenSolaris Code discussion list.  Please note that the mailing lists
544e5b757fSkupferare configured to only allow posts via the web forum interface or from
554e5b757fSkupferlist subscribers.
564e5b757fSkupfer
574e5b757fSkupfer
584e5b757fSkupferCurrently Known Issues
594e5b757fSkupfer----------------------
604e5b757fSkupfer	These were some of the major known issues at the time of this
614e5b757fSkupferdelivery.  The most recent list is available on the OpenSolaris.org
624e5b757fSkupferwebsite in the Nevada community at:
634e5b757fSkupferhttp://opensolaris.org/os/community/onnv/known_issues/
644e5b757fSkupfer
654e5b757fSkupfer<!-- #include http://opensolaris.org/os/community/onnv/known_issues -->
664e5b757fSkupfer
674e5b757fSkupfer
684e5b757fSkupferInstalling from Source
694e5b757fSkupfer----------------------
704e5b757fSkupfer
714e5b757fSkupfer<!-- #include http://opensolaris.org/os/community/onnv/install_quickstart -->
72