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