[xbuild] Throw ArgumentNullException if target name is null
[mono.git] / man / mono.1
1 .\" 
2 .\" mono manual page.
3 .\" Copyright 2003 Ximian, Inc. 
4 .\" Copyright 2004-2011 Novell, Inc. 
5 .\" Author:
6 .\"   Miguel de Icaza (miguel@gnu.org)
7 .\"
8 .TH Mono "Mono 2.11"
9 .SH NAME
10 mono \- Mono's ECMA-CLI native code generator (Just-in-Time and Ahead-of-Time)
11 .SH SYNOPSIS
12 .PP
13 .B mono [options] file [arguments...]
14 .PP
15 .B mono-sgen [options] file [arguments...]
16 .SH DESCRIPTION
17 \fImono\fP is a runtime implementation of the ECMA Common Language
18 Infrastructure.  This can be used to run ECMA and .NET applications.
19 .PP
20 The runtime contains a native code generator that transforms the
21 Common Intermediate Language into native code.
22 .PP
23 The code generator can operate in two modes: just in time compilation
24 (JIT) or ahead of time compilation (AOT).  Since code can be
25 dynamically loaded, the runtime environment and the JIT are always
26 present, even if code is compiled ahead of time.
27 .PP
28 The runtime loads the specified
29 .I file
30 and optionally passes
31 the
32 .I arguments
33 to it.  The 
34 .I file
35 is an ECMA assembly.  They typically have a .exe or .dll extension.
36 .PP
37 The runtime provides a number of configuration options for running
38 applications, for developing and debugging, and for testing and
39 debugging the runtime itself.
40 .PP
41 The \fImono\fP command uses the Boehm conservative garbage collector
42 while the \fImono-sgen\fP command uses a moving and generational
43 garbage collector.
44 .SH PORTABILITY
45 On Unix-based systems, Mono provides a mechanism to emulate the 
46 Windows-style file access, this includes providing a case insensitive
47 view of the file system, directory separator mapping (from \\ to /) and
48 stripping the drive letters.
49 .PP
50 This functionality is enabled by setting the 
51 .B MONO_IOMAP 
52 environment variable to one of 
53 .B all, drive
54 and 
55 .B case.
56 .PP
57 See the description for 
58 .B MONO_IOMAP
59 in the environment variables section for more details.
60 .SH RUNTIME OPTIONS
61 The following options are available:
62 .TP
63 \fB--aot\fR, \fB--aot[=options]\fR
64 This option is used to precompile the CIL code in the specified
65 assembly to native code.  The generated code is stored in a file with
66 the extension .so.  This file will be automatically picked up by the
67 runtime when the assembly is executed.  
68 .Sp 
69 Ahead-of-Time compilation is most useful if you use it in combination
70 with the -O=all,-shared flag which enables all of the optimizations in
71 the code generator to be performed.  Some of those optimizations are
72 not practical for Just-in-Time compilation since they might be very
73 time consuming.
74 .Sp
75 Unlike the .NET Framework, Ahead-of-Time compilation will not generate
76 domain independent code: it generates the same code that the
77 Just-in-Time compiler would produce.   Since most applications use a
78 single domain, this is fine.   If you want to optimize the generated
79 code for use in multi-domain applications, consider using the
80 -O=shared flag.
81 .Sp
82 This pre-compiles the methods, but the original assembly is still
83 required to execute as this one contains the metadata and exception
84 information which is not available on the generated file.  When
85 precompiling code, you might want to compile with all optimizations
86 (-O=all).  Pre-compiled code is position independent code.
87 .Sp
88 Pre compilation is just a mechanism to reduce startup time, increase
89 code sharing across multiple mono processes and avoid just-in-time
90 compilation program startup costs.  The original assembly must still
91 be present, as the metadata is contained there.
92 .Sp
93 AOT code typically can not be moved from one computer to another
94 (CPU-specific optimizations that are detected at runtime) so you
95 should not try to move the pre-generated assemblies or package the
96 pre-generated assemblies for deployment.    
97 .Sp
98 A few options are available as a parameter to the 
99 .B --aot 
100 command line option.   The options are separated by commas, and more
101 than one can be specified:
102 .RS
103 .ne 8
104 .TP
105 .I bind-to-runtime-version
106 .Sp
107 If specified, forces the generated AOT files to be bound to the
108 runtime version of the compiling Mono.   This will prevent the AOT
109 files from being consumed by a different Mono runtime.
110 .I full
111 This is currently an experimental feature as it is not complete.
112 This instructs Mono to precompile code that has historically not been
113 precompiled with AOT.   
114 .TP
115 .I outfile=[filename]
116 Instructs the AOT compiler to save the output to the specified file.
117 .TP
118 .I write-symbols
119 Instructs the AOT compiler to emit debug symbol information.
120 .TP
121 .I save-temps,keep-temps
122 Instructs the AOT compiler to keep temporary files.
123 .TP
124 .I threads=[number]
125 This is an experimental option for the AOT compiler to use multiple threads
126 when compiling the methods.
127 .TP
128 .I nodebug
129 Instructs the AOT compiler to not output any debugging information.
130 .TP
131 .I ntrampolines=[number]
132 When compiling in full aot mode, the method trampolines must be precreated
133 in the AOT image.  You can add additional method trampolines with this argument.
134 Defaults to 1024.
135 .TP
136 .I nrgctx-trampolines=[number]
137 When compiling in full aot mode, the generic sharing trampolines must be precreated
138 in the AOT image.  You can add additional method trampolines with this argument.
139 Defaults to 1024.
140 .TP
141 .I nimt-trampolines=[number]
142 When compiling in full aot mode, the IMT trampolines must be precreated
143 in the AOT image.  You can add additional method trampolines with this argument.
144 Defaults to 128.
145 .TP
146 .I print-skipped-methods
147 If the AOT compiler cannot compile a method for any reason, enabling this flag
148 will output the skipped methods to the console.
149 .TP
150 .I autoreg
151 The AOT compiler will emit a (ELF only) library initializer to automatically
152 register the aot compiled module with the runtime.  This is only useful in static
153 mode
154 .TP
155 .I asmonly
156 Instructs the AOT compiler to output assembly code instead of an object file.
157 .TP
158 .I soft-debug
159 This instructs the compiler to generate sequence point checks that
160 allow Mono's soft debugger to debug applications even on systems where
161 it is not possible to set breakpoints or to single step (certain
162 hardware configurations like the cell phones and video gaming
163 consoles). 
164 .TP
165 .I static
166 Create an ELF object file (.o) or .s file which can be statically linked into an
167 executable when embedding the mono runtime. When this option is used, the object file
168 needs to be registered with the embedded runtime using the mono_aot_register_module
169 function which takes as its argument the mono_aot_module_<ASSEMBLY NAME>_info global
170 symbol from the object file:
171
172 .nf
173 extern void *mono_aot_module_hello_info;
174
175 mono_aot_register_module (mono_aot_module_hello_info);
176 .fi
177 .ne
178 .TP
179 .I mtriple=<TRIPLE>
180 Use the GNU style target triple <TRIPLE> to determine some code generation options, i.e.
181 --mtriple=armv7-linux-gnueabi will generate code that targets ARMv7. This is currently
182 only supported by the ARM backend. In LLVM mode, this triple is passed on to the LLVM
183 llc compiler.
184 .TP
185 .I tool-prefix=<PREFIX>
186 Prepends <PREFIX> to the name of tools ran by the AOT compiler, i.e. 'as'/'ld'. For
187 example, --tool=prefix=arm-linux-gnueabi- will make the AOT compiler run
188 'arm-linux-gnueabi-as' instead of 'as'.
189 .TP
190 .I llvm-path=<PREFIX>
191 Same for the llvm tools 'opt' and 'llc'.
192 .TP
193 .I stats
194 Print various stats collected during AOT compilation.
195
196 .PP
197 For more information about AOT, see: http://www.mono-project.com/AOT
198 .RE
199 .TP
200 \fB--attach=[options]\fR
201 Currently the only option supported by this command line argument is
202 \fBdisable\fR which disables the attach functionality.
203 .TP
204 \fB--config filename\fR
205 Load the specified configuration file instead of the default one(s).
206 The default files are /etc/mono/config and ~/.mono/config or the file
207 specified in the MONO_CONFIG environment variable, if set.  See the
208 mono-config(5) man page for details on the format of this file.
209 .TP
210 \fB--debugger-agent=[options]\fR 
211 This instructs the Mono runtime to
212 start a debugging agent inside the Mono runtime and connect it to a
213 client user interface will control the Mono process.
214 This option is typically used by IDEs, like the MonoDevelop IDE.
215 .PP
216 The
217 configuration is specified using one of more of the following options:
218 .RS
219 .ne 8
220 .TP
221 .I transport=transport_name
222 .Sp
223 This is used to specify the transport that the debugger will use to
224 communicate.   It must be specified and currently requires this to
225 be 'dt_socket'. 
226 .TP
227 .I address=host:port
228 .Sp
229 Use this option to specify the IP address where your debugger client is
230 listening to.
231 .TP
232 .I loglevel=LEVEL
233 .Sp
234 Specifies the diagnostics log level for 
235 .TP
236 .I logfile=filename
237 .Sp
238 Used to specify the file where the log will be stored, it defaults to
239 standard output.
240 .TP
241 .I server=[y/n]
242 Defaults to no, with the default option Mono will actively connect to the
243 host/port configured with the \fBaddress\fR option.  If you set it to 'y', it 
244 instructs the Mono runtime to start debugging in server mode, where Mono
245 actively waits for the debugger front end to connect to the Mono process.  
246 Mono will print out to stdout the IP address and port where it is listening.
247 .TP
248 .I suspend=[y/n]
249 Defaults to yes, with the default option Mono will suspend the vm on startup 
250 until it connects successfully to a debugger front end.  If you set it to 'n', in 
251 conjunction with \fBserver=y\fR, it instructs the Mono runtime to run as normal, 
252 while caching metadata to send to the debugger front end on connection.
253 .ne
254 .RE
255 .TP
256 \fB--desktop\fR
257 Configures the virtual machine to be better suited for desktop
258 applications.  Currently this sets the GC system to avoid expanding
259 the heap as much as possible at the expense of slowing down garbage
260 collection a bit.
261 .TP
262 \fB--full-aot\fR
263 This is an experimental flag that instructs the Mono runtime to not
264 generate any code at runtime and depend exclusively on the code
265 generated from using mono --aot=full previously.   This is useful for
266 platforms that do not permit dynamic code generation.
267 .Sp
268 Notice that this feature will abort execution at runtime if a codepath
269 in your program, or Mono's class libraries attempts to generate code
270 dynamically.  You should test your software upfront and make sure that
271 you do not use any dynamic features.
272 .TP
273 \fB--gc=boehm\fR, \fB--gc=sgen\fR
274 Selects the Garbage Collector engine for Mono to use, Boehm or SGen.
275 Currently this merely ensures that you are running either the
276 \fImono\fR or \fImono-sgen\fR commands.    This flag can be set in the
277 \fBMONO_ENV_OPTIONS\fR environment variable to force all of your child
278 processes to use one particular kind of GC with the Mono runtime.
279 .TP
280 \fB--help\fR, \fB-h\fR
281 Displays usage instructions.
282 .TP
283 \fB--llvm\fR
284 If the Mono runtime has been compiled with LLVM support (not available
285 in all configurations), Mono will use the LLVM optimization and code
286 generation engine to JIT or AOT compile.     
287 .Sp
288 For more information, consult: http://www.mono-project.com/Mono_LLVM
289 .TP
290 \fB--nollvm\fR
291 When using a Mono that has been compiled with LLVM support, it forces
292 Mono to fallback to its JIT engine and not use the LLVM backend.
293 .TP
294 \fB--optimize=MODE\fR, \fB-O=MODE\fR
295 MODE is a comma separated list of optimizations.  They also allow
296 optimizations to be turned off by prefixing the optimization name with
297 a minus sign.
298 .Sp
299 In general, Mono has been tuned to use the default set of flags,
300 before using these flags for a deployment setting, you might want to
301 actually measure the benefits of using them.    
302 .Sp
303 The following optimizations are implemented:
304 .nf
305              all        Turn on all optimizations
306              peephole   Peephole postpass
307              branch     Branch optimizations
308              inline     Inline method calls
309              cfold      Constant folding
310              consprop   Constant propagation
311              copyprop   Copy propagation
312              deadce     Dead code elimination
313              linears    Linear scan global reg allocation
314              cmov       Conditional moves [arch-dependency]
315              shared     Emit per-domain code
316              sched      Instruction scheduling
317              intrins    Intrinsic method implementations
318              tailc      Tail recursion and tail calls
319              loop       Loop related optimizations
320              fcmov      Fast x86 FP compares [arch-dependency]
321              leaf       Leaf procedures optimizations
322              aot        Usage of Ahead Of Time compiled code
323              precomp    Precompile all methods before executing Main
324              abcrem     Array bound checks removal
325              ssapre     SSA based Partial Redundancy Elimination
326              sse2       SSE2 instructions on x86 [arch-dependency]
327              gshared    Enable generic code sharing.
328 .fi
329 .Sp
330 For example, to enable all the optimization but dead code
331 elimination and inlining, you can use:
332 .nf
333         -O=all,-deadce,-inline
334 .fi
335 .Sp
336 The flags that are flagged with [arch-dependency] indicate that the
337 given option if used in combination with Ahead of Time compilation
338 (--aot flag) would produce pre-compiled code that will depend on the
339 current CPU and might not be safely moved to another computer. 
340 .TP
341 \fB--runtime=VERSION\fR
342 Mono supports different runtime versions. The version used depends on the program
343 that is being run or on its configuration file (named program.exe.config). This option
344 can be used to override such autodetection, by forcing a different runtime version
345 to be used. Note that this should only be used to select a later compatible runtime
346 version than the one the program was compiled against. A typical usage is for
347 running a 1.1 program on a 2.0 version:
348 .nf
349          mono --runtime=v2.0.50727 program.exe
350 .fi
351 .TP
352 \fB--security\fR, \fB--security=mode\fR
353 Activate the security manager, a currently experimental feature in
354 Mono and it is OFF by default. The new code verifier can be enabled
355 with this option as well.
356 .RS
357 .ne 8
358 .PP
359 Using security without parameters is equivalent as calling it with the
360 "cas" parameter.  
361 .PP
362 The following modes are supported:
363 .TP
364 .I cas
365 This allows mono to support declarative security attributes,
366 e.g. execution of Code Access Security (CAS) or non-CAS demands.
367 .TP 
368 .I core-clr
369 Enables the core-clr security system, typically used for
370 Moonlight/Silverlight applications.  It provides a much simpler
371 security system than CAS, see http://www.mono-project.com/Moonlight
372 for more details and links to the descriptions of this new system. 
373 .TP
374 .I validil
375 Enables the new verifier and performs basic verification for code
376 validity.  In this mode, unsafe code and P/Invoke are allowed. This
377 mode provides a better safety guarantee but it is still possible
378 for managed code to crash Mono. 
379 .TP
380 .I verifiable
381 Enables the new verifier and performs full verification of the code
382 being executed.  It only allows verifiable code to be executed.
383 Unsafe code is not allowed but P/Invoke is.  This mode should
384 not allow managed code to crash mono.  The verification is not as
385 strict as ECMA 335 standard in order to stay compatible with the MS
386 runtime.
387 .PP
388 The security system acts on user code: code contained in mscorlib or
389 the global assembly cache is always trusted.
390 .ne
391 .RE
392 .TP
393 \fB--server\fR
394 Configures the virtual machine to be better suited for server
395 operations (currently, a no-op).
396 .TP
397 \fB--verify-all\fR 
398 Verifies mscorlib and assemblies in the global
399 assembly cache for valid IL, and all user code for IL
400 verifiability. 
401
402 This is different from \fB--security\fR's verifiable
403 or validil in that these options only check user code and skip
404 mscorlib and assemblies located on the global assembly cache.
405 .TP
406 \fB-V\fR, \fB--version\fR
407 Prints JIT version information (system configuration, release number
408 and branch names if available). 
409
410
411 .SH DEVELOPMENT OPTIONS
412 The following options are used to help when developing a JITed application.
413 .TP
414 \fB--debug\fR, \fB--debug=OPTIONS\fR
415 Turns on the debugging mode in the runtime.  If an assembly was
416 compiled with debugging information, it will produce line number
417 information for stack traces. 
418 .RS
419 .ne 8
420 .PP
421 The optional OPTIONS argument is a comma separated list of debugging
422 options.  These options are turned off by default since they generate
423 much larger and slower code at runtime.
424 .TP
425 The following options are supported:
426 .TP
427 .I casts
428 Produces a detailed error when throwing a InvalidCastException.   This
429 option needs to be enabled as this generates more verbose code at
430 execution time. 
431 .TP
432 .I mdb-optimizations
433 Disable some JIT optimizations which are usually only disabled when
434 running inside the debugger.  This can be helpful if you want to attach
435 to the running process with mdb.
436 .TP
437 .I gdb
438 Generate and register debugging information with gdb. This is only supported on some
439 platforms, and only when using gdb 7.0 or later.
440 .ne
441 .RE
442 .TP
443 \fB--profile[=profiler[:profiler_args]]\fR
444 Turns on profiling.  For more information about profiling applications
445 and code coverage see the sections "PROFILING" and "CODE COVERAGE"
446 below. 
447 .TP
448 This option can be used multiple times, each time will load an
449 additional profiler.   This allows developers to use modules that
450 extend the JIT through the Mono profiling interface.
451 .TP
452 \fB--trace[=expression]\fR
453 Shows method names as they are invoked.  By default all methods are
454 traced. 
455 .Sp
456 The trace can be customized to include or exclude methods, classes or
457 assemblies.  A trace expression is a comma separated list of targets,
458 each target can be prefixed with a minus sign to turn off a particular
459 target.  The words `program', `all' and `disabled' have special
460 meaning.  `program' refers to the main program being executed, and
461 `all' means all the method calls.
462 .Sp
463 The `disabled' option is used to start up with tracing disabled.  It
464 can be enabled at a later point in time in the program by sending the
465 SIGUSR2 signal to the runtime.
466 .Sp
467 Assemblies are specified by their name, for example, to trace all
468 calls in the System assembly, use:
469 .nf
470
471         mono --trace=System app.exe
472
473 .fi
474 Classes are specified with the T: prefix.  For example, to trace all
475 calls to the System.String class, use:
476 .nf
477
478         mono --trace=T:System.String app.exe
479
480 .fi
481 And individual methods are referenced with the M: prefix, and the
482 standard method notation:
483 .nf
484
485         mono --trace=M:System.Console:WriteLine app.exe
486
487 .fi
488 Exceptions can also be traced, it will cause a stack trace to be
489 printed every time an exception of the specified type is thrown.
490 The exception type can be specified with or without the namespace,
491 and to trace all exceptions, specify 'all' as the type name.
492 .nf
493
494         mono --trace=E:System.Exception app.exe
495
496 .fi
497 As previously noted, various rules can be specified at once:
498 .nf
499
500         mono --trace=T:System.String,T:System.Random app.exe
501
502 .fi
503 You can exclude pieces, the next example traces calls to
504 System.String except for the System.String:Concat method.
505 .nf
506
507         mono --trace=T:System.String,-M:System.String:Concat
508
509 .fi
510 Finally, namespaces can be specified using the N: prefix:
511 .nf
512
513         mono --trace=N:System.Xml
514
515 .fi
516 .TP
517 \fB--no-x86-stack-align\fR
518 Don't align stack frames on the x86 architecture.  By default, Mono
519 aligns stack frames to 16 bytes on x86, so that local floating point
520 and SIMD variables can be properly aligned.  This option turns off the
521 alignment, which usually saves one intruction per call, but might
522 result in significantly lower floating point and SIMD performance.
523 .TP
524 \fB--jitmap\fR
525 Generate a JIT method map in a /tmp/perf-PID.map file. This file is then
526 used, for example, by the perf tool included in recent Linux kernels.
527 Each line in the file has:
528 .nf
529
530         HEXADDR HEXSIZE methodname
531
532 .fi
533 Currently this option is only supported on Linux.
534 .SH JIT MAINTAINER OPTIONS
535 The maintainer options are only used by those developing the runtime
536 itself, and not typically of interest to runtime users or developers.
537 .TP
538 \fB--break method\fR
539 Inserts a breakpoint before the method whose name is `method'
540 (namespace.class:methodname).  Use `Main' as method name to insert a
541 breakpoint on the application's main method.
542 .TP
543 \fB--breakonex\fR
544 Inserts a breakpoint on exceptions.  This allows you to debug your
545 application with a native debugger when an exception is thrown.
546 .TP
547 \fB--compile name\fR
548 This compiles a method (namespace.name:methodname), this is used for
549 testing the compiler performance or to examine the output of the code
550 generator. 
551 .TP
552 \fB--compileall\fR
553 Compiles all the methods in an assembly.  This is used to test the
554 compiler performance or to examine the output of the code generator
555 .TP 
556 \fB--graph=TYPE METHOD\fR
557 This generates a postscript file with a graph with the details about
558 the specified method (namespace.name:methodname).  This requires `dot'
559 and ghostview to be installed (it expects Ghostview to be called
560 "gv"). 
561 .Sp
562 The following graphs are available:
563 .nf
564           cfg        Control Flow Graph (CFG)
565           dtree      Dominator Tree
566           code       CFG showing code
567           ssa        CFG showing code after SSA translation
568           optcode    CFG showing code after IR optimizations
569 .fi
570 .Sp
571 Some graphs will only be available if certain optimizations are turned
572 on.
573 .TP
574 \fB--ncompile\fR
575 Instruct the runtime on the number of times that the method specified
576 by --compile (or all the methods if --compileall is used) to be
577 compiled.  This is used for testing the code generator performance. 
578 .TP 
579 \fB--stats\fR
580 Displays information about the work done by the runtime during the
581 execution of an application. 
582 .TP
583 \fB--wapi=hps|semdel\fR
584 Perform maintenance of the process shared data.
585 .Sp
586 semdel will delete the global semaphore.
587 .Sp
588 hps will list the currently used handles.
589 .TP
590 \fB-v\fR, \fB--verbose\fR
591 Increases the verbosity level, each time it is listed, increases the
592 verbosity level to include more information (including, for example, 
593 a disassembly of the native code produced, code selector info etc.).
594 .SH ATTACH SUPPORT
595 The Mono runtime allows external processes to attach to a running
596 process and load assemblies into the running program.   To attach to
597 the process, a special protocol is implemented in the Mono.Management
598 assembly. 
599 .PP
600 With this support it is possible to load assemblies that have an entry
601 point (they are created with -target:exe or -target:winexe) to be
602 loaded and executed in the Mono process.
603 .PP
604 The code is loaded into the root domain, and it starts execution on
605 the special runtime attach thread.    The attached program should
606 create its own threads and return after invocation.
607 .PP
608 This support allows for example debugging applications by having the
609 csharp shell attach to running processes.
610 .SH PROFILING
611 The mono runtime includes a profiler that can be used to explore
612 various performance related problems in your application.  The
613 profiler is activated by passing the --profile command line argument
614 to the Mono runtime, the format is:
615 .nf
616
617         --profile[=profiler[:profiler_args]]
618
619 .fi
620 Mono has a built-in profiler called 'default' (and is also the default
621 if no arguments are specified), but developers can write custom
622 profilers, see the section "CUSTOM PROFILERS" for more details.
623 .PP
624 If a 
625 .I profiler 
626 is not specified, the default profiler is used.
627 .Sp
628 The 
629 .I profiler_args 
630 is a profiler-specific string of options for the profiler itself.
631 .Sp
632 The default profiler accepts the following options 'alloc' to profile
633 memory consumption by the application; 'time' to profile the time
634 spent on each routine; 'jit' to collect time spent JIT-compiling methods
635 and 'stat' to perform sample statistical profiling.
636 If no options are provided the default is 'alloc,time,jit'. 
637 .PP
638 By default the
639 profile data is printed to stdout: to change this, use the 'file=filename'
640 option to output the data to filename.
641 .Sp
642 For example:
643 .nf
644
645         mono --profile program.exe
646
647 .fi
648 .Sp
649 That will run the program with the default profiler and will do time
650 and allocation profiling.
651 .Sp
652 .nf
653
654         mono --profile=default:stat,alloc,file=prof.out program.exe
655
656 .fi
657 Will do  sample statistical profiling and allocation profiling on
658 program.exe. The profile data is put in prof.out.
659 .Sp
660 Note that the statistical profiler has a very low overhead and should
661 be the preferred profiler to use (for better output use the full path
662 to the mono binary when running and make sure you have installed the
663 addr2line utility that comes from the binutils package).
664 .SH LOG PROFILER
665 This is the most advanced profiler.   
666 .PP
667 The Mono \f[I]log\f[] profiler can be used to collect a lot of
668 information about a program running in the Mono runtime.
669 This data can be used (both while the process is running and later)
670 to do analyses of the program behaviour, determine resource usage,
671 performance issues or even look for particular execution patterns.
672 .PP
673 This is accomplished by logging the events provided by the Mono
674 runtime through the profiling interface and periodically writing
675 them to a file which can be later inspected with the mprof-report(1)
676 tool. 
677 .PP
678 More information about how to use the log profiler is available on the
679 mprof-report(1) page. 
680 .SH CUSTOM PROFILERS
681 Mono provides a mechanism for loading other profiling modules which in
682 the form of shared libraries.  These profiling modules can hook up to
683 various parts of the Mono runtime to gather information about the code
684 being executed.
685 .PP
686 To use a third party profiler you must pass the name of the profiler
687 to Mono, like this:
688 .nf
689
690         mono --profile=custom program.exe
691
692 .fi
693 .PP
694 In the above sample Mono will load the user defined profiler from the
695 shared library `mono-profiler-custom.so'.  This profiler module must
696 be on your dynamic linker library path.
697 .PP 
698 A list of other third party profilers is available from Mono's web
699 site (www.mono-project.com/Performance_Tips)
700 .PP
701 Custom profiles are written as shared libraries.  The shared library
702 must be called `mono-profiler-NAME.so' where `NAME' is the name of
703 your profiler.
704 .PP
705 For a sample of how to write your own custom profiler look in the
706 Mono source tree for in the samples/profiler.c.
707 .SH CODE COVERAGE
708 Mono ships with a code coverage module.  This module is activated by
709 using the Mono --profile=cov option.  The format is:
710 \fB--profile=cov[:assembly-name[/namespace]] test-suite.exe\fR
711 .PP
712 By default code coverage will default to all the assemblies loaded,
713 you can limit this by specifying the assembly name, for example to
714 perform code coverage in the routines of your program use, for example
715 the following command line limits the code coverage to routines in the
716 "demo" assembly:
717 .nf
718
719         mono --profile=cov:demo demo.exe
720
721 .fi
722 .PP
723 Notice that the 
724 .I assembly-name
725 does not include the extension.
726 .PP
727 You can further restrict the code coverage output by specifying a
728 namespace:
729 .nf
730
731         mono --profile=cov:demo/My.Utilities demo.exe
732
733 .fi
734 .PP
735 Which will only perform code coverage in the given assembly and
736 namespace.  
737 .PP
738 Typical output looks like this:
739 .nf
740
741         Not covered: Class:.ctor ()
742         Not covered: Class:A ()
743         Not covered: Driver:.ctor ()
744         Not covered: Driver:method ()
745         Partial coverage: Driver:Main ()
746                 offset 0x000a
747
748 .fi
749 .PP
750 The offsets displayed are IL offsets.
751 .PP
752 A more powerful coverage tool is available in the module `monocov'.
753 See the monocov(1) man page for details.
754 .SH DEBUGGING AIDS
755 To debug managed applications, you can use the 
756 .B mdb
757 command, a command line debugger.  
758 .PP
759 It is possible to obtain a stack trace of all the active threads in
760 Mono by sending the QUIT signal to Mono, you can do this from the
761 command line, like this:
762 .nf
763
764         kill -QUIT pid
765
766 .fi
767 Where pid is the Process ID of the Mono process you want to examine.
768 The process will continue running afterwards, but its state is not
769 guaranteed.
770 .PP
771 .B Important:
772 this is a last-resort mechanism for debugging applications and should
773 not be used to monitor or probe a production application.  The
774 integrity of the runtime after sending this signal is not guaranteed
775 and the application might crash or terminate at any given point
776 afterwards.   
777 .PP
778 The \fB--debug=casts\fR option can be used to get more detailed
779 information for Invalid Cast operations, it will provide information
780 about the types involved.   
781 .PP
782 You can use the MONO_LOG_LEVEL and MONO_LOG_MASK environment variables
783 to get verbose debugging output about the execution of your
784 application within Mono.
785 .PP
786 The 
787 .I MONO_LOG_LEVEL
788 environment variable if set, the logging level is changed to the set
789 value. Possible values are "error", "critical", "warning", "message",
790 "info", "debug". The default value is "error". Messages with a logging
791 level greater then or equal to the log level will be printed to
792 stdout/stderr.
793 .PP
794 Use "info" to track the dynamic loading of assemblies.
795 .PP
796 .PP
797 Use the 
798 .I MONO_LOG_MASK
799 environment variable to limit the extent of the messages you get: 
800 If set, the log mask is changed to the set value. Possible values are
801 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
802 (garbage collector), "cfg" (config file loader), "aot" (precompiler),
803 "security" (e.g. Moonlight CoreCLR support) and "all". 
804 The default value is "all". Changing the mask value allows you to display only 
805 messages for a certain component. You can use multiple masks by comma 
806 separating them. For example to see config file messages and assembly loader
807 messages set you mask to "asm,cfg".
808 .PP
809 The following is a common use to track down problems with P/Invoke:
810 .nf
811
812         $ MONO_LOG_LEVEL="debug" MONO_LOG_MASK="dll" mono glue.exe
813
814 .fi
815 .PP
816 .SH SERIALIZATION
817 Mono's XML serialization engine by default will use a reflection-based
818 approach to serialize which might be slow for continuous processing
819 (web service applications).  The serialization engine will determine
820 when a class must use a hand-tuned serializer based on a few
821 parameters and if needed it will produce a customized C# serializer
822 for your types at runtime.  This customized serializer then gets
823 dynamically loaded into your application.
824 .PP
825 You can control this with the MONO_XMLSERIALIZER_THS environment
826 variable.
827 .PP
828 The possible values are 
829 .B `no' 
830 to disable the use of a C# customized
831 serializer, or an integer that is the minimum number of uses before
832 the runtime will produce a custom serializer (0 will produce a
833 custom serializer on the first access, 50 will produce a serializer on
834 the 50th use). Mono will fallback to an interpreted serializer if the
835 serializer generation somehow fails. This behavior can be disabled
836 by setting the option
837 .B `nofallback'
838 (for example: MONO_XMLSERIALIZER_THS=0,nofallback).
839 .SH ENVIRONMENT VARIABLES
840 .TP
841 \fBGC_DONT_GC\fR
842 Turns off the garbage collection in Mono.  This should be only used
843 for debugging purposes
844 .TP
845 \fBLVM_COUNT\fR
846 When Mono is compiled with LLVM support, this instructs the runtime to
847 stop using LLVM after the specified number of methods are JITed.
848 This is a tool used in diagnostics to help isolate problems in the
849 code generation backend.   For example \fBLLVM_COUNT=10\fR would only
850 compile 10 methods with LLVM and then switch to the Mono JIT engine.
851 \fBLLVM_COUNT=0\fR would disable the LLVM engine altogether.
852 .TP
853 \fBMONO_AOT_CACHE\fR
854 If set, this variable will instruct Mono to ahead-of-time compile new
855 assemblies on demand and store the result into a cache in
856 ~/.mono/aot-cache. 
857 .TP
858 \fBMONO_ASPNET_INHIBIT_SETTINGSMAP\fR
859 Mono contains a feature which allows modifying settings in the .config files shipped
860 with Mono by using config section mappers. The mappers and the mapping rules are
861 defined in the $prefix/etc/mono/2.0/settings.map file and, optionally, in the
862 settings.map file found in the top-level directory of your ASP.NET application.
863 Both files are read by System.Web on application startup, if they are found at the
864 above locations. If you don't want the mapping to be performed you can set this
865 variable in your environment before starting the application and no action will
866 be taken.
867 .TP
868 \fBMONO_CFG_DIR\fR
869 If set, this variable overrides the default system configuration directory
870 ($PREFIX/etc). It's used to locate machine.config file.
871 .TP
872 \fBMONO_COM\fR
873 Sets the style of COM interop.  If the value of this variable is "MS"
874 Mono will use string marhsalling routines from the liboleaut32 for the
875 BSTR type library, any other values will use the mono-builtin BSTR
876 string marshalling.
877 .TP
878 \fBMONO_CONFIG\fR
879 If set, this variable overrides the default runtime configuration file
880 ($PREFIX/etc/mono/config). The --config command line options overrides the
881 environment variable.
882 .TP
883 \fBMONO_CPU_ARCH\fR
884 Override the automatic cpu detection mechanism. Currently used only on arm.
885 The format of the value is as follows:
886 .nf
887
888         "armvV [thumb]"
889
890 .fi
891 where V is the architecture number 4, 5, 6, 7 and the options can be currently be
892 "thunb". Example:
893 .nf
894
895         MONO_CPU_ARCH="armv4 thumb" mono ...
896
897 .fi
898 .TP
899 \fBMONO_DISABLE_AIO\fR
900 If set, tells mono NOT to attempt using native asynchronous I/O services. In
901 that case, a default select/poll implementation is used. Currently only epoll()
902 is supported.
903 .TP
904 \fBMONO_DISABLE_MANAGED_COLLATION\fR
905 If this environment variable is `yes', the runtime uses unmanaged
906 collation (which actually means no culture-sensitive collation). It
907 internally disables managed collation functionality invoked via the
908 members of System.Globalization.CompareInfo class. Collation is
909 enabled by default.
910 .TP
911 \fBMONO_DISABLE_SHM\fR
912 Unix only: If set, disables the shared memory files used for
913 cross-process handles: process have only private handles.  This means
914 that process and thread handles are not available to other processes,
915 and named mutexes, named events and named semaphores are not visible
916 between processes.
917 .Sp
918 This is can also be enabled by default by passing the
919 "--disable-shared-handles" option to configure.
920 .Sp
921 This is the default from mono 2.8 onwards.
922 .TP
923 \fBMONO_EGD_SOCKET\fR
924 For platforms that do not otherwise have a way of obtaining random bytes
925 this can be set to the name of a file system socket on which an egd or
926 prngd daemon is listening.
927 .TP
928 \fBMONO_ENABLE_SHM\fR
929 Unix only: Enable support for cross-process handles.  Cross-process
930 handles are used to expose process handles, thread handles, named
931 mutexes, named events and named semaphores across Unix processes.
932 .TP
933 \fBMONO_ENV_OPTIONS\fR
934 This environment variable allows you to pass command line arguments to
935 a Mono process through the environment.   This is useful for example
936 to force all of your Mono processes to use LLVM or SGEN without having
937 to modify any launch scripts.
938 .TP
939 \fBMONO_EVENTLOG_TYPE\fR
940 Sets the type of event log provider to use (for System.Diagnostics.EventLog).
941 .Sp
942 Possible values are:
943 .RS
944 .TP
945 .I "local[:path]"
946 .Sp
947 Persists event logs and entries to the local file system.
948 .Sp
949 The directory in which to persist the event logs, event sources and entries
950 can be specified as part of the value.
951 .Sp
952 If the path is not explicitly set, it defaults to "/var/lib/mono/eventlog"
953 on unix and "%APPDATA%\mono\eventlog" on Windows.
954 .TP
955 .I "win32"
956 .Sp
957 .B 
958 Uses the native win32 API to write events and registers event logs and
959 event sources in the registry.   This is only available on Windows. 
960 .Sp
961 On Unix, the directory permission for individual event log and event source
962 directories is set to 777 (with +t bit) allowing everyone to read and write
963 event log entries while only allowing entries to be deleted by the user(s)
964 that created them.
965 .TP
966 .I "null"
967 .Sp
968 Silently discards any events.
969 .ne
970 .PP
971 The default is "null" on Unix (and versions of Windows before NT), and 
972 "win32" on Windows NT (and higher).
973 .RE
974 .TP
975 \fBMONO_EXTERNAL_ENCODINGS\fR
976 If set, contains a colon-separated list of text encodings to try when
977 turning externally-generated text (e.g. command-line arguments or
978 filenames) into Unicode.  The encoding names come from the list
979 provided by iconv, and the special case "default_locale" which refers
980 to the current locale's default encoding.
981 .IP
982 When reading externally-generated text strings UTF-8 is tried first,
983 and then this list is tried in order with the first successful
984 conversion ending the search.  When writing external text (e.g. new
985 filenames or arguments to new processes) the first item in this list
986 is used, or UTF-8 if the environment variable is not set.
987 .IP
988 The problem with using MONO_EXTERNAL_ENCODINGS to process your
989 files is that it results in a problem: although its possible to get
990 the right file name it is not necessarily possible to open the file.
991 In general if you have problems with encodings in your filenames you
992 should use the "convmv" program.
993 .TP
994 \fBMONO_GC_PARAMS\fR
995 When using Mono with the SGen garbage collector this variable controls
996 several parameters of the collector.  The variable's value is a comma
997 separated list of words.
998 .RS
999 .ne 8
1000 .TP
1001 \fBnursery-size=\fIsize\fR
1002 Sets the size of the nursery.  The size is specified in bytes and must
1003 be a power of two.  The suffixes `k', `m' and `g' can be used to
1004 specify kilo-, mega- and gigabytes, respectively.  The nursery is the
1005 first generation (of two).  A larger nursery will usually speed up the
1006 program but will obviously use more memory.  The default nursery size
1007 4 MB.
1008 .TP
1009 \fBmajor=\fIcollector\fR
1010 Specifies which major collector to use.  Options are `marksweep' for
1011 the Mark&Sweep collector, `marksweep-par' for parallel Mark&Sweep,
1012 `marksweep-fixed' for Mark&Sweep with a fixed heap,
1013 `marksweep-fixed-par' for parallel Mark&Sweep with a fixed heap and
1014 `copying' for the copying collector. The Mark&Sweep collector is the
1015 default.
1016 .TP
1017 \fBmajor-heap-size=\fIsize\fR
1018 Sets the size of the major heap (not including the large object space)
1019 for the fixed-heap Mark&Sweep collector (i.e. `marksweep-fixed' and
1020 `marksweep-fixed-par').  The size is in bytes, with optional suffixes
1021 `k', `m' and `g' to specify kilo-, mega- and gigabytes, respectively.
1022 The default is 512 megabytes.
1023 .TP
1024 \fBwbarrier=\fIwbarrier\fR
1025 Specifies which write barrier to use.  Options are `cardtable' and
1026 `remset'.  The card table barrier is faster but less precise, and only
1027 supported for the Mark&Sweep major collector on 32 bit platforms.  The
1028 default is `cardtable' if it is supported, otherwise `remset'. The cardtable
1029 write barrier is faster and has a more stable and usually smaller
1030 memory footprint. If the program causes too much pinning during
1031 thread scan, it might be faster to enable remset.
1032 .TP
1033 \fBevacuation-threshold=\fIthreshold\fR
1034 Sets the evacuation threshold in percent.  This option is only available
1035 on the Mark&Sweep major collectors.  The value must be an
1036 integer in the range 0 to 100.  The default is 66.  If the sweep phase of
1037 the collection finds that the occupancy of a specific heap block type is
1038 less than this percentage, it will do a copying collection for that block
1039 type in the next major collection, thereby restoring occupancy to close
1040 to 100 percent.  A value of 0 turns evacuation off.
1041 .TP
1042 \fB(no-)concurrent-sweep\fR
1043 Enables or disables concurrent sweep for the Mark&Sweep collector.  If
1044 enabled, the sweep phase of the garbage collection is done in a thread
1045 concurrently with the application.  Concurrent sweep is disabled by
1046 default.
1047 .TP
1048 \fBstack-mark=\fImark-mode\fR
1049 Specifies how application threads should be scanned. Options are
1050 `precise` and `conservative`. Precise marking allow the collector
1051 to know what values on stack are references and what are not.
1052 Conservative marking threats all values as potentially references
1053 and leave them untouched. Precise marking reduces floating garbage
1054 and can speed up nursery collection and allocation rate, it has
1055 the downside of requiring a significant extra memory per compiled
1056 method. The right option, unfortunately, requires experimentation.
1057 .ne
1058 .RE
1059 .TP
1060 \fBMONO_GC_DEBUG\fR
1061 When using Mono with the SGen garbage collector this environment
1062 variable can be used to turn on various debugging features of the
1063 collector.  The value of this variable is a comma separated list of
1064 words.
1065 .RS
1066 .ne 8
1067 .TP
1068 \fInumber\fR
1069 Sets the debug level to the specified number.
1070 .TP
1071 \fBcollect-before-allocs\fR
1072 .TP
1073 \fBcheck-at-minor-collections\fR
1074 This performs a consistency check on minor collections and also clears
1075 the nursery at collection time, instead of the default, when buffers
1076 are allocated (clear-at-gc).   The consistency check ensures that
1077 there are no major to minor references that are not on the remembered
1078 sets. 
1079 .TP
1080 \fBxdomain-checks\fR
1081 Performs a check to make sure that no references are left to an
1082 unloaded AppDomain.
1083 .TP
1084 \fBclear-at-gc\fR
1085 This clears the nursery at GC time instead of doing it when the thread
1086 local allocation buffer (TLAB) is created.  The default is to clear
1087 the nursery at TLAB creation time.
1088 .TP
1089 \fBconservative-stack-mark\fR
1090 Forces the GC to scan the stack conservatively, even if precise
1091 scanning is available.
1092 .TP
1093 \fBcheck-scan-starts\fR
1094 If set, does a plausibility check on the scan_starts before and after each collection
1095 .TP
1096 \fBheap-dump=\fIfile\fR
1097 Dumps the heap contents to the specified file.   To visualize the
1098 information, use the mono-heapviz tool.
1099 .TP
1100 \fBbinary-protocol=\fIfile\fR
1101 Outputs the debugging output to the specified file.   For this to
1102 work, Mono needs to be compiled with the BINARY_PROTOCOL define on
1103 sgen-gc.c.   You can then use this command to explore the output
1104 .nf
1105                 sgen-grep-binprot 0x1234 0x5678 < file
1106 .fi
1107 .ne
1108 .RE
1109 .TP
1110 \fBMONO_GAC_PREFIX\fR
1111 Provides a prefix the runtime uses to look for Global Assembly Caches.
1112 Directories are separated by the platform path separator (colons on
1113 unix). MONO_GAC_PREFIX should point to the top directory of a prefixed
1114 install. Or to the directory provided in the gacutil /gacdir command. Example:
1115 .B /home/username/.mono:/usr/local/mono/
1116 .TP
1117 \fBMONO_IOMAP\fR
1118 Enables some filename rewriting support to assist badly-written
1119 applications that hard-code Windows paths.  Set to a colon-separated
1120 list of "drive" to strip drive letters, or "case" to do
1121 case-insensitive file matching in every directory in a path.  "all"
1122 enables all rewriting methods.  (Backslashes are always mapped to
1123 slashes if this variable is set to a valid option).
1124 .fi
1125 .Sp
1126 For example, this would work from the shell:
1127 .nf
1128
1129         MONO_IOMAP=drive:case
1130         export MONO_IOMAP
1131
1132 .fi
1133 If you are using mod_mono to host your web applications, you can use
1134 the 
1135 .B MonoIOMAP
1136 directive instead, like this:
1137 .nf
1138
1139         MonoIOMAP <appalias> all
1140
1141 .fi
1142 See mod_mono(8) for more details.
1143
1144 Additionally. Mono includes a profiler module which allows one to track what
1145 adjustements to file paths IOMAP code needs to do. The tracking code reports
1146 the managed location (full stack trace) from which the IOMAP-ed call was made and,
1147 on process exit, the locations where all the IOMAP-ed strings were created in
1148 managed code. The latter report is only approximate as it is not always possible
1149 to estimate the actual location where the string was created. The code uses simple
1150 heuristics - it analyzes stack trace leading back to the string allocation location
1151 and ignores all the managed code which lives in assemblies installed in GAC as well as in the
1152 class libraries shipped with Mono (since they are assumed to be free of case-sensitivity
1153 issues). It then reports the first location in the user's code - in most cases this will be
1154 the place where the string is allocated or very close to the location. The reporting code
1155 is implemented as a custom profiler module (see the "PROFILING" section) and can be loaded
1156 in the following way:
1157 .fi
1158 .Sp
1159 .nf
1160
1161         mono --profile=iomap yourapplication.exe
1162
1163 .fi
1164 Note, however, that Mono currently supports only one profiler module
1165 at a time.
1166 .TP
1167 \fBMONO_LLVM\fR
1168 When Mono is using the LLVM code generation backend you can use this
1169 environment variable to pass code generation options to the LLVM
1170 compiler.   
1171 .TP
1172 \fBMONO_MANAGED_WATCHER\fR
1173 If set to "disabled", System.IO.FileSystemWatcher will use a file watcher 
1174 implementation which silently ignores all the watching requests.
1175 If set to any other value, System.IO.FileSystemWatcher will use the default
1176 managed implementation (slow). If unset, mono will try to use inotify, FAM, 
1177 Gamin, kevent under Unix systems and native API calls on Windows, falling 
1178 back to the managed implementation on error.
1179 .TP
1180 \fBMONO_MESSAGING_PROVIDER\fR
1181 Mono supports a plugin model for its implementation of System.Messaging making
1182 it possible to support a variety of messaging implementations (e.g. AMQP, ActiveMQ).
1183 To specify which messaging implementation is to be used the evironement variable
1184 needs to be set to the full class name for the provider.  E.g. to use the RabbitMQ based
1185 AMQP implementation the variable should be set to:
1186
1187 .nf
1188 Mono.Messaging.RabbitMQ.RabbitMQMessagingProvider,Mono.Messaging.RabbitMQ
1189 .TP
1190 \fBMONO_NO_SMP\fR
1191 If set causes the mono process to be bound to a single processor. This may be
1192 useful when debugging or working around race conditions.
1193 .TP
1194 \fBMONO_NO_TLS\fR
1195 Disable inlining of thread local accesses. Try setting this if you get a segfault
1196 early on in the execution of mono.
1197 .TP
1198 \fBMONO_PATH\fR
1199 Provides a search path to the runtime where to look for library
1200 files.   This is a tool convenient for debugging applications, but
1201 should not be used by deployed applications as it breaks the assembly
1202 loader in subtle ways. 
1203 .Sp
1204 Directories are separated by the platform path separator (colons on unix). Example:
1205 .B /home/username/lib:/usr/local/mono/lib
1206 .Sp
1207 Alternative solutions to MONO_PATH include: installing libraries into
1208 the Global Assembly Cache (see gacutil(1)) or having the dependent
1209 libraries side-by-side with the main executable.
1210 .Sp
1211 For a complete description of recommended practices for application
1212 deployment, see
1213 http://www.mono-project.com/Guidelines:Application_Deployment
1214 .TP
1215 \fBMONO_RTC\fR
1216 Experimental RTC support in the statistical profiler: if the user has
1217 the permission, more accurate statistics are gathered.  The MONO_RTC
1218 value must be restricted to what the Linux rtc allows: power of two
1219 from 64 to 8192 Hz. To enable higher frequencies like 4096 Hz, run as root:
1220 .nf
1221
1222         echo 4096 > /proc/sys/dev/rtc/max-user-freq
1223
1224 .fi
1225 .Sp
1226 For example:
1227 .nf
1228
1229         MONO_RTC=4096 mono --profiler=default:stat program.exe
1230
1231 .fi
1232 .TP 
1233 \fBMONO_SHARED_DIR\fR
1234 If set its the directory where the ".wapi" handle state is stored.
1235 This is the directory where the Windows I/O Emulation layer stores its
1236 shared state data (files, events, mutexes, pipes).  By default Mono
1237 will store the ".wapi" directory in the users's home directory.
1238 .TP 
1239 \fBMONO_SHARED_HOSTNAME\fR
1240 Uses the string value of this variable as a replacement for the host name when
1241 creating file names in the ".wapi" directory. This helps if the host name of
1242 your machine is likely to be changed when a mono application is running or if
1243 you have a .wapi directory shared among several different computers.
1244 .Sp
1245 Mono typically uses the hostname to create the files that are used to
1246 share state across multiple Mono processes.  This is done to support
1247 home directories that might be shared over the network.
1248 .TP
1249 \fBMONO_STRICT_IO_EMULATION\fR
1250 If set, extra checks are made during IO operations.  Currently, this
1251 includes only advisory locks around file writes.
1252 .TP
1253 \fBMONO_THEME\fR
1254 The name of the theme to be used by Windows.Forms.   Available themes today
1255 include "clearlooks", "nice" and "win32".
1256 .Sp
1257 The default is "win32".  
1258 .TP
1259 \fBMONO_TLS_SESSION_CACHE_TIMEOUT\fR
1260 The time, in seconds, that the SSL/TLS session cache will keep it's entry to
1261 avoid a new negotiation between the client and a server. Negotiation are very
1262 CPU intensive so an application-specific custom value may prove useful for 
1263 small embedded systems.
1264 .Sp
1265 The default is 180 seconds.
1266 .TP
1267 \fBMONO_THREADS_PER_CPU\fR
1268 The maximum number of threads in the general threadpool will be
1269 20 + (MONO_THREADS_PER_CPU * number of CPUs). The default value for this
1270 variable is 10.
1271 .TP
1272 \fBMONO_XMLSERIALIZER_THS\fR
1273 Controls the threshold for the XmlSerializer to produce a custom
1274 serializer for a given class instead of using the Reflection-based
1275 interpreter.  The possible values are `no' to disable the use of a
1276 custom serializer or a number to indicate when the XmlSerializer
1277 should start serializing.   The default value is 50, which means that
1278 the a custom serializer will be produced on the 50th use.
1279 .TP
1280 \fBMONO_X509_REVOCATION_MODE\fR
1281 Sets the revocation mode used when validating a X509 certificate chain (https,
1282 ftps, smtps...).  The default is 'nocheck', which performs no revocation check
1283 at all. The other possible values are 'offline', which performs CRL check (not
1284 implemented yet) and 'online' which uses OCSP and CRL to verify the revocation
1285 status (not implemented yet).
1286 .SH ENVIRONMENT VARIABLES FOR DEBUGGING
1287 .TP
1288 \fBMONO_ASPNET_NODELETE\fR
1289 If set to any value, temporary source files generated by ASP.NET support
1290 classes will not be removed. They will be kept in the user's temporary
1291 directory.
1292 .TP
1293 \fBMONO_DEBUG\fR
1294 If set, enables some features of the runtime useful for debugging.
1295 This variable should contain a comma separated list of debugging options.
1296 Currently, the following options are supported:
1297 .RS
1298 .ne 8
1299 .TP
1300 \fBbreak-on-unverified\fR
1301 If this variable is set, when the Mono VM runs into a verification
1302 problem, instead of throwing an exception it will break into the
1303 debugger.  This is useful when debugging verifier problems
1304 .TP
1305 \fBcasts\fR
1306 This option can be used to get more detailed information from
1307 InvalidCast exceptions, it will provide information about the types
1308 involved.     
1309 .TP
1310 \fBcollect-pagefault-stats\fR
1311 Collects information about pagefaults.   This is used internally to
1312 track the number of page faults produced to load metadata.  To display
1313 this information you must use this option with "--stats" command line
1314 option.
1315 .TP
1316 \fBdont-free-domains\fR
1317 This is an Optimization for multi-AppDomain applications (most
1318 commonly ASP.NET applications).  Due to internal limitations Mono,
1319 Mono by default does not use typed allocations on multi-appDomain
1320 applications as they could leak memory when a domain is unloaded. 
1321 .Sp
1322 Although this is a fine default, for applications that use more than
1323 on AppDomain heavily (for example, ASP.NET applications) it is worth
1324 trading off the small leaks for the increased performance
1325 (additionally, since ASP.NET applications are not likely going to
1326 unload the application domains on production systems, it is worth
1327 using this feature). 
1328 .TP
1329 \fBdyn-runtime-invoke\fR
1330 Instructs the runtime to try to use a generic runtime-invoke wrapper
1331 instead of creating one invoke wrapper.
1332 .TP
1333 \fBgdb\fR 
1334 Equivalent to setting the \fBMONO_XDEBUG\fR variable, this emits
1335 symbols into a shared library as the code is JITed that can be loaded
1336 into GDB to inspect symbols.
1337 .TP
1338 \fBgen-seq-points\fR 
1339 Automatically generates sequence points where the
1340 IL stack is empty.  These are places where the debugger can set a
1341 breakpoint.
1342 .TP
1343 \fBexplicit-null-checks\fR
1344 Makes the JIT generate an explicit NULL check on variable dereferences
1345 instead of depending on the operating system to raise a SIGSEGV or
1346 another form of trap event when an invalid memory location is
1347 accessed. 
1348 .TP
1349 \fBhandle-sigint\fR
1350 Captures the interrupt signal (Control-C) and displays a stack trace
1351 when pressed.  Useful to find out where the program is executing at a
1352 given point.  This only displays the stack trace of a single thread. 
1353 .TP
1354 \fBinit-stacks\FR 
1355 Instructs the runtime to initialize the stack with
1356 some known values (0x2a on x86-64) at the start of a method to assist
1357 in debuggin the JIT engine.
1358 .TP
1359 \fBkeep-delegates\fR
1360 This option will leak delegate trampolines that are no longer
1361 referenced as to present the user with more information about a
1362 delegate misuse.  Basically a delegate instance might be created,
1363 passed to unmanaged code, and no references kept in managed code,
1364 which will garbage collect the code.  With this option it is possible
1365 to track down the source of the problems. 
1366 .TP
1367 \fBreverse-pinvoke-exceptions
1368 This option will cause mono to abort with a descriptive message when
1369 during stack unwinding after an exception it reaches a native stack
1370 frame. This happens when a managed delegate is passed to native code,
1371 and the managed delegate throws an exception. Mono will normally try
1372 to unwind the stack to the first (managed) exception handler, and it
1373 will skip any native stack frames in the process. This leads to 
1374 undefined behaviour (since mono doesn't know how to process native
1375 frames), leaks, and possibly crashes too.
1376 .TP
1377 \fBno-gdb-backtrace\fR
1378 This option will disable the GDB backtrace emitted by the runtime
1379 after a SIGSEGV or SIGABRT in unmanaged code.
1380 .TP
1381 \fBsuspend-on-sigsegv\fR
1382 This option will suspend the program when a native SIGSEGV is received.
1383 This is useful for debugging crashes which do not happen under gdb,
1384 since a live process contains more information than a core file.
1385 .ne
1386 .RE
1387 .TP
1388 \fBMONO_LOG_LEVEL\fR
1389 The logging level, possible values are `error', `critical', `warning',
1390 `message', `info' and `debug'.  See the DEBUGGING section for more
1391 details.
1392 .TP
1393 \fBMONO_LOG_MASK\fR
1394 Controls the domain of the Mono runtime that logging will apply to. 
1395 If set, the log mask is changed to the set value. Possible values are
1396 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
1397 (garbage collector), "cfg" (config file loader), "aot" (precompiler),
1398 "security" (e.g. Moonlight CoreCLR support) and "all". 
1399 The default value is "all". Changing the mask value allows you to display only 
1400 messages for a certain component. You can use multiple masks by comma 
1401 separating them. For example to see config file messages and assembly loader
1402 messages set you mask to "asm,cfg".
1403 .TP
1404 \fBMONO_TRACE\fR
1405 Used for runtime tracing of method calls. The format of the comma separated
1406 trace options is:
1407 .nf
1408
1409         [-]M:method name
1410         [-]N:namespace
1411         [-]T:class name
1412         [-]all
1413         [-]program
1414         disabled                Trace output off upon start.
1415
1416 .fi
1417 You can toggle trace output on/off sending a SIGUSR2 signal to the program.
1418 .TP
1419 \fBMONO_TRACE_LISTENER\fR
1420 If set, enables the System.Diagnostics.DefaultTraceListener, which will 
1421 print the output of the System.Diagnostics Trace and Debug classes.  
1422 It can be set to a filename, and to Console.Out or Console.Error to display
1423 output to standard output or standard error, respectively. If it's set to
1424 Console.Out or Console.Error you can append an optional prefix that will
1425 be used when writing messages like this: Console.Error:MyProgramName.
1426 See the System.Diagnostics.DefaultTraceListener documentation for more
1427 information.
1428 .TP
1429 \fBMONO_XEXCEPTIONS\fR
1430 This throws an exception when a X11 error is encountered; by default a
1431 message is displayed but execution continues
1432 .TP
1433 \fBMONO_XMLSERIALIZER_DEBUG\fR
1434 Set this value to 1 to prevent the serializer from removing the
1435 temporary files that are created for fast serialization;  This might
1436 be useful when debugging.
1437 .TP
1438 \fBMONO_XSYNC\fR
1439 This is used in the System.Windows.Forms implementation when running
1440 with the X11 backend.  This is used to debug problems in Windows.Forms
1441 as it forces all of the commands send to X11 server to be done
1442 synchronously.   The default mode of operation is asynchronous which
1443 makes it hard to isolate the root of certain problems.
1444 .TP
1445 \fBMONO_GENERIC_SHARING\fR
1446 This environment variable controls the kind of generic sharing used.
1447 This variable is used by internal JIT developers and should not be
1448 changed in production.  Do not use it.
1449 .Sp
1450 The variable controls which classes will have generic code sharing
1451 enabled.
1452 .Sp
1453 Permissible values are:
1454 .RS
1455 .TP 
1456 .I "all" 
1457 All generated code can be shared. 
1458 .TP
1459 .I "collections" 
1460 Only the classes in System.Collections.Generic will have its code
1461 shared (this is the default value).
1462 .TP
1463 .I "corlib"
1464 Only code in corlib will have its code shared.
1465 .TP
1466 .I "none"
1467 No generic code sharing will be performed.
1468 .RE
1469 .Sp
1470 Generic code sharing by default only applies to collections.   The
1471 Mono JIT by default turns this on.
1472 .TP
1473 \fBMONO_XDEBUG\fR
1474 When the the MONO_XDEBUG env var is set, debugging info for JITted
1475 code is emitted into a shared library, loadable into gdb. This enables,
1476 for example, to see managed frame names on gdb backtraces.   
1477 .TP
1478 \fBMONO_VERBOSE_METHOD\fR
1479 Enables the maximum JIT verbosity for the specified method. This is
1480 very helpfull to diagnose a miscompilation problems of a specific
1481 method.
1482 .SH VALGRIND
1483 If you want to use Valgrind, you will find the file `mono.supp'
1484 useful, it contains the suppressions for the GC which trigger
1485 incorrect warnings.  Use it like this:
1486 .nf
1487     valgrind --suppressions=mono.supp mono ...
1488 .fi
1489 .SH DTRACE
1490 On some platforms, Mono can expose a set of DTrace probes (also known
1491 as user-land statically defined, USDT Probes).
1492 .TP
1493 They are defined in the file `mono.d'.
1494 .TP
1495 .B ves-init-begin, ves-init-end
1496 .Sp
1497 Begin and end of runtime initialization.
1498 .TP
1499 .B method-compile-begin, method-compile-end
1500 .Sp
1501 Begin and end of method compilation.
1502 The probe arguments are class name, method name and signature,
1503 and in case of method-compile-end success or failure of compilation.
1504 .TP
1505 .B gc-begin, gc-end
1506 .Sp
1507 Begin and end of Garbage Collection.
1508 .TP
1509 To verify the availability of the probes, run:
1510 .nf
1511     dtrace -P mono'$target' -l -c mono
1512 .fi
1513 .SH PERMISSIONS
1514 Mono's Ping implementation for detecting network reachability can
1515 create the ICMP packets itself without requiring the system ping
1516 command to do the work.  If you want to enable this on Linux for
1517 non-root users, you need to give the Mono binary special permissions.
1518 .PP
1519 As root, run this command:
1520 .nf
1521    # setcap cap_net_raw=+ep /usr/bin/mono
1522 .fi
1523 .SH FILES
1524 On Unix assemblies are loaded from the installation lib directory.  If you set
1525 `prefix' to /usr, the assemblies will be located in /usr/lib.  On
1526 Windows, the assemblies are loaded from the directory where mono and
1527 mint live.
1528 .TP
1529 .B ~/.mono/aot-cache
1530 .Sp
1531 The directory for the ahead-of-time compiler demand creation
1532 assemblies are located. 
1533 .TP
1534 .B /etc/mono/config, ~/.mono/config
1535 .Sp
1536 Mono runtime configuration file.  See the mono-config(5) manual page
1537 for more information.
1538 .TP
1539 .B ~/.config/.mono/certs, /usr/share/.mono/certs
1540 .Sp
1541 Contains Mono certificate stores for users / machine. See the certmgr(1) 
1542 manual page for more information on managing certificate stores and
1543 the mozroots(1) page for information on how to import the Mozilla root
1544 certificates into the Mono certificate store. 
1545 .TP
1546 .B ~/.mono/assemblies/ASSEMBLY/ASSEMBLY.config
1547 .Sp
1548 Files in this directory allow a user to customize the configuration
1549 for a given system assembly, the format is the one described in the
1550 mono-config(5) page. 
1551 .TP
1552 .B ~/.config/.mono/keypairs, /usr/share/.mono/keypairs
1553 .Sp
1554 Contains Mono cryptographic keypairs for users / machine. They can be 
1555 accessed by using a CspParameters object with DSACryptoServiceProvider
1556 and RSACryptoServiceProvider classes.
1557 .TP
1558 .B ~/.config/.isolatedstorage, ~/.local/share/.isolatedstorage, /usr/share/.isolatedstorage
1559 .Sp
1560 Contains Mono isolated storage for non-roaming users, roaming users and 
1561 local machine. Isolated storage can be accessed using the classes from 
1562 the System.IO.IsolatedStorage namespace.
1563 .TP
1564 .B <assembly>.config
1565 .Sp
1566 Configuration information for individual assemblies is loaded by the
1567 runtime from side-by-side files with the .config files, see the
1568 http://www.mono-project.com/Config for more information.
1569 .TP
1570 .B Web.config, web.config
1571 .Sp
1572 ASP.NET applications are configured through these files, the
1573 configuration is done on a per-directory basis.  For more information
1574 on this subject see the http://www.mono-project.com/Config_system.web
1575 page. 
1576 .SH MAILING LISTS
1577 Mailing lists are listed at the
1578 http://www.mono-project.com/Mailing_Lists
1579 .SH WEB SITE
1580 http://www.mono-project.com
1581 .SH SEE ALSO
1582 .PP
1583 certmgr(1), csharp(1), mcs(1), mdb(1), monocov(1), monodis(1),
1584 mono-config(5), mozroots(1), mprof-report(1), pdb2mdb(1), xsp(1), mod_mono(8).
1585 .PP
1586 For more information on AOT:
1587 http://www.mono-project.com/AOT
1588 .PP
1589 For ASP.NET-related documentation, see the xsp(1) manual page