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