[sgen] Fix heavy binary protocol build (#17037)
[mono-project.git] / man / mono.1
blob4370decd60e8caa91cbf0ca7eabf73e98cfbb5fb
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 mcpu=[native o generic]
250 cpu=native allows AOT mode to use all instructions current CPU supports, e.g. AVX2, SSE42, etc.
251 Default value is 'generic'.
252 .I llvm-outfile=[filename]
253 Gives the path for the temporary LLVM bitcode file created during AOT.
254 .I dedup
255 Each AOT module will typically contain the code for inflated methods and wrappers that
256 are called by code in that module. In dedup mode, we identify and skip compiling all of those
257 methods. When using this mode with fullaot, dedup-include is required or these methods will 
258 remain missing.
260 .I dedup-include=[filename]
261 In dedup-include mode, we are in the pass of compilation where we compile the methods
262 that we had previously skipped. All of them are emitted into the assembly that is passed
263 as this option. We consolidate the many duplicate skipped copies of the same method into one.
266 .I info
267 Print the architecture the AOT in this copy of Mono targets and quit.
269 .I interp
270 Generates all required wrappers, so that it is possible to run --interpreter without
271 any code generation at runtime.  This option only makes sense with \fBmscorlib.dll\fR.
272 Embedders can set
274 .I depfile=[filename]
275 Outputs a gcc -M style dependency file.
278 mono_jit_set_aot_mode (MONO_AOT_MODE_INTERP);
282 .I ld-flags
283 Additional flags to pass to the C linker (if the current AOT mode calls for invoking it).
285 .I llvm-path=<PREFIX>
286 Same for the llvm tools 'opt' and 'llc'.
288 .I msym-dir=<PATH>
289 Instructs the AOT compiler to generate offline sequence points .msym files.
290 The generated .msym files will be stored into a subfolder of <PATH> named as the
291 compilation AOTID.
293 .I mtriple=<TRIPLE>
294 Use the GNU style target triple <TRIPLE> to determine some code generation options, i.e.
295 --mtriple=armv7-linux-gnueabi will generate code that targets ARMv7. This is currently
296 only supported by the ARM backend. In LLVM mode, this triple is passed on to the LLVM
297 llc compiler.
299 .I nimt-trampolines=[number]
300 When compiling in full aot mode, the IMT trampolines must be precreated
301 in the AOT image.  You can add additional method trampolines with this argument.
302 Defaults to 512.
304 .I ngsharedvt-trampolines=[number]
305 When compiling in full aot mode, the value type generic sharing trampolines must be precreated
306 in the AOT image.  You can add additional method trampolines with this argument.
307 Defaults to 512.
309 .I nodebug
310 Instructs the AOT compiler to not output any debugging information.
312 .I no-direct-calls
313 This prevents the AOT compiler from generating a direct calls to a
314 method.   The AOT compiler usually generates direct calls for certain
315 methods that do not require going through the PLT (for example,
316 methods that are known to not require a hook like a static
317 constructor) or call into simple internal calls.
319 .I nrgctx-trampolines=[number]
320 When compiling in full aot mode, the generic sharing trampolines must be precreated
321 in the AOT image.  You can add additional method trampolines with this argument.
322 Defaults to 4096.
324 .I nrgctx-fetch-trampolines=[number]
325 When compiling in full aot mode, the generic sharing fetch trampolines must be precreated
326 in the AOT image.  You can add additional method trampolines with this argument.
327 Defaults to 128.
329 .I ntrampolines=[number]
330 When compiling in full aot mode, the method trampolines must be precreated
331 in the AOT image.  You can add additional method trampolines with this argument.
332 Defaults to 4096.
334 .I outfile=[filename]
335 Instructs the AOT compiler to save the output to the specified file.
337 .I print-skipped-methods
338 If the AOT compiler cannot compile a method for any reason, enabling this flag
339 will output the skipped methods to the console.
341 .I profile=[file]
342 Specify a file to use for profile-guided optimization. See the \fBAOT profiler\fR sub-section. To specify multiple files, include the
343 .I profile
344 option multiple times.
346 .I profile-only
347 AOT *only* the methods described in the files specified with the
348 .I profile
349 option. See the \fBAOT profiler\fR sub-section.
351 .I readonly-value=namespace.typename.fieldname=type/value
352 Override the value of a static readonly field. Usually, during JIT
353 compilation, the static constructor is ran eagerly, so the value of
354 a static readonly field is known at compilation time and the compiler
355 can do a number of optimizations based on it. During AOT, instead, the static
356 constructor can't be ran, so this option can be used to set the value of such
357 a field and enable the same set of optimizations.
358 Type can be any of i1, i2, i4 for integers of the respective sizes (in bytes).
359 Note that signed/unsigned numbers do not matter here, just the storage size.
360 This option can be specified multiple times and it doesn't prevent the static
361 constructor for the type defining the field to execute with the usual rules
362 at runtime (hence possibly computing a different value for the field).
364 .I save-temps,keep-temps
365 Instructs the AOT compiler to keep temporary files.
367 .I soft-debug
368 This instructs the compiler to generate sequence point checks that
369 allow Mono's soft debugger to debug applications even on systems where
370 it is not possible to set breakpoints or to single step (certain
371 hardware configurations like the cell phones and video gaming
372 consoles). 
374 .I static
375 Create an ELF object file (.o) or .s file which can be statically linked into an
376 executable when embedding the mono runtime. When this option is used, the object file
377 needs to be registered with the embedded runtime using the mono_aot_register_module
378 function which takes as its argument the mono_aot_module_<ASSEMBLY NAME>_info global
379 symbol from the object file:
382 extern void *mono_aot_module_hello_info;
384 mono_aot_register_module (mono_aot_module_hello_info);
388 .I stats
389 Print various stats collected during AOT compilation.
391 .I temp-path=[path]
392 Explicitly specify path to store temporary files created during AOT compilation.
394 .I threads=[number]
395 This is an experimental option for the AOT compiler to use multiple threads
396 when compiling the methods.
398 .I tool-prefix=<PREFIX>
399 Prepends <PREFIX> to the name of tools ran by the AOT compiler, i.e. 'as'/'ld'. For
400 example, --tool=prefix=arm-linux-gnueabi- will make the AOT compiler run
401 'arm-linux-gnueabi-as' instead of 'as'.
403 .I verbose
404 Prints additional information about type loading failures.
406 .I write-symbols,no-write-symbols
407 Instructs the AOT compiler to emit (or not emit) debug symbol information.
409 .I no-opt
410 Instructs the AOT compiler tot no call opt when compiling with LLVM.
412 For more information about AOT, see: http://www.mono-project.com/docs/advanced/aot/
415 \fB--aot-path=PATH\fR
416 List of additional directories to search for AOT images.
418 \fB--apply-bindings=FILE\fR
419 Apply the assembly bindings from the specified configuration file when running
420 the AOT compiler.  This is useful when compiling an auxiliary assembly that is
421 referenced by a main assembly that provides a configuration file.  For example,
422 if app.exe uses lib.dll then in order to make the assembly bindings from
423 app.exe.config available when compiling lib.dll ahead of time, use:
425         mono --apply-bindings=app.exe.config --aot lib.dll
428 \fB--assembly-loader=MODE\fR
429 If mode is \fBstrict\fR, Mono will check that the public key token, culture and version
430 of a candidate assembly matches the requested strong name.  If mode is \fBlegacy\fR, as
431 long as the name matches, the candidate will be allowed. \fBstrict\fR is the behavior
432 consistent with .NET Framework but may break some existing mono-based applications.
433 The default is \fBlegacy\fR.
435 \fB--attach=[options]\fR
436 Currently the only option supported by this command line argument is
437 \fBdisable\fR which disables the attach functionality.
439 \fB--config filename\fR
440 Load the specified configuration file instead of the default one(s).
441 The default files are /etc/mono/config and ~/.mono/config or the file
442 specified in the MONO_CONFIG environment variable, if set.  See the
443 mono-config(5) man page for details on the format of this file.
445 \fB--debugger-agent=[options]\fR 
446 This instructs the Mono runtime to
447 start a debugging agent inside the Mono runtime and connect it to a
448 client user interface will control the Mono process.
449 This option is typically used by IDEs, like the MonoDevelop or Visual Studio IDEs.
451 The configuration is specified using one of more of the following options:
453 .ne 8
455 .I address=host:port
457 Use this option to specify the IP address where your debugger client is
458 listening to.
460 .I loglevel=LEVEL
462 Specifies the diagnostics log level for 
464 .I logfile=filename
466 Used to specify the file where the log will be stored, it defaults to
467 standard output.
469 .I server=[y/n]
470 Defaults to no, with the default option Mono will actively connect to the
471 host/port configured with the \fBaddress\fR option.  If you set it to 'y', it 
472 instructs the Mono runtime to start debugging in server mode, where Mono
473 actively waits for the debugger front end to connect to the Mono process.  
474 Mono will print out to stdout the IP address and port where it is listening.
476 .I setpgid=[y/n]
477 If set to yes, Mono will call \fBsetpgid(0, 0)\fR on startup, if that function
478 is available on the system. This is useful for ensuring that signals delivered
479 to a process that is executing the debuggee are not propagated to the debuggee,
480 e.g. when Ctrl-C sends \fBSIGINT\fR to the \fBsdb\fR tool.
482 .I suspend=[y/n]
483 Defaults to yes, with the default option Mono will suspend the vm on startup 
484 until it connects successfully to a debugger front end.  If you set it to 'n', in 
485 conjunction with \fBserver=y\fR, it instructs the Mono runtime to run as normal, 
486 while caching metadata to send to the debugger front end on connection..
488 .I transport=transport_name
490 This is used to specify the transport that the debugger will use to
491 communicate.   It must be specified and currently requires this to
492 be 'dt_socket'. 
496 \fB--desktop\fR
497 Configures the virtual machine to be better suited for desktop
498 applications.  Currently this sets the GC system to avoid expanding
499 the heap as much as possible at the expense of slowing down garbage
500 collection a bit.
502 \fB--full-aot\fR
503 This flag instructs the Mono runtime to not
504 generate any code at runtime and depend exclusively on the code
505 generated from using mono --aot=full previously.  This is useful for
506 platforms that do not permit dynamic code generation, or if you need
507 to run assemblies that have been stripped of IL (for example using
508 mono-cil-strip).
510 Notice that this feature will abort execution at runtime if a codepath
511 in your program, or Mono's class libraries attempts to generate code
512 dynamically.  You should test your software upfront and make sure that
513 you do not use any dynamic features.
515 \fB--full-aot-interp\fR
516 Same as --full-aot with fallback to the interpreter.
518 \fB--gc=boehm\fR, \fB--gc=sgen\fR
519 Selects the Garbage Collector engine for Mono to use, Boehm or SGen.
520 Currently this merely ensures that you are running either the
521 \fImono\fR or \fImono-sgen\fR commands.    This flag can be set in the
522 \fBMONO_ENV_OPTIONS\fR environment variable to force all of your child
523 processes to use one particular kind of GC with the Mono runtime.
525 \fB--gc-debug=[options]\fR
526 Command line equivalent of the \fBMONO_GC_DEBUG\fR environment variable.
528 \fB--gc-params=[options]\fR
529 Command line equivalent of the \fBMONO_GC_PARAMS\fR environment variable.
531 \fB--arch=32\fR, \fB--arch=64\fR
532 (Mac OS X only): Selects the bitness of the Mono binary used, if
533 available. If the binary used is already for the selected bitness, nothing
534 changes. If not, the execution switches to a binary with the selected
535 bitness suffix installed side by side (for example, '/bin/mono --arch=64'
536 will switch to '/bin/mono64' iff '/bin/mono' is a 32-bit build).
538 \fB--help\fR, \fB-h\fR
539 Displays usage instructions.
541 \fB--interpreter\fR
542 The Mono runtime will use its interpreter to execute a given assembly.
543 The interpreter is usually slower than the JIT, but it can be useful on
544 platforms where code generation at runtime is not allowed.
546 \fB--hybrid-aot\fR
547 This flag allows the Mono runtime to run assemblies
548 that have been stripped of IL, for example using mono-cil-strip. For this to
549 work, the assembly must have been AOT compiled with --aot=hybrid.
551 This flag is similar to --full-aot, but it does not disable the JIT. This means
552 you can use dynamic features such as System.Reflection.Emit.
554 \fB--llvm\fR
555 If the Mono runtime has been compiled with LLVM support (not available
556 in all configurations), Mono will use the LLVM optimization and code
557 generation engine to JIT or AOT compile.     
559 For more information, consult: http://www.mono-project.com/docs/advanced/mono-llvm/
561 \fB--ffast-math\fR
562 This flag allows Mono and LLVM to apply aggressive floating point optimizations.
563 Can break IEEE754 compliance.
565 \fB--nollvm\fR
566 When using a Mono that has been compiled with LLVM support, it forces
567 Mono to fallback to its JIT engine and not use the LLVM backend.
569 \fB--optimize=MODE\fR, \fB-O=MODE\fR
570 MODE is a comma separated list of optimizations.  They also allow
571 optimizations to be turned off by prefixing the optimization name with
572 a minus sign.
574 In general, Mono has been tuned to use the default set of flags,
575 before using these flags for a deployment setting, you might want to
576 actually measure the benefits of using them.    
578 The following optimization flags are implemented in the core engine:
580              abcrem     Array bound checks removal
581              all        Turn on all optimizations
582              aot        Usage of Ahead Of Time compiled code
583              branch     Branch optimizations
584              cfold      Constant folding
585              cmov       Conditional moves [arch-dependency]
586              deadce     Dead code elimination
587              consprop   Constant propagation
588              copyprop   Copy propagation
589              fcmov      Fast x86 FP compares [arch-dependency]
590              float32    Perform 32-bit float arithmetic using 32-bit operations
591              gshared    Enable generic code sharing.
592              inline     Inline method calls
593              intrins    Intrinsic method implementations
594              linears    Linear scan global reg allocation
595              leaf       Leaf procedures optimizations
596              loop       Loop related optimizations
597              peephole   Peephole postpass
598              precomp    Precompile all methods before executing Main
599              sched      Instruction scheduling
600              shared     Emit per-domain code
601              sse2       SSE2 instructions on x86 [arch-dependency]
602              tailc      Tail recursion and tail calls
605 For example, to enable all the optimization but dead code
606 elimination and inlining, you can use:
608         -O=all,-deadce,-inline
611 The flags that are flagged with [arch-dependency] indicate that the
612 given option if used in combination with Ahead of Time compilation
613 (--aot flag) would produce pre-compiled code that will depend on the
614 current CPU and might not be safely moved to another computer. 
616 .ne 8
618 The following optimizations are supported
620 .I float32
621 Requests that the runtime performn 32-bit floating point operations
622 using only 32-bits.   By default the Mono runtime tries to use the
623 highest precision available for floating point operations, but while
624 this might render better results, the code might run slower.   This
625 options also affects the code generated by the LLVM backend.
627 .I inline
628 Controls whether the runtime should attempt to inline (the default),
629 or not inline methods invocations
632 \fB--response=FILE\fR
633 Provides a response file, this instructs the Mono command to read
634 other command line options from the specified file, as if the
635 options had been specified on the command line.   Useful when you have
636 very long command lines.
638 \fB--runtime=VERSION\fR
639 Mono supports different runtime versions. The version used depends on the program
640 that is being run or on its configuration file (named program.exe.config). This option
641 can be used to override such autodetection, by forcing a different runtime version
642 to be used. Note that this should only be used to select a later compatible runtime
643 version than the one the program was compiled against. A typical usage is for
644 running a 1.1 program on a 2.0 version:
646          mono --runtime=v2.0.50727 program.exe
649 \fB--server\fR
650 Configures the virtual machine to be better suited for server
651 operations (currently, allows a heavier threadpool initialization).
653 \fB--use-map-jit\fR
654 Instructs Mono to generate code using MAP_JIT on MacOS.  Necessary for
655 bundled applications.
657 \fB--verify-all\fR 
658 Verifies mscorlib and assemblies in the global
659 assembly cache for valid IL, and all user code for IL
660 verifiability. 
662 This is different from \fB--security\fR's verifiable
663 or validil in that these options only check user code and skip
664 mscorlib and assemblies located on the global assembly cache.
666 \fB-V\fR, \fB--version\fR
667 Prints JIT version information (system configuration, release number
668 and branch names if available). 
670 \fB--version=number\fR
671 Print version number only.
674 .SH DEVELOPMENT OPTIONS
675 The following options are used to help when developing a JITed application.
677 \fB--debug\fR, \fB--debug=OPTIONS\fR
678 Turns on the debugging mode in the runtime.  If an assembly was
679 compiled with debugging information, it will produce line number
680 information for stack traces. 
682 .ne 8
684 The optional OPTIONS argument is a comma separated list of debugging
685 options.  These options are turned off by default since they generate
686 much larger and slower code at runtime.
688 The following options are supported:
690 .I casts
691 Produces a detailed error when throwing a InvalidCastException.   This
692 option needs to be enabled as this generates more verbose code at
693 execution time. 
695 .I mdb-optimizations
696 Disable some JIT optimizations which are usually only disabled when
697 running inside the debugger.  This can be helpful if you want to attach
698 to the running process with mdb.
700 .I gdb
701 Generate and register debugging information with gdb. This is only supported on some
702 platforms, and only when using gdb 7.0 or later.
706 \fB\-\-profile\fR[=\fIprofiler\fR[:\fIprofiler_args\fR]]\fR
707 Loads a profiler module with the given arguments. For more information,
708 see the \fBPROFILING\fR section.
710 This option can be used multiple times; each time will load an additional
711 profiler module.
713 \fB--trace[=expression]\fR
714 Shows method names as they are invoked.  By default all methods are
715 traced. 
717 The trace can be customized to include or exclude methods, classes or
718 assemblies.  A trace expression is a comma separated list of targets,
719 each target can be prefixed with a minus sign to turn off a particular
720 target.  The words `program', `all' and `disabled' have special
721 meaning.  `program' refers to the main program being executed, and
722 `all' means all the method calls.
724 The `disabled' option is used to start up with tracing disabled.  It
725 can be enabled at a later point in time in the program by sending the
726 SIGUSR2 signal to the runtime.
728 Assemblies are specified by their name, for example, to trace all
729 calls in the System assembly, use:
732         mono --trace=System app.exe
735 Classes are specified with the T: prefix.  For example, to trace all
736 calls to the System.String class, use:
739         mono --trace=T:System.String app.exe
742 And individual methods are referenced with the M: prefix, and the
743 standard method notation:
746         mono --trace=M:System.Console:WriteLine app.exe
749 Exceptions can also be traced, it will cause a stack trace to be
750 printed every time an exception of the specified type is thrown.
751 The exception type can be specified with or without the namespace,
752 and to trace all exceptions, specify 'all' as the type name.
755         mono --trace=E:System.Exception app.exe
758 As previously noted, various rules can be specified at once:
761         mono --trace=T:System.String,T:System.Random app.exe
764 You can exclude pieces, the next example traces calls to
765 System.String except for the System.String:Concat method.
768         mono --trace=T:System.String,-M:System.String:Concat
771 You can trace managed to unmanaged transitions using
772 the wrapper qualifier:
775         mono --trace=wrapper app.exe
778 Finally, namespaces can be specified using the N: prefix:
781         mono --trace=N:System.Xml
785 \fB--no-x86-stack-align\fR
786 Don't align stack frames on the x86 architecture.  By default, Mono
787 aligns stack frames to 16 bytes on x86, so that local floating point
788 and SIMD variables can be properly aligned.  This option turns off the
789 alignment, which usually saves one instruction per call, but might
790 result in significantly lower floating point and SIMD performance.
792 \fB--jitmap\fR
793 Generate a JIT method map in a /tmp/perf-PID.map file. This file is then
794 used, for example, by the perf tool included in recent Linux kernels.
795 Each line in the file has:
798         HEXADDR HEXSIZE methodname
801 Currently this option is only supported on Linux.
802 .SH JIT MAINTAINER OPTIONS
803 The maintainer options are only used by those developing the runtime
804 itself, and not typically of interest to runtime users or developers.
806 \fB--bisect=optimization:filename\fR
807 This flag is used by the automatic optimization bug bisector.  It
808 takes an optimization flag and a filename of a file containing a list
809 of full method names, one per line.  When it compiles one of the
810 methods in the file it will use the optimization given, in addition to
811 the optimizations that are otherwise enabled.  Note that if the
812 optimization is enabled by default, you should disable it with `-O`,
813 otherwise it will just apply to every method, whether it's in the file
814 or not.
816 \fB--break method\fR
817 Inserts a breakpoint before the method whose name is `method'
818 (namespace.class:methodname).  Use `Main' as method name to insert a
819 breakpoint on the application's main method.  You can use it also with
820 generics, for example "System.Collections.Generic.Queue`1:Peek"
822 \fB--breakonex\fR
823 Inserts a breakpoint on exceptions.  This allows you to debug your
824 application with a native debugger when an exception is thrown.
826 \fB--compile name\fR
827 This compiles a method (namespace.name:methodname), this is used for
828 testing the compiler performance or to examine the output of the code
829 generator. 
831 \fB--compile-all\fR
832 Compiles all the methods in an assembly.  This is used to test the
833 compiler performance or to examine the output of the code generator
834 .TP 
835 \fB--graph=TYPE METHOD\fR
836 This generates a postscript file with a graph with the details about
837 the specified method (namespace.name:methodname).  This requires `dot'
838 and ghostview to be installed (it expects Ghostview to be called
839 "gv"). 
841 The following graphs are available:
843           cfg        Control Flow Graph (CFG)
844           dtree      Dominator Tree
845           code       CFG showing code
846           ssa        CFG showing code after SSA translation
847           optcode    CFG showing code after IR optimizations
850 Some graphs will only be available if certain optimizations are turned
853 \fB--ncompile\fR
854 Instruct the runtime on the number of times that the method specified
855 by --compile (or all the methods if --compile-all is used) to be
856 compiled.  This is used for testing the code generator performance. 
857 .TP 
858 \fB--stats\fR
859 Displays information about the work done by the runtime during the
860 execution of an application. 
862 \fB--wapi=hps|semdel\fR
863 Perform maintenance of the process shared data.
865 semdel will delete the global semaphore.
867 hps will list the currently used handles.
869 \fB-v\fR, \fB--verbose\fR
870 Increases the verbosity level, each time it is listed, increases the
871 verbosity level to include more information (including, for example, 
872 a disassembly of the native code produced, code selector info etc.).
873 .SH ATTACH SUPPORT
874 The Mono runtime allows external processes to attach to a running
875 process and load assemblies into the running program.   To attach to
876 the process, a special protocol is implemented in the Mono.Management
877 assembly. 
879 With this support it is possible to load assemblies that have an entry
880 point (they are created with -target:exe or -target:winexe) to be
881 loaded and executed in the Mono process.
883 The code is loaded into the root domain, and it starts execution on
884 the special runtime attach thread.    The attached program should
885 create its own threads and return after invocation.
887 This support allows for example debugging applications by having the
888 csharp shell attach to running processes.
889 .SH PROFILING
890 The Mono runtime includes a profiler API that dynamically loaded
891 profiler modules and embedders can use to collect performance-related
892 data about an application. Profiler modules are loaded by passing the
893 \fB\-\-profile\fR command line argument to the Mono runtime.
895 Mono ships with a few profiler modules, of which the \fBlog\fR profiler
896 is the most feature-rich. It is also the default profiler if the
897 \fIprofiler\fR argument is not given, or if \fBdefault\fR is given.
898 It is possible to write your own profiler modules; see the
899 \fBCustom profilers\fR sub-section.
900 .SS Log profiler
901 The log profiler can be used to collect a lot of information about
902 a program running in the Mono runtime. This data can be used (both
903 while the process is running and later) to do analyses of the
904 program behavior, determine resource usage, performance issues or
905 even look for particular execution patterns.
907 This is accomplished by logging the events provided by the Mono
908 runtime through the profiler API and periodically writing them to a
909 file which can later be inspected with the \fBmprof\-report\fR(1)
910 tool.
912 More information about how to use the log profiler is available on
913 the \fBmono\-profilers\fR(1) page, under the \fBLOG PROFILER\fR
914 section, as well as the \fBmprof\-report\fR(1) page.
915 .SS Coverage profiler
916 The code coverage profiler can instrument a program to help determine
917 which classes, methods, code paths, etc are actually executed. This
918 is most useful when running a test suite to determine whether the
919 tests actually cover the code they're expected to.
921 More information about how to use the coverage profiler is available
922 on the \fBmono\-profilers\fR(1) page, under the \fBCOVERAGE
923 PROFILER\fR section.
924 .SS AOT profiler
925 The AOT profiler can help improve startup performance by logging
926 which generic instantiations are used by a program, which the AOT
927 compiler can then use to compile those instantiations ahead of time
928 so that they won't have to be JIT compiled at startup.
930 More information about how to use the AOT profiler is available on
931 the \fBmono\-profilers\fR(1) page, under the \fBAOT PROFILER\fR
932 section.
933 .SS Custom profilers
934 Custom profiler modules can be loaded in exactly the same way as the
935 standard modules that ship with Mono. They can also access the same
936 profiler API to gather all kinds of information about the code being
937 executed.
939 For example, to use a third-party profiler called \fBcustom\fR, you
940 would load it like this:
944 mono --profile=custom program.exe
948 You could also pass arguments to it:
952 mono --profile=custom:arg1,arg2=arg3 program.exe
956 In the above example, Mono will load the profiler from the shared
957 library called \fIlibmono\-profiler\-custom.so\fR (name varies based
958 on platform, e.g., \fIlibmono\-profiler\-custom.dylib\fR on OS X).
959 This profiler module must be on your dynamic linker library path
960 (\fBLD_LIBRARY_PATH\fR on most systems, \fBDYLD_LIBRARY_PATH\fR on
961 OS X).
963 For a sample of how to write your own custom profiler, look at the
964 \fIsamples/profiler/sample.c\fR file in the Mono source tree.
965 .SH DEBUGGING AIDS
966 To debug managed applications, you can use the 
967 .B mdb
968 command, a command line debugger.  
970 It is possible to obtain a stack trace of all the active threads in
971 Mono by sending the QUIT signal to Mono, you can do this from the
972 command line, like this:
975         kill -QUIT pid
978 Where pid is the Process ID of the Mono process you want to examine.
979 The process will continue running afterwards, but its state is not
980 guaranteed.
982 .B Important:
983 this is a last-resort mechanism for debugging applications and should
984 not be used to monitor or probe a production application.  The
985 integrity of the runtime after sending this signal is not guaranteed
986 and the application might crash or terminate at any given point
987 afterwards.   
989 The \fB--debug=casts\fR option can be used to get more detailed
990 information for Invalid Cast operations, it will provide information
991 about the types involved.   
993 You can use the MONO_LOG_LEVEL and MONO_LOG_MASK environment variables
994 to get verbose debugging output about the execution of your
995 application within Mono.
997 The 
998 .I MONO_LOG_LEVEL
999 environment variable if set, the logging level is changed to the set
1000 value. Possible values are "error", "critical", "warning", "message",
1001 "info", "debug". The default value is "error". Messages with a logging
1002 level greater then or equal to the log level will be printed to
1003 stdout/stderr.
1005 Use "info" to track the dynamic loading of assemblies.
1008 Use the 
1009 .I MONO_LOG_MASK
1010 environment variable to limit the extent of the messages you get: 
1011 If set, the log mask is changed to the set value. Possible values are
1012 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
1013 (garbage collector), "cfg" (config file loader), "aot" (precompiler),
1014 "security" (e.g. Moonlight CoreCLR support), "threadpool" (thread pool generic), 
1015 "io-selector" (async socket operations), "io-layer" (I/O layer - processes, files, 
1016 sockets, events, semaphores, mutexes and handles), "io-layer-process", 
1017 "io-layer-file", "io-layer-socket", "io-layer-event", "io-layer-semaphore", 
1018 "io-layer-mutex", "io-layer-handle" and "all". 
1019 The default value is "all". Changing the mask value allows you to display only 
1020 messages for a certain component. You can use multiple masks by comma 
1021 separating them. For example to see config file messages and assembly loader
1022 messages set you mask to "asm,cfg".
1024 The following is a common use to track down problems with P/Invoke:
1027         $ MONO_LOG_LEVEL="debug" MONO_LOG_MASK="dll" mono glue.exe
1031 .SH DEBUGGING WITH LLDB
1032 If you are using LLDB, you can use the 
1033 .B mono.py
1034 script to print some internal data structures with it.   To use this,
1035 add this to your 
1036 .B  $HOME/.lldbinit
1037 file:
1039 command script import $PREFIX/lib/mono/lldb/mono.py
1042 Where $PREFIX is the prefix value that you used when you configured
1043 Mono (typically /usr).
1045 Once this is done, then you can inspect some Mono Runtime data structures,
1046 for example:
1048 (lldb) p method
1050 (MonoMethod *) $0 = 0x05026ac0 [mscorlib]System.OutOfMemoryException:.ctor()
1052 .SH SERIALIZATION
1053 Mono's XML serialization engine by default will use a reflection-based
1054 approach to serialize which might be slow for continuous processing
1055 (web service applications).  The serialization engine will determine
1056 when a class must use a hand-tuned serializer based on a few
1057 parameters and if needed it will produce a customized C# serializer
1058 for your types at runtime.  This customized serializer then gets
1059 dynamically loaded into your application.
1061 You can control this with the MONO_XMLSERIALIZER_THS environment
1062 variable.
1064 The possible values are 
1065 .B `no' 
1066 to disable the use of a C# customized
1067 serializer, or an integer that is the minimum number of uses before
1068 the runtime will produce a custom serializer (0 will produce a
1069 custom serializer on the first access, 50 will produce a serializer on
1070 the 50th use). Mono will fallback to an interpreted serializer if the
1071 serializer generation somehow fails. This behavior can be disabled
1072 by setting the option
1073 .B `nofallback'
1074 (for example: MONO_XMLSERIALIZER_THS=0,nofallback).
1075 .SH ENVIRONMENT VARIABLES
1077 \fBGC_DONT_GC\fR
1078 Turns off the garbage collection in Mono.  This should be only used
1079 for debugging purposes
1081 \fBHTTP_PROXY\fR
1082 (Also \fBhttp_proxy\fR) If set, web requests using the Mono
1083 Class Library will be automatically proxied through the given URL.
1084 Not supported on Windows, Mac OS, iOS or Android. See also \fBNO_PROXY\fR.
1086 \fBLLVM_COUNT\fR
1087 When Mono is compiled with LLVM support, this instructs the runtime to
1088 stop using LLVM after the specified number of methods are JITed.
1089 This is a tool used in diagnostics to help isolate problems in the
1090 code generation backend.   For example \fBLLVM_COUNT=10\fR would only
1091 compile 10 methods with LLVM and then switch to the Mono JIT engine.
1092 \fBLLVM_COUNT=0\fR would disable the LLVM engine altogether.
1094 \fBMONO_ASPNET_INHIBIT_SETTINGSMAP\fR
1095 Mono contains a feature which allows modifying settings in the .config files shipped
1096 with Mono by using config section mappers. The mappers and the mapping rules are
1097 defined in the $prefix/etc/mono/2.0/settings.map file and, optionally, in the
1098 settings.map file found in the top-level directory of your ASP.NET application.
1099 Both files are read by System.Web on application startup, if they are found at the
1100 above locations. If you don't want the mapping to be performed you can set this
1101 variable in your environment before starting the application and no action will
1102 be taken.
1104 \fBMONO_ASPNET_WEBCONFIG_CACHESIZE\fR
1105 Mono has a cache of ConfigSection objects for speeding up WebConfigurationManager
1106 queries. Its default size is 100 items, and when more items are needed, cache
1107 evictions start happening. If evictions are too frequent this could impose
1108 unnecessary overhead, which could be avoided by using this environment variable
1109 to set up a higher cache size (or to lower memory requirements by decreasing it).
1111 \fBMONO_CAIRO_DEBUG_DISPOSE\fR
1112 If set, causes Mono.Cairo to collect stack traces when objects are allocated,
1113 so that the finalization/Dispose warnings include information about the
1114 instance's origin.
1116 \fBMONO_CFG_DIR\fR
1117 If set, this variable overrides the default system configuration directory
1118 ($PREFIX/etc). It's used to locate machine.config file.
1120 \fBMONO_COM\fR
1121 Sets the style of COM interop.  If the value of this variable is "MS"
1122 Mono will use string marhsalling routines from the liboleaut32 for the
1123 BSTR type library, any other values will use the mono-builtin BSTR
1124 string marshalling.
1126 \fBMONO_CONFIG\fR
1127 If set, this variable overrides the default runtime configuration file
1128 ($PREFIX/etc/mono/config). The --config command line options overrides the
1129 environment variable.
1131 \fBMONO_CPU_ARCH\fR
1132 Override the automatic cpu detection mechanism. Currently used only on arm.
1133 The format of the value is as follows:
1136         "armvV [thumb[2]]"
1139 where V is the architecture number 4, 5, 6, 7 and the options can be currently be
1140 "thumb" or "thumb2". Example:
1143         MONO_CPU_ARCH="armv4 thumb" mono ...
1147 \fBMONO_ARM_FORCE_SOFT_FLOAT\fR
1148 When Mono is built with a soft float fallback on ARM and this variable is set to
1149 "1", Mono will always emit soft float code, even if a VFP unit is
1150 detected.
1152 \fBMONO_DARWIN_USE_KQUEUE_FSW\fR
1153 Fall back on the kqueue FileSystemWatcher implementation in Darwin. The default is the FSEvent implementation.
1155 \fBMONO_DARWIN_WATCHER_MAXFDS\fR
1156 This is a debugging aid used to force limits on the kqueue FileSystemWatcher
1157 implementation in Darwin.   There is no limit by default.
1159 \fBMONO_DISABLE_MANAGED_COLLATION\fR
1160 If this environment variable is `yes', the runtime uses unmanaged
1161 collation (which actually means no culture-sensitive collation). It
1162 internally disables managed collation functionality invoked via the
1163 members of System.Globalization.CompareInfo class. Collation is
1164 enabled by default.
1166 \fBMONO_DISABLE_SHARED_AREA\fR
1167 Unix only: If set, disable usage of shared memory for exposing
1168 performance counters. This means it will not be possible to both
1169 externally read performance counters from this processes or read
1170 those of external processes.
1172 \fBMONO_DNS\fR
1173 When set, enables the use of a fully managed DNS resolver instead of the
1174 regular libc functions. This resolver performs much better when multiple
1175 queries are run in parallel.
1177 Note that /etc/nsswitch.conf will be ignored.
1179 \fBMONO_EGD_SOCKET\fR
1180 For platforms that do not otherwise have a way of obtaining random bytes
1181 this can be set to the name of a file system socket on which an egd or
1182 prngd daemon is listening.
1184 \fBMONO_ENABLE_AIO\fR
1185 If set, tells mono to attempt using native asynchronous I/O services. If not
1186 set, a default select/poll implementation is used. Currently epoll and kqueue
1187 are supported.
1189 \fBMONO_THREADS_SUSPEND\fR Selects a mechanism that Mono will use to suspend
1190 threads.  May be set to "preemptive", "coop", or "hybrid".  Threads may need to
1191 be suspended by the debugger, or using some .NET threading APIs, and most
1192 commonly when the SGen garbage collector needs to stop all threads during a
1193 critical phase of garbage collection.  Preemptive mode is the mode that Mono
1194 has used historically, going back to the Boehm days, where the garbage
1195 collector would run at any point and suspend execution of all threads as
1196 required to perform a garbage collection.  The cooperative mode on the other
1197 hand requires the cooperation of all threads to stop at a safe point.  This
1198 makes for an easier to debug garbage collector and it improves the stability of
1199 the runtime because threads are not suspended when accessing critical
1200 resources.  In scenarios where Mono is embedded in another application,
1201 cooperative suspend requires the embedder code to follow coding guidelines in
1202 order to cooperate with the garbage collector.  Cooperative suspend in embedded
1203 Mono is currently experimental.  Hybrid mode is a combination of the two that
1204 retains better compatability with scenarios where Mono is embedded in another
1205 application: threads that are running managed code or code that comprises the
1206 Mono runtime will be cooperatively suspended, while threads running embedder
1207 code will be preemptively suspended.  Hybrid suspend is the default on some
1208 desktop platforms.
1210 Alternatively, coop and hybrid mode can be enabled at compile time by using the
1211 --enable-cooperative-suspend or --enable-hybrid-suspend flags, respectively,
1212 when calling configure.  The \fBMONO_THREADS_SUSPEND\fR environment variable
1213 takes priority over the compiled default.
1215 \fBMONO_ENABLE_COOP_SUSPEND\fR
1216 This environment variable is obsolete, but retained for backward compatibility.
1217 Use \fBMONO_THREADS_SUSPEND\fR set to "coop" instead.  Note that if configure flags
1218 were provided to enable cooperative or hybrid suspend, this variable is ignored.
1220 \fBMONO_ENV_OPTIONS\fR
1221 This environment variable allows you to pass command line arguments to
1222 a Mono process through the environment.   This is useful for example
1223 to force all of your Mono processes to use LLVM or SGEN without having
1224 to modify any launch scripts.
1226 \fBMONO_SDB_ENV_OPTIONS\fR
1227 Used to pass extra options to the debugger agent in the runtime, as they were passed
1228 using --debugger-agent=.
1230 \fBMONO_EVENTLOG_TYPE\fR
1231 Sets the type of event log provider to use (for System.Diagnostics.EventLog).
1233 Possible values are:
1236 .I "local[:path]"
1238 Persists event logs and entries to the local file system.
1240 The directory in which to persist the event logs, event sources and entries
1241 can be specified as part of the value.
1243 If the path is not explicitly set, it defaults to "/var/lib/mono/eventlog"
1244 on unix and "%APPDATA%\mono\eventlog" on Windows.
1246 .I "win32"
1248 .B 
1249 Uses the native win32 API to write events and registers event logs and
1250 event sources in the registry.   This is only available on Windows. 
1252 On Unix, the directory permission for individual event log and event source
1253 directories is set to 777 (with +t bit) allowing everyone to read and write
1254 event log entries while only allowing entries to be deleted by the user(s)
1255 that created them.
1257 .I "null"
1259 Silently discards any events.
1262 The default is "null" on Unix (and versions of Windows before NT), and 
1263 "win32" on Windows NT (and higher).
1266 \fBMONO_EXTERNAL_ENCODINGS\fR
1267 If set, contains a colon-separated list of text encodings to try when
1268 turning externally-generated text (e.g. command-line arguments or
1269 filenames) into Unicode.  The encoding names come from the list
1270 provided by iconv, and the special case "default_locale" which refers
1271 to the current locale's default encoding.
1273 When reading externally-generated text strings UTF-8 is tried first,
1274 and then this list is tried in order with the first successful
1275 conversion ending the search.  When writing external text (e.g. new
1276 filenames or arguments to new processes) the first item in this list
1277 is used, or UTF-8 if the environment variable is not set.
1279 The problem with using MONO_EXTERNAL_ENCODINGS to process your
1280 files is that it results in a problem: although its possible to get
1281 the right file name it is not necessarily possible to open the file.
1282 In general if you have problems with encodings in your filenames you
1283 should use the "convmv" program.
1285 \fBMONO_GC_PARAMS\fR
1286 When using Mono with the SGen garbage collector this variable controls
1287 several parameters of the collector.  The variable's value is a comma
1288 separated list of words.
1290 .ne 8
1292 \fBmax-heap-size=\fIsize\fR
1293 Sets the maximum size of the heap. The size is specified in bytes and must
1294 be a power of two. The suffixes `k', `m' and `g' can be used to
1295 specify kilo-, mega- and gigabytes, respectively. The limit is the sum
1296 of the nursery, major heap and large object heap. Once the limit is reached
1297 the application will receive OutOfMemoryExceptions when trying to allocate.
1298 Not the full extent of memory set in max-heap-size could be available to
1299 satisfy a single allocation due to internal fragmentation. By default heap
1300 limits is disabled and the GC will try to use all available memory.
1302 \fBnursery-size=\fIsize\fR
1303 Sets the size of the nursery.  The size is specified in bytes and must
1304 be a power of two.  The suffixes `k', `m' and `g' can be used to
1305 specify kilo-, mega- and gigabytes, respectively.  The nursery is the
1306 first generation (of two).  A larger nursery will usually speed up the
1307 program but will obviously use more memory.  The default nursery size
1308 4 MB.
1310 \fBmajor=\fIcollector\fR
1311 Specifies which major collector to use.
1312 Options are `marksweep' for the Mark&Sweep collector, `marksweep-conc'
1313 for concurrent Mark&Sweep and `marksweep-conc-par' for parallel and
1314 concurrent Mark&Sweep.  The concurrent Mark&Sweep collector is the default.
1316 \fBmode=balanced|throughput|pause\fR[:\fImax-pause\fR]
1317 Specifies what should be the garbage collector's target. The `throughput'
1318 mode aims to reduce time spent in the garbage collector and improve
1319 application speed, the `pause' mode aims to keep pause times to a minimum
1320 and it receives the argument \fImax-pause\fR which specifies the maximum
1321 pause time in milliseconds that is acceptable and the `balanced' mode
1322 which is a general purpose optimal mode.
1324 \fBsoft-heap-limit=\fIsize\fR
1325 Once the heap size gets larger than this size, ignore what the default
1326 major collection trigger metric says and only allow four nursery size's
1327 of major heap growth between major collections.
1329 \fBevacuation-threshold=\fIthreshold\fR
1330 Sets the evacuation threshold in percent.  This option is only available
1331 on the Mark&Sweep major collectors.  The value must be an
1332 integer in the range 0 to 100.  The default is 66.  If the sweep phase of
1333 the collection finds that the occupancy of a specific heap block type is
1334 less than this percentage, it will do a copying collection for that block
1335 type in the next major collection, thereby restoring occupancy to close
1336 to 100 percent.  A value of 0 turns evacuation off.
1338 \fB(no-)lazy-sweep\fR
1339 Enables or disables lazy sweep for the Mark&Sweep collector.  If
1340 enabled, the sweeping of individual major heap blocks is done
1341 piecemeal whenever the need arises, typically during nursery
1342 collections.  Lazy sweeping is enabled by default.
1344 \fB(no-)concurrent-sweep\fR
1345 Enables or disables concurrent sweep for the Mark&Sweep collector.  If
1346 enabled, the iteration of all major blocks to determine which ones can
1347 be freed and which ones have to be kept and swept, is done
1348 concurrently with the running program.  Concurrent sweeping is enabled
1349 by default.
1351 \fBstack-mark=\fImark-mode\fR
1352 Specifies how application threads should be scanned. Options are
1353 `precise` and `conservative`. Precise marking allow the collector
1354 to know what values on stack are references and what are not.
1355 Conservative marking threats all values as potentially references
1356 and leave them untouched. Precise marking reduces floating garbage
1357 and can speed up nursery collection and allocation rate, it has
1358 the downside of requiring a significant extra memory per compiled
1359 method. The right option, unfortunately, requires experimentation.
1361 \fBsave-target-ratio=\fIratio\fR
1362 Specifies the target save ratio for the major collector. The collector
1363 lets a given amount of memory to be promoted from the nursery due to
1364 minor collections before it triggers a major collection. This amount
1365 is based on how much memory it expects to free. It is represented as
1366 a ratio of the size of the heap after a major collection.
1367 Valid values are between 0.1 and 2.0. The default is 0.5.
1368 Smaller values will keep the major heap size smaller but will trigger
1369 more major collections. Likewise, bigger values will use more memory
1370 and result in less frequent major collections.
1371 This option is EXPERIMENTAL, so it might disappear in later versions of mono.
1373 \fBdefault-allowance-ratio=\fIratio\fR
1374 Specifies the default allocation allowance when the calculated size
1375 is too small. The allocation allowance is how much memory the collector
1376 let be promoted before triggered a major collection.
1377 It is a ratio of the nursery size.
1378 Valid values are between 1.0 and 10.0. The default is 4.0.
1379 Smaller values lead to smaller heaps and more frequent major collections.
1380 Likewise, bigger values will allow the heap to grow faster but use
1381 more memory when it reaches a stable size.
1382 This option is EXPERIMENTAL, so it might disappear in later versions of mono.
1384 \fBminor=\fIminor-collector\fR
1385 Specifies which minor collector to use. Options are `simple' which
1386 promotes all objects from the nursery directly to the old generation,
1387 `simple-par' which has same promotion behavior as `simple' but using
1388 multiple workers and `split' which lets objects stay longer on the nursery
1389 before promoting.
1391 \fBalloc-ratio=\fIratio\fR
1392 Specifies the ratio of memory from the nursery to be use by the alloc space.
1393 This only can only be used with the split minor collector.
1394 Valid values are integers between 1 and 100. Default is 60.
1396 \fBpromotion-age=\fIage\fR
1397 Specifies the required age of an object must reach inside the nursery before
1398 been promoted to the old generation. This only can only be used with the
1399 split minor collector.
1400 Valid values are integers between 1 and 14. Default is 2.
1402 \fB(no-)cementing\fR
1403 Enables or disables cementing.  This can dramatically shorten nursery
1404 collection times on some benchmarks where pinned objects are referred
1405 to from the major heap.
1407 \fBallow-synchronous-major\fR
1408 This forbids the major collector from performing synchronous major collections.
1409 The major collector might want to do a synchronous collection due to excessive
1410 fragmentation. Disabling this might trigger OutOfMemory error in situations that
1411 would otherwise not happen.
1415 \fBMONO_GC_DEBUG\fR
1416 When using Mono with the SGen garbage collector this environment
1417 variable can be used to turn on various debugging features of the
1418 collector.  The value of this variable is a comma separated list of
1419 words.  Do not use these options in production.
1421 .ne 8
1423 \fInumber\fR
1424 Sets the debug level to the specified number.
1426 \fBprint-allowance\fR
1427 After each major collection prints memory consumption for before and
1428 after the collection and the allowance for the minor collector, i.e. how
1429 much the heap is allowed to grow from minor collections before the next
1430 major collection is triggered.
1432 \fBprint-pinning\fR
1433 Gathers statistics on the classes whose objects are pinned in the
1434 nursery and for which global remset entries are added.  Prints those
1435 statistics when shutting down.
1437 \fBcollect-before-allocs\fR
1439 \fBcheck-remset-consistency\fR
1440 This performs a remset consistency check at various opportunities, and
1441 also clears the nursery at collection time, instead of the default,
1442 when buffers are allocated (clear-at-gc).  The consistency check
1443 ensures that there are no major to minor references that are not on
1444 the remembered sets.
1446 \fBmod-union-consistency-check\fR
1447 Checks that the mod-union cardtable is consistent before each
1448 finishing major collection pause.  This check is only applicable to
1449 concurrent major collectors.
1451 \fBcheck-mark-bits\fR
1452 Checks that mark bits in the major heap are consistent at the end of
1453 each major collection.  Consistent mark bits mean that if an object is
1454 marked, all objects that it had references to must also be marked.
1456 \fBcheck-nursery-untag\fR
1457 After garbage collections, check whether all vtable pointers are no
1458 longer tagged.
1460 \fBxdomain-checks\fR
1461 Performs a check to make sure that no references are left to an
1462 unloaded AppDomain.
1464 \fBclear-at-tlab-creation\fR
1465 Clears the nursery incrementally when the thread local allocation
1466 buffers (TLAB) are created.  The default setting clears the whole
1467 nursery at GC time.
1469 \fBdebug-clear-at-tlab-creation\fR
1470 Clears the nursery incrementally when the thread local allocation
1471 buffers (TLAB) are created, but at GC time fills it with the byte
1472 `0xff`, which should result in a crash more quickly if
1473 `clear-at-tlab-creation` doesn't work properly.
1475 \fBclear-at-gc\fR
1476 This clears the nursery at GC time instead of doing it when the thread
1477 local allocation buffer (TLAB) is created.  The default is to clear
1478 the nursery at TLAB creation time.
1480 \fBdisable-minor\fR
1481 Don't do minor collections.  If the nursery is full, a major collection
1482 is triggered instead, unless it, too, is disabled.
1484 \fBdisable-major\fR
1485 Don't do major collections.
1487 \fBconservative-stack-mark\fR
1488 Forces the GC to scan the stack conservatively, even if precise
1489 scanning is available.
1491 \fBno-managed-allocator\fR
1492 Disables the managed allocator.
1494 \fBcheck-scan-starts\fR
1495 If set, does a plausibility check on the scan_starts before and after each collection
1497 \fBverify-nursery-at-minor-gc\fR
1498 If set, does a complete object walk of the nursery at the start of each minor collection.
1500 \fBdump-nursery-at-minor-gc\fR
1501 If set, dumps the contents of the nursery at the start of each minor collection. Requires 
1502 verify-nursery-at-minor-gc to be set.
1504 \fBheap-dump=\fIfile\fR
1505 Dumps the heap contents to the specified file.   To visualize the
1506 information, use the mono-heapviz tool.
1508 \fBbinary-protocol=\fIfile\fR
1509 Outputs the debugging output to the specified file.   For this to
1510 work, Mono needs to be compiled with the BINARY_PROTOCOL define on
1511 sgen-gc.c.   You can then use this command to explore the output
1513                 sgen-grep-binprot 0x1234 0x5678 < file
1516 \fBnursery-canaries\fR
1517 If set, objects allocated in the nursery are suffixed with a canary (guard)
1518 word, which is checked on each minor collection. Can be used to detect/debug
1519 heap corruption issues.
1522 \fBdo-not-finalize(=\fIclasses\fB)\fR
1523 If enabled, finalizers will not be run.  Everything else will be
1524 unaffected: finalizable objects will still be put into the
1525 finalization queue where they survive until they're scheduled to
1526 finalize.  Once they're not in the queue anymore they will be
1527 collected regularly.  If a list of comma-separated class names is
1528 given, only objects from those classes will not be finalized.
1531 \fBlog-finalizers\fR
1532 Log verbosely around the finalization process to aid debugging.
1536 \fBMONO_GAC_PREFIX\fR
1537 Provides a prefix the runtime uses to look for Global Assembly Caches.
1538 Directories are separated by the platform path separator (colons on
1539 unix). MONO_GAC_PREFIX should point to the top directory of a prefixed
1540 install. Or to the directory provided in the gacutil /gacdir command. Example:
1541 .B /home/username/.mono:/usr/local/mono/
1543 \fBMONO_IOMAP\fR
1544 Enables some filename rewriting support to assist badly-written
1545 applications that hard-code Windows paths.  Set to a colon-separated
1546 list of "drive" to strip drive letters, or "case" to do
1547 case-insensitive file matching in every directory in a path.  "all"
1548 enables all rewriting methods.  (Backslashes are always mapped to
1549 slashes if this variable is set to a valid option).
1552 For example, this would work from the shell:
1555         MONO_IOMAP=drive:case
1556         export MONO_IOMAP
1559 If you are using mod_mono to host your web applications, you can use
1560 the 
1561 .B MonoIOMAP
1562 directive instead, like this:
1565         MonoIOMAP <appalias> all
1568 See mod_mono(8) for more details.
1570 \fBMONO_LLVM\fR
1571 When Mono is using the LLVM code generation backend you can use this
1572 environment variable to pass code generation options to the LLVM
1573 compiler.   
1575 \fBMONO_MANAGED_WATCHER\fR
1576 If set to "disabled", System.IO.FileSystemWatcher will use a file watcher 
1577 implementation which silently ignores all the watching requests.
1578 If set to any other value, System.IO.FileSystemWatcher will use the default
1579 managed implementation (slow). If unset, mono will try to use inotify, FAM, 
1580 Gamin, kevent under Unix systems and native API calls on Windows, falling 
1581 back to the managed implementation on error.
1583 \fBMONO_MESSAGING_PROVIDER\fR
1584 Mono supports a plugin model for its implementation of System.Messaging making
1585 it possible to support a variety of messaging implementations (e.g. AMQP, ActiveMQ).
1586 To specify which messaging implementation is to be used the evironement variable
1587 needs to be set to the full class name for the provider.  E.g. to use the RabbitMQ based
1588 AMQP implementation the variable should be set to:
1591 Mono.Messaging.RabbitMQ.RabbitMQMessagingProvider,Mono.Messaging.RabbitMQ
1593 \fBMONO_NO_SMP\fR
1594 If set causes the mono process to be bound to a single processor. This may be
1595 useful when debugging or working around race conditions.
1597 \fBMONO_NO_TLS\fR
1598 Disable inlining of thread local accesses. Try setting this if you get a segfault
1599 early on in the execution of mono.
1601 \fBMONO_PATH\fR
1602 Provides a search path to the runtime where to look for library
1603 files.   This is a tool convenient for debugging applications, but
1604 should not be used by deployed applications as it breaks the assembly
1605 loader in subtle ways. 
1607 Directories are separated by the platform path separator (colons on unix). Example:
1608 .B /home/username/lib:/usr/local/mono/lib
1610 Relative paths are resolved based on the launch-time current directory.
1612 Alternative solutions to MONO_PATH include: installing libraries into
1613 the Global Assembly Cache (see gacutil(1)) or having the dependent
1614 libraries side-by-side with the main executable.
1616 For a complete description of recommended practices for application
1617 deployment, see
1618 http://www.mono-project.com/docs/getting-started/application-deployment/
1620 \fBMONO_SHARED_DIR\fR
1621 If set its the directory where the ".wapi" handle state is stored.
1622 This is the directory where the Windows I/O Emulation layer stores its
1623 shared state data (files, events, mutexes, pipes).  By default Mono
1624 will store the ".wapi" directory in the users's home directory.
1625 .TP 
1626 \fBMONO_SHARED_HOSTNAME\fR
1627 Uses the string value of this variable as a replacement for the host name when
1628 creating file names in the ".wapi" directory. This helps if the host name of
1629 your machine is likely to be changed when a mono application is running or if
1630 you have a .wapi directory shared among several different computers.
1632 Mono typically uses the hostname to create the files that are used to
1633 share state across multiple Mono processes.  This is done to support
1634 home directories that might be shared over the network.
1636 \fBMONO_STRICT_IO_EMULATION\fR
1637 If set, extra checks are made during IO operations.  Currently, this
1638 includes only advisory locks around file writes.
1640 \fBMONO_TLS_PROVIDER\fR
1641 This environment variable controls which TLS/SSL provider Mono will
1642 use.  The options are usually determined by the operating system where
1643 Mono was compiled and the configuration options that were used for
1644 it.   
1646 .ne 8
1648 .I default
1649 Uses the default TLS stack that the Mono runtime was configured with.
1650 Usually this is configured to use Apple's SSL stack on Apple
1651 platforms, and Boring SSL on other platforms.
1653 .I apple
1654 Forces the use of the Apple SSL stack, only works on Apple platforms.
1656 .I btls
1657 Forces the use of the BoringSSL stack.    See
1658 https://opensource.google.com/projects/boringssl for more information
1659 about this stack.
1661 .I legacy
1662 This is the old Mono stack, which only supports SSL and TLS up to
1663 version 1.0.   It is deprecated and will be removed in the future.
1666 \fBMONO_TLS_SESSION_CACHE_TIMEOUT\fR
1667 The time, in seconds, that the SSL/TLS session cache will keep it's entry to
1668 avoid a new negotiation between the client and a server. Negotiation are very
1669 CPU intensive so an application-specific custom value may prove useful for 
1670 small embedded systems.
1672 The default is 180 seconds.
1674 \fBMONO_THREADS_PER_CPU\fR
1675 The minimum number of threads in the general threadpool will be 
1676 MONO_THREADS_PER_CPU * number of CPUs. The default value for this
1677 variable is 1.
1679 \fBMONO_XMLSERIALIZER_THS\fR
1680 Controls the threshold for the XmlSerializer to produce a custom
1681 serializer for a given class instead of using the Reflection-based
1682 interpreter.  The possible values are `no' to disable the use of a
1683 custom serializer or a number to indicate when the XmlSerializer
1684 should start serializing.   The default value is 50, which means that
1685 the a custom serializer will be produced on the 50th use.
1687 \fBMONO_X509_REVOCATION_MODE\fR
1688 Sets the revocation mode used when validating a X509 certificate chain (https,
1689 ftps, smtps...).  The default is 'nocheck', which performs no revocation check
1690 at all. The other possible values are 'offline', which performs CRL check (not
1691 implemented yet) and 'online' which uses OCSP and CRL to verify the revocation
1692 status (not implemented yet).
1694 \fBNO_PROXY\fR
1695 (Also \fBno_proxy\fR) If both \fBHTTP_PROXY\fR and \fBNO_PROXY\fR are
1696 set, \fBNO_PROXY\fR will be treated as a comma-separated list of "bypass" domains
1697 which will not be sent through the proxy. Domains in \fBNO_PROXY\fR may contain
1698 wildcards, as in "*.mono-project.com" or "build????.local". Not supported on
1699 Windows, Mac OS, iOS or Android.
1700 .SH ENVIRONMENT VARIABLES FOR DEBUGGING
1702 \fBMONO_ASPNET_NODELETE\fR
1703 If set to any value, temporary source files generated by ASP.NET support
1704 classes will not be removed. They will be kept in the user's temporary
1705 directory.
1707 \fBMONO_DEBUG\fR
1708 If set, enables some features of the runtime useful for debugging.
1709 This variable should contain a comma separated list of debugging options.
1710 Currently, the following options are supported:
1712 .ne 8
1714 \fBalign-small-structs\fR
1715 Enables small structs alignment to 4/8 bytes.
1717 \fBarm-use-fallback-tls\fR
1718 When this option is set on ARM, a fallback thread local store will be used instead
1719 of the default fast thread local storage primitives.
1721 \fBbreak-on-unverified\fR
1722 If this variable is set, when the Mono VM runs into a verification
1723 problem, instead of throwing an exception it will break into the
1724 debugger.  This is useful when debugging verifier problems
1726 \fBcasts\fR
1727 This option can be used to get more detailed information from
1728 InvalidCast exceptions, it will provide information about the types
1729 involved.     
1731 \fBcheck-pinvoke-callconv\fR
1732 This option causes the runtime to check for calling convention
1733 mismatches when using pinvoke, i.e. mixing cdecl/stdcall. It only
1734 works on windows. If a mismatch is detected, an
1735 ExecutionEngineException is thrown.
1737 \fBcollect-pagefault-stats\fR
1738 Collects information about pagefaults.   This is used internally to
1739 track the number of page faults produced to load metadata.  To display
1740 this information you must use this option with "--stats" command line
1741 option.
1743 \fBdebug-domain-unload\fR
1744 When this option is set, the runtime will invalidate the domain memory
1745 pool instead of destroying it.
1747 \fBdisable_omit_fp\fR
1748 Disables a compiler optimization where the frame pointer is omitted
1749 from the stack. This optimization can interact badly with debuggers.
1751 \fBdont-free-domains\fR
1752 This is an Optimization for multi-AppDomain applications (most
1753 commonly ASP.NET applications).  Due to internal limitations Mono,
1754 Mono by default does not use typed allocations on multi-appDomain
1755 applications as they could leak memory when a domain is unloaded. 
1757 Although this is a fine default, for applications that use more than
1758 on AppDomain heavily (for example, ASP.NET applications) it is worth
1759 trading off the small leaks for the increased performance
1760 (additionally, since ASP.NET applications are not likely going to
1761 unload the application domains on production systems, it is worth
1762 using this feature). 
1764 \fBdyn-runtime-invoke\fR
1765 Instructs the runtime to try to use a generic runtime-invoke wrapper
1766 instead of creating one invoke wrapper.
1768 \fBexplicit-null-checks\fR
1769 Makes the JIT generate an explicit NULL check on variable dereferences
1770 instead of depending on the operating system to raise a SIGSEGV or
1771 another form of trap event when an invalid memory location is
1772 accessed.
1774 \fBgdb\fR 
1775 Equivalent to setting the \fBMONO_XDEBUG\fR variable, this emits
1776 symbols into a shared library as the code is JITed that can be loaded
1777 into GDB to inspect symbols.
1779 \fBgen-seq-points\fR 
1780 Automatically generates sequence points where the
1781 IL stack is empty.  These are places where the debugger can set a
1782 breakpoint.
1784 \fBno-compact-seq-points\fR
1785 Unless the option is used, the runtime generates sequence points data that
1786 maps native offsets to IL offsets. Sequence point data is used to
1787 display IL offset in stacktraces. Stacktraces with IL offsets can be
1788 symbolicated using mono-symbolicate tool.
1790 \fBhandle-sigint\fR
1791 Captures the interrupt signal (Control-C) and displays a stack trace
1792 when pressed.  Useful to find out where the program is executing at a
1793 given point.  This only displays the stack trace of a single thread. 
1795 \fBinit-stacks\fR
1796 Instructs the runtime to initialize the stack with
1797 some known values (0x2a on x86-64) at the start of a method to assist
1798 in debuggin the JIT engine.
1800 \fBkeep-delegates\fR
1801 This option will leak delegate trampolines that are no longer
1802 referenced as to present the user with more information about a
1803 delegate misuse.  Basically a delegate instance might be created,
1804 passed to unmanaged code, and no references kept in managed code,
1805 which will garbage collect the code.  With this option it is possible
1806 to track down the source of the problems. 
1808 \fBno-gdb-backtrace\fR
1809 This option will disable the GDB backtrace emitted by the runtime
1810 after a SIGSEGV or SIGABRT in unmanaged code.
1812 \fBpartial-sharing\fR
1813 When this option is set, the runtime can share generated code between
1814 generic types effectively reducing the amount of code generated.
1816 \fBreverse-pinvoke-exceptions
1817 This option will cause mono to abort with a descriptive message when
1818 during stack unwinding after an exception it reaches a native stack
1819 frame. This happens when a managed delegate is passed to native code,
1820 and the managed delegate throws an exception. Mono will normally try
1821 to unwind the stack to the first (managed) exception handler, and it
1822 will skip any native stack frames in the process. This leads to 
1823 undefined behaviour (since mono doesn't know how to process native
1824 frames), leaks, and possibly crashes too.
1826 \fBsingle-imm-size\fR
1827 This guarantees that each time managed code is compiled the same
1828 instructions and registers are used, regardless of the size of used
1829 values.
1831 \fBsoft-breakpoints\fR
1832 This option allows using single-steps and breakpoints in hardware
1833 where we cannot do it with signals.
1835 \fBsuspend-on-native-crash\fR
1836 This option will suspend the program when a native crash occurs (SIGSEGV, SIGILL, ...).
1837 This is useful for debugging crashes which do not happen under gdb,
1838 since a live process contains more information than a core file.
1840 \fBsuspend-on-sigsegv\fR
1841 Same as \fBsuspend-on-native-crash\fR.
1843 \fBsuspend-on-exception\fR
1844 This option will suspend the program when an exception occurs.
1846 \fBsuspend-on-unhandled\fR
1847 This option will suspend the program when an unhandled exception occurs.
1849 \fBthread-dump-dir=DIR\fR
1850 Use DIR for storage thread dumps created by SIGQUIT.
1852 \fBverbose-gdb\fR
1853 Make gdb output on native crashes more verbose.
1857 \fBMONO_LOG_LEVEL\fR
1858 The logging level, possible values are `error', `critical', `warning',
1859 `message', `info' and `debug'.  See the DEBUGGING section for more
1860 details.
1862 \fBMONO_LOG_MASK\fR
1863 Controls the domain of the Mono runtime that logging will apply to. 
1864 If set, the log mask is changed to the set value. Possible values are
1865 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
1866 (garbage collector), "cfg" (config file loader), "aot" (precompiler),
1867 "security" (e.g. Moonlight CoreCLR support) and "all". 
1868 The default value is "all". Changing the mask value allows you to display only 
1869 messages for a certain component. You can use multiple masks by comma 
1870 separating them. For example to see config file messages and assembly loader
1871 messages set you mask to "asm,cfg".
1873 \fBMONO_LOG_DEST\fR
1874 Controls where trace log messages are written. If not set then the messages go to stdout. 
1875 If set, the string either specifies a path to a file that will have messages appended to
1876 it, or the string "syslog" in which case the messages will be written to the system log.
1877 Under Windows, this is simulated by writing to a file called "mono.log". 
1878 \fBMONO_LOG_HEADER\fR
1879 Controls whether trace log messages not directed to syslog have the id, timestamp, and
1880 pid as the prefix to the log message. To enable a header this environment variable need
1881 just be non-null. 
1883 \fBMONO_TRACE\fR
1884 Used for runtime tracing of method calls. The format of the comma separated
1885 trace options is:
1888         [-]M:method name
1889         [-]N:namespace
1890         [-]T:class name
1891         [-]all
1892         [-]program
1893         disabled                Trace output off upon start.
1896 You can toggle trace output on/off sending a SIGUSR2 signal to the program.
1898 \fBMONO_TRACE_LISTENER\fR
1899 If set, enables the System.Diagnostics.DefaultTraceListener, which will 
1900 print the output of the System.Diagnostics Trace and Debug classes.  
1901 It can be set to a filename, and to Console.Out or Console.Error to display
1902 output to standard output or standard error, respectively. If it's set to
1903 Console.Out or Console.Error you can append an optional prefix that will
1904 be used when writing messages like this: Console.Error:MyProgramName.
1905 See the System.Diagnostics.DefaultTraceListener documentation for more
1906 information.
1908 \fBMONO_WCF_TRACE\fR
1909 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.
1911 \fBMONO_XEXCEPTIONS\fR
1912 This throws an exception when a X11 error is encountered; by default a
1913 message is displayed but execution continues
1915 \fBMONO_XMLSERIALIZER_DEBUG\fR
1916 Set this value to 1 to prevent the serializer from removing the
1917 temporary files that are created for fast serialization;  This might
1918 be useful when debugging.
1920 \fBMONO_XSYNC\fR
1921 This is used in the System.Windows.Forms implementation when running
1922 with the X11 backend.  This is used to debug problems in Windows.Forms
1923 as it forces all of the commands send to X11 server to be done
1924 synchronously.   The default mode of operation is asynchronous which
1925 makes it hard to isolate the root of certain problems.
1927 \fBMONO_XDEBUG\fR
1928 When the the MONO_XDEBUG env var is set, debugging info for JITted
1929 code is emitted into a shared library, loadable into gdb. This enables,
1930 for example, to see managed frame names on gdb backtraces.   
1932 \fBMONO_VERBOSE_METHOD\fR
1933 Enables the maximum JIT verbosity for the specified method. This is
1934 very helpfull to diagnose a miscompilation problems of a specific
1935 method.   This can be a semicolon-separated list of method names to
1936 match.  If the name is simple, this applies to any method with that
1937 name, otherwise you can use a mono method description (see the section
1938 METHOD DESCRIPTIONS).
1940 \fBMONO_JIT_DUMP_METHOD\fR
1941 Enables sending of the JITs intermediate representation for a specified
1942 method to the IdealGraphVisualizer tool.
1944 \fBMONO_VERBOSE_HWCAP\fR
1945 If set, makes the JIT output information about detected CPU features
1946 (such as SSE, CMOV, FCMOV, etc) to stdout.
1948 \fBMONO_CONSERVATIVE_HWCAP\fR
1949 If set, the JIT will not perform any hardware capability detection. This
1950 may be useful to pinpoint the cause of JIT issues. This is the default
1951 when Mono is built as an AOT cross compiler, so that the generated code
1952 will run on most hardware.
1953 .SH VALGRIND
1954 If you want to use Valgrind, you will find the file `mono.supp'
1955 useful, it contains the suppressions for the GC which trigger
1956 incorrect warnings.  Use it like this:
1958     valgrind --suppressions=mono.supp mono ...
1960 .SH DTRACE
1961 On some platforms, Mono can expose a set of DTrace probes (also known
1962 as user-land statically defined, USDT Probes).
1964 They are defined in the file `mono.d'.
1966 .B ves-init-begin, ves-init-end
1968 Begin and end of runtime initialization.
1970 .B method-compile-begin, method-compile-end
1972 Begin and end of method compilation.
1973 The probe arguments are class name, method name and signature,
1974 and in case of method-compile-end success or failure of compilation.
1976 .B gc-begin, gc-end
1978 Begin and end of Garbage Collection.
1980 To verify the availability of the probes, run:
1982     dtrace -P mono'$target' -l -c mono
1984 .SH PERMISSIONS
1985 Mono's Ping implementation for detecting network reachability can
1986 create the ICMP packets itself without requiring the system ping
1987 command to do the work.  If you want to enable this on Linux for
1988 non-root users, you need to give the Mono binary special permissions.
1990 As root, run this command:
1992    # setcap cap_net_raw=+ep /usr/bin/mono
1994 .SH FILES
1995 On Unix assemblies are loaded from the installation lib directory.  If you set
1996 `prefix' to /usr, the assemblies will be located in /usr/lib.  On
1997 Windows, the assemblies are loaded from the directory where mono and
1998 mint live.
2000 .B ~/.mono/aot-cache
2002 The directory for the ahead-of-time compiler demand creation
2003 assemblies are located. 
2005 .B /etc/mono/config, ~/.mono/config
2007 Mono runtime configuration file.  See the mono-config(5) manual page
2008 for more information.
2010 .B ~/.config/.mono/certs, /usr/share/.mono/certs
2012 Contains Mono certificate stores for users / machine. See the certmgr(1) 
2013 manual page for more information on managing certificate stores and
2014 the mozroots(1) page for information on how to import the Mozilla root
2015 certificates into the Mono certificate store. 
2017 .B ~/.mono/assemblies/ASSEMBLY/ASSEMBLY.config
2019 Files in this directory allow a user to customize the configuration
2020 for a given system assembly, the format is the one described in the
2021 mono-config(5) page. 
2023 .B ~/.config/.mono/keypairs, /usr/share/.mono/keypairs
2025 Contains Mono cryptographic keypairs for users / machine. They can be 
2026 accessed by using a CspParameters object with DSACryptoServiceProvider
2027 and RSACryptoServiceProvider classes.
2029 .B ~/.config/.isolatedstorage, ~/.local/share/.isolatedstorage, /usr/share/.isolatedstorage
2031 Contains Mono isolated storage for non-roaming users, roaming users and 
2032 local machine. Isolated storage can be accessed using the classes from 
2033 the System.IO.IsolatedStorage namespace.
2035 .B <assembly>.config
2037 Configuration information for individual assemblies is loaded by the
2038 runtime from side-by-side files with the .config files, see the
2039 http://www.mono-project.com/Config for more information.
2041 .B Web.config, web.config
2043 ASP.NET applications are configured through these files, the
2044 configuration is done on a per-directory basis.  For more information
2045 on this subject see the http://www.mono-project.com/Config_system.web
2046 page. 
2047 .SH MAILING LISTS
2048 Mailing lists are listed at the
2049 http://www.mono-project.com/community/help/mailing-lists/
2050 .SH WEB SITE
2051 http://www.mono-project.com
2052 .SH SEE ALSO
2054 \fBcertmgr\fR(1), \fBcert-sync\fR(1), \fBcsharp\fR(1),
2055 \fBgacutil\fR(1), \fBmcs\fR(1), \fBmonodis\fR(1),
2056 \fBmono-config\fR(5), \fBmono\-profilers\fR(1),
2057 \fBmprof\-report\fR(1), \fBpdb2mdb\fR(1), \fBxsp\fR(1),
2058 \fBmod_mono\fR(8)
2060 For more information on AOT:
2061 http://www.mono-project.com/docs/advanced/aot/
2063 For ASP.NET-related documentation, see the xsp(1) manual page