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