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