X-Git-Url: http://wien.tomnetworks.com/gitweb/?a=blobdiff_plain;f=README;h=d436e14e7936b0b22c87807cd5980c6590a4b858;hb=2de89fc2ef057c4c52fdb4fa55d4d3c30f1c57e3;hp=9b18f536b9b3dd84a881c607f0d1341b5957c701;hpb=bd9f9ee7cb81823608edc76ef9d0b6416783fe71;p=mono.git diff --git a/README b/README index 9b18f536b9b..d436e14e793 100644 --- a/README +++ b/README @@ -1,9 +1,9 @@ This is Mono. -1. Installation -2. Using Mono -3. Directory Roadmap + 1. Installation + 2. Using Mono + 3. Directory Roadmap 1. Compilation and Installation =============================== @@ -25,6 +25,11 @@ This is Mono. http://www.hpl.hp.com/research/linux/libunwind/download.php4 + On Solaris, make sure that you used GNU tar to unpack this package, as + Solaris tar will not unpack this correctly, and you will get strange errors. + + On Solaris, make sure that you use the GNU toolchain to build the software. + Optional dependencies: * libgdiplus @@ -32,6 +37,11 @@ This is Mono. If you want to get support for System.Drawing, you will need to get Libgdiplus. + * libzlib + + This library and the development headers are required for compression + file support in the 2.0 profile. + b. Building the Software ------------------------ @@ -42,7 +52,8 @@ This is Mono. make make install - Mono supports a JIT engine on x86, SPARC, SPARCv9, S/390, AMD64 and PowerPC systems. + Mono supports a JIT engine on x86, SPARC, SPARCv9, S/390, + S/390x, AMD64, ARM and PowerPC systems. If you obtained this as a snapshot, you will need an existing Mono installation. To upgrade your installation, unpack both @@ -56,6 +67,14 @@ This is Mono. ./autogen.sh --prefix=/usr/local make + The Mono build system is silent for most compilation commands. + To enable a more verbose compile (for example, to pinpoint + problems in your makefiles or your system) pass the V=1 flag to make, like this: + + make V=1 + + + c. Building the software from SVN --------------------------------- @@ -71,6 +90,19 @@ This is Mono. ./autogen.sh --prefix=/usr/local make + For people with non-standard installations of the auto* utils and of + pkg-config (common on misconfigured OSX and windows boxes), you could get + an error like this: + + ./configure: line 19176: syntax error near unexpected token `PKG_CHECK_MODULES(BASE_DEPENDENCIES,' ... + + This means that you need to set the ACLOCAL_FLAGS environment var + when invoking autogen.sh, like this: + + ACLOCAL_FLAGS="-I $acprefix/share/aclocal" ./autogen.sh --prefix=/usr/loca + + where $acprefix is the prefix where aclocal has been installed. + This will automatically go into the mcs/ tree and build the binaries there. @@ -87,10 +119,11 @@ This is Mono. If you don't have a working Mono installation, an obvious choice is to install the latest released packages of 'mono' for your - distribution and try from the beginning. + distribution and running autogen.sh; make; make install in the + mono module directory. - You can also try a slightly more risky approach that should work - almost all the time. + You can also try a slightly more risky approach: this may not work, + so start from the released tarball as detailed above. This works by first getting the latest version of the 'monolite' distribution, which contains just enough to run the 'mcs' @@ -108,7 +141,7 @@ This is Mono. also try passing EXTERNAL_MCS=false on the make command-line. Testing and Installation - ------------------------ + ------------------------ You can run (part of) the mono and mcs testsuites with the command: @@ -133,6 +166,259 @@ This is Mono. Failure to follow these steps may result in a broken installation. + d. Common Configuration Options + ------------------------------- + + The following are the configuration options that someone + building Mono might want to use: + + + --with-gc=[boehm, included, sgen, none] + + Selects the garbage collector engine to use, the + default is the "included" value. + + included: + This is the default value, and its + the most feature complete, it will allow Mono + to use typed allocations and support the + debugger. + + It is essentially a slightly modified Boehm GC + + boehm: + This is used to use a system-install Boehm GC, + it is useful to test new features available in + Boehm GC, but we do not recommend that people + use this, as it disables a few features. + + sgen: + The under-development Generational GC for + Mono, do not use this in production. + + none: + Disables the inclusion of a garbage + collector. + + --with-tls=__thread,pthread + + Controls how Mono should access thread local storage, + pthread forces Mono to use the pthread APIs, while + __thread uses compiler-optimized access to it. + + Although __thread is faster, it requires support from + the compiler, kernel and libc. Old Linux systems do + not support with __thread. + + This value is typically pre-configured and there is no + need to set it, unless you are trying to debug a + problem. + + --with-sigaltstack=yes,no + + Experimental: Use at your own risk, it is known to + cause problems with garbage collection and is hard to + reproduce those bugs. + + This controls whether Mono will install a special + signal handler to handle stack overflows. If set to + "yes", it will turn stack overflows into the + StackOverflowException. Otherwise when a stack + overflow happens, your program will receive a + segmentation fault. + + The configure script will try to detect if your + operating system supports this. Some older Linux + systems do not support this feature, or you might want + to override the auto-detection. + + --with-static_mono=yes,no + + This controls whether `mono' should link against a + static library (libmono.a) or a shared library + (libmono.so). + + This defaults to yes, and will improve the performance + of the `mono' program. + + This only affects the `mono' binary, the shared + library libmono.so will always be produced for + developers that want to embed the runtime in their + application. + + --with-xen-opt=yes,no + + The default value for this is `yes', and it makes Mono + generate code which might be slightly slower on + average systems, but the resulting executable will run + faster under the Xen virtualization system. + + --with-large-heap=yes,no + + Enable support for GC heaps larger than 3GB. + + This value is set to `no' by default. + + --with-ikvm-native=yes,no + + Controls whether the IKVM JNI interface library is + built or not. This is used if you are planning on + using the IKVM Java Virtual machine with Mono. + + This defaults to `yes'. + + --with-profile2=yes,no + + Whether you want to build the 2.x libraries (support + for Generics and the 2.0/3.5 APIS). + + It defaults to `yes'. + + --with-moonlight=yes,no + + Whether you want to generate the Silverlight/Moonlight + libraries and toolchain in addition to the default + (1.1 and 2.0 APIs). + + This will produce the `smcs' compiler which will reference + the Silverlight modified assemblies (mscorlib.dll, + System.dll, System.Code.dll and System.Xml.Core.dll) and turn + on the LINQ extensions for the compiler. + + --with-libgdiplus=installed,sibling, + + This is used to configure where should Mono look for + libgdiplus when running the System.Drawing tests. + + It defaults to `installed', which means that the + library is available to Mono through the regular + system setup. + + `sibling' can be used to specify that a libgdiplus + that resides as a sibling of this directory (mono) + should be used. + + Or you can specify a path to a libgdiplus. + + --disable-shared-memory + + Use this option to disable the use of shared memory in + Mono (this is equivalent to setting the MONO_DISABLE_SHM + environment variable, although this removes the feature + completely). + + Disabling the shared memory support will disable certain + features like cross-process named mutexes. + + --enable-minimal=LIST + + Use this feature to specify optional runtime + components that you might not want to include. This + is only useful for developers embedding Mono that + require a subset of Mono functionality. + + The list is a comma-separated list of components that + should be removed, these are: + + aot: + Disables support for the Ahead of Time + compilation. + + com: + Disables COM support. + + debug: + Drop debugging support. + + decimal: + Disables support for System.Decimal. + + generics: + Generics support. Disabling this will not + allow Mono to run any 2.0 libraries or + code that contains generics. + + jit: + Removes the JIT engine from the build, this reduces + the executable size, and requires that all code + executed by the virtual machine be compiled with + Full AOT before execution. + + large_code: + Disables support for large assemblies. + + logging: + Disables support for debug logging. + + pinvoke: + Support for Platform Invocation services, + disabling this will drop support for any + libraries using DllImport. + + profiler: + Disables support for the default profiler. + + reflection_emit: + Drop System.Reflection.Emit support + + reflection_emit_save: + Drop support for saving dynamically created + assemblies (AssemblyBuilderAccess.Save) in + System.Reflection.Emit. + + simd: + Disables support for the Mono.SIMD intrinsics + library. + + ssa: + Disables compilation for the SSA optimization + framework, and the various SSA-based + optimizations. + + --enable-big-arrays + + This enables the use arrays whose indexes are larger + than Int32.MaxValue. + + By default Mono has the same limitation as .NET on + Win32 and Win64 and limits array indexes to 32-bit + values (even on 64-bit systems). + + In certain scenarios where large arrays are required, + you can pass this flag and Mono will be built to + support 64-bit arrays. + + This is not the default as it breaks the C embedding + ABI that we have exposed through the Mono development + cycle. + + --enable-parallel-mark + + Use this option to enable the garbage collector to use + multiple CPUs to do its work. This helps performance + on multi-CPU machines as the work is divided across CPUS. + + This option is not currently the default as we have + not done much testing with Mono. + + --enable-dtrace + + On Solaris and MacOS X builds a version of the Mono + runtime that contains DTrace probes and can + participate in the system profiling using DTrace. + + + --disable-dev-random + + Mono uses /dev/random to obtain good random data for + any source that requires random numbers. If your + system does not support this, you might want to + disable it. + + There are a number of runtime options to control this + also, see the man page. + + 2. Using Mono ============= @@ -141,8 +427,6 @@ This is Mono. * runtime engine mono program.exe - or - mint program.exe * C# compiler @@ -158,9 +442,6 @@ This is Mono. 3. Directory Roadmap ==================== - doc/ - Contains the web site contents. - docs/ Technical documents about the Mono runtime. @@ -173,7 +454,7 @@ This is Mono. metadata/ The object system and metadata reader. - jit/ + mini/ The Just in Time Compiler. dis/ @@ -191,7 +472,7 @@ This is Mono. definition of the CIL bytecodes. interp/ - Interpreter for CLI executables. + Interpreter for CLI executables (obsolete). arch/ Architecture specific portions. @@ -200,6 +481,11 @@ This is Mono. Manual pages for the various Mono commands and programs. + samples/ + + Some simple sample programs on uses of the Mono + runtime as an embedded library. + scripts/ Scripts used to invoke Mono and the corresponding program. @@ -209,3 +495,9 @@ This is Mono. A directory that contains the Makefiles that link the mono/ and mcs/ build systems. + ../olive/ + + If the directory ../olive is present (as an + independent checkout) from the Mono module, that + directory is automatically configured to share the + same prefix than this module gets.