3 .\" Copyright 2003 Ximian, Inc.
4 .\" Copyright 2004-2011 Novell, Inc.
5 .\" Copyright 2011-2012 Xamarin Inc
6 .\" Copyright 2013 7digital Media Ltd.
8 .\" Miguel de Icaza (miguel@gnu.org)
12 mono \- Mono's ECMA-CLI native code generator (Just-in-Time and Ahead-of-Time)
15 .B mono [options] file [arguments...]
17 .B mono-sgen [options] file [arguments...]
19 \fImono\fP is a runtime implementation of the ECMA Common Language
20 Infrastructure. This can be used to run ECMA and .NET applications.
22 The runtime contains a native code generator that transforms the
23 Common Intermediate Language into native code.
25 The code generator can operate in two modes: just in time compilation
26 (JIT) or ahead of time compilation (AOT). Since code can be
27 dynamically loaded, the runtime environment and the JIT are always
28 present, even if code is compiled ahead of time.
30 The runtime loads the specified
37 is an ECMA assembly. They typically have a .exe or .dll extension.
39 The runtime provides a number of configuration options for running
40 applications, for developing and debugging, and for testing and
41 debugging the runtime itself.
43 The \fImono\fP command uses the Boehm conservative garbage collector
44 while the \fImono-sgen\fP command uses a moving and generational
47 On Unix-based systems, Mono provides a mechanism to emulate the
48 Windows-style file access, this includes providing a case insensitive
49 view of the file system, directory separator mapping (from \\ to /) and
50 stripping the drive letters.
52 This functionality is enabled by setting the
54 environment variable to one of
59 See the description for
61 in the environment variables section for more details.
63 The following options are available:
65 \fB--aot\fR, \fB--aot[=options]\fR
66 This option is used to precompile the CIL code in the specified
67 assembly to native code. The generated code is stored in a file with
68 the extension .so. This file will be automatically picked up by the
69 runtime when the assembly is executed.
71 Ahead-of-Time compilation is most useful if you use it in combination
72 with the -O=all,-shared flag which enables all of the optimizations in
73 the code generator to be performed. Some of those optimizations are
74 not practical for Just-in-Time compilation since they might be very
77 Unlike the .NET Framework, Ahead-of-Time compilation will not generate
78 domain independent code: it generates the same code that the
79 Just-in-Time compiler would produce. Since most applications use a
80 single domain, this is fine. If you want to optimize the generated
81 code for use in multi-domain applications, consider using the
84 This pre-compiles the methods, but the original assembly is still
85 required to execute as this one contains the metadata and exception
86 information which is not available on the generated file. When
87 precompiling code, you might want to compile with all optimizations
88 (-O=all). Pre-compiled code is position independent code.
90 Pre compilation is just a mechanism to reduce startup time, increase
91 code sharing across multiple mono processes and avoid just-in-time
92 compilation program startup costs. The original assembly must still
93 be present, as the metadata is contained there.
95 AOT code typically can not be moved from one computer to another
96 (CPU-specific optimizations that are detected at runtime) so you
97 should not try to move the pre-generated assemblies or package the
98 pre-generated assemblies for deployment.
100 A few options are available as a parameter to the
102 command line option. The options are separated by commas, and more
103 than one can be specified:
108 The AOT compiler will emit a (ELF only) library initializer to automatically
109 register the aot compiled module with the runtime. This is only useful in static
113 Instructs the AOT compiler to output assembly code instead of an
116 .I bind-to-runtime-version
118 If specified, forces the generated AOT files to be bound to the
119 runtime version of the compiling Mono. This will prevent the AOT
120 files from being consumed by a different Mono runtime.
122 This is currently an experimental feature as it is not complete.
123 This instructs Mono to precompile code that has historically not been
124 precompiled with AOT.
128 When this option is specified, P/Invoke methods are invoked directly
129 instead of going through the operating system symbol lookup operation.
131 .I llvm-path=<PREFIX>
132 Same for the llvm tools 'opt' and 'llc'.
135 Use the GNU style target triple <TRIPLE> to determine some code generation options, i.e.
136 --mtriple=armv7-linux-gnueabi will generate code that targets ARMv7. This is currently
137 only supported by the ARM backend. In LLVM mode, this triple is passed on to the LLVM
140 .I nimt-trampolines=[number]
141 When compiling in full aot mode, the IMT trampolines must be precreated
142 in the AOT image. You can add additional method trampolines with this argument.
146 Instructs the AOT compiler to not output any debugging information.
149 Instructs the AOT compiler to emit DWARF debugging information. When
150 used together with the nodebug option, only DWARF debugging
151 information is emitted, but not the information that can be used at
154 .I nrgctx-trampolines=[number]
155 When compiling in full aot mode, the generic sharing trampolines must be precreated
156 in the AOT image. You can add additional method trampolines with this argument.
159 .I ntrampolines=[number]
160 When compiling in full aot mode, the method trampolines must be precreated
161 in the AOT image. You can add additional method trampolines with this argument.
164 .I outfile=[filename]
165 Instructs the AOT compiler to save the output to the specified file.
167 .I print-skipped-methods
168 If the AOT compiler cannot compile a method for any reason, enabling this flag
169 will output the skipped methods to the console.
171 .I readonly-value=namespace.typename.fieldname=type/value
172 Override the value of a static readonly field. Usually, during JIT
173 compilation, the static constructor is ran eagerly, so the value of
174 a static readonly field is known at compilation time and the compiler
175 can do a number of optimizations based on it. During AOT, instead, the static
176 constructor can't be ran, so this option can be used to set the value of such
177 a field and enable the same set of optimizations.
178 Type can be any of i1, i2, i4 for integers of the respective sizes (in bytes).
179 Note that signed/unsigned numbers do not matter here, just the storage size.
180 This option can be specified multiple times and it doesn't prevent the static
181 constructor for the type defining the field to execute with the usual rules
182 at runtime (hence possibly computing a different value for the field).
185 .I save-temps,keep-temps
186 Instructs the AOT compiler to keep temporary files.
189 This instructs the compiler to generate sequence point checks that
190 allow Mono's soft debugger to debug applications even on systems where
191 it is not possible to set breakpoints or to single step (certain
192 hardware configurations like the cell phones and video gaming
196 Create an ELF object file (.o) or .s file which can be statically linked into an
197 executable when embedding the mono runtime. When this option is used, the object file
198 needs to be registered with the embedded runtime using the mono_aot_register_module
199 function which takes as its argument the mono_aot_module_<ASSEMBLY NAME>_info global
200 symbol from the object file:
203 extern void *mono_aot_module_hello_info;
205 mono_aot_register_module (mono_aot_module_hello_info);
210 Print various stats collected during AOT compilation.
213 This is an experimental option for the AOT compiler to use multiple threads
214 when compiling the methods.
216 .I tool-prefix=<PREFIX>
217 Prepends <PREFIX> to the name of tools ran by the AOT compiler, i.e. 'as'/'ld'. For
218 example, --tool=prefix=arm-linux-gnueabi- will make the AOT compiler run
219 'arm-linux-gnueabi-as' instead of 'as'.
222 Instructs the AOT compiler to emit debug symbol information.
224 For more information about AOT, see: http://www.mono-project.com/AOT
227 \fB--attach=[options]\fR
228 Currently the only option supported by this command line argument is
229 \fBdisable\fR which disables the attach functionality.
231 \fB--config filename\fR
232 Load the specified configuration file instead of the default one(s).
233 The default files are /etc/mono/config and ~/.mono/config or the file
234 specified in the MONO_CONFIG environment variable, if set. See the
235 mono-config(5) man page for details on the format of this file.
237 \fB--debugger-agent=[options]\fR
238 This instructs the Mono runtime to
239 start a debugging agent inside the Mono runtime and connect it to a
240 client user interface will control the Mono process.
241 This option is typically used by IDEs, like the MonoDevelop IDE.
243 The configuration is specified using one of more of the following options:
249 Use this option to specify the IP address where your debugger client is
254 Specifies the diagnostics log level for
258 Used to specify the file where the log will be stored, it defaults to
262 Defaults to no, with the default option Mono will actively connect to the
263 host/port configured with the \fBaddress\fR option. If you set it to 'y', it
264 instructs the Mono runtime to start debugging in server mode, where Mono
265 actively waits for the debugger front end to connect to the Mono process.
266 Mono will print out to stdout the IP address and port where it is listening.
269 If set to yes, Mono will call \fBsetpgid(0, 0)\fB on startup, if that function
270 is available on the system. This is useful for ensuring that signals delivered
271 to a process that is executing the debuggee are not propagated to the debuggee,
272 e.g. when Ctrl-C sends \fBSIGINT\fB to the \fBsdb\fB tool.
275 Defaults to yes, with the default option Mono will suspend the vm on startup
276 until it connects successfully to a debugger front end. If you set it to 'n', in
277 conjunction with \fBserver=y\fR, it instructs the Mono runtime to run as normal,
278 while caching metadata to send to the debugger front end on connection..
280 .I transport=transport_name
282 This is used to specify the transport that the debugger will use to
283 communicate. It must be specified and currently requires this to
289 Configures the virtual machine to be better suited for desktop
290 applications. Currently this sets the GC system to avoid expanding
291 the heap as much as possible at the expense of slowing down garbage
295 This is an experimental flag that instructs the Mono runtime to not
296 generate any code at runtime and depend exclusively on the code
297 generated from using mono --aot=full previously. This is useful for
298 platforms that do not permit dynamic code generation.
300 Notice that this feature will abort execution at runtime if a codepath
301 in your program, or Mono's class libraries attempts to generate code
302 dynamically. You should test your software upfront and make sure that
303 you do not use any dynamic features.
305 \fB--gc=boehm\fR, \fB--gc=sgen\fR
306 Selects the Garbage Collector engine for Mono to use, Boehm or SGen.
307 Currently this merely ensures that you are running either the
308 \fImono\fR or \fImono-sgen\fR commands. This flag can be set in the
309 \fBMONO_ENV_OPTIONS\fR environment variable to force all of your child
310 processes to use one particular kind of GC with the Mono runtime.
312 \fB--help\fR, \fB-h\fR
313 Displays usage instructions.
316 If the Mono runtime has been compiled with LLVM support (not available
317 in all configurations), Mono will use the LLVM optimization and code
318 generation engine to JIT or AOT compile.
320 For more information, consult: http://www.mono-project.com/Mono_LLVM
323 When using a Mono that has been compiled with LLVM support, it forces
324 Mono to fallback to its JIT engine and not use the LLVM backend.
326 \fB--optimize=MODE\fR, \fB-O=MODE\fR
327 MODE is a comma separated list of optimizations. They also allow
328 optimizations to be turned off by prefixing the optimization name with
331 In general, Mono has been tuned to use the default set of flags,
332 before using these flags for a deployment setting, you might want to
333 actually measure the benefits of using them.
335 The following optimizations are implemented:
337 all Turn on all optimizations
338 peephole Peephole postpass
339 branch Branch optimizations
340 inline Inline method calls
341 cfold Constant folding
342 consprop Constant propagation
343 copyprop Copy propagation
344 deadce Dead code elimination
345 linears Linear scan global reg allocation
346 cmov Conditional moves [arch-dependency]
347 shared Emit per-domain code
348 sched Instruction scheduling
349 intrins Intrinsic method implementations
350 tailc Tail recursion and tail calls
351 loop Loop related optimizations
352 fcmov Fast x86 FP compares [arch-dependency]
353 leaf Leaf procedures optimizations
354 aot Usage of Ahead Of Time compiled code
355 precomp Precompile all methods before executing Main
356 abcrem Array bound checks removal
357 ssapre SSA based Partial Redundancy Elimination
358 sse2 SSE2 instructions on x86 [arch-dependency]
359 gshared Enable generic code sharing.
362 For example, to enable all the optimization but dead code
363 elimination and inlining, you can use:
365 -O=all,-deadce,-inline
368 The flags that are flagged with [arch-dependency] indicate that the
369 given option if used in combination with Ahead of Time compilation
370 (--aot flag) would produce pre-compiled code that will depend on the
371 current CPU and might not be safely moved to another computer.
373 \fB--runtime=VERSION\fR
374 Mono supports different runtime versions. The version used depends on the program
375 that is being run or on its configuration file (named program.exe.config). This option
376 can be used to override such autodetection, by forcing a different runtime version
377 to be used. Note that this should only be used to select a later compatible runtime
378 version than the one the program was compiled against. A typical usage is for
379 running a 1.1 program on a 2.0 version:
381 mono --runtime=v2.0.50727 program.exe
384 \fB--security\fR, \fB--security=mode\fR
385 Activate the security manager, a currently experimental feature in
386 Mono and it is OFF by default. The new code verifier can be enabled
387 with this option as well.
391 Using security without parameters is equivalent as calling it with the
394 The following modes are supported:
397 This allows mono to support declarative security attributes,
398 e.g. execution of Code Access Security (CAS) or non-CAS demands.
401 Enables the core-clr security system, typically used for
402 Moonlight/Silverlight applications. It provides a much simpler
403 security system than CAS, see http://www.mono-project.com/Moonlight
404 for more details and links to the descriptions of this new system.
407 Enables the new verifier and performs basic verification for code
408 validity. In this mode, unsafe code and P/Invoke are allowed. This
409 mode provides a better safety guarantee but it is still possible
410 for managed code to crash Mono.
413 Enables the new verifier and performs full verification of the code
414 being executed. It only allows verifiable code to be executed.
415 Unsafe code is not allowed but P/Invoke is. This mode should
416 not allow managed code to crash mono. The verification is not as
417 strict as ECMA 335 standard in order to stay compatible with the MS
420 The security system acts on user code: code contained in mscorlib or
421 the global assembly cache is always trusted.
426 Configures the virtual machine to be better suited for server
427 operations (currently, allows a heavier threadpool initialization).
430 Verifies mscorlib and assemblies in the global
431 assembly cache for valid IL, and all user code for IL
434 This is different from \fB--security\fR's verifiable
435 or validil in that these options only check user code and skip
436 mscorlib and assemblies located on the global assembly cache.
438 \fB-V\fR, \fB--version\fR
439 Prints JIT version information (system configuration, release number
440 and branch names if available).
443 .SH DEVELOPMENT OPTIONS
444 The following options are used to help when developing a JITed application.
446 \fB--debug\fR, \fB--debug=OPTIONS\fR
447 Turns on the debugging mode in the runtime. If an assembly was
448 compiled with debugging information, it will produce line number
449 information for stack traces.
453 The optional OPTIONS argument is a comma separated list of debugging
454 options. These options are turned off by default since they generate
455 much larger and slower code at runtime.
457 The following options are supported:
460 Produces a detailed error when throwing a InvalidCastException. This
461 option needs to be enabled as this generates more verbose code at
465 Disable some JIT optimizations which are usually only disabled when
466 running inside the debugger. This can be helpful if you want to attach
467 to the running process with mdb.
470 Generate and register debugging information with gdb. This is only supported on some
471 platforms, and only when using gdb 7.0 or later.
475 \fB--profile[=profiler[:profiler_args]]\fR
476 Turns on profiling. For more information about profiling applications
477 and code coverage see the sections "PROFILING" and "CODE COVERAGE"
480 This option can be used multiple times, each time will load an
481 additional profiler. This allows developers to use modules that
482 extend the JIT through the Mono profiling interface.
484 \fB--trace[=expression]\fR
485 Shows method names as they are invoked. By default all methods are
488 The trace can be customized to include or exclude methods, classes or
489 assemblies. A trace expression is a comma separated list of targets,
490 each target can be prefixed with a minus sign to turn off a particular
491 target. The words `program', `all' and `disabled' have special
492 meaning. `program' refers to the main program being executed, and
493 `all' means all the method calls.
495 The `disabled' option is used to start up with tracing disabled. It
496 can be enabled at a later point in time in the program by sending the
497 SIGUSR2 signal to the runtime.
499 Assemblies are specified by their name, for example, to trace all
500 calls in the System assembly, use:
503 mono --trace=System app.exe
506 Classes are specified with the T: prefix. For example, to trace all
507 calls to the System.String class, use:
510 mono --trace=T:System.String app.exe
513 And individual methods are referenced with the M: prefix, and the
514 standard method notation:
517 mono --trace=M:System.Console:WriteLine app.exe
520 Exceptions can also be traced, it will cause a stack trace to be
521 printed every time an exception of the specified type is thrown.
522 The exception type can be specified with or without the namespace,
523 and to trace all exceptions, specify 'all' as the type name.
526 mono --trace=E:System.Exception app.exe
529 As previously noted, various rules can be specified at once:
532 mono --trace=T:System.String,T:System.Random app.exe
535 You can exclude pieces, the next example traces calls to
536 System.String except for the System.String:Concat method.
539 mono --trace=T:System.String,-M:System.String:Concat
542 You can trace managed to unmanaged transitions using
543 the wrapper qualifier:
546 mono --trace=wrapper app.exe
549 Finally, namespaces can be specified using the N: prefix:
552 mono --trace=N:System.Xml
556 \fB--no-x86-stack-align\fR
557 Don't align stack frames on the x86 architecture. By default, Mono
558 aligns stack frames to 16 bytes on x86, so that local floating point
559 and SIMD variables can be properly aligned. This option turns off the
560 alignment, which usually saves one intruction per call, but might
561 result in significantly lower floating point and SIMD performance.
564 Generate a JIT method map in a /tmp/perf-PID.map file. This file is then
565 used, for example, by the perf tool included in recent Linux kernels.
566 Each line in the file has:
569 HEXADDR HEXSIZE methodname
572 Currently this option is only supported on Linux.
573 .SH JIT MAINTAINER OPTIONS
574 The maintainer options are only used by those developing the runtime
575 itself, and not typically of interest to runtime users or developers.
578 Inserts a breakpoint before the method whose name is `method'
579 (namespace.class:methodname). Use `Main' as method name to insert a
580 breakpoint on the application's main method. You can use it also with
581 generics, for example "System.Collections.Generic.Queue`1:Peek"
584 Inserts a breakpoint on exceptions. This allows you to debug your
585 application with a native debugger when an exception is thrown.
588 This compiles a method (namespace.name:methodname), this is used for
589 testing the compiler performance or to examine the output of the code
593 Compiles all the methods in an assembly. This is used to test the
594 compiler performance or to examine the output of the code generator
596 \fB--graph=TYPE METHOD\fR
597 This generates a postscript file with a graph with the details about
598 the specified method (namespace.name:methodname). This requires `dot'
599 and ghostview to be installed (it expects Ghostview to be called
602 The following graphs are available:
604 cfg Control Flow Graph (CFG)
606 code CFG showing code
607 ssa CFG showing code after SSA translation
608 optcode CFG showing code after IR optimizations
611 Some graphs will only be available if certain optimizations are turned
615 Instruct the runtime on the number of times that the method specified
616 by --compile (or all the methods if --compileall is used) to be
617 compiled. This is used for testing the code generator performance.
620 Displays information about the work done by the runtime during the
621 execution of an application.
623 \fB--wapi=hps|semdel\fR
624 Perform maintenance of the process shared data.
626 semdel will delete the global semaphore.
628 hps will list the currently used handles.
630 \fB-v\fR, \fB--verbose\fR
631 Increases the verbosity level, each time it is listed, increases the
632 verbosity level to include more information (including, for example,
633 a disassembly of the native code produced, code selector info etc.).
635 The Mono runtime allows external processes to attach to a running
636 process and load assemblies into the running program. To attach to
637 the process, a special protocol is implemented in the Mono.Management
640 With this support it is possible to load assemblies that have an entry
641 point (they are created with -target:exe or -target:winexe) to be
642 loaded and executed in the Mono process.
644 The code is loaded into the root domain, and it starts execution on
645 the special runtime attach thread. The attached program should
646 create its own threads and return after invocation.
648 This support allows for example debugging applications by having the
649 csharp shell attach to running processes.
651 The mono runtime includes a profiler that can be used to explore
652 various performance related problems in your application. The
653 profiler is activated by passing the --profile command line argument
654 to the Mono runtime, the format is:
657 --profile[=profiler[:profiler_args]]
660 Mono has a built-in profiler called 'default' (and is also the default
661 if no arguments are specified), but developers can write custom
662 profilers, see the section "CUSTOM PROFILERS" for more details.
666 is not specified, the default profiler is used.
670 is a profiler-specific string of options for the profiler itself.
672 The default profiler accepts the following options 'alloc' to profile
673 memory consumption by the application; 'time' to profile the time
674 spent on each routine; 'jit' to collect time spent JIT-compiling methods
675 and 'stat' to perform sample statistical profiling.
676 If no options are provided the default is 'alloc,time,jit'.
679 profile data is printed to stdout: to change this, use the 'file=filename'
680 option to output the data to filename.
685 mono --profile program.exe
689 That will run the program with the default profiler and will do time
690 and allocation profiling.
694 mono --profile=default:stat,alloc,file=prof.out program.exe
697 Will do sample statistical profiling and allocation profiling on
698 program.exe. The profile data is put in prof.out.
700 Note that the statistical profiler has a very low overhead and should
701 be the preferred profiler to use (for better output use the full path
702 to the mono binary when running and make sure you have installed the
703 addr2line utility that comes from the binutils package).
705 This is the most advanced profiler.
707 The Mono \f[I]log\f[] profiler can be used to collect a lot of
708 information about a program running in the Mono runtime.
709 This data can be used (both while the process is running and later)
710 to do analyses of the program behaviour, determine resource usage,
711 performance issues or even look for particular execution patterns.
713 This is accomplished by logging the events provided by the Mono
714 runtime through the profiling interface and periodically writing
715 them to a file which can be later inspected with the mprof-report(1)
718 More information about how to use the log profiler is available on the
719 mprof-report(1) page.
721 Mono provides a mechanism for loading other profiling modules which in
722 the form of shared libraries. These profiling modules can hook up to
723 various parts of the Mono runtime to gather information about the code
726 To use a third party profiler you must pass the name of the profiler
730 mono --profile=custom program.exe
734 In the above sample Mono will load the user defined profiler from the
735 shared library `mono-profiler-custom.so'. This profiler module must
736 be on your dynamic linker library path.
738 A list of other third party profilers is available from Mono's web
739 site (www.mono-project.com/Performance_Tips)
741 Custom profiles are written as shared libraries. The shared library
742 must be called `mono-profiler-NAME.so' where `NAME' is the name of
745 For a sample of how to write your own custom profiler look in the
746 Mono source tree for in the samples/profiler.c.
748 Mono ships with a code coverage module. This module is activated by
749 using the Mono --profile=cov option. The format is:
750 \fB--profile=cov[:assembly-name[/namespace]] test-suite.exe\fR
752 By default code coverage will default to all the assemblies loaded,
753 you can limit this by specifying the assembly name, for example to
754 perform code coverage in the routines of your program use, for example
755 the following command line limits the code coverage to routines in the
759 mono --profile=cov:demo demo.exe
765 does not include the extension.
767 You can further restrict the code coverage output by specifying a
771 mono --profile=cov:demo/My.Utilities demo.exe
775 Which will only perform code coverage in the given assembly and
778 Typical output looks like this:
781 Not covered: Class:.ctor ()
782 Not covered: Class:A ()
783 Not covered: Driver:.ctor ()
784 Not covered: Driver:method ()
785 Partial coverage: Driver:Main ()
790 The offsets displayed are IL offsets.
792 A more powerful coverage tool is available in the module `monocov'.
793 See the monocov(1) man page for details.
795 To debug managed applications, you can use the
797 command, a command line debugger.
799 It is possible to obtain a stack trace of all the active threads in
800 Mono by sending the QUIT signal to Mono, you can do this from the
801 command line, like this:
807 Where pid is the Process ID of the Mono process you want to examine.
808 The process will continue running afterwards, but its state is not
812 this is a last-resort mechanism for debugging applications and should
813 not be used to monitor or probe a production application. The
814 integrity of the runtime after sending this signal is not guaranteed
815 and the application might crash or terminate at any given point
818 The \fB--debug=casts\fR option can be used to get more detailed
819 information for Invalid Cast operations, it will provide information
820 about the types involved.
822 You can use the MONO_LOG_LEVEL and MONO_LOG_MASK environment variables
823 to get verbose debugging output about the execution of your
824 application within Mono.
828 environment variable if set, the logging level is changed to the set
829 value. Possible values are "error", "critical", "warning", "message",
830 "info", "debug". The default value is "error". Messages with a logging
831 level greater then or equal to the log level will be printed to
834 Use "info" to track the dynamic loading of assemblies.
839 environment variable to limit the extent of the messages you get:
840 If set, the log mask is changed to the set value. Possible values are
841 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
842 (garbage collector), "cfg" (config file loader), "aot" (precompiler),
843 "security" (e.g. Moonlight CoreCLR support) and "all".
844 The default value is "all". Changing the mask value allows you to display only
845 messages for a certain component. You can use multiple masks by comma
846 separating them. For example to see config file messages and assembly loader
847 messages set you mask to "asm,cfg".
849 The following is a common use to track down problems with P/Invoke:
852 $ MONO_LOG_LEVEL="debug" MONO_LOG_MASK="dll" mono glue.exe
857 Mono's XML serialization engine by default will use a reflection-based
858 approach to serialize which might be slow for continuous processing
859 (web service applications). The serialization engine will determine
860 when a class must use a hand-tuned serializer based on a few
861 parameters and if needed it will produce a customized C# serializer
862 for your types at runtime. This customized serializer then gets
863 dynamically loaded into your application.
865 You can control this with the MONO_XMLSERIALIZER_THS environment
868 The possible values are
870 to disable the use of a C# customized
871 serializer, or an integer that is the minimum number of uses before
872 the runtime will produce a custom serializer (0 will produce a
873 custom serializer on the first access, 50 will produce a serializer on
874 the 50th use). Mono will fallback to an interpreted serializer if the
875 serializer generation somehow fails. This behavior can be disabled
876 by setting the option
878 (for example: MONO_XMLSERIALIZER_THS=0,nofallback).
879 .SH ENVIRONMENT VARIABLES
882 Turns off the garbage collection in Mono. This should be only used
883 for debugging purposes
886 When Mono is compiled with LLVM support, this instructs the runtime to
887 stop using LLVM after the specified number of methods are JITed.
888 This is a tool used in diagnostics to help isolate problems in the
889 code generation backend. For example \fBLLVM_COUNT=10\fR would only
890 compile 10 methods with LLVM and then switch to the Mono JIT engine.
891 \fBLLVM_COUNT=0\fR would disable the LLVM engine altogether.
894 If set, this variable will instruct Mono to ahead-of-time compile new
895 assemblies on demand and store the result into a cache in
898 \fBMONO_ASPNET_INHIBIT_SETTINGSMAP\fR
899 Mono contains a feature which allows modifying settings in the .config files shipped
900 with Mono by using config section mappers. The mappers and the mapping rules are
901 defined in the $prefix/etc/mono/2.0/settings.map file and, optionally, in the
902 settings.map file found in the top-level directory of your ASP.NET application.
903 Both files are read by System.Web on application startup, if they are found at the
904 above locations. If you don't want the mapping to be performed you can set this
905 variable in your environment before starting the application and no action will
908 \fBMONO_ASPNET_WEBCONFIG_CACHESIZE\fR
909 Mono has a cache of ConfigSection objects for speeding up WebConfigurationManager
910 queries. Its default size is 100 items, and when more items are needed, cache
911 evictions start happening. If evictions are too frequent this could impose
912 unnecessary overhead, which could be avoided by using this environment variable
913 to set up a higher cache size (or to lower memory requirements by decreasing it).
915 \fBMONO_CAIRO_DEBUG_DISPOSE\fR
916 If set, causes Mono.Cairo to collect stack traces when objects are allocated,
917 so that the finalization/Dispose warnings include information about the
921 If set, this variable overrides the default system configuration directory
922 ($PREFIX/etc). It's used to locate machine.config file.
925 Sets the style of COM interop. If the value of this variable is "MS"
926 Mono will use string marhsalling routines from the liboleaut32 for the
927 BSTR type library, any other values will use the mono-builtin BSTR
931 If set, this variable overrides the default runtime configuration file
932 ($PREFIX/etc/mono/config). The --config command line options overrides the
933 environment variable.
936 Override the automatic cpu detection mechanism. Currently used only on arm.
937 The format of the value is as follows:
943 where V is the architecture number 4, 5, 6, 7 and the options can be currently be
944 "thumb" or "thumb2". Example:
947 MONO_CPU_ARCH="armv4 thumb" mono ...
951 \fBMONO_DISABLE_AIO\fR
952 If set, tells mono NOT to attempt using native asynchronous I/O services. In
953 that case, a default select/poll implementation is used. Currently only epoll()
956 \fBMONO_DISABLE_MANAGED_COLLATION\fR
957 If this environment variable is `yes', the runtime uses unmanaged
958 collation (which actually means no culture-sensitive collation). It
959 internally disables managed collation functionality invoked via the
960 members of System.Globalization.CompareInfo class. Collation is
963 \fBMONO_DISABLE_SHM\fR
964 Unix only: If set, disables the shared memory files used for
965 cross-process handles: process have only private handles. This means
966 that process and thread handles are not available to other processes,
967 and named mutexes, named events and named semaphores are not visible
970 This is can also be enabled by default by passing the
971 "--disable-shared-handles" option to configure.
973 This is the default from mono 2.8 onwards.
975 \fBMONO_DISABLE_SHARED_AREA\fR
976 Unix only: If set, disable usage of shared memory for exposing
977 performance counters. This means it will not be possible to both
978 externally read performance counters from this processes or read
979 those of external processes.
982 When set, enables the use of a fully managed DNS resolver instead of the
983 regular libc functions. This resolver performs much better when multiple
984 queries are run in parallel.
986 Note that /etc/nsswitch.conf will be ignored.
988 \fBMONO_EGD_SOCKET\fR
989 For platforms that do not otherwise have a way of obtaining random bytes
990 this can be set to the name of a file system socket on which an egd or
991 prngd daemon is listening.
993 \fBMONO_ENABLE_SHM\fR
994 Unix only: Enable support for cross-process handles. Cross-process
995 handles are used to expose process handles, thread handles, named
996 mutexes, named events and named semaphores across Unix processes.
998 \fBMONO_ENV_OPTIONS\fR
999 This environment variable allows you to pass command line arguments to
1000 a Mono process through the environment. This is useful for example
1001 to force all of your Mono processes to use LLVM or SGEN without having
1002 to modify any launch scripts.
1004 \fBMONO_ENV_OPTIONS\fR
1005 Used to pass extra options to the debugger agent in the runtime, as they were passed
1006 using --debugger-agent=.
1008 \fBMONO_EVENTLOG_TYPE\fR
1009 Sets the type of event log provider to use (for System.Diagnostics.EventLog).
1011 Possible values are:
1016 Persists event logs and entries to the local file system.
1018 The directory in which to persist the event logs, event sources and entries
1019 can be specified as part of the value.
1021 If the path is not explicitly set, it defaults to "/var/lib/mono/eventlog"
1022 on unix and "%APPDATA%\mono\eventlog" on Windows.
1027 Uses the native win32 API to write events and registers event logs and
1028 event sources in the registry. This is only available on Windows.
1030 On Unix, the directory permission for individual event log and event source
1031 directories is set to 777 (with +t bit) allowing everyone to read and write
1032 event log entries while only allowing entries to be deleted by the user(s)
1037 Silently discards any events.
1040 The default is "null" on Unix (and versions of Windows before NT), and
1041 "win32" on Windows NT (and higher).
1044 \fBMONO_EXTERNAL_ENCODINGS\fR
1045 If set, contains a colon-separated list of text encodings to try when
1046 turning externally-generated text (e.g. command-line arguments or
1047 filenames) into Unicode. The encoding names come from the list
1048 provided by iconv, and the special case "default_locale" which refers
1049 to the current locale's default encoding.
1051 When reading externally-generated text strings UTF-8 is tried first,
1052 and then this list is tried in order with the first successful
1053 conversion ending the search. When writing external text (e.g. new
1054 filenames or arguments to new processes) the first item in this list
1055 is used, or UTF-8 if the environment variable is not set.
1057 The problem with using MONO_EXTERNAL_ENCODINGS to process your
1058 files is that it results in a problem: although its possible to get
1059 the right file name it is not necessarily possible to open the file.
1060 In general if you have problems with encodings in your filenames you
1061 should use the "convmv" program.
1063 \fBMONO_GC_PARAMS\fR
1064 When using Mono with the SGen garbage collector this variable controls
1065 several parameters of the collector. The variable's value is a comma
1066 separated list of words.
1070 \fBnursery-size=\fIsize\fR
1071 Sets the size of the nursery. The size is specified in bytes and must
1072 be a power of two. The suffixes `k', `m' and `g' can be used to
1073 specify kilo-, mega- and gigabytes, respectively. The nursery is the
1074 first generation (of two). A larger nursery will usually speed up the
1075 program but will obviously use more memory. The default nursery size
1078 \fBmajor=\fIcollector\fR Specifies which major collector to use.
1079 Options are `marksweep' for the Mark&Sweep collector, and
1080 `marksweep-conc' for concurrent Mark&Sweep. The non-concurrent
1081 Mark&Sweep collector is the default.
1083 \fBsoft-heap-limit=\fIsize\fR
1084 Once the heap size gets larger than this size, ignore what the default
1085 major collection trigger metric says and only allow four nursery size's
1086 of major heap growth between major collections.
1088 \fBevacuation-threshold=\fIthreshold\fR
1089 Sets the evacuation threshold in percent. This option is only available
1090 on the Mark&Sweep major collectors. The value must be an
1091 integer in the range 0 to 100. The default is 66. If the sweep phase of
1092 the collection finds that the occupancy of a specific heap block type is
1093 less than this percentage, it will do a copying collection for that block
1094 type in the next major collection, thereby restoring occupancy to close
1095 to 100 percent. A value of 0 turns evacuation off.
1097 \fB(no-)lazy-sweep\fR
1098 Enables or disables lazy sweep for the Mark&Sweep collector. If
1099 enabled, the sweep phase of the garbage collection is done piecemeal
1100 whenever the need arises, typically during nursery collections. Lazy
1101 sweeping is enabled by default.
1103 \fBstack-mark=\fImark-mode\fR
1104 Specifies how application threads should be scanned. Options are
1105 `precise` and `conservative`. Precise marking allow the collector
1106 to know what values on stack are references and what are not.
1107 Conservative marking threats all values as potentially references
1108 and leave them untouched. Precise marking reduces floating garbage
1109 and can speed up nursery collection and allocation rate, it has
1110 the downside of requiring a significant extra memory per compiled
1111 method. The right option, unfortunately, requires experimentation.
1113 \fBsave-target-ratio=\fIratio\fR
1114 Specifies the target save ratio for the major collector. The collector
1115 lets a given amount of memory to be promoted from the nursery due to
1116 minor collections before it triggers a major collection. This amount
1117 is based on how much memory it expects to free. It is represented as
1118 a ratio of the size of the heap after a major collection.
1119 Valid values are between 0.1 and 2.0. The default is 0.5.
1120 Smaller values will keep the major heap size smaller but will trigger
1121 more major collections. Likewise, bigger values will use more memory
1122 and result in less frequent major collections.
1123 This option is EXPERIMENTAL, so it might disappear in later versions of mono.
1125 \fBdefault-allowance-ratio=\fIratio\fR
1126 Specifies the default allocation allowance when the calculated size
1127 is too small. The allocation allowance is how much memory the collector
1128 let be promoted before triggered a major collection.
1129 It is a ratio of the nursery size.
1130 Valid values are between 1.0 and 10.0. The default is 4.0.
1131 Smaller values lead to smaller heaps and more frequent major collections.
1132 Likewise, bigger values will allow the heap to grow faster but use
1133 more memory when it reaches a stable size.
1134 This option is EXPERIMENTAL, so it might disappear in later versions of mono.
1136 \fBminor=\fIminor-collector\fR
1137 Specifies which minor collector to use. Options are 'simple' which
1138 promotes all objects from the nursery directly to the old generation
1139 and 'split' which lets object stay longer on the nursery before promoting.
1141 \fBalloc-ratio=\fIratio\fR
1142 Specifies the ratio of memory from the nursery to be use by the alloc space.
1143 This only can only be used with the split minor collector.
1144 Valid values are integers between 1 and 100. Default is 60.
1146 \fBpromotion-age=\fIage\fR
1147 Specifies the required age of an object must reach inside the nursery before
1148 been promoted to the old generation. This only can only be used with the
1149 split minor collector.
1150 Valid values are integers between 1 and 14. Default is 2.
1152 \fB(no-)cementing\fR
1153 Enables or disables cementing. This can dramatically shorten nursery
1154 collection times on some benchmarks where pinned objects are referred
1155 to from the major heap.
1160 When using Mono with the SGen garbage collector this environment
1161 variable can be used to turn on various debugging features of the
1162 collector. The value of this variable is a comma separated list of
1163 words. Do not use these options in production.
1168 Sets the debug level to the specified number.
1170 \fBprint-allowance\fR
1171 After each major collection prints memory consumption for before and
1172 after the collection and the allowance for the minor collector, i.e. how
1173 much the heap is allowed to grow from minor collections before the next
1174 major collection is triggered.
1177 Gathers statistics on the classes whose objects are pinned in the
1178 nursery and for which global remset entries are added. Prints those
1179 statistics when shutting down.
1181 \fBcollect-before-allocs\fR
1183 \fBcheck-at-minor-collections\fR
1184 This performs a consistency check on minor collections and also clears
1185 the nursery at collection time, instead of the default, when buffers
1186 are allocated (clear-at-gc). The consistency check ensures that
1187 there are no major to minor references that are not on the remembered
1190 \fBmod-union-consistency-check\fR
1191 Checks that the mod-union cardtable is consistent before each
1192 finishing major collection pause. This check is only applicable to
1193 concurrent major collectors.
1195 \fBcheck-mark-bits\fR
1196 Checks that mark bits in the major heap are consistent at the end of
1197 each major collection. Consistent mark bits mean that if an object is
1198 marked, all objects that it had references to must also be marked.
1200 \fBcheck-nursery-pinned\fR
1201 After nursery collections, and before starting concurrent collections,
1202 check whether all nursery objects are pinned, or not pinned -
1203 depending on context. Does nothing when the split nursery collector
1206 \fBxdomain-checks\fR
1207 Performs a check to make sure that no references are left to an
1210 \fBclear-at-tlab-creation\fR
1211 Clears the nursery incrementally when the thread local allocation
1212 buffers (TLAB) are created. The default setting clears the whole
1215 \fBdebug-clear-at-tlab-creation\fR
1216 Clears the nursery incrementally when the thread local allocation
1217 buffers (TLAB) are created, but at GC time fills it with the byte
1218 `0xff`, which should result in a crash more quickly if
1219 `clear-at-tlab-creation` doesn't work properly.
1222 This clears the nursery at GC time instead of doing it when the thread
1223 local allocation buffer (TLAB) is created. The default is to clear
1224 the nursery at TLAB creation time.
1227 Don't do minor collections. If the nursery is full, a major collection
1228 is triggered instead, unless it, too, is disabled.
1231 Don't do major collections.
1233 \fBconservative-stack-mark\fR
1234 Forces the GC to scan the stack conservatively, even if precise
1235 scanning is available.
1237 \fBno-managed-allocator\fR
1238 Disables the managed allocator.
1240 \fBcheck-scan-starts\fR
1241 If set, does a plausibility check on the scan_starts before and after each collection
1243 \fBverify-nursery-at-minor-gc\fR
1244 If set, does a complete object walk of the nursery at the start of each minor collection.
1246 \fBdump-nursery-at-minor-gc\fR
1247 If set, dumps the contents of the nursery at the start of each minor collection. Requires
1248 verify-nursery-at-minor-gc to be set.
1250 \fBheap-dump=\fIfile\fR
1251 Dumps the heap contents to the specified file. To visualize the
1252 information, use the mono-heapviz tool.
1254 \fBbinary-protocol=\fIfile\fR
1255 Outputs the debugging output to the specified file. For this to
1256 work, Mono needs to be compiled with the BINARY_PROTOCOL define on
1257 sgen-gc.c. You can then use this command to explore the output
1259 sgen-grep-binprot 0x1234 0x5678 < file
1261 \fBnursery-canaries\fR
1262 If set, objects allocated in the nursery are suffixed with a canary (guard)
1263 word, which is checked on each minor collection. Can be used to detect/debug
1264 heap corruption issues.
1269 \fBMONO_GAC_PREFIX\fR
1270 Provides a prefix the runtime uses to look for Global Assembly Caches.
1271 Directories are separated by the platform path separator (colons on
1272 unix). MONO_GAC_PREFIX should point to the top directory of a prefixed
1273 install. Or to the directory provided in the gacutil /gacdir command. Example:
1274 .B /home/username/.mono:/usr/local/mono/
1277 Enables some filename rewriting support to assist badly-written
1278 applications that hard-code Windows paths. Set to a colon-separated
1279 list of "drive" to strip drive letters, or "case" to do
1280 case-insensitive file matching in every directory in a path. "all"
1281 enables all rewriting methods. (Backslashes are always mapped to
1282 slashes if this variable is set to a valid option).
1285 For example, this would work from the shell:
1288 MONO_IOMAP=drive:case
1292 If you are using mod_mono to host your web applications, you can use
1295 directive instead, like this:
1298 MonoIOMAP <appalias> all
1301 See mod_mono(8) for more details.
1303 Additionally. Mono includes a profiler module which allows one to track what
1304 adjustements to file paths IOMAP code needs to do. The tracking code reports
1305 the managed location (full stack trace) from which the IOMAP-ed call was made and,
1306 on process exit, the locations where all the IOMAP-ed strings were created in
1307 managed code. The latter report is only approximate as it is not always possible
1308 to estimate the actual location where the string was created. The code uses simple
1309 heuristics - it analyzes stack trace leading back to the string allocation location
1310 and ignores all the managed code which lives in assemblies installed in GAC as well as in the
1311 class libraries shipped with Mono (since they are assumed to be free of case-sensitivity
1312 issues). It then reports the first location in the user's code - in most cases this will be
1313 the place where the string is allocated or very close to the location. The reporting code
1314 is implemented as a custom profiler module (see the "PROFILING" section) and can be loaded
1315 in the following way:
1320 mono --profile=iomap yourapplication.exe
1323 Note, however, that Mono currently supports only one profiler module
1327 When Mono is using the LLVM code generation backend you can use this
1328 environment variable to pass code generation options to the LLVM
1331 \fBMONO_MANAGED_WATCHER\fR
1332 If set to "disabled", System.IO.FileSystemWatcher will use a file watcher
1333 implementation which silently ignores all the watching requests.
1334 If set to any other value, System.IO.FileSystemWatcher will use the default
1335 managed implementation (slow). If unset, mono will try to use inotify, FAM,
1336 Gamin, kevent under Unix systems and native API calls on Windows, falling
1337 back to the managed implementation on error.
1339 \fBMONO_MESSAGING_PROVIDER\fR
1340 Mono supports a plugin model for its implementation of System.Messaging making
1341 it possible to support a variety of messaging implementations (e.g. AMQP, ActiveMQ).
1342 To specify which messaging implementation is to be used the evironement variable
1343 needs to be set to the full class name for the provider. E.g. to use the RabbitMQ based
1344 AMQP implementation the variable should be set to:
1347 Mono.Messaging.RabbitMQ.RabbitMQMessagingProvider,Mono.Messaging.RabbitMQ
1350 If set causes the mono process to be bound to a single processor. This may be
1351 useful when debugging or working around race conditions.
1354 Disable inlining of thread local accesses. Try setting this if you get a segfault
1355 early on in the execution of mono.
1358 Provides a search path to the runtime where to look for library
1359 files. This is a tool convenient for debugging applications, but
1360 should not be used by deployed applications as it breaks the assembly
1361 loader in subtle ways.
1363 Directories are separated by the platform path separator (colons on unix). Example:
1364 .B /home/username/lib:/usr/local/mono/lib
1366 Relative paths are resolved based on the launch-time current directory.
1368 Alternative solutions to MONO_PATH include: installing libraries into
1369 the Global Assembly Cache (see gacutil(1)) or having the dependent
1370 libraries side-by-side with the main executable.
1372 For a complete description of recommended practices for application
1374 http://www.mono-project.com/Guidelines:Application_Deployment
1377 Experimental RTC support in the statistical profiler: if the user has
1378 the permission, more accurate statistics are gathered. The MONO_RTC
1379 value must be restricted to what the Linux rtc allows: power of two
1380 from 64 to 8192 Hz. To enable higher frequencies like 4096 Hz, run as root:
1383 echo 4096 > /proc/sys/dev/rtc/max-user-freq
1390 MONO_RTC=4096 mono --profiler=default:stat program.exe
1394 \fBMONO_SHARED_DIR\fR
1395 If set its the directory where the ".wapi" handle state is stored.
1396 This is the directory where the Windows I/O Emulation layer stores its
1397 shared state data (files, events, mutexes, pipes). By default Mono
1398 will store the ".wapi" directory in the users's home directory.
1400 \fBMONO_SHARED_HOSTNAME\fR
1401 Uses the string value of this variable as a replacement for the host name when
1402 creating file names in the ".wapi" directory. This helps if the host name of
1403 your machine is likely to be changed when a mono application is running or if
1404 you have a .wapi directory shared among several different computers.
1406 Mono typically uses the hostname to create the files that are used to
1407 share state across multiple Mono processes. This is done to support
1408 home directories that might be shared over the network.
1410 \fBMONO_STRICT_IO_EMULATION\fR
1411 If set, extra checks are made during IO operations. Currently, this
1412 includes only advisory locks around file writes.
1415 The name of the theme to be used by Windows.Forms. Available themes today
1416 include "clearlooks", "nice" and "win32".
1418 The default is "win32".
1420 \fBMONO_TLS_SESSION_CACHE_TIMEOUT\fR
1421 The time, in seconds, that the SSL/TLS session cache will keep it's entry to
1422 avoid a new negotiation between the client and a server. Negotiation are very
1423 CPU intensive so an application-specific custom value may prove useful for
1424 small embedded systems.
1426 The default is 180 seconds.
1428 \fBMONO_THREADS_PER_CPU\fR
1429 The minimum number of threads in the general threadpool will be
1430 MONO_THREADS_PER_CPU * number of CPUs. The default value for this
1433 \fBMONO_XMLSERIALIZER_THS\fR
1434 Controls the threshold for the XmlSerializer to produce a custom
1435 serializer for a given class instead of using the Reflection-based
1436 interpreter. The possible values are `no' to disable the use of a
1437 custom serializer or a number to indicate when the XmlSerializer
1438 should start serializing. The default value is 50, which means that
1439 the a custom serializer will be produced on the 50th use.
1441 \fBMONO_X509_REVOCATION_MODE\fR
1442 Sets the revocation mode used when validating a X509 certificate chain (https,
1443 ftps, smtps...). The default is 'nocheck', which performs no revocation check
1444 at all. The other possible values are 'offline', which performs CRL check (not
1445 implemented yet) and 'online' which uses OCSP and CRL to verify the revocation
1446 status (not implemented yet).
1447 .SH ENVIRONMENT VARIABLES FOR DEBUGGING
1449 \fBMONO_ASPNET_NODELETE\fR
1450 If set to any value, temporary source files generated by ASP.NET support
1451 classes will not be removed. They will be kept in the user's temporary
1455 If set, enables some features of the runtime useful for debugging.
1456 This variable should contain a comma separated list of debugging options.
1457 Currently, the following options are supported:
1461 \fBbreak-on-unverified\fR
1462 If this variable is set, when the Mono VM runs into a verification
1463 problem, instead of throwing an exception it will break into the
1464 debugger. This is useful when debugging verifier problems
1467 This option can be used to get more detailed information from
1468 InvalidCast exceptions, it will provide information about the types
1471 \fBcollect-pagefault-stats\fR
1472 Collects information about pagefaults. This is used internally to
1473 track the number of page faults produced to load metadata. To display
1474 this information you must use this option with "--stats" command line
1477 \fBdont-free-domains\fR
1478 This is an Optimization for multi-AppDomain applications (most
1479 commonly ASP.NET applications). Due to internal limitations Mono,
1480 Mono by default does not use typed allocations on multi-appDomain
1481 applications as they could leak memory when a domain is unloaded.
1483 Although this is a fine default, for applications that use more than
1484 on AppDomain heavily (for example, ASP.NET applications) it is worth
1485 trading off the small leaks for the increased performance
1486 (additionally, since ASP.NET applications are not likely going to
1487 unload the application domains on production systems, it is worth
1488 using this feature).
1490 \fBdyn-runtime-invoke\fR
1491 Instructs the runtime to try to use a generic runtime-invoke wrapper
1492 instead of creating one invoke wrapper.
1495 Equivalent to setting the \fBMONO_XDEBUG\fR variable, this emits
1496 symbols into a shared library as the code is JITed that can be loaded
1497 into GDB to inspect symbols.
1499 \fBgen-seq-points\fR
1500 Automatically generates sequence points where the
1501 IL stack is empty. These are places where the debugger can set a
1504 \fBexplicit-null-checks\fR
1505 Makes the JIT generate an explicit NULL check on variable dereferences
1506 instead of depending on the operating system to raise a SIGSEGV or
1507 another form of trap event when an invalid memory location is
1511 Captures the interrupt signal (Control-C) and displays a stack trace
1512 when pressed. Useful to find out where the program is executing at a
1513 given point. This only displays the stack trace of a single thread.
1516 Instructs the runtime to initialize the stack with
1517 some known values (0x2a on x86-64) at the start of a method to assist
1518 in debuggin the JIT engine.
1520 \fBkeep-delegates\fR
1521 This option will leak delegate trampolines that are no longer
1522 referenced as to present the user with more information about a
1523 delegate misuse. Basically a delegate instance might be created,
1524 passed to unmanaged code, and no references kept in managed code,
1525 which will garbage collect the code. With this option it is possible
1526 to track down the source of the problems.
1528 \fBreverse-pinvoke-exceptions
1529 This option will cause mono to abort with a descriptive message when
1530 during stack unwinding after an exception it reaches a native stack
1531 frame. This happens when a managed delegate is passed to native code,
1532 and the managed delegate throws an exception. Mono will normally try
1533 to unwind the stack to the first (managed) exception handler, and it
1534 will skip any native stack frames in the process. This leads to
1535 undefined behaviour (since mono doesn't know how to process native
1536 frames), leaks, and possibly crashes too.
1538 \fBno-gdb-backtrace\fR
1539 This option will disable the GDB backtrace emitted by the runtime
1540 after a SIGSEGV or SIGABRT in unmanaged code.
1542 \fBsuspend-on-sigsegv\fR
1543 This option will suspend the program when a native SIGSEGV is received.
1544 This is useful for debugging crashes which do not happen under gdb,
1545 since a live process contains more information than a core file.
1547 \fBcheck-pinvoke-callconv\fR
1548 This option causes the runtime to check for calling convention
1549 mismatches when using pinvoke, i.e. mixing cdecl/stdcall. It only
1550 works on windows. If a mismatch is detected, an
1551 ExecutionEngineException is thrown.
1555 \fBMONO_LOG_LEVEL\fR
1556 The logging level, possible values are `error', `critical', `warning',
1557 `message', `info' and `debug'. See the DEBUGGING section for more
1561 Controls the domain of the Mono runtime that logging will apply to.
1562 If set, the log mask is changed to the set value. Possible values are
1563 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
1564 (garbage collector), "cfg" (config file loader), "aot" (precompiler),
1565 "security" (e.g. Moonlight CoreCLR support) and "all".
1566 The default value is "all". Changing the mask value allows you to display only
1567 messages for a certain component. You can use multiple masks by comma
1568 separating them. For example to see config file messages and assembly loader
1569 messages set you mask to "asm,cfg".
1572 Used for runtime tracing of method calls. The format of the comma separated
1581 disabled Trace output off upon start.
1584 You can toggle trace output on/off sending a SIGUSR2 signal to the program.
1586 \fBMONO_TRACE_LISTENER\fR
1587 If set, enables the System.Diagnostics.DefaultTraceListener, which will
1588 print the output of the System.Diagnostics Trace and Debug classes.
1589 It can be set to a filename, and to Console.Out or Console.Error to display
1590 output to standard output or standard error, respectively. If it's set to
1591 Console.Out or Console.Error you can append an optional prefix that will
1592 be used when writing messages like this: Console.Error:MyProgramName.
1593 See the System.Diagnostics.DefaultTraceListener documentation for more
1596 \fBMONO_WCF_TRACE\fR
1597 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.
1599 \fBMONO_XEXCEPTIONS\fR
1600 This throws an exception when a X11 error is encountered; by default a
1601 message is displayed but execution continues
1603 \fBMONO_XMLSERIALIZER_DEBUG\fR
1604 Set this value to 1 to prevent the serializer from removing the
1605 temporary files that are created for fast serialization; This might
1606 be useful when debugging.
1609 This is used in the System.Windows.Forms implementation when running
1610 with the X11 backend. This is used to debug problems in Windows.Forms
1611 as it forces all of the commands send to X11 server to be done
1612 synchronously. The default mode of operation is asynchronous which
1613 makes it hard to isolate the root of certain problems.
1615 \fBMONO_GENERIC_SHARING\fR
1616 This environment variable controls the kind of generic sharing used.
1617 This variable is used by internal JIT developers and should not be
1618 changed in production. Do not use it.
1620 The variable controls which classes will have generic code sharing
1623 Permissible values are:
1627 All generated code can be shared.
1630 Only the classes in System.Collections.Generic will have its code
1631 shared (this is the default value).
1634 Only code in corlib will have its code shared.
1637 No generic code sharing will be performed.
1640 Generic code sharing by default only applies to collections. The
1641 Mono JIT by default turns this on.
1644 When the the MONO_XDEBUG env var is set, debugging info for JITted
1645 code is emitted into a shared library, loadable into gdb. This enables,
1646 for example, to see managed frame names on gdb backtraces.
1648 \fBMONO_VERBOSE_METHOD\fR
1649 Enables the maximum JIT verbosity for the specified method. This is
1650 very helpfull to diagnose a miscompilation problems of a specific
1653 \fBMONO_VERBOSE_HWCAP\fR
1654 If set, makes the JIT output information about detected CPU features
1655 (such as SSE, CMOV, FCMOV, etc) to stdout.
1657 \fBMONO_CONSERVATIVE_HWCAP\fR
1658 If set, the JIT will not perform any hardware capability detection. This
1659 may be useful to pinpoint the cause of JIT issues. This is the default
1660 when Mono is built as an AOT cross compiler, so that the generated code
1661 will run on most hardware.
1663 If you want to use Valgrind, you will find the file `mono.supp'
1664 useful, it contains the suppressions for the GC which trigger
1665 incorrect warnings. Use it like this:
1667 valgrind --suppressions=mono.supp mono ...
1670 On some platforms, Mono can expose a set of DTrace probes (also known
1671 as user-land statically defined, USDT Probes).
1673 They are defined in the file `mono.d'.
1675 .B ves-init-begin, ves-init-end
1677 Begin and end of runtime initialization.
1679 .B method-compile-begin, method-compile-end
1681 Begin and end of method compilation.
1682 The probe arguments are class name, method name and signature,
1683 and in case of method-compile-end success or failure of compilation.
1687 Begin and end of Garbage Collection.
1689 To verify the availability of the probes, run:
1691 dtrace -P mono'$target' -l -c mono
1694 Mono's Ping implementation for detecting network reachability can
1695 create the ICMP packets itself without requiring the system ping
1696 command to do the work. If you want to enable this on Linux for
1697 non-root users, you need to give the Mono binary special permissions.
1699 As root, run this command:
1701 # setcap cap_net_raw=+ep /usr/bin/mono
1704 On Unix assemblies are loaded from the installation lib directory. If you set
1705 `prefix' to /usr, the assemblies will be located in /usr/lib. On
1706 Windows, the assemblies are loaded from the directory where mono and
1709 .B ~/.mono/aot-cache
1711 The directory for the ahead-of-time compiler demand creation
1712 assemblies are located.
1714 .B /etc/mono/config, ~/.mono/config
1716 Mono runtime configuration file. See the mono-config(5) manual page
1717 for more information.
1719 .B ~/.config/.mono/certs, /usr/share/.mono/certs
1721 Contains Mono certificate stores for users / machine. See the certmgr(1)
1722 manual page for more information on managing certificate stores and
1723 the mozroots(1) page for information on how to import the Mozilla root
1724 certificates into the Mono certificate store.
1726 .B ~/.mono/assemblies/ASSEMBLY/ASSEMBLY.config
1728 Files in this directory allow a user to customize the configuration
1729 for a given system assembly, the format is the one described in the
1730 mono-config(5) page.
1732 .B ~/.config/.mono/keypairs, /usr/share/.mono/keypairs
1734 Contains Mono cryptographic keypairs for users / machine. They can be
1735 accessed by using a CspParameters object with DSACryptoServiceProvider
1736 and RSACryptoServiceProvider classes.
1738 .B ~/.config/.isolatedstorage, ~/.local/share/.isolatedstorage, /usr/share/.isolatedstorage
1740 Contains Mono isolated storage for non-roaming users, roaming users and
1741 local machine. Isolated storage can be accessed using the classes from
1742 the System.IO.IsolatedStorage namespace.
1744 .B <assembly>.config
1746 Configuration information for individual assemblies is loaded by the
1747 runtime from side-by-side files with the .config files, see the
1748 http://www.mono-project.com/Config for more information.
1750 .B Web.config, web.config
1752 ASP.NET applications are configured through these files, the
1753 configuration is done on a per-directory basis. For more information
1754 on this subject see the http://www.mono-project.com/Config_system.web
1757 Mailing lists are listed at the
1758 http://www.mono-project.com/Mailing_Lists
1760 http://www.mono-project.com
1763 certmgr(1), csharp(1), mcs(1), mdb(1), monocov(1), monodis(1),
1764 mono-config(5), mozroots(1), mprof-report(1), pdb2mdb(1), xsp(1), mod_mono(8).
1766 For more information on AOT:
1767 http://www.mono-project.com/AOT
1769 For ASP.NET-related documentation, see the xsp(1) manual page
projects / mono.git / blob