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