Update pipeline-netcore-runtime.yml
[mono-project.git] / man / mono.1
blobecffd2044826540f430860184e647ec87aba4873
1 .\" 
2 .\" mono manual page.
3 .\" Copyright 2003 Ximian, Inc. 
4 .\" Copyright 2004-2011 Novell, Inc. 
5 .\" Copyright 2011-2012 Xamarin Inc
6 .\" Copyright 2013 7digital Media Ltd.
7 .\" Author:
8 .\"   Miguel de Icaza (miguel@gnu.org)
9 .\"
10 .TH Mono "mono"
11 .SH NAME
12 mono \- Mono's ECMA-CLI native code generator (Just-in-Time and Ahead-of-Time)
13 .SH SYNOPSIS
14 .PP
15 .B mono [options] file [arguments...]
16 .PP
17 .B mono-sgen [options] file [arguments...]
18 .SH DESCRIPTION
19 \fImono\fP is a runtime implementation of the ECMA Common Language
20 Infrastructure.  This can be used to run ECMA and .NET applications.
21 .PP
22 The runtime loads the specified
23 .I file
24 and optionally passes
25 the
26 .I arguments
27 to it.  The 
28 .I file
29 is an ECMA assembly.  They typically have a .exe or .dll extension.
30 .PP
31 These executables can reference additional functionality in the form
32 of assembly references.  By default those assembly references are
33 resolved as follows: the \fBmscorlib.dll\fR is resolved from the
34 system profile that is configured by Mono, and other assemblies are
35 loaded from the Global Assembly Cache (GAC).   
36 .PP
37 The runtime contains a native code generator that transforms the
38 Common Intermediate Language into native code.
39 .PP
40 The code generator can operate in two modes: Just-in-time compilation
41 (JIT) or Ahead-of-time compilation (AOT).  Since code can be
42 dynamically loaded, the runtime environment and the JIT are always
43 present, even if code is compiled ahead of time.
44 .PP
45 The runtime provides a number of configuration options for running
46 applications, for developing and debugging, and for testing and
47 debugging the runtime itself.
48 .PP
49 The \fImono\fP command uses the moving and generational SGen garbage collector
50 while the \fImono-boehm\fP command uses the conservative Boehm
51 garbage collector.
52 .SH PORTABILITY
53 On Unix-based systems, Mono provides a mechanism to emulate the 
54 Windows-style file access, this includes providing a case insensitive
55 view of the file system, directory separator mapping (from \\ to /) and
56 stripping the drive letters.
57 .PP
58 This functionality is enabled by setting the 
59 .B MONO_IOMAP 
60 environment variable to one of 
61 .B all, drive
62 and 
63 .B case.
64 .PP
65 See the description for 
66 .B MONO_IOMAP
67 in the environment variables section for more details.
68 .SH METHOD DESCRIPTIONS
69 A number of diagnostic command line options take as argument a method
70 description.   A method description is a textual representation that
71 can be used to uniquely identify a method.   The syntax is as follows:
72 .nf
73 [namespace]classname:methodname[(arguments)]
74 .fi
75 .PP
76 The values in brackets are optional, like the namespace and the
77 arguments.   The arguments themselves are either empty, or a
78 comma-separated list of arguments.   Both the
79 \fBclassname\fR
80 and
81 \fBmethodname\fR
82 can be set to the special value '*' to match any values (Unix shell
83 users should escape the argument to avoid the shell interpreting
84 this).
85 .PP
86 The arguments, if present should be a comma separated list of types
87 either a full typename, or for built-in types it should use the
88 low-level ILAsm type names for the built-in types,
89 like 'void', 'char', 'bool', 'byte', 'sbyte', 'uint16', 'int16', 'uint',
90 'int', 'ulong', 'long', 'uintptr', 'intptr', 'single', 'double', 'string', 'object'.
91 .PP
92 Pointer types should be the name of the type, followed by a '*',
93 arrays should be the typename followed by '[' one or more commas (to
94 indicate the rank of the array), and ']'.
95 .PP
96 Generic values should use '<', one or more type names, separated by
97 both a comma and a space and '>'.
98 .PP
99 By-reference arguments should include a "&" after the typename.
101 Examples:
103 *:ctor(int)             // All constructors that take an int as an argument
104 *:Main                  // Methods named Main in any class
105 *:Main(string[])        // Methods named Main that take a string array in any class
107 .SH RUNTIME OPTIONS
108 The following options are available:
110 \fB--aot\fR, \fB--aot[=options]\fR
111 This option is used to precompile the CIL code in the specified
112 assembly to native code.  The generated code is stored in a file with
113 the extension .so.  This file will be automatically picked up by the
114 runtime when the assembly is executed.  
115 .Sp 
116 Ahead-of-Time compilation is most useful if you use it in combination
117 with the -O=all,-shared flag which enables all of the optimizations in
118 the code generator to be performed.  Some of those optimizations are
119 not practical for Just-in-Time compilation since they might be very
120 time consuming.
122 Unlike the .NET Framework, Ahead-of-Time compilation will not generate
123 domain independent code: it generates the same code that the
124 Just-in-Time compiler would produce.   Since most applications use a
125 single domain, this is fine.   If you want to optimize the generated
126 code for use in multi-domain applications, consider using the
127 -O=shared flag.
129 This pre-compiles the methods, but the original assembly is still
130 required to execute as this one contains the metadata and exception
131 information which is not available on the generated file.  When
132 precompiling code, you might want to compile with all optimizations
133 (-O=all).  Pre-compiled code is position independent code.
135 Precompilation is just a mechanism to reduce startup time, increase
136 code sharing across multiple mono processes and avoid just-in-time
137 compilation program startup costs.  The original assembly must still
138 be present, as the metadata is contained there.
140 AOT code typically can not be moved from one computer to another
141 (CPU-specific optimizations that are detected at runtime) so you
142 should not try to move the pre-generated assemblies or package the
143 pre-generated assemblies for deployment.    
145 A few options are available as a parameter to the 
146 .B --aot 
147 command line option.   The options are separated by commas, and more
148 than one can be specified:
150 .ne 8
152 .I asmonly
153 Instructs the AOT compiler to output assembly code instead of an
154 object file.
156 .I bind-to-runtime-version
158 If specified, forces the generated AOT files to be bound to the
159 runtime version of the compiling Mono.   This will prevent the AOT
160 files from being consumed by a different Mono runtime.
162 .I data-outfile=FILE.dll.aotdata
164 This instructs the AOT code generator to output certain data
165 constructs into a separate file.   This can reduce the executable
166 images some five to twenty percent.   Developers need to then ship the
167 resulting aotdata as a resource and register a hook to load the data
168 on demand by using the 
169 .I mono_install_load_aot_data_hook
170 method.
172 .I direct-icalls
174 When this option is specified, icalls (internal calls made from the
175 standard library into the mono runtime code) are invoked directly
176 instead of going through the operating system symbol lookup operation.
177 This requires use of the
178 .I static
179 option.
181 .I direct-pinvoke
183 When this option is specified, P/Invoke methods are invoked directly
184 instead of going through the operating system symbol lookup operation.
185 This requires use of the
186 .I static
187 option.
189 .I dwarfdebug
190 Instructs the AOT compiler to emit DWARF debugging information. When
191 used together with the nodebug option, only DWARF debugging
192 information is emitted, but not the information that can be used at
193 runtime.
195 .I full
197 This creates binaries which can be used with the --full-aot option.
199 .I hybrid
201 This creates binaries which can be used with the --hybrid-aot option.
203 .I llvm
204 AOT will be performed with the LLVM backend instead of the Mono backend where possible. This will be slower to compile but most likely result in a performance improvement.
206 .I llvmonly
207 AOT will be performed with the LLVM backend exclusively and the Mono backend will not be used. The only output in this mode will be the bitcode file normally specified with the
208 .I llvm-outfile
209 option. Use of
210 .I llvmonly
211 automatically enables the
212 .I full
214 .I llvm
215 options. This feature is experimental.
217 .I llvmopts=[options]
218 Use this option to add more flags to the built-in set of flags passed to the
219 LLVM optimizer.   When you invoke the 
220 .I mono
221 command with the 
222 .I --aot=llvm 
223 it displays the current list of flags that are being passed to the 
224 .I opt
225 command.  
226 .I The list of possible flags that can be passed can be
227 obtained by calling the bundled 
228 .I opt 
229 program that comes with Mono, and calling it like this:
232         opt --help
237 .I llvmllc=[options]
238 Use this option to add more flags to the built-in set of flags passed to the
239 LLVM static compiler (llc).   The list of possible flags that can be passed can be
240 obtained by calling the bundled 
241 .I llc
242 program that comes with Mono, and calling it like this:
245         llc --help
249 .I llvm-outfile=[filename]
250 Gives the path for the temporary LLVM bitcode file created during AOT.
251 .I dedup
252 Each AOT module will typically contain the code for inflated methods and wrappers that
253 are called by code in that module. In dedup mode, we identify and skip compiling all of those
254 methods. When using this mode with fullaot, dedup-include is required or these methods will 
255 remain missing.
257 .I dedup-include=[filename]
258 In dedup-include mode, we are in the pass of compilation where we compile the methods
259 that we had previously skipped. All of them are emitted into the assembly that is passed
260 as this option. We consolidate the many duplicate skipped copies of the same method into one.
263 .I info
264 Print the architecture the AOT in this copy of Mono targets and quit.
266 .I interp
267 Generates all required wrappers, so that it is possible to run --interpreter without
268 any code generation at runtime.  This option only makes sense with \fBmscorlib.dll\fR.
269 Embedders can set
271 .I depfile=[filename]
272 Outputs a gcc -M style dependency file.
275 mono_jit_set_aot_mode (MONO_AOT_MODE_INTERP);
279 .I ld-flags
280 Additional flags to pass to the C linker (if the current AOT mode calls for invoking it).
282 .I llvm-path=<PREFIX>
283 Same for the llvm tools 'opt' and 'llc'.
285 .I msym-dir=<PATH>
286 Instructs the AOT compiler to generate offline sequence points .msym files.
287 The generated .msym files will be stored into a subfolder of <PATH> named as the
288 compilation AOTID.
290 .I mtriple=<TRIPLE>
291 Use the GNU style target triple <TRIPLE> to determine some code generation options, i.e.
292 --mtriple=armv7-linux-gnueabi will generate code that targets ARMv7. This is currently
293 only supported by the ARM backend. In LLVM mode, this triple is passed on to the LLVM
294 llc compiler.
296 .I nimt-trampolines=[number]
297 When compiling in full aot mode, the IMT trampolines must be precreated
298 in the AOT image.  You can add additional method trampolines with this argument.
299 Defaults to 512.
301 .I ngsharedvt-trampolines=[number]
302 When compiling in full aot mode, the value type generic sharing trampolines must be precreated
303 in the AOT image.  You can add additional method trampolines with this argument.
304 Defaults to 512.
306 .I nodebug
307 Instructs the AOT compiler to not output any debugging information.
309 .I no-direct-calls
310 This prevents the AOT compiler from generating a direct calls to a
311 method.   The AOT compiler usually generates direct calls for certain
312 methods that do not require going through the PLT (for example,
313 methods that are known to not require a hook like a static
314 constructor) or call into simple internal calls.
316 .I nrgctx-trampolines=[number]
317 When compiling in full aot mode, the generic sharing trampolines must be precreated
318 in the AOT image.  You can add additional method trampolines with this argument.
319 Defaults to 4096.
321 .I nrgctx-fetch-trampolines=[number]
322 When compiling in full aot mode, the generic sharing fetch trampolines must be precreated
323 in the AOT image.  You can add additional method trampolines with this argument.
324 Defaults to 128.
326 .I ntrampolines=[number]
327 When compiling in full aot mode, the method trampolines must be precreated
328 in the AOT image.  You can add additional method trampolines with this argument.
329 Defaults to 4096.
331 .I outfile=[filename]
332 Instructs the AOT compiler to save the output to the specified file.
334 .I print-skipped-methods
335 If the AOT compiler cannot compile a method for any reason, enabling this flag
336 will output the skipped methods to the console.
338 .I profile=[file]
339 Specify a file to use for profile-guided optimization. See the \fBAOT profiler\fR sub-section. To specify multiple files, include the
340 .I profile
341 option multiple times.
343 .I profile-only
344 AOT *only* the methods described in the files specified with the
345 .I profile
346 option. See the \fBAOT profiler\fR sub-section.
348 .I readonly-value=namespace.typename.fieldname=type/value
349 Override the value of a static readonly field. Usually, during JIT
350 compilation, the static constructor is ran eagerly, so the value of
351 a static readonly field is known at compilation time and the compiler
352 can do a number of optimizations based on it. During AOT, instead, the static
353 constructor can't be ran, so this option can be used to set the value of such
354 a field and enable the same set of optimizations.
355 Type can be any of i1, i2, i4 for integers of the respective sizes (in bytes).
356 Note that signed/unsigned numbers do not matter here, just the storage size.
357 This option can be specified multiple times and it doesn't prevent the static
358 constructor for the type defining the field to execute with the usual rules
359 at runtime (hence possibly computing a different value for the field).
361 .I save-temps,keep-temps
362 Instructs the AOT compiler to keep temporary files.
364 .I soft-debug
365 This instructs the compiler to generate sequence point checks that
366 allow Mono's soft debugger to debug applications even on systems where
367 it is not possible to set breakpoints or to single step (certain
368 hardware configurations like the cell phones and video gaming
369 consoles). 
371 .I static
372 Create an ELF object file (.o) or .s file which can be statically linked into an
373 executable when embedding the mono runtime. When this option is used, the object file
374 needs to be registered with the embedded runtime using the mono_aot_register_module
375 function which takes as its argument the mono_aot_module_<ASSEMBLY NAME>_info global
376 symbol from the object file:
379 extern void *mono_aot_module_hello_info;
381 mono_aot_register_module (mono_aot_module_hello_info);
385 .I stats
386 Print various stats collected during AOT compilation.
388 .I temp-path=[path]
389 Explicitly specify path to store temporary files created during AOT compilation.
391 .I threads=[number]
392 This is an experimental option for the AOT compiler to use multiple threads
393 when compiling the methods.
395 .I tool-prefix=<PREFIX>
396 Prepends <PREFIX> to the name of tools ran by the AOT compiler, i.e. 'as'/'ld'. For
397 example, --tool=prefix=arm-linux-gnueabi- will make the AOT compiler run
398 'arm-linux-gnueabi-as' instead of 'as'.
400 .I verbose
401 Prints additional information about type loading failures.
403 .I write-symbols,no-write-symbols
404 Instructs the AOT compiler to emit (or not emit) debug symbol information.
406 .I no-opt
407 Instructs the AOT compiler tot no call opt when compiling with LLVM.
409 For more information about AOT, see: http://www.mono-project.com/docs/advanced/aot/
412 \fB--aot-path=PATH\fR
413 List of additional directories to search for AOT images.
415 \fB--apply-bindings=FILE\fR
416 Apply the assembly bindings from the specified configuration file when running
417 the AOT compiler.  This is useful when compiling an auxiliary assembly that is
418 referenced by a main assembly that provides a configuration file.  For example,
419 if app.exe uses lib.dll then in order to make the assembly bindings from
420 app.exe.config available when compiling lib.dll ahead of time, use:
422         mono --apply-bindings=app.exe.config --aot lib.dll
425 \fB--assembly-loader=MODE\fR
426 If mode is \fBstrict\fR, Mono will check that the public key token, culture and version
427 of a candidate assembly matches the requested strong name.  If mode is \fBlegacy\fR, as
428 long as the name matches, the candidate will be allowed. \fBstrict\fR is the behavior
429 consistent with .NET Framework but may break some existing mono-based applications.
430 The default is \fBlegacy\fR.
432 \fB--attach=[options]\fR
433 Currently the only option supported by this command line argument is
434 \fBdisable\fR which disables the attach functionality.
436 \fB--config filename\fR
437 Load the specified configuration file instead of the default one(s).
438 The default files are /etc/mono/config and ~/.mono/config or the file
439 specified in the MONO_CONFIG environment variable, if set.  See the
440 mono-config(5) man page for details on the format of this file.
442 \fB--debugger-agent=[options]\fR 
443 This instructs the Mono runtime to
444 start a debugging agent inside the Mono runtime and connect it to a
445 client user interface will control the Mono process.
446 This option is typically used by IDEs, like the MonoDevelop or Visual Studio IDEs.
448 The configuration is specified using one of more of the following options:
450 .ne 8
452 .I address=host:port
454 Use this option to specify the IP address where your debugger client is
455 listening to.
457 .I loglevel=LEVEL
459 Specifies the diagnostics log level for 
461 .I logfile=filename
463 Used to specify the file where the log will be stored, it defaults to
464 standard output.
466 .I server=[y/n]
467 Defaults to no, with the default option Mono will actively connect to the
468 host/port configured with the \fBaddress\fR option.  If you set it to 'y', it 
469 instructs the Mono runtime to start debugging in server mode, where Mono
470 actively waits for the debugger front end to connect to the Mono process.  
471 Mono will print out to stdout the IP address and port where it is listening.
473 .I setpgid=[y/n]
474 If set to yes, Mono will call \fBsetpgid(0, 0)\fR on startup, if that function
475 is available on the system. This is useful for ensuring that signals delivered
476 to a process that is executing the debuggee are not propagated to the debuggee,
477 e.g. when Ctrl-C sends \fBSIGINT\fR to the \fBsdb\fR tool.
479 .I suspend=[y/n]
480 Defaults to yes, with the default option Mono will suspend the vm on startup 
481 until it connects successfully to a debugger front end.  If you set it to 'n', in 
482 conjunction with \fBserver=y\fR, it instructs the Mono runtime to run as normal, 
483 while caching metadata to send to the debugger front end on connection..
485 .I transport=transport_name
487 This is used to specify the transport that the debugger will use to
488 communicate.   It must be specified and currently requires this to
489 be 'dt_socket'. 
493 \fB--desktop\fR
494 Configures the virtual machine to be better suited for desktop
495 applications.  Currently this sets the GC system to avoid expanding
496 the heap as much as possible at the expense of slowing down garbage
497 collection a bit.
499 \fB--full-aot\fR
500 This flag instructs the Mono runtime to not
501 generate any code at runtime and depend exclusively on the code
502 generated from using mono --aot=full previously.  This is useful for
503 platforms that do not permit dynamic code generation, or if you need
504 to run assemblies that have been stripped of IL (for example using
505 mono-cil-strip).
507 Notice that this feature will abort execution at runtime if a codepath
508 in your program, or Mono's class libraries attempts to generate code
509 dynamically.  You should test your software upfront and make sure that
510 you do not use any dynamic features.
512 \fB--full-aot-interp\fR
513 Same as --full-aot with fallback to the interpreter.
515 \fB--gc=boehm\fR, \fB--gc=sgen\fR
516 Selects the Garbage Collector engine for Mono to use, Boehm or SGen.
517 Currently this merely ensures that you are running either the
518 \fImono\fR or \fImono-sgen\fR commands.    This flag can be set in the
519 \fBMONO_ENV_OPTIONS\fR environment variable to force all of your child
520 processes to use one particular kind of GC with the Mono runtime.
522 \fB--gc-debug=[options]\fR
523 Command line equivalent of the \fBMONO_GC_DEBUG\fR environment variable.
525 \fB--gc-params=[options]\fR
526 Command line equivalent of the \fBMONO_GC_PARAMS\fR environment variable.
528 \fB--arch=32\fR, \fB--arch=64\fR
529 (Mac OS X only): Selects the bitness of the Mono binary used, if
530 available. If the binary used is already for the selected bitness, nothing
531 changes. If not, the execution switches to a binary with the selected
532 bitness suffix installed side by side (for example, '/bin/mono --arch=64'
533 will switch to '/bin/mono64' iff '/bin/mono' is a 32-bit build).
535 \fB--help\fR, \fB-h\fR
536 Displays usage instructions.
538 \fB--interpreter\fR
539 The Mono runtime will use its interpreter to execute a given assembly.
540 The interpreter is usually slower than the JIT, but it can be useful on
541 platforms where code generation at runtime is not allowed.
543 \fB--hybrid-aot\fR
544 This flag allows the Mono runtime to run assemblies
545 that have been stripped of IL, for example using mono-cil-strip. For this to
546 work, the assembly must have been AOT compiled with --aot=hybrid.
548 This flag is similar to --full-aot, but it does not disable the JIT. This means
549 you can use dynamic features such as System.Reflection.Emit.
551 \fB--llvm\fR
552 If the Mono runtime has been compiled with LLVM support (not available
553 in all configurations), Mono will use the LLVM optimization and code
554 generation engine to JIT or AOT compile.     
556 For more information, consult: http://www.mono-project.com/docs/advanced/mono-llvm/
558 \fB--ffast-math\fR
559 This flag allows Mono and LLVM to apply aggressive floating point optimizations.
560 Be carefule, it breaks IEEE754 compliance.
562 \fB--nollvm\fR
563 When using a Mono that has been compiled with LLVM support, it forces
564 Mono to fallback to its JIT engine and not use the LLVM backend.
566 \fB--optimize=MODE\fR, \fB-O=MODE\fR
567 MODE is a comma separated list of optimizations.  They also allow
568 optimizations to be turned off by prefixing the optimization name with
569 a minus sign.
571 In general, Mono has been tuned to use the default set of flags,
572 before using these flags for a deployment setting, you might want to
573 actually measure the benefits of using them.    
575 The following optimization flags are implemented in the core engine:
577              abcrem     Array bound checks removal
578              all        Turn on all optimizations
579              aot        Usage of Ahead Of Time compiled code
580              branch     Branch optimizations
581              cfold      Constant folding
582              cmov       Conditional moves [arch-dependency]
583              deadce     Dead code elimination
584              consprop   Constant propagation
585              copyprop   Copy propagation
586              fcmov      Fast x86 FP compares [arch-dependency]
587              float32    Perform 32-bit float arithmetic using 32-bit operations
588              gshared    Enable generic code sharing.
589              inline     Inline method calls
590              intrins    Intrinsic method implementations
591              linears    Linear scan global reg allocation
592              leaf       Leaf procedures optimizations
593              loop       Loop related optimizations
594              peephole   Peephole postpass
595              precomp    Precompile all methods before executing Main
596              sched      Instruction scheduling
597              shared     Emit per-domain code
598              sse2       SSE2 instructions on x86 [arch-dependency]
599              tailc      Tail recursion and tail calls
602 For example, to enable all the optimization but dead code
603 elimination and inlining, you can use:
605         -O=all,-deadce,-inline
608 The flags that are flagged with [arch-dependency] indicate that the
609 given option if used in combination with Ahead of Time compilation
610 (--aot flag) would produce pre-compiled code that will depend on the
611 current CPU and might not be safely moved to another computer. 
613 .ne 8
615 The following optimizations are supported
617 .I float32
618 Requests that the runtime performn 32-bit floating point operations
619 using only 32-bits.   By default the Mono runtime tries to use the
620 highest precision available for floating point operations, but while
621 this might render better results, the code might run slower.   This
622 options also affects the code generated by the LLVM backend.
624 .I inline
625 Controls whether the runtime should attempt to inline (the default),
626 or not inline methods invocations
629 \fB--response=FILE\fR
630 Provides a response file, this instructs the Mono command to read
631 other command line options from the specified file, as if the
632 options had been specified on the command line.   Useful when you have
633 very long command lines.
635 \fB--runtime=VERSION\fR
636 Mono supports different runtime versions. The version used depends on the program
637 that is being run or on its configuration file (named program.exe.config). This option
638 can be used to override such autodetection, by forcing a different runtime version
639 to be used. Note that this should only be used to select a later compatible runtime
640 version than the one the program was compiled against. A typical usage is for
641 running a 1.1 program on a 2.0 version:
643          mono --runtime=v2.0.50727 program.exe
646 \fB--server\fR
647 Configures the virtual machine to be better suited for server
648 operations (currently, allows a heavier threadpool initialization).
650 \fB--use-map-jit\fR
651 Instructs Mono to generate code using MAP_JIT on MacOS.  Necessary for
652 bundled applications.
654 \fB--verify-all\fR 
655 Verifies mscorlib and assemblies in the global
656 assembly cache for valid IL, and all user code for IL
657 verifiability. 
659 This is different from \fB--security\fR's verifiable
660 or validil in that these options only check user code and skip
661 mscorlib and assemblies located on the global assembly cache.
663 \fB-V\fR, \fB--version\fR
664 Prints JIT version information (system configuration, release number
665 and branch names if available). 
667 \fB--version=number\fR
668 Print version number only.
671 .SH DEVELOPMENT OPTIONS
672 The following options are used to help when developing a JITed application.
674 \fB--debug\fR, \fB--debug=OPTIONS\fR
675 Turns on the debugging mode in the runtime.  If an assembly was
676 compiled with debugging information, it will produce line number
677 information for stack traces. 
679 .ne 8
681 The optional OPTIONS argument is a comma separated list of debugging
682 options.  These options are turned off by default since they generate
683 much larger and slower code at runtime.
685 The following options are supported:
687 .I casts
688 Produces a detailed error when throwing a InvalidCastException.   This
689 option needs to be enabled as this generates more verbose code at
690 execution time. 
692 .I mdb-optimizations
693 Disable some JIT optimizations which are usually only disabled when
694 running inside the debugger.  This can be helpful if you want to attach
695 to the running process with mdb.
697 .I gdb
698 Generate and register debugging information with gdb. This is only supported on some
699 platforms, and only when using gdb 7.0 or later.
703 \fB\-\-profile\fR[=\fIprofiler\fR[:\fIprofiler_args\fR]]\fR
704 Loads a profiler module with the given arguments. For more information,
705 see the \fBPROFILING\fR section.
707 This option can be used multiple times; each time will load an additional
708 profiler module.
710 \fB--trace[=expression]\fR
711 Shows method names as they are invoked.  By default all methods are
712 traced. 
714 The trace can be customized to include or exclude methods, classes or
715 assemblies.  A trace expression is a comma separated list of targets,
716 each target can be prefixed with a minus sign to turn off a particular
717 target.  The words `program', `all' and `disabled' have special
718 meaning.  `program' refers to the main program being executed, and
719 `all' means all the method calls.
721 The `disabled' option is used to start up with tracing disabled.  It
722 can be enabled at a later point in time in the program by sending the
723 SIGUSR2 signal to the runtime.
725 Assemblies are specified by their name, for example, to trace all
726 calls in the System assembly, use:
729         mono --trace=System app.exe
732 Classes are specified with the T: prefix.  For example, to trace all
733 calls to the System.String class, use:
736         mono --trace=T:System.String app.exe
739 And individual methods are referenced with the M: prefix, and the
740 standard method notation:
743         mono --trace=M:System.Console:WriteLine app.exe
746 Exceptions can also be traced, it will cause a stack trace to be
747 printed every time an exception of the specified type is thrown.
748 The exception type can be specified with or without the namespace,
749 and to trace all exceptions, specify 'all' as the type name.
752         mono --trace=E:System.Exception app.exe
755 As previously noted, various rules can be specified at once:
758         mono --trace=T:System.String,T:System.Random app.exe
761 You can exclude pieces, the next example traces calls to
762 System.String except for the System.String:Concat method.
765         mono --trace=T:System.String,-M:System.String:Concat
768 You can trace managed to unmanaged transitions using
769 the wrapper qualifier:
772         mono --trace=wrapper app.exe
775 Finally, namespaces can be specified using the N: prefix:
778         mono --trace=N:System.Xml
782 \fB--no-x86-stack-align\fR
783 Don't align stack frames on the x86 architecture.  By default, Mono
784 aligns stack frames to 16 bytes on x86, so that local floating point
785 and SIMD variables can be properly aligned.  This option turns off the
786 alignment, which usually saves one instruction per call, but might
787 result in significantly lower floating point and SIMD performance.
789 \fB--jitmap\fR
790 Generate a JIT method map in a /tmp/perf-PID.map file. This file is then
791 used, for example, by the perf tool included in recent Linux kernels.
792 Each line in the file has:
795         HEXADDR HEXSIZE methodname
798 Currently this option is only supported on Linux.
799 .SH JIT MAINTAINER OPTIONS
800 The maintainer options are only used by those developing the runtime
801 itself, and not typically of interest to runtime users or developers.
803 \fB--bisect=optimization:filename\fR
804 This flag is used by the automatic optimization bug bisector.  It
805 takes an optimization flag and a filename of a file containing a list
806 of full method names, one per line.  When it compiles one of the
807 methods in the file it will use the optimization given, in addition to
808 the optimizations that are otherwise enabled.  Note that if the
809 optimization is enabled by default, you should disable it with `-O`,
810 otherwise it will just apply to every method, whether it's in the file
811 or not.
813 \fB--break method\fR
814 Inserts a breakpoint before the method whose name is `method'
815 (namespace.class:methodname).  Use `Main' as method name to insert a
816 breakpoint on the application's main method.  You can use it also with
817 generics, for example "System.Collections.Generic.Queue`1:Peek"
819 \fB--breakonex\fR
820 Inserts a breakpoint on exceptions.  This allows you to debug your
821 application with a native debugger when an exception is thrown.
823 \fB--compile name\fR
824 This compiles a method (namespace.name:methodname), this is used for
825 testing the compiler performance or to examine the output of the code
826 generator. 
828 \fB--compile-all\fR
829 Compiles all the methods in an assembly.  This is used to test the
830 compiler performance or to examine the output of the code generator
831 .TP 
832 \fB--graph=TYPE METHOD\fR
833 This generates a postscript file with a graph with the details about
834 the specified method (namespace.name:methodname).  This requires `dot'
835 and ghostview to be installed (it expects Ghostview to be called
836 "gv"). 
838 The following graphs are available:
840           cfg        Control Flow Graph (CFG)
841           dtree      Dominator Tree
842           code       CFG showing code
843           ssa        CFG showing code after SSA translation
844           optcode    CFG showing code after IR optimizations
847 Some graphs will only be available if certain optimizations are turned
850 \fB--ncompile\fR
851 Instruct the runtime on the number of times that the method specified
852 by --compile (or all the methods if --compile-all is used) to be
853 compiled.  This is used for testing the code generator performance. 
854 .TP 
855 \fB--stats\fR
856 Displays information about the work done by the runtime during the
857 execution of an application. 
859 \fB--wapi=hps|semdel\fR
860 Perform maintenance of the process shared data.
862 semdel will delete the global semaphore.
864 hps will list the currently used handles.
866 \fB-v\fR, \fB--verbose\fR
867 Increases the verbosity level, each time it is listed, increases the
868 verbosity level to include more information (including, for example, 
869 a disassembly of the native code produced, code selector info etc.).
870 .SH ATTACH SUPPORT
871 The Mono runtime allows external processes to attach to a running
872 process and load assemblies into the running program.   To attach to
873 the process, a special protocol is implemented in the Mono.Management
874 assembly. 
876 With this support it is possible to load assemblies that have an entry
877 point (they are created with -target:exe or -target:winexe) to be
878 loaded and executed in the Mono process.
880 The code is loaded into the root domain, and it starts execution on
881 the special runtime attach thread.    The attached program should
882 create its own threads and return after invocation.
884 This support allows for example debugging applications by having the
885 csharp shell attach to running processes.
886 .SH PROFILING
887 The Mono runtime includes a profiler API that dynamically loaded
888 profiler modules and embedders can use to collect performance-related
889 data about an application. Profiler modules are loaded by passing the
890 \fB\-\-profile\fR command line argument to the Mono runtime.
892 Mono ships with a few profiler modules, of which the \fBlog\fR profiler
893 is the most feature-rich. It is also the default profiler if the
894 \fIprofiler\fR argument is not given, or if \fBdefault\fR is given.
895 It is possible to write your own profiler modules; see the
896 \fBCustom profilers\fR sub-section.
897 .SS Log profiler
898 The log profiler can be used to collect a lot of information about
899 a program running in the Mono runtime. This data can be used (both
900 while the process is running and later) to do analyses of the
901 program behavior, determine resource usage, performance issues or
902 even look for particular execution patterns.
904 This is accomplished by logging the events provided by the Mono
905 runtime through the profiler API and periodically writing them to a
906 file which can later be inspected with the \fBmprof\-report\fR(1)
907 tool.
909 More information about how to use the log profiler is available on
910 the \fBmono\-profilers\fR(1) page, under the \fBLOG PROFILER\fR
911 section, as well as the \fBmprof\-report\fR(1) page.
912 .SS Coverage profiler
913 The code coverage profiler can instrument a program to help determine
914 which classes, methods, code paths, etc are actually executed. This
915 is most useful when running a test suite to determine whether the
916 tests actually cover the code they're expected to.
918 More information about how to use the coverage profiler is available
919 on the \fBmono\-profilers\fR(1) page, under the \fBCOVERAGE
920 PROFILER\fR section.
921 .SS AOT profiler
922 The AOT profiler can help improve startup performance by logging
923 which generic instantiations are used by a program, which the AOT
924 compiler can then use to compile those instantiations ahead of time
925 so that they won't have to be JIT compiled at startup.
927 More information about how to use the AOT profiler is available on
928 the \fBmono\-profilers\fR(1) page, under the \fBAOT PROFILER\fR
929 section.
930 .SS Custom profilers
931 Custom profiler modules can be loaded in exactly the same way as the
932 standard modules that ship with Mono. They can also access the same
933 profiler API to gather all kinds of information about the code being
934 executed.
936 For example, to use a third-party profiler called \fBcustom\fR, you
937 would load it like this:
941 mono --profile=custom program.exe
945 You could also pass arguments to it:
949 mono --profile=custom:arg1,arg2=arg3 program.exe
953 In the above example, Mono will load the profiler from the shared
954 library called \fIlibmono\-profiler\-custom.so\fR (name varies based
955 on platform, e.g., \fIlibmono\-profiler\-custom.dylib\fR on OS X).
956 This profiler module must be on your dynamic linker library path
957 (\fBLD_LIBRARY_PATH\fR on most systems, \fBDYLD_LIBRARY_PATH\fR on
958 OS X).
960 For a sample of how to write your own custom profiler, look at the
961 \fIsamples/profiler/sample.c\fR file in the Mono source tree.
962 .SH DEBUGGING AIDS
963 To debug managed applications, you can use the 
964 .B mdb
965 command, a command line debugger.  
967 It is possible to obtain a stack trace of all the active threads in
968 Mono by sending the QUIT signal to Mono, you can do this from the
969 command line, like this:
972         kill -QUIT pid
975 Where pid is the Process ID of the Mono process you want to examine.
976 The process will continue running afterwards, but its state is not
977 guaranteed.
979 .B Important:
980 this is a last-resort mechanism for debugging applications and should
981 not be used to monitor or probe a production application.  The
982 integrity of the runtime after sending this signal is not guaranteed
983 and the application might crash or terminate at any given point
984 afterwards.   
986 The \fB--debug=casts\fR option can be used to get more detailed
987 information for Invalid Cast operations, it will provide information
988 about the types involved.   
990 You can use the MONO_LOG_LEVEL and MONO_LOG_MASK environment variables
991 to get verbose debugging output about the execution of your
992 application within Mono.
994 The 
995 .I MONO_LOG_LEVEL
996 environment variable if set, the logging level is changed to the set
997 value. Possible values are "error", "critical", "warning", "message",
998 "info", "debug". The default value is "error". Messages with a logging
999 level greater then or equal to the log level will be printed to
1000 stdout/stderr.
1002 Use "info" to track the dynamic loading of assemblies.
1005 Use the 
1006 .I MONO_LOG_MASK
1007 environment variable to limit the extent of the messages you get: 
1008 If set, the log mask is changed to the set value. Possible values are
1009 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
1010 (garbage collector), "cfg" (config file loader), "aot" (precompiler),
1011 "security" (e.g. Moonlight CoreCLR support), "threadpool" (thread pool generic), 
1012 "io-selector" (async socket operations), "io-layer" (I/O layer - processes, files, 
1013 sockets, events, semaphores, mutexes and handles), "io-layer-process", 
1014 "io-layer-file", "io-layer-socket", "io-layer-event", "io-layer-semaphore", 
1015 "io-layer-mutex", "io-layer-handle" and "all". 
1016 The default value is "all". Changing the mask value allows you to display only 
1017 messages for a certain component. You can use multiple masks by comma 
1018 separating them. For example to see config file messages and assembly loader
1019 messages set you mask to "asm,cfg".
1021 The following is a common use to track down problems with P/Invoke:
1024         $ MONO_LOG_LEVEL="debug" MONO_LOG_MASK="dll" mono glue.exe
1028 .SH DEBUGGING WITH LLDB
1029 If you are using LLDB, you can use the 
1030 .B mono.py
1031 script to print some internal data structures with it.   To use this,
1032 add this to your 
1033 .B  $HOME/.lldbinit
1034 file:
1036 command script import $PREFIX/lib/mono/lldb/mono.py
1039 Where $PREFIX is the prefix value that you used when you configured
1040 Mono (typically /usr).
1042 Once this is done, then you can inspect some Mono Runtime data structures,
1043 for example:
1045 (lldb) p method
1047 (MonoMethod *) $0 = 0x05026ac0 [mscorlib]System.OutOfMemoryException:.ctor()
1049 .SH SERIALIZATION
1050 Mono's XML serialization engine by default will use a reflection-based
1051 approach to serialize which might be slow for continuous processing
1052 (web service applications).  The serialization engine will determine
1053 when a class must use a hand-tuned serializer based on a few
1054 parameters and if needed it will produce a customized C# serializer
1055 for your types at runtime.  This customized serializer then gets
1056 dynamically loaded into your application.
1058 You can control this with the MONO_XMLSERIALIZER_THS environment
1059 variable.
1061 The possible values are 
1062 .B `no' 
1063 to disable the use of a C# customized
1064 serializer, or an integer that is the minimum number of uses before
1065 the runtime will produce a custom serializer (0 will produce a
1066 custom serializer on the first access, 50 will produce a serializer on
1067 the 50th use). Mono will fallback to an interpreted serializer if the
1068 serializer generation somehow fails. This behavior can be disabled
1069 by setting the option
1070 .B `nofallback'
1071 (for example: MONO_XMLSERIALIZER_THS=0,nofallback).
1072 .SH ENVIRONMENT VARIABLES
1074 \fBGC_DONT_GC\fR
1075 Turns off the garbage collection in Mono.  This should be only used
1076 for debugging purposes
1078 \fBHTTP_PROXY\fR
1079 (Also \fBhttp_proxy\fR) If set, web requests using the Mono
1080 Class Library will be automatically proxied through the given URL.
1081 Not supported on Windows, Mac OS, iOS or Android. See also \fBNO_PROXY\fR.
1083 \fBLLVM_COUNT\fR
1084 When Mono is compiled with LLVM support, this instructs the runtime to
1085 stop using LLVM after the specified number of methods are JITed.
1086 This is a tool used in diagnostics to help isolate problems in the
1087 code generation backend.   For example \fBLLVM_COUNT=10\fR would only
1088 compile 10 methods with LLVM and then switch to the Mono JIT engine.
1089 \fBLLVM_COUNT=0\fR would disable the LLVM engine altogether.
1091 \fBMONO_ASPNET_INHIBIT_SETTINGSMAP\fR
1092 Mono contains a feature which allows modifying settings in the .config files shipped
1093 with Mono by using config section mappers. The mappers and the mapping rules are
1094 defined in the $prefix/etc/mono/2.0/settings.map file and, optionally, in the
1095 settings.map file found in the top-level directory of your ASP.NET application.
1096 Both files are read by System.Web on application startup, if they are found at the
1097 above locations. If you don't want the mapping to be performed you can set this
1098 variable in your environment before starting the application and no action will
1099 be taken.
1101 \fBMONO_ASPNET_WEBCONFIG_CACHESIZE\fR
1102 Mono has a cache of ConfigSection objects for speeding up WebConfigurationManager
1103 queries. Its default size is 100 items, and when more items are needed, cache
1104 evictions start happening. If evictions are too frequent this could impose
1105 unnecessary overhead, which could be avoided by using this environment variable
1106 to set up a higher cache size (or to lower memory requirements by decreasing it).
1108 \fBMONO_CAIRO_DEBUG_DISPOSE\fR
1109 If set, causes Mono.Cairo to collect stack traces when objects are allocated,
1110 so that the finalization/Dispose warnings include information about the
1111 instance's origin.
1113 \fBMONO_CFG_DIR\fR
1114 If set, this variable overrides the default system configuration directory
1115 ($PREFIX/etc). It's used to locate machine.config file.
1117 \fBMONO_COM\fR
1118 Sets the style of COM interop.  If the value of this variable is "MS"
1119 Mono will use string marhsalling routines from the liboleaut32 for the
1120 BSTR type library, any other values will use the mono-builtin BSTR
1121 string marshalling.
1123 \fBMONO_CONFIG\fR
1124 If set, this variable overrides the default runtime configuration file
1125 ($PREFIX/etc/mono/config). The --config command line options overrides the
1126 environment variable.
1128 \fBMONO_CPU_ARCH\fR
1129 Override the automatic cpu detection mechanism. Currently used only on arm.
1130 The format of the value is as follows:
1133         "armvV [thumb[2]]"
1136 where V is the architecture number 4, 5, 6, 7 and the options can be currently be
1137 "thumb" or "thumb2". Example:
1140         MONO_CPU_ARCH="armv4 thumb" mono ...
1144 \fBMONO_ARM_FORCE_SOFT_FLOAT\fR
1145 When Mono is built with a soft float fallback on ARM and this variable is set to
1146 "1", Mono will always emit soft float code, even if a VFP unit is
1147 detected.
1149 \fBMONO_DARWIN_USE_KQUEUE_FSW\fR
1150 Fall back on the kqueue FileSystemWatcher implementation in Darwin. The default is the FSEvent implementation.
1152 \fBMONO_DARWIN_WATCHER_MAXFDS\fR
1153 This is a debugging aid used to force limits on the kqueue FileSystemWatcher
1154 implementation in Darwin.   There is no limit by default.
1156 \fBMONO_DISABLE_MANAGED_COLLATION\fR
1157 If this environment variable is `yes', the runtime uses unmanaged
1158 collation (which actually means no culture-sensitive collation). It
1159 internally disables managed collation functionality invoked via the
1160 members of System.Globalization.CompareInfo class. Collation is
1161 enabled by default.
1163 \fBMONO_DISABLE_SHARED_AREA\fR
1164 Unix only: If set, disable usage of shared memory for exposing
1165 performance counters. This means it will not be possible to both
1166 externally read performance counters from this processes or read
1167 those of external processes.
1169 \fBMONO_DNS\fR
1170 When set, enables the use of a fully managed DNS resolver instead of the
1171 regular libc functions. This resolver performs much better when multiple
1172 queries are run in parallel.
1174 Note that /etc/nsswitch.conf will be ignored.
1176 \fBMONO_EGD_SOCKET\fR
1177 For platforms that do not otherwise have a way of obtaining random bytes
1178 this can be set to the name of a file system socket on which an egd or
1179 prngd daemon is listening.
1181 \fBMONO_ENABLE_AIO\fR
1182 If set, tells mono to attempt using native asynchronous I/O services. If not
1183 set, a default select/poll implementation is used. Currently epoll and kqueue
1184 are supported.
1186 \fBMONO_THREADS_SUSPEND\fR Selects a mechanism that Mono will use to suspend
1187 threads.  May be set to "preemptive", "coop", or "hybrid".  Threads may need to
1188 be suspended by the debugger, or using some .NET threading APIs, and most
1189 commonly when the SGen garbage collector needs to stop all threads during a
1190 critical phase of garbage collection.  Preemptive mode is the mode that Mono
1191 has used historically, going back to the Boehm days, where the garbage
1192 collector would run at any point and suspend execution of all threads as
1193 required to perform a garbage collection.  The cooperative mode on the other
1194 hand requires the cooperation of all threads to stop at a safe point.  This
1195 makes for an easier to debug garbage collector and it improves the stability of
1196 the runtime because threads are not suspended when accessing critical
1197 resources.  In scenarios where Mono is embedded in another application,
1198 cooperative suspend requires the embedder code to follow coding guidelines in
1199 order to cooperate with the garbage collector.  Cooperative suspend in embedded
1200 Mono is currently experimental.  Hybrid mode is a combination of the two that
1201 retains better compatability with scenarios where Mono is embedded in another
1202 application: threads that are running managed code or code that comprises the
1203 Mono runtime will be cooperatively suspended, while threads running embedder
1204 code will be preemptively suspended.  Hybrid suspend is the default on some
1205 desktop platforms.
1207 Alternatively, coop and hybrid mode can be enabled at compile time by using the
1208 --enable-cooperative-suspend or --enable-hybrid-suspend flags, respectively,
1209 when calling configure.  The \fBMONO_THREADS_SUSPEND\fR environment variable
1210 takes priority over the compiled default.
1212 \fBMONO_ENABLE_COOP_SUSPEND\fR
1213 This environment variable is obsolete, but retained for backward compatibility.
1214 Use \fBMONO_THREADS_SUSPEND\fR set to "coop" instead.  Note that if configure flags
1215 were provided to enable cooperative or hybrid suspend, this variable is ignored.
1217 \fBMONO_ENV_OPTIONS\fR
1218 This environment variable allows you to pass command line arguments to
1219 a Mono process through the environment.   This is useful for example
1220 to force all of your Mono processes to use LLVM or SGEN without having
1221 to modify any launch scripts.
1223 \fBMONO_SDB_ENV_OPTIONS\fR
1224 Used to pass extra options to the debugger agent in the runtime, as they were passed
1225 using --debugger-agent=.
1227 \fBMONO_EVENTLOG_TYPE\fR
1228 Sets the type of event log provider to use (for System.Diagnostics.EventLog).
1230 Possible values are:
1233 .I "local[:path]"
1235 Persists event logs and entries to the local file system.
1237 The directory in which to persist the event logs, event sources and entries
1238 can be specified as part of the value.
1240 If the path is not explicitly set, it defaults to "/var/lib/mono/eventlog"
1241 on unix and "%APPDATA%\mono\eventlog" on Windows.
1243 .I "win32"
1245 .B 
1246 Uses the native win32 API to write events and registers event logs and
1247 event sources in the registry.   This is only available on Windows. 
1249 On Unix, the directory permission for individual event log and event source
1250 directories is set to 777 (with +t bit) allowing everyone to read and write
1251 event log entries while only allowing entries to be deleted by the user(s)
1252 that created them.
1254 .I "null"
1256 Silently discards any events.
1259 The default is "null" on Unix (and versions of Windows before NT), and 
1260 "win32" on Windows NT (and higher).
1263 \fBMONO_EXTERNAL_ENCODINGS\fR
1264 If set, contains a colon-separated list of text encodings to try when
1265 turning externally-generated text (e.g. command-line arguments or
1266 filenames) into Unicode.  The encoding names come from the list
1267 provided by iconv, and the special case "default_locale" which refers
1268 to the current locale's default encoding.
1270 When reading externally-generated text strings UTF-8 is tried first,
1271 and then this list is tried in order with the first successful
1272 conversion ending the search.  When writing external text (e.g. new
1273 filenames or arguments to new processes) the first item in this list
1274 is used, or UTF-8 if the environment variable is not set.
1276 The problem with using MONO_EXTERNAL_ENCODINGS to process your
1277 files is that it results in a problem: although its possible to get
1278 the right file name it is not necessarily possible to open the file.
1279 In general if you have problems with encodings in your filenames you
1280 should use the "convmv" program.
1282 \fBMONO_GC_PARAMS\fR
1283 When using Mono with the SGen garbage collector this variable controls
1284 several parameters of the collector.  The variable's value is a comma
1285 separated list of words.
1287 .ne 8
1289 \fBmax-heap-size=\fIsize\fR
1290 Sets the maximum size of the heap. The size is specified in bytes and must
1291 be a power of two. The suffixes `k', `m' and `g' can be used to
1292 specify kilo-, mega- and gigabytes, respectively. The limit is the sum
1293 of the nursery, major heap and large object heap. Once the limit is reached
1294 the application will receive OutOfMemoryExceptions when trying to allocate.
1295 Not the full extent of memory set in max-heap-size could be available to
1296 satisfy a single allocation due to internal fragmentation. By default heap
1297 limits is disabled and the GC will try to use all available memory.
1299 \fBnursery-size=\fIsize\fR
1300 Sets the size of the nursery.  The size is specified in bytes and must
1301 be a power of two.  The suffixes `k', `m' and `g' can be used to
1302 specify kilo-, mega- and gigabytes, respectively.  The nursery is the
1303 first generation (of two).  A larger nursery will usually speed up the
1304 program but will obviously use more memory.  The default nursery size
1305 4 MB.
1307 \fBmajor=\fIcollector\fR
1308 Specifies which major collector to use.
1309 Options are `marksweep' for the Mark&Sweep collector, `marksweep-conc'
1310 for concurrent Mark&Sweep and `marksweep-conc-par' for parallel and
1311 concurrent Mark&Sweep.  The concurrent Mark&Sweep collector is the default.
1313 \fBmode=balanced|throughput|pause\fR[:\fImax-pause\fR]
1314 Specifies what should be the garbage collector's target. The `throughput'
1315 mode aims to reduce time spent in the garbage collector and improve
1316 application speed, the `pause' mode aims to keep pause times to a minimum
1317 and it receives the argument \fImax-pause\fR which specifies the maximum
1318 pause time in milliseconds that is acceptable and the `balanced' mode
1319 which is a general purpose optimal mode.
1321 \fBsoft-heap-limit=\fIsize\fR
1322 Once the heap size gets larger than this size, ignore what the default
1323 major collection trigger metric says and only allow four nursery size's
1324 of major heap growth between major collections.
1326 \fBevacuation-threshold=\fIthreshold\fR
1327 Sets the evacuation threshold in percent.  This option is only available
1328 on the Mark&Sweep major collectors.  The value must be an
1329 integer in the range 0 to 100.  The default is 66.  If the sweep phase of
1330 the collection finds that the occupancy of a specific heap block type is
1331 less than this percentage, it will do a copying collection for that block
1332 type in the next major collection, thereby restoring occupancy to close
1333 to 100 percent.  A value of 0 turns evacuation off.
1335 \fB(no-)lazy-sweep\fR
1336 Enables or disables lazy sweep for the Mark&Sweep collector.  If
1337 enabled, the sweeping of individual major heap blocks is done
1338 piecemeal whenever the need arises, typically during nursery
1339 collections.  Lazy sweeping is enabled by default.
1341 \fB(no-)concurrent-sweep\fR
1342 Enables or disables concurrent sweep for the Mark&Sweep collector.  If
1343 enabled, the iteration of all major blocks to determine which ones can
1344 be freed and which ones have to be kept and swept, is done
1345 concurrently with the running program.  Concurrent sweeping is enabled
1346 by default.
1348 \fBstack-mark=\fImark-mode\fR
1349 Specifies how application threads should be scanned. Options are
1350 `precise` and `conservative`. Precise marking allow the collector
1351 to know what values on stack are references and what are not.
1352 Conservative marking threats all values as potentially references
1353 and leave them untouched. Precise marking reduces floating garbage
1354 and can speed up nursery collection and allocation rate, it has
1355 the downside of requiring a significant extra memory per compiled
1356 method. The right option, unfortunately, requires experimentation.
1358 \fBsave-target-ratio=\fIratio\fR
1359 Specifies the target save ratio for the major collector. The collector
1360 lets a given amount of memory to be promoted from the nursery due to
1361 minor collections before it triggers a major collection. This amount
1362 is based on how much memory it expects to free. It is represented as
1363 a ratio of the size of the heap after a major collection.
1364 Valid values are between 0.1 and 2.0. The default is 0.5.
1365 Smaller values will keep the major heap size smaller but will trigger
1366 more major collections. Likewise, bigger values will use more memory
1367 and result in less frequent major collections.
1368 This option is EXPERIMENTAL, so it might disappear in later versions of mono.
1370 \fBdefault-allowance-ratio=\fIratio\fR
1371 Specifies the default allocation allowance when the calculated size
1372 is too small. The allocation allowance is how much memory the collector
1373 let be promoted before triggered a major collection.
1374 It is a ratio of the nursery size.
1375 Valid values are between 1.0 and 10.0. The default is 4.0.
1376 Smaller values lead to smaller heaps and more frequent major collections.
1377 Likewise, bigger values will allow the heap to grow faster but use
1378 more memory when it reaches a stable size.
1379 This option is EXPERIMENTAL, so it might disappear in later versions of mono.
1381 \fBminor=\fIminor-collector\fR
1382 Specifies which minor collector to use. Options are `simple' which
1383 promotes all objects from the nursery directly to the old generation,
1384 `simple-par' which has same promotion behavior as `simple' but using
1385 multiple workers and `split' which lets objects stay longer on the nursery
1386 before promoting.
1388 \fBalloc-ratio=\fIratio\fR
1389 Specifies the ratio of memory from the nursery to be use by the alloc space.
1390 This only can only be used with the split minor collector.
1391 Valid values are integers between 1 and 100. Default is 60.
1393 \fBpromotion-age=\fIage\fR
1394 Specifies the required age of an object must reach inside the nursery before
1395 been promoted to the old generation. This only can only be used with the
1396 split minor collector.
1397 Valid values are integers between 1 and 14. Default is 2.
1399 \fB(no-)cementing\fR
1400 Enables or disables cementing.  This can dramatically shorten nursery
1401 collection times on some benchmarks where pinned objects are referred
1402 to from the major heap.
1404 \fBallow-synchronous-major\fR
1405 This forbids the major collector from performing synchronous major collections.
1406 The major collector might want to do a synchronous collection due to excessive
1407 fragmentation. Disabling this might trigger OutOfMemory error in situations that
1408 would otherwise not happen.
1412 \fBMONO_GC_DEBUG\fR
1413 When using Mono with the SGen garbage collector this environment
1414 variable can be used to turn on various debugging features of the
1415 collector.  The value of this variable is a comma separated list of
1416 words.  Do not use these options in production.
1418 .ne 8
1420 \fInumber\fR
1421 Sets the debug level to the specified number.
1423 \fBprint-allowance\fR
1424 After each major collection prints memory consumption for before and
1425 after the collection and the allowance for the minor collector, i.e. how
1426 much the heap is allowed to grow from minor collections before the next
1427 major collection is triggered.
1429 \fBprint-pinning\fR
1430 Gathers statistics on the classes whose objects are pinned in the
1431 nursery and for which global remset entries are added.  Prints those
1432 statistics when shutting down.
1434 \fBcollect-before-allocs\fR
1436 \fBcheck-remset-consistency\fR
1437 This performs a remset consistency check at various opportunities, and
1438 also clears the nursery at collection time, instead of the default,
1439 when buffers are allocated (clear-at-gc).  The consistency check
1440 ensures that there are no major to minor references that are not on
1441 the remembered sets.
1443 \fBmod-union-consistency-check\fR
1444 Checks that the mod-union cardtable is consistent before each
1445 finishing major collection pause.  This check is only applicable to
1446 concurrent major collectors.
1448 \fBcheck-mark-bits\fR
1449 Checks that mark bits in the major heap are consistent at the end of
1450 each major collection.  Consistent mark bits mean that if an object is
1451 marked, all objects that it had references to must also be marked.
1453 \fBcheck-nursery-untag\fR
1454 After garbage collections, check whether all vtable pointers are no
1455 longer tagged.
1457 \fBxdomain-checks\fR
1458 Performs a check to make sure that no references are left to an
1459 unloaded AppDomain.
1461 \fBclear-at-tlab-creation\fR
1462 Clears the nursery incrementally when the thread local allocation
1463 buffers (TLAB) are created.  The default setting clears the whole
1464 nursery at GC time.
1466 \fBdebug-clear-at-tlab-creation\fR
1467 Clears the nursery incrementally when the thread local allocation
1468 buffers (TLAB) are created, but at GC time fills it with the byte
1469 `0xff`, which should result in a crash more quickly if
1470 `clear-at-tlab-creation` doesn't work properly.
1472 \fBclear-at-gc\fR
1473 This clears the nursery at GC time instead of doing it when the thread
1474 local allocation buffer (TLAB) is created.  The default is to clear
1475 the nursery at TLAB creation time.
1477 \fBdisable-minor\fR
1478 Don't do minor collections.  If the nursery is full, a major collection
1479 is triggered instead, unless it, too, is disabled.
1481 \fBdisable-major\fR
1482 Don't do major collections.
1484 \fBconservative-stack-mark\fR
1485 Forces the GC to scan the stack conservatively, even if precise
1486 scanning is available.
1488 \fBno-managed-allocator\fR
1489 Disables the managed allocator.
1491 \fBcheck-scan-starts\fR
1492 If set, does a plausibility check on the scan_starts before and after each collection
1494 \fBverify-nursery-at-minor-gc\fR
1495 If set, does a complete object walk of the nursery at the start of each minor collection.
1497 \fBdump-nursery-at-minor-gc\fR
1498 If set, dumps the contents of the nursery at the start of each minor collection. Requires 
1499 verify-nursery-at-minor-gc to be set.
1501 \fBheap-dump=\fIfile\fR
1502 Dumps the heap contents to the specified file.   To visualize the
1503 information, use the mono-heapviz tool.
1505 \fBbinary-protocol=\fIfile\fR
1506 Outputs the debugging output to the specified file.   For this to
1507 work, Mono needs to be compiled with the BINARY_PROTOCOL define on
1508 sgen-gc.c.   You can then use this command to explore the output
1510                 sgen-grep-binprot 0x1234 0x5678 < file
1513 \fBnursery-canaries\fR
1514 If set, objects allocated in the nursery are suffixed with a canary (guard)
1515 word, which is checked on each minor collection. Can be used to detect/debug
1516 heap corruption issues.
1519 \fBdo-not-finalize(=\fIclasses\fB)\fR
1520 If enabled, finalizers will not be run.  Everything else will be
1521 unaffected: finalizable objects will still be put into the
1522 finalization queue where they survive until they're scheduled to
1523 finalize.  Once they're not in the queue anymore they will be
1524 collected regularly.  If a list of comma-separated class names is
1525 given, only objects from those classes will not be finalized.
1528 \fBlog-finalizers\fR
1529 Log verbosely around the finalization process to aid debugging.
1533 \fBMONO_GAC_PREFIX\fR
1534 Provides a prefix the runtime uses to look for Global Assembly Caches.
1535 Directories are separated by the platform path separator (colons on
1536 unix). MONO_GAC_PREFIX should point to the top directory of a prefixed
1537 install. Or to the directory provided in the gacutil /gacdir command. Example:
1538 .B /home/username/.mono:/usr/local/mono/
1540 \fBMONO_IOMAP\fR
1541 Enables some filename rewriting support to assist badly-written
1542 applications that hard-code Windows paths.  Set to a colon-separated
1543 list of "drive" to strip drive letters, or "case" to do
1544 case-insensitive file matching in every directory in a path.  "all"
1545 enables all rewriting methods.  (Backslashes are always mapped to
1546 slashes if this variable is set to a valid option).
1549 For example, this would work from the shell:
1552         MONO_IOMAP=drive:case
1553         export MONO_IOMAP
1556 If you are using mod_mono to host your web applications, you can use
1557 the 
1558 .B MonoIOMAP
1559 directive instead, like this:
1562         MonoIOMAP <appalias> all
1565 See mod_mono(8) for more details.
1567 \fBMONO_LLVM\fR
1568 When Mono is using the LLVM code generation backend you can use this
1569 environment variable to pass code generation options to the LLVM
1570 compiler.   
1572 \fBMONO_MANAGED_WATCHER\fR
1573 If set to "disabled", System.IO.FileSystemWatcher will use a file watcher 
1574 implementation which silently ignores all the watching requests.
1575 If set to any other value, System.IO.FileSystemWatcher will use the default
1576 managed implementation (slow). If unset, mono will try to use inotify, FAM, 
1577 Gamin, kevent under Unix systems and native API calls on Windows, falling 
1578 back to the managed implementation on error.
1580 \fBMONO_MESSAGING_PROVIDER\fR
1581 Mono supports a plugin model for its implementation of System.Messaging making
1582 it possible to support a variety of messaging implementations (e.g. AMQP, ActiveMQ).
1583 To specify which messaging implementation is to be used the evironement variable
1584 needs to be set to the full class name for the provider.  E.g. to use the RabbitMQ based
1585 AMQP implementation the variable should be set to:
1588 Mono.Messaging.RabbitMQ.RabbitMQMessagingProvider,Mono.Messaging.RabbitMQ
1590 \fBMONO_NO_SMP\fR
1591 If set causes the mono process to be bound to a single processor. This may be
1592 useful when debugging or working around race conditions.
1594 \fBMONO_NO_TLS\fR
1595 Disable inlining of thread local accesses. Try setting this if you get a segfault
1596 early on in the execution of mono.
1598 \fBMONO_PATH\fR
1599 Provides a search path to the runtime where to look for library
1600 files.   This is a tool convenient for debugging applications, but
1601 should not be used by deployed applications as it breaks the assembly
1602 loader in subtle ways. 
1604 Directories are separated by the platform path separator (colons on unix). Example:
1605 .B /home/username/lib:/usr/local/mono/lib
1607 Relative paths are resolved based on the launch-time current directory.
1609 Alternative solutions to MONO_PATH include: installing libraries into
1610 the Global Assembly Cache (see gacutil(1)) or having the dependent
1611 libraries side-by-side with the main executable.
1613 For a complete description of recommended practices for application
1614 deployment, see
1615 http://www.mono-project.com/docs/getting-started/application-deployment/
1617 \fBMONO_SHARED_DIR\fR
1618 If set its the directory where the ".wapi" handle state is stored.
1619 This is the directory where the Windows I/O Emulation layer stores its
1620 shared state data (files, events, mutexes, pipes).  By default Mono
1621 will store the ".wapi" directory in the users's home directory.
1622 .TP 
1623 \fBMONO_SHARED_HOSTNAME\fR
1624 Uses the string value of this variable as a replacement for the host name when
1625 creating file names in the ".wapi" directory. This helps if the host name of
1626 your machine is likely to be changed when a mono application is running or if
1627 you have a .wapi directory shared among several different computers.
1629 Mono typically uses the hostname to create the files that are used to
1630 share state across multiple Mono processes.  This is done to support
1631 home directories that might be shared over the network.
1633 \fBMONO_STRICT_IO_EMULATION\fR
1634 If set, extra checks are made during IO operations.  Currently, this
1635 includes only advisory locks around file writes.
1637 \fBMONO_TLS_PROVIDER\fR
1638 This environment variable controls which TLS/SSL provider Mono will
1639 use.  The options are usually determined by the operating system where
1640 Mono was compiled and the configuration options that were used for
1641 it.   
1643 .ne 8
1645 .I default
1646 Uses the default TLS stack that the Mono runtime was configured with.
1647 Usually this is configured to use Apple's SSL stack on Apple
1648 platforms, and Boring SSL on other platforms.
1650 .I apple
1651 Forces the use of the Apple SSL stack, only works on Apple platforms.
1653 .I btls
1654 Forces the use of the BoringSSL stack.    See
1655 https://opensource.google.com/projects/boringssl for more information
1656 about this stack.
1658 .I legacy
1659 This is the old Mono stack, which only supports SSL and TLS up to
1660 version 1.0.   It is deprecated and will be removed in the future.
1663 \fBMONO_TLS_SESSION_CACHE_TIMEOUT\fR
1664 The time, in seconds, that the SSL/TLS session cache will keep it's entry to
1665 avoid a new negotiation between the client and a server. Negotiation are very
1666 CPU intensive so an application-specific custom value may prove useful for 
1667 small embedded systems.
1669 The default is 180 seconds.
1671 \fBMONO_THREADS_PER_CPU\fR
1672 The minimum number of threads in the general threadpool will be 
1673 MONO_THREADS_PER_CPU * number of CPUs. The default value for this
1674 variable is 1.
1676 \fBMONO_XMLSERIALIZER_THS\fR
1677 Controls the threshold for the XmlSerializer to produce a custom
1678 serializer for a given class instead of using the Reflection-based
1679 interpreter.  The possible values are `no' to disable the use of a
1680 custom serializer or a number to indicate when the XmlSerializer
1681 should start serializing.   The default value is 50, which means that
1682 the a custom serializer will be produced on the 50th use.
1684 \fBMONO_X509_REVOCATION_MODE\fR
1685 Sets the revocation mode used when validating a X509 certificate chain (https,
1686 ftps, smtps...).  The default is 'nocheck', which performs no revocation check
1687 at all. The other possible values are 'offline', which performs CRL check (not
1688 implemented yet) and 'online' which uses OCSP and CRL to verify the revocation
1689 status (not implemented yet).
1691 \fBNO_PROXY\fR
1692 (Also \fBno_proxy\fR) If both \fBHTTP_PROXY\fR and \fBNO_PROXY\fR are
1693 set, \fBNO_PROXY\fR will be treated as a comma-separated list of "bypass" domains
1694 which will not be sent through the proxy. Domains in \fBNO_PROXY\fR may contain
1695 wildcards, as in "*.mono-project.com" or "build????.local". Not supported on
1696 Windows, Mac OS, iOS or Android.
1697 .SH ENVIRONMENT VARIABLES FOR DEBUGGING
1699 \fBMONO_ASPNET_NODELETE\fR
1700 If set to any value, temporary source files generated by ASP.NET support
1701 classes will not be removed. They will be kept in the user's temporary
1702 directory.
1704 \fBMONO_DEBUG\fR
1705 If set, enables some features of the runtime useful for debugging.
1706 This variable should contain a comma separated list of debugging options.
1707 Currently, the following options are supported:
1709 .ne 8
1711 \fBalign-small-structs\fR
1712 Enables small structs alignment to 4/8 bytes.
1714 \fBarm-use-fallback-tls\fR
1715 When this option is set on ARM, a fallback thread local store will be used instead
1716 of the default fast thread local storage primitives.
1718 \fBbreak-on-unverified\fR
1719 If this variable is set, when the Mono VM runs into a verification
1720 problem, instead of throwing an exception it will break into the
1721 debugger.  This is useful when debugging verifier problems
1723 \fBcasts\fR
1724 This option can be used to get more detailed information from
1725 InvalidCast exceptions, it will provide information about the types
1726 involved.     
1728 \fBcheck-pinvoke-callconv\fR
1729 This option causes the runtime to check for calling convention
1730 mismatches when using pinvoke, i.e. mixing cdecl/stdcall. It only
1731 works on windows. If a mismatch is detected, an
1732 ExecutionEngineException is thrown.
1734 \fBcollect-pagefault-stats\fR
1735 Collects information about pagefaults.   This is used internally to
1736 track the number of page faults produced to load metadata.  To display
1737 this information you must use this option with "--stats" command line
1738 option.
1740 \fBdebug-domain-unload\fR
1741 When this option is set, the runtime will invalidate the domain memory
1742 pool instead of destroying it.
1744 \fBdisable_omit_fp\fR
1745 Disables a compiler optimization where the frame pointer is omitted
1746 from the stack. This optimization can interact badly with debuggers.
1748 \fBdont-free-domains\fR
1749 This is an Optimization for multi-AppDomain applications (most
1750 commonly ASP.NET applications).  Due to internal limitations Mono,
1751 Mono by default does not use typed allocations on multi-appDomain
1752 applications as they could leak memory when a domain is unloaded. 
1754 Although this is a fine default, for applications that use more than
1755 on AppDomain heavily (for example, ASP.NET applications) it is worth
1756 trading off the small leaks for the increased performance
1757 (additionally, since ASP.NET applications are not likely going to
1758 unload the application domains on production systems, it is worth
1759 using this feature). 
1761 \fBdyn-runtime-invoke\fR
1762 Instructs the runtime to try to use a generic runtime-invoke wrapper
1763 instead of creating one invoke wrapper.
1765 \fBexplicit-null-checks\fR
1766 Makes the JIT generate an explicit NULL check on variable dereferences
1767 instead of depending on the operating system to raise a SIGSEGV or
1768 another form of trap event when an invalid memory location is
1769 accessed.
1771 \fBgdb\fR 
1772 Equivalent to setting the \fBMONO_XDEBUG\fR variable, this emits
1773 symbols into a shared library as the code is JITed that can be loaded
1774 into GDB to inspect symbols.
1776 \fBgen-seq-points\fR 
1777 Automatically generates sequence points where the
1778 IL stack is empty.  These are places where the debugger can set a
1779 breakpoint.
1781 \fBno-compact-seq-points\fR
1782 Unless the option is used, the runtime generates sequence points data that
1783 maps native offsets to IL offsets. Sequence point data is used to
1784 display IL offset in stacktraces. Stacktraces with IL offsets can be
1785 symbolicated using mono-symbolicate tool.
1787 \fBhandle-sigint\fR
1788 Captures the interrupt signal (Control-C) and displays a stack trace
1789 when pressed.  Useful to find out where the program is executing at a
1790 given point.  This only displays the stack trace of a single thread. 
1792 \fBinit-stacks\fR
1793 Instructs the runtime to initialize the stack with
1794 some known values (0x2a on x86-64) at the start of a method to assist
1795 in debuggin the JIT engine.
1797 \fBkeep-delegates\fR
1798 This option will leak delegate trampolines that are no longer
1799 referenced as to present the user with more information about a
1800 delegate misuse.  Basically a delegate instance might be created,
1801 passed to unmanaged code, and no references kept in managed code,
1802 which will garbage collect the code.  With this option it is possible
1803 to track down the source of the problems. 
1805 \fBno-gdb-backtrace\fR
1806 This option will disable the GDB backtrace emitted by the runtime
1807 after a SIGSEGV or SIGABRT in unmanaged code.
1809 \fBpartial-sharing\fR
1810 When this option is set, the runtime can share generated code between
1811 generic types effectively reducing the amount of code generated.
1813 \fBreverse-pinvoke-exceptions
1814 This option will cause mono to abort with a descriptive message when
1815 during stack unwinding after an exception it reaches a native stack
1816 frame. This happens when a managed delegate is passed to native code,
1817 and the managed delegate throws an exception. Mono will normally try
1818 to unwind the stack to the first (managed) exception handler, and it
1819 will skip any native stack frames in the process. This leads to 
1820 undefined behaviour (since mono doesn't know how to process native
1821 frames), leaks, and possibly crashes too.
1823 \fBsingle-imm-size\fR
1824 This guarantees that each time managed code is compiled the same
1825 instructions and registers are used, regardless of the size of used
1826 values.
1828 \fBsoft-breakpoints\fR
1829 This option allows using single-steps and breakpoints in hardware
1830 where we cannot do it with signals.
1832 \fBsuspend-on-native-crash\fR
1833 This option will suspend the program when a native crash occurs (SIGSEGV, SIGILL, ...).
1834 This is useful for debugging crashes which do not happen under gdb,
1835 since a live process contains more information than a core file.
1837 \fBsuspend-on-sigsegv\fR
1838 Same as \fBsuspend-on-native-crash\fR.
1840 \fBsuspend-on-exception\fR
1841 This option will suspend the program when an exception occurs.
1843 \fBsuspend-on-unhandled\fR
1844 This option will suspend the program when an unhandled exception occurs.
1846 \fBthread-dump-dir=DIR\fR
1847 Use DIR for storage thread dumps created by SIGQUIT.
1849 \fBverbose-gdb\fR
1850 Make gdb output on native crashes more verbose.
1854 \fBMONO_LOG_LEVEL\fR
1855 The logging level, possible values are `error', `critical', `warning',
1856 `message', `info' and `debug'.  See the DEBUGGING section for more
1857 details.
1859 \fBMONO_LOG_MASK\fR
1860 Controls the domain of the Mono runtime that logging will apply to. 
1861 If set, the log mask is changed to the set value. Possible values are
1862 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
1863 (garbage collector), "cfg" (config file loader), "aot" (precompiler),
1864 "security" (e.g. Moonlight CoreCLR support) and "all". 
1865 The default value is "all". Changing the mask value allows you to display only 
1866 messages for a certain component. You can use multiple masks by comma 
1867 separating them. For example to see config file messages and assembly loader
1868 messages set you mask to "asm,cfg".
1870 \fBMONO_LOG_DEST\fR
1871 Controls where trace log messages are written. If not set then the messages go to stdout. 
1872 If set, the string either specifies a path to a file that will have messages appended to
1873 it, or the string "syslog" in which case the messages will be written to the system log.
1874 Under Windows, this is simulated by writing to a file called "mono.log". 
1875 \fBMONO_LOG_HEADER\fR
1876 Controls whether trace log messages not directed to syslog have the id, timestamp, and
1877 pid as the prefix to the log message. To enable a header this environment variable need
1878 just be non-null. 
1880 \fBMONO_TRACE\fR
1881 Used for runtime tracing of method calls. The format of the comma separated
1882 trace options is:
1885         [-]M:method name
1886         [-]N:namespace
1887         [-]T:class name
1888         [-]all
1889         [-]program
1890         disabled                Trace output off upon start.
1893 You can toggle trace output on/off sending a SIGUSR2 signal to the program.
1895 \fBMONO_TRACE_LISTENER\fR
1896 If set, enables the System.Diagnostics.DefaultTraceListener, which will 
1897 print the output of the System.Diagnostics Trace and Debug classes.  
1898 It can be set to a filename, and to Console.Out or Console.Error to display
1899 output to standard output or standard error, respectively. If it's set to
1900 Console.Out or Console.Error you can append an optional prefix that will
1901 be used when writing messages like this: Console.Error:MyProgramName.
1902 See the System.Diagnostics.DefaultTraceListener documentation for more
1903 information.
1905 \fBMONO_WCF_TRACE\fR
1906 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.
1908 \fBMONO_XEXCEPTIONS\fR
1909 This throws an exception when a X11 error is encountered; by default a
1910 message is displayed but execution continues
1912 \fBMONO_XMLSERIALIZER_DEBUG\fR
1913 Set this value to 1 to prevent the serializer from removing the
1914 temporary files that are created for fast serialization;  This might
1915 be useful when debugging.
1917 \fBMONO_XSYNC\fR
1918 This is used in the System.Windows.Forms implementation when running
1919 with the X11 backend.  This is used to debug problems in Windows.Forms
1920 as it forces all of the commands send to X11 server to be done
1921 synchronously.   The default mode of operation is asynchronous which
1922 makes it hard to isolate the root of certain problems.
1924 \fBMONO_XDEBUG\fR
1925 When the the MONO_XDEBUG env var is set, debugging info for JITted
1926 code is emitted into a shared library, loadable into gdb. This enables,
1927 for example, to see managed frame names on gdb backtraces.   
1929 \fBMONO_VERBOSE_METHOD\fR
1930 Enables the maximum JIT verbosity for the specified method. This is
1931 very helpfull to diagnose a miscompilation problems of a specific
1932 method.   This can be a semicolon-separated list of method names to
1933 match.  If the name is simple, this applies to any method with that
1934 name, otherwise you can use a mono method description (see the section
1935 METHOD DESCRIPTIONS).
1937 \fBMONO_JIT_DUMP_METHOD\fR
1938 Enables sending of the JITs intermediate representation for a specified
1939 method to the IdealGraphVisualizer tool.
1941 \fBMONO_VERBOSE_HWCAP\fR
1942 If set, makes the JIT output information about detected CPU features
1943 (such as SSE, CMOV, FCMOV, etc) to stdout.
1945 \fBMONO_CONSERVATIVE_HWCAP\fR
1946 If set, the JIT will not perform any hardware capability detection. This
1947 may be useful to pinpoint the cause of JIT issues. This is the default
1948 when Mono is built as an AOT cross compiler, so that the generated code
1949 will run on most hardware.
1950 .SH VALGRIND
1951 If you want to use Valgrind, you will find the file `mono.supp'
1952 useful, it contains the suppressions for the GC which trigger
1953 incorrect warnings.  Use it like this:
1955     valgrind --suppressions=mono.supp mono ...
1957 .SH DTRACE
1958 On some platforms, Mono can expose a set of DTrace probes (also known
1959 as user-land statically defined, USDT Probes).
1961 They are defined in the file `mono.d'.
1963 .B ves-init-begin, ves-init-end
1965 Begin and end of runtime initialization.
1967 .B method-compile-begin, method-compile-end
1969 Begin and end of method compilation.
1970 The probe arguments are class name, method name and signature,
1971 and in case of method-compile-end success or failure of compilation.
1973 .B gc-begin, gc-end
1975 Begin and end of Garbage Collection.
1977 To verify the availability of the probes, run:
1979     dtrace -P mono'$target' -l -c mono
1981 .SH PERMISSIONS
1982 Mono's Ping implementation for detecting network reachability can
1983 create the ICMP packets itself without requiring the system ping
1984 command to do the work.  If you want to enable this on Linux for
1985 non-root users, you need to give the Mono binary special permissions.
1987 As root, run this command:
1989    # setcap cap_net_raw=+ep /usr/bin/mono
1991 .SH FILES
1992 On Unix assemblies are loaded from the installation lib directory.  If you set
1993 `prefix' to /usr, the assemblies will be located in /usr/lib.  On
1994 Windows, the assemblies are loaded from the directory where mono and
1995 mint live.
1997 .B ~/.mono/aot-cache
1999 The directory for the ahead-of-time compiler demand creation
2000 assemblies are located. 
2002 .B /etc/mono/config, ~/.mono/config
2004 Mono runtime configuration file.  See the mono-config(5) manual page
2005 for more information.
2007 .B ~/.config/.mono/certs, /usr/share/.mono/certs
2009 Contains Mono certificate stores for users / machine. See the certmgr(1) 
2010 manual page for more information on managing certificate stores and
2011 the mozroots(1) page for information on how to import the Mozilla root
2012 certificates into the Mono certificate store. 
2014 .B ~/.mono/assemblies/ASSEMBLY/ASSEMBLY.config
2016 Files in this directory allow a user to customize the configuration
2017 for a given system assembly, the format is the one described in the
2018 mono-config(5) page. 
2020 .B ~/.config/.mono/keypairs, /usr/share/.mono/keypairs
2022 Contains Mono cryptographic keypairs for users / machine. They can be 
2023 accessed by using a CspParameters object with DSACryptoServiceProvider
2024 and RSACryptoServiceProvider classes.
2026 .B ~/.config/.isolatedstorage, ~/.local/share/.isolatedstorage, /usr/share/.isolatedstorage
2028 Contains Mono isolated storage for non-roaming users, roaming users and 
2029 local machine. Isolated storage can be accessed using the classes from 
2030 the System.IO.IsolatedStorage namespace.
2032 .B <assembly>.config
2034 Configuration information for individual assemblies is loaded by the
2035 runtime from side-by-side files with the .config files, see the
2036 http://www.mono-project.com/Config for more information.
2038 .B Web.config, web.config
2040 ASP.NET applications are configured through these files, the
2041 configuration is done on a per-directory basis.  For more information
2042 on this subject see the http://www.mono-project.com/Config_system.web
2043 page. 
2044 .SH MAILING LISTS
2045 Mailing lists are listed at the
2046 http://www.mono-project.com/community/help/mailing-lists/
2047 .SH WEB SITE
2048 http://www.mono-project.com
2049 .SH SEE ALSO
2051 \fBcertmgr\fR(1), \fBcert-sync\fR(1), \fBcsharp\fR(1),
2052 \fBgacutil\fR(1), \fBmcs\fR(1), \fBmonodis\fR(1),
2053 \fBmono-config\fR(5), \fBmono\-profilers\fR(1),
2054 \fBmprof\-report\fR(1), \fBpdb2mdb\fR(1), \fBxsp\fR(1),
2055 \fBmod_mono\fR(8)
2057 For more information on AOT:
2058 http://www.mono-project.com/docs/advanced/aot/
2060 For ASP.NET-related documentation, see the xsp(1) manual page