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