Wed Feb 24 15:47:16 CET 2010 Paolo Molaro <lupus@ximian.com>
[mono.git] / README
1
2 This is Mono.
3
4         1. Installation
5         2. Using Mono
6         3. Directory Roadmap
7
8 1. Compilation and Installation
9 ===============================
10
11    a. Build Requirements
12    ---------------------
13
14         To build Mono, you will need the following components:
15
16                 * pkg-config
17
18                   Available from: http://www.freedesktop.org/Software/pkgconfig
19
20                 * glib 2.4
21
22                   Available from: http://www.gtk.org/
23
24         On Itanium, you must obtain libunwind:
25
26                 http://www.hpl.hp.com/research/linux/libunwind/download.php4
27
28         On Solaris, make sure that you used GNU tar to unpack this package, as
29         Solaris tar will not unpack this correctly, and you will get strange errors.
30
31         On Solaris, make sure that you use the GNU toolchain to build the software.
32
33         Optional dependencies:
34
35                 * libgdiplus
36
37                   If you want to get support for System.Drawing, you will need to get
38                   Libgdiplus.
39
40                 * libzlib
41
42                   This library and the development headers are required for compression
43                   file support in the 2.0 profile.
44
45     b. Building the Software
46     ------------------------
47         
48         If you obtained this package as an officially released tarball,
49         this is very simple, use configure and make:
50
51                 ./configure --prefix=/usr/local
52                 make
53                 make install
54
55         Mono supports a JIT engine on x86, SPARC, SPARCv9, S/390,
56         S/390x, AMD64, ARM and PowerPC systems.   
57
58         If you obtained this as a snapshot, you will need an existing
59         Mono installation.  To upgrade your installation, unpack both
60         mono and mcs:
61
62                 tar xzf mcs-XXXX.tar.gz
63                 tar xzf mono-XXXX.tar.gz
64                 mv mono-XXX mono
65                 mv mcs-XXX mcs
66                 cd mono
67                 ./autogen.sh --prefix=/usr/local
68                 make
69
70         The Mono build system is silent for most compilation commands.
71         To enable a more verbose compile (for example, to pinpoint
72         problems in your makefiles or your system) pass the V=1 flag to make, like this:
73
74                  make V=1
75
76
77
78     c. Building the software from SVN
79     ---------------------------------
80
81         If you are building the software from SVN, make sure that you
82         have up-to-date mcs and mono sources:
83
84                 svn co svn+ssh://USER@mono-cvs.ximian.com/source/trunk/mono
85                 svn co svn+ssh://USER@mono-cvs.ximian.com/source/trunk/mcs
86
87         Then, go into the mono directory, and configure:
88
89                 cd mono
90                 ./autogen.sh --prefix=/usr/local
91                 make
92
93         For people with non-standard installations of the auto* utils and of
94         pkg-config (common on misconfigured OSX and windows boxes), you could get
95         an error like this:
96
97         ./configure: line 19176: syntax error near unexpected token `PKG_CHECK_MODULES(BASE_DEPENDENCIES,' ...
98
99         This means that you need to set the ACLOCAL_FLAGS environment var
100         when invoking autogen.sh, like this:
101
102                 ACLOCAL_FLAGS="-I $acprefix/share/aclocal" ./autogen.sh --prefix=/usr/loca
103         
104         where $acprefix is the prefix where aclocal has been installed.
105
106         This will automatically go into the mcs/ tree and build the
107         binaries there.
108
109         This assumes that you have a working mono installation, and that
110         there's a C# compiler named 'mcs', and a corresponding IL
111         runtime called 'mono'.  You can use two make variables
112         EXTERNAL_MCS and EXTERNAL_RUNTIME to override these.  e.g., you
113         can say
114
115           make EXTERNAL_MCS=/foo/bar/mcs EXTERNAL_RUNTIME=/somewhere/else/mono
116         
117         If you don't have a working Mono installation
118         ---------------------------------------------
119
120         If you don't have a working Mono installation, an obvious choice
121         is to install the latest released packages of 'mono' for your
122         distribution and running autogen.sh; make; make install in the
123         mono module directory.
124
125         You can also try a slightly more risky approach: this may not work,
126         so start from the released tarball as detailed above.
127
128         This works by first getting the latest version of the 'monolite'
129         distribution, which contains just enough to run the 'mcs'
130         compiler.  You do this with:
131
132                 make get-monolite-latest
133
134         This will download and automatically gunzip and untar the
135         tarball, and place the files appropriately so that you can then
136         just run:
137
138                 make
139
140         To ensure that you're using the 'monolite' distribution, you can
141         also try passing EXTERNAL_MCS=false on the make command-line.
142
143         Testing and Installation
144         ------------------------
145
146         You can run (part of) the mono and mcs testsuites with the command:
147
148                 make check
149
150         All tests should pass.  
151
152         If you want more extensive tests, including those that test the
153         class libraries, you need to re-run 'configure' with the
154         '--enable-nunit-tests' flag, and try
155
156                 make -k check
157
158         Expect to find a few testsuite failures.  As a sanity check, you
159         can compare the failures you got with
160
161                 http://go-mono.com/tests/displayTestResults.php
162
163         You can now install mono with:
164
165                 make install
166
167         Failure to follow these steps may result in a broken installation. 
168
169     d. Common Configuration Options
170     -------------------------------
171
172         The following are the configuration options that someone
173         building Mono might want to use:
174         
175
176         --with-gc=[boehm, included, sgen, none]
177
178                 Selects the garbage collector engine to use, the
179                 default is the "included" value.
180         
181                 included: 
182                         This is the default value, and its
183                         the most feature complete, it will allow Mono
184                         to use typed allocations and support the
185                         debugger.
186
187                         It is essentially a slightly modified Boehm GC
188
189                 boehm:
190                         This is used to use a system-install Boehm GC,
191                         it is useful to test new features available in
192                         Boehm GC, but we do not recommend that people
193                         use this, as it disables a few features.
194
195                 sgen:
196                         The under-development Generational GC for
197                         Mono, do not use this in production.
198
199                 none:
200                         Disables the inclusion of a garbage
201                         collector.  
202
203         --with-tls=__thread,pthread
204
205                 Controls how Mono should access thread local storage,
206                 pthread forces Mono to use the pthread APIs, while
207                 __thread uses compiler-optimized access to it.
208
209                 Although __thread is faster, it requires support from
210                 the compiler, kernel and libc.   Old Linux systems do
211                 not support with __thread.
212
213                 This value is typically pre-configured and there is no
214                 need to set it, unless you are trying to debug a
215                 problem.
216
217         --with-sigaltstack=yes,no
218
219                 Experimental: Use at your own risk, it is known to
220                 cause problems with garbage collection and is hard to
221                 reproduce those bugs.
222
223                 This controls whether Mono will install a special
224                 signal handler to handle stack overflows.   If set to
225                 "yes", it will turn stack overflows into the
226                 StackOverflowException.  Otherwise when a stack
227                 overflow happens, your program will receive a
228                 segmentation fault.
229
230                 The configure script will try to detect if your
231                 operating system supports this.   Some older Linux
232                 systems do not support this feature, or you might want
233                 to override the auto-detection.
234
235         --with-static_mono=yes,no
236
237                 This controls whether `mono' should link against a
238                 static library (libmono.a) or a shared library
239                 (libmono.so). 
240
241                 This defaults to yes, and will improve the performance
242                 of the `mono' program. 
243
244                 This only affects the `mono' binary, the shared
245                 library libmono.so will always be produced for
246                 developers that want to embed the runtime in their
247                 application.
248
249         --with-xen-opt=yes,no
250
251                 The default value for this is `yes', and it makes Mono
252                 generate code which might be slightly slower on
253                 average systems, but the resulting executable will run
254                 faster under the Xen virtualization system.
255
256         --with-large-heap=yes,no
257
258                 Enable support for GC heaps larger than 3GB.
259
260                 This value is set to `no' by default.
261
262         --with-ikvm-native=yes,no
263
264                 Controls whether the IKVM JNI interface library is
265                 built or not.  This is used if you are planning on
266                 using the IKVM Java Virtual machine with Mono.
267
268                 This defaults to `yes'.
269
270         --with-profile2=yes,no
271
272                 Whether you want to build the 2.x libraries (support
273                 for Generics and the 2.0/3.5 APIS).
274
275                 It defaults to `yes'.
276
277         --with-moonlight=yes,no
278
279                 Whether you want to generate the Silverlight/Moonlight
280                 libraries and toolchain in addition to the default
281                 (1.1 and 2.0 APIs).
282
283                 This will produce the `smcs' compiler which will reference
284                 the Silverlight modified assemblies (mscorlib.dll,
285                 System.dll, System.Code.dll and System.Xml.Core.dll) and turn
286                 on the LINQ extensions for the compiler.
287
288         --with-libgdiplus=installed,sibling,<path>
289
290                 This is used to configure where should Mono look for
291                 libgdiplus when running the System.Drawing tests.
292
293                 It defaults to `installed', which means that the
294                 library is available to Mono through the regular
295                 system setup.
296
297                 `sibling' can be used to specify that a libgdiplus
298                 that resides as a sibling of this directory (mono)
299                 should be used.
300
301                 Or you can specify a path to a libgdiplus.
302
303         --disable-shared-memory 
304
305                 Use this option to disable the use of shared memory in
306                 Mono (this is equivalent to setting the MONO_DISABLE_SHM
307                 environment variable, although this removes the feature
308                 completely).
309
310                 Disabling the shared memory support will disable certain
311                 features like cross-process named mutexes.
312
313         --enable-minimal=LIST
314
315                 Use this feature to specify optional runtime
316                 components that you might not want to include.  This
317                 is only useful for developers embedding Mono that
318                 require a subset of Mono functionality.
319
320                 The list is a comma-separated list of components that
321                 should be removed, these are:
322
323                 aot:
324                         Disables support for the Ahead of Time
325                         compilation.
326
327                 attach:
328                         Support for the Mono.Management assembly and the
329                         VMAttach API (allowing code to be injected into
330                         a target VM)
331
332                 com:
333                         Disables COM support.
334
335                 debug:
336                         Drop debugging support.
337
338                 decimal:
339                         Disables support for System.Decimal.
340
341                 full_messages:
342                         By default Mono comes with a full table
343                         of messages for error codes.   This feature
344                         turns off uncommon error messages and reduces
345                         the runtime size.
346
347                 generics:
348                         Generics support.  Disabling this will not
349                         allow Mono to run any 2.0 libraries or
350                         code that contains generics.
351
352                 jit:
353                         Removes the JIT engine from the build, this reduces
354                         the executable size, and requires that all code
355                         executed by the virtual machine be compiled with
356                         Full AOT before execution.
357
358                 large_code:
359                         Disables support for large assemblies.
360
361                 logging:
362                         Disables support for debug logging.
363
364                 pinvoke:
365                         Support for Platform Invocation services,
366                         disabling this will drop support for any
367                         libraries using DllImport.
368
369                 portability:
370                         Removes support for MONO_IOMAP, the environment
371                         variables for simplifying porting applications that 
372                         are case-insensitive and that mix the Unix and Windows path separators.
373
374                 profiler:
375                         Disables support for the default profiler.
376
377                 reflection_emit:
378                         Drop System.Reflection.Emit support
379
380                 reflection_emit_save:
381                         Drop support for saving dynamically created
382                         assemblies (AssemblyBuilderAccess.Save) in
383                         System.Reflection.Emit.
384
385                 shadow_copy:
386                         Disables support for AppDomain's shadow copies
387                         (you can disable this if you do not plan on 
388                         using appdomains).
389
390                 simd:
391                         Disables support for the Mono.SIMD intrinsics
392                         library.
393
394                 ssa:
395                         Disables compilation for the SSA optimization
396                         framework, and the various SSA-based
397                         optimizations.
398
399         --enable-llvm
400
401                 This enables the use of LLVM as a code generation engine
402                 for Mono.  The LLVM code generator and optimizer will be 
403                 used instead of Mono's built-in code generator for both
404                 Just in Time and Ahead of Time compilations.
405
406                 See the http://www.mono-project.com/Mono_LLVM for the 
407                 full details and up-to-date information on this feature.
408
409                 You will need to have an LLVM built that Mono can link
410                 against
411
412         --enable-big-arrays
413
414                 This enables the use arrays whose indexes are larger
415                 than Int32.MaxValue.   
416
417                 By default Mono has the same limitation as .NET on
418                 Win32 and Win64 and limits array indexes to 32-bit
419                 values (even on 64-bit systems).
420
421                 In certain scenarios where large arrays are required,
422                 you can pass this flag and Mono will be built to
423                 support 64-bit arrays.
424
425                 This is not the default as it breaks the C embedding
426                 ABI that we have exposed through the Mono development
427                 cycle.
428
429         --enable-parallel-mark
430
431                 Use this option to enable the garbage collector to use
432                 multiple CPUs to do its work.  This helps performance
433                 on multi-CPU machines as the work is divided across CPUS.
434
435                 This option is not currently the default as we have
436                 not done much testing with Mono.
437
438         --enable-dtrace
439
440                 On Solaris and MacOS X builds a version of the Mono
441                 runtime that contains DTrace probes and can
442                 participate in the system profiling using DTrace.
443
444
445         --disable-dev-random
446
447                 Mono uses /dev/random to obtain good random data for
448                 any source that requires random numbers.   If your
449                 system does not support this, you might want to
450                 disable it.
451
452                 There are a number of runtime options to control this
453                 also, see the man page.
454
455
456 2. Using Mono
457 =============
458
459         Once you have installed the software, you can run a few programs:
460
461         * runtime engine
462
463                 mono program.exe
464
465         * C# compiler
466
467                 mcs program.cs
468
469         * CIL Disassembler
470
471                 monodis program.exe
472
473         See the man pages for mono(1), mint(1), monodis(1) and mcs(2)
474         for further details.
475
476 3. Directory Roadmap
477 ====================
478
479         docs/
480                 Technical documents about the Mono runtime.
481
482         data/
483                 Configuration files installed as part of the Mono runtime.
484
485         mono/
486                 The core of the Mono Runtime.
487
488                 metadata/
489                         The object system and metadata reader.
490
491                 mini/
492                         The Just in Time Compiler.
493
494                 dis/
495                         CIL executable Disassembler
496
497                 cli/
498                         Common code for the JIT and the interpreter.
499
500                 io-layer/
501                         The I/O layer and system abstraction for 
502                         emulating the .NET IO model.
503
504                 cil/
505                         Common Intermediate Representation, XML
506                         definition of the CIL bytecodes.
507
508                 interp/
509                         Interpreter for CLI executables (obsolete).
510
511                 arch/
512                         Architecture specific portions.
513
514         man/
515
516                 Manual pages for the various Mono commands and programs.
517
518         samples/
519
520                 Some simple sample programs on uses of the Mono
521                 runtime as an embedded library.   
522
523         scripts/
524
525                 Scripts used to invoke Mono and the corresponding program.
526
527         runtime/
528
529                 A directory that contains the Makefiles that link the
530                 mono/ and mcs/ build systems.
531
532         ../olive/
533
534                 If the directory ../olive is present (as an
535                 independent checkout) from the Mono module, that
536                 directory is automatically configured to share the
537                 same prefix than this module gets.
538