* SqlCommand.cs: Added bool argument to ValidateCommand to specify
[mono.git] / README
diff --git a/README b/README
index c4c7a2ce800f3f7750ce5dc34fceb3cfc554c824..02f4bde7a83f345fb4f1f311f2b6fdaa738e1ec5 100644 (file)
--- a/README
+++ b/README
@@ -52,8 +52,8 @@ This is Mono.
                make
                make install
 
-       Mono supports a JIT engine on x86, SPARC, SPARCv9, S/390, AMD64, ARM
-       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
@@ -133,7 +133,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:
 
@@ -208,6 +208,10 @@ This is Mono.
 
        --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
@@ -220,7 +224,7 @@ This is Mono.
                systems do not support this feature, or you might want
                to override the auto-detection.
 
-       --with-static-mono=yes,no
+       --with-static_mono=yes,no
 
                This controls whether `mono' should link against a
                static library (libmono.a) or a shared library
@@ -260,6 +264,19 @@ This is Mono.
                Whether you want to build libraries that are still not
                completed (The 2.0 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 Silvelright modified assemblies (mscorlib.dll,
+               System.dll, System.Code.dll and System.Xml.Core.dll) and turn
+               on the LINQ extensions for the compiler.
+
+               This option defaults to `no' and it is considered pre-alpha.
+
        --with-libgdiplus=installed,sibling,<path>
 
                This is used to configure where should Mono look for
@@ -275,6 +292,16 @@ This is Mono.
 
                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
@@ -325,6 +352,39 @@ This is Mono.
                        allow Mono to run any 2.0 libraries or
                        code that contains generics.
                
+       --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
@@ -398,6 +458,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.
@@ -407,3 +472,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.