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