3 .\" Copyright 2003 Ximian, Inc.
4 .\" Copyright 2004-2011 Novell, Inc.
5 .\" Copyright 2011-2012 Xamarin Inc
7 .\" Miguel de Icaza (miguel@gnu.org)
11 mono \- Mono's ECMA-CLI native code generator (Just-in-Time and Ahead-of-Time)
14 .B mono [options] file [arguments...]
16 .B mono-sgen [options] file [arguments...]
18 \fImono\fP is a runtime implementation of the ECMA Common Language
19 Infrastructure. This can be used to run ECMA and .NET applications.
21 The runtime contains a native code generator that transforms the
22 Common Intermediate Language into native code.
24 The code generator can operate in two modes: just in time compilation
25 (JIT) or ahead of time compilation (AOT). Since code can be
26 dynamically loaded, the runtime environment and the JIT are always
27 present, even if code is compiled ahead of time.
29 The runtime loads the specified
36 is an ECMA assembly. They typically have a .exe or .dll extension.
38 The runtime provides a number of configuration options for running
39 applications, for developing and debugging, and for testing and
40 debugging the runtime itself.
42 The \fImono\fP command uses the Boehm conservative garbage collector
43 while the \fImono-sgen\fP command uses a moving and generational
46 On Unix-based systems, Mono provides a mechanism to emulate the
47 Windows-style file access, this includes providing a case insensitive
48 view of the file system, directory separator mapping (from \\ to /) and
49 stripping the drive letters.
51 This functionality is enabled by setting the
53 environment variable to one of
58 See the description for
60 in the environment variables section for more details.
62 The following options are available:
64 \fB--aot\fR, \fB--aot[=options]\fR
65 This option is used to precompile the CIL code in the specified
66 assembly to native code. The generated code is stored in a file with
67 the extension .so. This file will be automatically picked up by the
68 runtime when the assembly is executed.
70 Ahead-of-Time compilation is most useful if you use it in combination
71 with the -O=all,-shared flag which enables all of the optimizations in
72 the code generator to be performed. Some of those optimizations are
73 not practical for Just-in-Time compilation since they might be very
76 Unlike the .NET Framework, Ahead-of-Time compilation will not generate
77 domain independent code: it generates the same code that the
78 Just-in-Time compiler would produce. Since most applications use a
79 single domain, this is fine. If you want to optimize the generated
80 code for use in multi-domain applications, consider using the
83 This pre-compiles the methods, but the original assembly is still
84 required to execute as this one contains the metadata and exception
85 information which is not available on the generated file. When
86 precompiling code, you might want to compile with all optimizations
87 (-O=all). Pre-compiled code is position independent code.
89 Pre compilation is just a mechanism to reduce startup time, increase
90 code sharing across multiple mono processes and avoid just-in-time
91 compilation program startup costs. The original assembly must still
92 be present, as the metadata is contained there.
94 AOT code typically can not be moved from one computer to another
95 (CPU-specific optimizations that are detected at runtime) so you
96 should not try to move the pre-generated assemblies or package the
97 pre-generated assemblies for deployment.
99 A few options are available as a parameter to the
101 command line option. The options are separated by commas, and more
102 than one can be specified:
107 The AOT compiler will emit a (ELF only) library initializer to automatically
108 register the aot compiled module with the runtime. This is only useful in static
112 Instructs the AOT compiler to output assembly code instead of an
115 .I bind-to-runtime-version
117 If specified, forces the generated AOT files to be bound to the
118 runtime version of the compiling Mono. This will prevent the AOT
119 files from being consumed by a different Mono runtime.
121 This is currently an experimental feature as it is not complete.
122 This instructs Mono to precompile code that has historically not been
123 precompiled with AOT.
127 When this option is specified, P/Invoke methods are invoked directly
128 instead of going through the operating system symbol lookup operation.
130 .I llvm-path=<PREFIX>
131 Same for the llvm tools 'opt' and 'llc'.
134 Use the GNU style target triple <TRIPLE> to determine some code generation options, i.e.
135 --mtriple=armv7-linux-gnueabi will generate code that targets ARMv7. This is currently
136 only supported by the ARM backend. In LLVM mode, this triple is passed on to the LLVM
139 .I nimt-trampolines=[number]
140 When compiling in full aot mode, the IMT trampolines must be precreated
141 in the AOT image. You can add additional method trampolines with this argument.
145 Instructs the AOT compiler to not output any debugging information.
148 Instructs the AOT compiler to emit DWARF debugging information. When
149 used together with the nodebug option, only DWARF debugging
150 information is emitted, but not the information that can be used at
153 .I nrgctx-trampolines=[number]
154 When compiling in full aot mode, the generic sharing trampolines must be precreated
155 in the AOT image. You can add additional method trampolines with this argument.
158 .I ntrampolines=[number]
159 When compiling in full aot mode, the method trampolines must be precreated
160 in the AOT image. You can add additional method trampolines with this argument.
163 .I outfile=[filename]
164 Instructs the AOT compiler to save the output to the specified file.
166 .I print-skipped-methods
167 If the AOT compiler cannot compile a method for any reason, enabling this flag
168 will output the skipped methods to the console.
170 .I readonly-value=namespace.typename.fieldname=type/value
171 Override the value of a static readonly field. Usually, during JIT
172 compilation, the static constructor is ran eagerly, so the value of
173 a static readonly field is known at compilation time and the compiler
174 can do a number of optimizations based on it. During AOT, instead, the static
175 constructor can't be ran, so this option can be used to set the value of such
176 a field and enable the same set of optimizations.
177 Type can be any of i1, i2, i4 for integers of the respective sizes (in bytes).
178 Note that signed/unsigned numbers do not matter here, just the storage size.
179 This option can be specified multiple times and it doesn't prevent the static
180 constructor for the type defining the field to execute with the usual rules
181 at runtime (hence possibly computing a different value for the field).
184 .I save-temps,keep-temps
185 Instructs the AOT compiler to keep temporary files.
188 This instructs the compiler to generate sequence point checks that
189 allow Mono's soft debugger to debug applications even on systems where
190 it is not possible to set breakpoints or to single step (certain
191 hardware configurations like the cell phones and video gaming
195 Create an ELF object file (.o) or .s file which can be statically linked into an
196 executable when embedding the mono runtime. When this option is used, the object file
197 needs to be registered with the embedded runtime using the mono_aot_register_module
198 function which takes as its argument the mono_aot_module_<ASSEMBLY NAME>_info global
199 symbol from the object file:
202 extern void *mono_aot_module_hello_info;
204 mono_aot_register_module (mono_aot_module_hello_info);
209 Print various stats collected during AOT compilation.
212 This is an experimental option for the AOT compiler to use multiple threads
213 when compiling the methods.
215 .I tool-prefix=<PREFIX>
216 Prepends <PREFIX> to the name of tools ran by the AOT compiler, i.e. 'as'/'ld'. For
217 example, --tool=prefix=arm-linux-gnueabi- will make the AOT compiler run
218 'arm-linux-gnueabi-as' instead of 'as'.
221 Instructs the AOT compiler to emit debug symbol information.
223 For more information about AOT, see: http://www.mono-project.com/AOT
226 \fB--attach=[options]\fR
227 Currently the only option supported by this command line argument is
228 \fBdisable\fR which disables the attach functionality.
230 \fB--config filename\fR
231 Load the specified configuration file instead of the default one(s).
232 The default files are /etc/mono/config and ~/.mono/config or the file
233 specified in the MONO_CONFIG environment variable, if set. See the
234 mono-config(5) man page for details on the format of this file.
236 \fB--debugger-agent=[options]\fR
237 This instructs the Mono runtime to
238 start a debugging agent inside the Mono runtime and connect it to a
239 client user interface will control the Mono process.
240 This option is typically used by IDEs, like the MonoDevelop IDE.
242 The configuration is specified using one of more of the following options:
248 Use this option to specify the IP address where your debugger client is
253 Specifies the diagnostics log level for
257 Used to specify the file where the log will be stored, it defaults to
261 Defaults to no, with the default option Mono will actively connect to the
262 host/port configured with the \fBaddress\fR option. If you set it to 'y', it
263 instructs the Mono runtime to start debugging in server mode, where Mono
264 actively waits for the debugger front end to connect to the Mono process.
265 Mono will print out to stdout the IP address and port where it is listening.
268 Defaults to yes, with the default option Mono will suspend the vm on startup
269 until it connects successfully to a debugger front end. If you set it to 'n', in
270 conjunction with \fBserver=y\fR, it instructs the Mono runtime to run as normal,
271 while caching metadata to send to the debugger front end on connection..
273 .I transport=transport_name
275 This is used to specify the transport that the debugger will use to
276 communicate. It must be specified and currently requires this to
282 Configures the virtual machine to be better suited for desktop
283 applications. Currently this sets the GC system to avoid expanding
284 the heap as much as possible at the expense of slowing down garbage
288 This is an experimental flag that instructs the Mono runtime to not
289 generate any code at runtime and depend exclusively on the code
290 generated from using mono --aot=full previously. This is useful for
291 platforms that do not permit dynamic code generation.
293 Notice that this feature will abort execution at runtime if a codepath
294 in your program, or Mono's class libraries attempts to generate code
295 dynamically. You should test your software upfront and make sure that
296 you do not use any dynamic features.
298 \fB--gc=boehm\fR, \fB--gc=sgen\fR
299 Selects the Garbage Collector engine for Mono to use, Boehm or SGen.
300 Currently this merely ensures that you are running either the
301 \fImono\fR or \fImono-sgen\fR commands. This flag can be set in the
302 \fBMONO_ENV_OPTIONS\fR environment variable to force all of your child
303 processes to use one particular kind of GC with the Mono runtime.
305 \fB--help\fR, \fB-h\fR
306 Displays usage instructions.
309 If the Mono runtime has been compiled with LLVM support (not available
310 in all configurations), Mono will use the LLVM optimization and code
311 generation engine to JIT or AOT compile.
313 For more information, consult: http://www.mono-project.com/Mono_LLVM
316 When using a Mono that has been compiled with LLVM support, it forces
317 Mono to fallback to its JIT engine and not use the LLVM backend.
319 \fB--optimize=MODE\fR, \fB-O=MODE\fR
320 MODE is a comma separated list of optimizations. They also allow
321 optimizations to be turned off by prefixing the optimization name with
324 In general, Mono has been tuned to use the default set of flags,
325 before using these flags for a deployment setting, you might want to
326 actually measure the benefits of using them.
328 The following optimizations are implemented:
330 all Turn on all optimizations
331 peephole Peephole postpass
332 branch Branch optimizations
333 inline Inline method calls
334 cfold Constant folding
335 consprop Constant propagation
336 copyprop Copy propagation
337 deadce Dead code elimination
338 linears Linear scan global reg allocation
339 cmov Conditional moves [arch-dependency]
340 shared Emit per-domain code
341 sched Instruction scheduling
342 intrins Intrinsic method implementations
343 tailc Tail recursion and tail calls
344 loop Loop related optimizations
345 fcmov Fast x86 FP compares [arch-dependency]
346 leaf Leaf procedures optimizations
347 aot Usage of Ahead Of Time compiled code
348 precomp Precompile all methods before executing Main
349 abcrem Array bound checks removal
350 ssapre SSA based Partial Redundancy Elimination
351 sse2 SSE2 instructions on x86 [arch-dependency]
352 gshared Enable generic code sharing.
355 For example, to enable all the optimization but dead code
356 elimination and inlining, you can use:
358 -O=all,-deadce,-inline
361 The flags that are flagged with [arch-dependency] indicate that the
362 given option if used in combination with Ahead of Time compilation
363 (--aot flag) would produce pre-compiled code that will depend on the
364 current CPU and might not be safely moved to another computer.
366 \fB--runtime=VERSION\fR
367 Mono supports different runtime versions. The version used depends on the program
368 that is being run or on its configuration file (named program.exe.config). This option
369 can be used to override such autodetection, by forcing a different runtime version
370 to be used. Note that this should only be used to select a later compatible runtime
371 version than the one the program was compiled against. A typical usage is for
372 running a 1.1 program on a 2.0 version:
374 mono --runtime=v2.0.50727 program.exe
377 \fB--security\fR, \fB--security=mode\fR
378 Activate the security manager, a currently experimental feature in
379 Mono and it is OFF by default. The new code verifier can be enabled
380 with this option as well.
384 Using security without parameters is equivalent as calling it with the
387 The following modes are supported:
390 This allows mono to support declarative security attributes,
391 e.g. execution of Code Access Security (CAS) or non-CAS demands.
394 Enables the core-clr security system, typically used for
395 Moonlight/Silverlight applications. It provides a much simpler
396 security system than CAS, see http://www.mono-project.com/Moonlight
397 for more details and links to the descriptions of this new system.
400 Enables the new verifier and performs basic verification for code
401 validity. In this mode, unsafe code and P/Invoke are allowed. This
402 mode provides a better safety guarantee but it is still possible
403 for managed code to crash Mono.
406 Enables the new verifier and performs full verification of the code
407 being executed. It only allows verifiable code to be executed.
408 Unsafe code is not allowed but P/Invoke is. This mode should
409 not allow managed code to crash mono. The verification is not as
410 strict as ECMA 335 standard in order to stay compatible with the MS
413 The security system acts on user code: code contained in mscorlib or
414 the global assembly cache is always trusted.
419 Configures the virtual machine to be better suited for server
420 operations (currently, a no-op).
423 Verifies mscorlib and assemblies in the global
424 assembly cache for valid IL, and all user code for IL
427 This is different from \fB--security\fR's verifiable
428 or validil in that these options only check user code and skip
429 mscorlib and assemblies located on the global assembly cache.
431 \fB-V\fR, \fB--version\fR
432 Prints JIT version information (system configuration, release number
433 and branch names if available).
436 .SH DEVELOPMENT OPTIONS
437 The following options are used to help when developing a JITed application.
439 \fB--debug\fR, \fB--debug=OPTIONS\fR
440 Turns on the debugging mode in the runtime. If an assembly was
441 compiled with debugging information, it will produce line number
442 information for stack traces.
446 The optional OPTIONS argument is a comma separated list of debugging
447 options. These options are turned off by default since they generate
448 much larger and slower code at runtime.
450 The following options are supported:
453 Produces a detailed error when throwing a InvalidCastException. This
454 option needs to be enabled as this generates more verbose code at
458 Disable some JIT optimizations which are usually only disabled when
459 running inside the debugger. This can be helpful if you want to attach
460 to the running process with mdb.
463 Generate and register debugging information with gdb. This is only supported on some
464 platforms, and only when using gdb 7.0 or later.
468 \fB--profile[=profiler[:profiler_args]]\fR
469 Turns on profiling. For more information about profiling applications
470 and code coverage see the sections "PROFILING" and "CODE COVERAGE"
473 This option can be used multiple times, each time will load an
474 additional profiler. This allows developers to use modules that
475 extend the JIT through the Mono profiling interface.
477 \fB--trace[=expression]\fR
478 Shows method names as they are invoked. By default all methods are
481 The trace can be customized to include or exclude methods, classes or
482 assemblies. A trace expression is a comma separated list of targets,
483 each target can be prefixed with a minus sign to turn off a particular
484 target. The words `program', `all' and `disabled' have special
485 meaning. `program' refers to the main program being executed, and
486 `all' means all the method calls.
488 The `disabled' option is used to start up with tracing disabled. It
489 can be enabled at a later point in time in the program by sending the
490 SIGUSR2 signal to the runtime.
492 Assemblies are specified by their name, for example, to trace all
493 calls in the System assembly, use:
496 mono --trace=System app.exe
499 Classes are specified with the T: prefix. For example, to trace all
500 calls to the System.String class, use:
503 mono --trace=T:System.String app.exe
506 And individual methods are referenced with the M: prefix, and the
507 standard method notation:
510 mono --trace=M:System.Console:WriteLine app.exe
513 Exceptions can also be traced, it will cause a stack trace to be
514 printed every time an exception of the specified type is thrown.
515 The exception type can be specified with or without the namespace,
516 and to trace all exceptions, specify 'all' as the type name.
519 mono --trace=E:System.Exception app.exe
522 As previously noted, various rules can be specified at once:
525 mono --trace=T:System.String,T:System.Random app.exe
528 You can exclude pieces, the next example traces calls to
529 System.String except for the System.String:Concat method.
532 mono --trace=T:System.String,-M:System.String:Concat
535 You can trace managed to unmanaged transitions using
536 the wrapper qualifier:
539 mono --trace=wrapper app.exe
542 Finally, namespaces can be specified using the N: prefix:
545 mono --trace=N:System.Xml
549 \fB--no-x86-stack-align\fR
550 Don't align stack frames on the x86 architecture. By default, Mono
551 aligns stack frames to 16 bytes on x86, so that local floating point
552 and SIMD variables can be properly aligned. This option turns off the
553 alignment, which usually saves one intruction per call, but might
554 result in significantly lower floating point and SIMD performance.
557 Generate a JIT method map in a /tmp/perf-PID.map file. This file is then
558 used, for example, by the perf tool included in recent Linux kernels.
559 Each line in the file has:
562 HEXADDR HEXSIZE methodname
565 Currently this option is only supported on Linux.
566 .SH JIT MAINTAINER OPTIONS
567 The maintainer options are only used by those developing the runtime
568 itself, and not typically of interest to runtime users or developers.
571 Inserts a breakpoint before the method whose name is `method'
572 (namespace.class:methodname). Use `Main' as method name to insert a
573 breakpoint on the application's main method.
576 Inserts a breakpoint on exceptions. This allows you to debug your
577 application with a native debugger when an exception is thrown.
580 This compiles a method (namespace.name:methodname), this is used for
581 testing the compiler performance or to examine the output of the code
585 Compiles all the methods in an assembly. This is used to test the
586 compiler performance or to examine the output of the code generator
588 \fB--graph=TYPE METHOD\fR
589 This generates a postscript file with a graph with the details about
590 the specified method (namespace.name:methodname). This requires `dot'
591 and ghostview to be installed (it expects Ghostview to be called
594 The following graphs are available:
596 cfg Control Flow Graph (CFG)
598 code CFG showing code
599 ssa CFG showing code after SSA translation
600 optcode CFG showing code after IR optimizations
603 Some graphs will only be available if certain optimizations are turned
607 Instruct the runtime on the number of times that the method specified
608 by --compile (or all the methods if --compileall is used) to be
609 compiled. This is used for testing the code generator performance.
612 Displays information about the work done by the runtime during the
613 execution of an application.
615 \fB--wapi=hps|semdel\fR
616 Perform maintenance of the process shared data.
618 semdel will delete the global semaphore.
620 hps will list the currently used handles.
622 \fB-v\fR, \fB--verbose\fR
623 Increases the verbosity level, each time it is listed, increases the
624 verbosity level to include more information (including, for example,
625 a disassembly of the native code produced, code selector info etc.).
627 The Mono runtime allows external processes to attach to a running
628 process and load assemblies into the running program. To attach to
629 the process, a special protocol is implemented in the Mono.Management
632 With this support it is possible to load assemblies that have an entry
633 point (they are created with -target:exe or -target:winexe) to be
634 loaded and executed in the Mono process.
636 The code is loaded into the root domain, and it starts execution on
637 the special runtime attach thread. The attached program should
638 create its own threads and return after invocation.
640 This support allows for example debugging applications by having the
641 csharp shell attach to running processes.
643 The mono runtime includes a profiler that can be used to explore
644 various performance related problems in your application. The
645 profiler is activated by passing the --profile command line argument
646 to the Mono runtime, the format is:
649 --profile[=profiler[:profiler_args]]
652 Mono has a built-in profiler called 'default' (and is also the default
653 if no arguments are specified), but developers can write custom
654 profilers, see the section "CUSTOM PROFILERS" for more details.
658 is not specified, the default profiler is used.
662 is a profiler-specific string of options for the profiler itself.
664 The default profiler accepts the following options 'alloc' to profile
665 memory consumption by the application; 'time' to profile the time
666 spent on each routine; 'jit' to collect time spent JIT-compiling methods
667 and 'stat' to perform sample statistical profiling.
668 If no options are provided the default is 'alloc,time,jit'.
671 profile data is printed to stdout: to change this, use the 'file=filename'
672 option to output the data to filename.
677 mono --profile program.exe
681 That will run the program with the default profiler and will do time
682 and allocation profiling.
686 mono --profile=default:stat,alloc,file=prof.out program.exe
689 Will do sample statistical profiling and allocation profiling on
690 program.exe. The profile data is put in prof.out.
692 Note that the statistical profiler has a very low overhead and should
693 be the preferred profiler to use (for better output use the full path
694 to the mono binary when running and make sure you have installed the
695 addr2line utility that comes from the binutils package).
697 This is the most advanced profiler.
699 The Mono \f[I]log\f[] profiler can be used to collect a lot of
700 information about a program running in the Mono runtime.
701 This data can be used (both while the process is running and later)
702 to do analyses of the program behaviour, determine resource usage,
703 performance issues or even look for particular execution patterns.
705 This is accomplished by logging the events provided by the Mono
706 runtime through the profiling interface and periodically writing
707 them to a file which can be later inspected with the mprof-report(1)
710 More information about how to use the log profiler is available on the
711 mprof-report(1) page.
713 Mono provides a mechanism for loading other profiling modules which in
714 the form of shared libraries. These profiling modules can hook up to
715 various parts of the Mono runtime to gather information about the code
718 To use a third party profiler you must pass the name of the profiler
722 mono --profile=custom program.exe
726 In the above sample Mono will load the user defined profiler from the
727 shared library `mono-profiler-custom.so'. This profiler module must
728 be on your dynamic linker library path.
730 A list of other third party profilers is available from Mono's web
731 site (www.mono-project.com/Performance_Tips)
733 Custom profiles are written as shared libraries. The shared library
734 must be called `mono-profiler-NAME.so' where `NAME' is the name of
737 For a sample of how to write your own custom profiler look in the
738 Mono source tree for in the samples/profiler.c.
740 Mono ships with a code coverage module. This module is activated by
741 using the Mono --profile=cov option. The format is:
742 \fB--profile=cov[:assembly-name[/namespace]] test-suite.exe\fR
744 By default code coverage will default to all the assemblies loaded,
745 you can limit this by specifying the assembly name, for example to
746 perform code coverage in the routines of your program use, for example
747 the following command line limits the code coverage to routines in the
751 mono --profile=cov:demo demo.exe
757 does not include the extension.
759 You can further restrict the code coverage output by specifying a
763 mono --profile=cov:demo/My.Utilities demo.exe
767 Which will only perform code coverage in the given assembly and
770 Typical output looks like this:
773 Not covered: Class:.ctor ()
774 Not covered: Class:A ()
775 Not covered: Driver:.ctor ()
776 Not covered: Driver:method ()
777 Partial coverage: Driver:Main ()
782 The offsets displayed are IL offsets.
784 A more powerful coverage tool is available in the module `monocov'.
785 See the monocov(1) man page for details.
787 To debug managed applications, you can use the
789 command, a command line debugger.
791 It is possible to obtain a stack trace of all the active threads in
792 Mono by sending the QUIT signal to Mono, you can do this from the
793 command line, like this:
799 Where pid is the Process ID of the Mono process you want to examine.
800 The process will continue running afterwards, but its state is not
804 this is a last-resort mechanism for debugging applications and should
805 not be used to monitor or probe a production application. The
806 integrity of the runtime after sending this signal is not guaranteed
807 and the application might crash or terminate at any given point
810 The \fB--debug=casts\fR option can be used to get more detailed
811 information for Invalid Cast operations, it will provide information
812 about the types involved.
814 You can use the MONO_LOG_LEVEL and MONO_LOG_MASK environment variables
815 to get verbose debugging output about the execution of your
816 application within Mono.
820 environment variable if set, the logging level is changed to the set
821 value. Possible values are "error", "critical", "warning", "message",
822 "info", "debug". The default value is "error". Messages with a logging
823 level greater then or equal to the log level will be printed to
826 Use "info" to track the dynamic loading of assemblies.
831 environment variable to limit the extent of the messages you get:
832 If set, the log mask is changed to the set value. Possible values are
833 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
834 (garbage collector), "cfg" (config file loader), "aot" (precompiler),
835 "security" (e.g. Moonlight CoreCLR support) and "all".
836 The default value is "all". Changing the mask value allows you to display only
837 messages for a certain component. You can use multiple masks by comma
838 separating them. For example to see config file messages and assembly loader
839 messages set you mask to "asm,cfg".
841 The following is a common use to track down problems with P/Invoke:
844 $ MONO_LOG_LEVEL="debug" MONO_LOG_MASK="dll" mono glue.exe
849 Mono's XML serialization engine by default will use a reflection-based
850 approach to serialize which might be slow for continuous processing
851 (web service applications). The serialization engine will determine
852 when a class must use a hand-tuned serializer based on a few
853 parameters and if needed it will produce a customized C# serializer
854 for your types at runtime. This customized serializer then gets
855 dynamically loaded into your application.
857 You can control this with the MONO_XMLSERIALIZER_THS environment
860 The possible values are
862 to disable the use of a C# customized
863 serializer, or an integer that is the minimum number of uses before
864 the runtime will produce a custom serializer (0 will produce a
865 custom serializer on the first access, 50 will produce a serializer on
866 the 50th use). Mono will fallback to an interpreted serializer if the
867 serializer generation somehow fails. This behavior can be disabled
868 by setting the option
870 (for example: MONO_XMLSERIALIZER_THS=0,nofallback).
871 .SH ENVIRONMENT VARIABLES
874 Turns off the garbage collection in Mono. This should be only used
875 for debugging purposes
878 When Mono is compiled with LLVM support, this instructs the runtime to
879 stop using LLVM after the specified number of methods are JITed.
880 This is a tool used in diagnostics to help isolate problems in the
881 code generation backend. For example \fBLLVM_COUNT=10\fR would only
882 compile 10 methods with LLVM and then switch to the Mono JIT engine.
883 \fBLLVM_COUNT=0\fR would disable the LLVM engine altogether.
886 If set, this variable will instruct Mono to ahead-of-time compile new
887 assemblies on demand and store the result into a cache in
890 \fBMONO_ASPNET_INHIBIT_SETTINGSMAP\fR
891 Mono contains a feature which allows modifying settings in the .config files shipped
892 with Mono by using config section mappers. The mappers and the mapping rules are
893 defined in the $prefix/etc/mono/2.0/settings.map file and, optionally, in the
894 settings.map file found in the top-level directory of your ASP.NET application.
895 Both files are read by System.Web on application startup, if they are found at the
896 above locations. If you don't want the mapping to be performed you can set this
897 variable in your environment before starting the application and no action will
901 If set, this variable overrides the default system configuration directory
902 ($PREFIX/etc). It's used to locate machine.config file.
905 Sets the style of COM interop. If the value of this variable is "MS"
906 Mono will use string marhsalling routines from the liboleaut32 for the
907 BSTR type library, any other values will use the mono-builtin BSTR
911 If set, this variable overrides the default runtime configuration file
912 ($PREFIX/etc/mono/config). The --config command line options overrides the
913 environment variable.
916 Override the automatic cpu detection mechanism. Currently used only on arm.
917 The format of the value is as follows:
923 where V is the architecture number 4, 5, 6, 7 and the options can be currently be
927 MONO_CPU_ARCH="armv4 thumb" mono ...
931 \fBMONO_DISABLE_AIO\fR
932 If set, tells mono NOT to attempt using native asynchronous I/O services. In
933 that case, a default select/poll implementation is used. Currently only epoll()
936 \fBMONO_DISABLE_MANAGED_COLLATION\fR
937 If this environment variable is `yes', the runtime uses unmanaged
938 collation (which actually means no culture-sensitive collation). It
939 internally disables managed collation functionality invoked via the
940 members of System.Globalization.CompareInfo class. Collation is
943 \fBMONO_DISABLE_SHM\fR
944 Unix only: If set, disables the shared memory files used for
945 cross-process handles: process have only private handles. This means
946 that process and thread handles are not available to other processes,
947 and named mutexes, named events and named semaphores are not visible
950 This is can also be enabled by default by passing the
951 "--disable-shared-handles" option to configure.
953 This is the default from mono 2.8 onwards.
955 \fBMONO_DISABLE_SHARED_AREA\fR
956 Unix only: If set, disable usage of shared memory for exposing
957 performance counters. This means it will not be possible to both
958 externally read performance counters from this processes or read
959 those of external processes.
962 When set, enables the use of a fully managed DNS resolver instead of the
963 regular libc functions. This resolver performs much better when multiple
964 queries are run in parallel.
966 Note that /etc/nsswitch.conf will be ignored.
968 \fBMONO_EGD_SOCKET\fR
969 For platforms that do not otherwise have a way of obtaining random bytes
970 this can be set to the name of a file system socket on which an egd or
971 prngd daemon is listening.
973 \fBMONO_ENABLE_SHM\fR
974 Unix only: Enable support for cross-process handles. Cross-process
975 handles are used to expose process handles, thread handles, named
976 mutexes, named events and named semaphores across Unix processes.
978 \fBMONO_ENV_OPTIONS\fR
979 This environment variable allows you to pass command line arguments to
980 a Mono process through the environment. This is useful for example
981 to force all of your Mono processes to use LLVM or SGEN without having
982 to modify any launch scripts.
984 \fBMONO_ENV_OPTIONS\fR
985 Used to pass extra options to the debugger agent in the runtime, as they were passed
986 using --debugger-agent=.
988 \fBMONO_EVENTLOG_TYPE\fR
989 Sets the type of event log provider to use (for System.Diagnostics.EventLog).
996 Persists event logs and entries to the local file system.
998 The directory in which to persist the event logs, event sources and entries
999 can be specified as part of the value.
1001 If the path is not explicitly set, it defaults to "/var/lib/mono/eventlog"
1002 on unix and "%APPDATA%\mono\eventlog" on Windows.
1007 Uses the native win32 API to write events and registers event logs and
1008 event sources in the registry. This is only available on Windows.
1010 On Unix, the directory permission for individual event log and event source
1011 directories is set to 777 (with +t bit) allowing everyone to read and write
1012 event log entries while only allowing entries to be deleted by the user(s)
1017 Silently discards any events.
1020 The default is "null" on Unix (and versions of Windows before NT), and
1021 "win32" on Windows NT (and higher).
1024 \fBMONO_EXTERNAL_ENCODINGS\fR
1025 If set, contains a colon-separated list of text encodings to try when
1026 turning externally-generated text (e.g. command-line arguments or
1027 filenames) into Unicode. The encoding names come from the list
1028 provided by iconv, and the special case "default_locale" which refers
1029 to the current locale's default encoding.
1031 When reading externally-generated text strings UTF-8 is tried first,
1032 and then this list is tried in order with the first successful
1033 conversion ending the search. When writing external text (e.g. new
1034 filenames or arguments to new processes) the first item in this list
1035 is used, or UTF-8 if the environment variable is not set.
1037 The problem with using MONO_EXTERNAL_ENCODINGS to process your
1038 files is that it results in a problem: although its possible to get
1039 the right file name it is not necessarily possible to open the file.
1040 In general if you have problems with encodings in your filenames you
1041 should use the "convmv" program.
1043 \fBMONO_GC_PARAMS\fR
1044 When using Mono with the SGen garbage collector this variable controls
1045 several parameters of the collector. The variable's value is a comma
1046 separated list of words.
1050 \fBnursery-size=\fIsize\fR
1051 Sets the size of the nursery. The size is specified in bytes and must
1052 be a power of two. The suffixes `k', `m' and `g' can be used to
1053 specify kilo-, mega- and gigabytes, respectively. The nursery is the
1054 first generation (of two). A larger nursery will usually speed up the
1055 program but will obviously use more memory. The default nursery size
1058 \fBmajor=\fIcollector\fR
1059 Specifies which major collector to use. Options are `marksweep' for
1060 the Mark&Sweep collector, `marksweep-conc' for concurrent Mark&Sweep,
1061 `marksweep-par' for parallel Mark&Sweep, `marksweep-fixed' for
1062 Mark&Sweep with a fixed heap, and `marksweep-fixed-par' for parallel
1063 Mark&Sweep with a fixed heap. The Mark&Sweep collector is the default.
1065 \fBmajor-heap-size=\fIsize\fR
1066 Sets the size of the major heap (not including the large object space)
1067 for the fixed-heap Mark&Sweep collector (i.e. `marksweep-fixed' and
1068 `marksweep-fixed-par'). The size is in bytes, with optional suffixes
1069 `k', `m' and `g' to specify kilo-, mega- and gigabytes, respectively.
1070 The default is 512 megabytes.
1072 \fBsoft-heap-limit=\fIsize\fR
1073 Once the heap size gets larger than this size, ignore what the default
1074 major collection trigger metric says and only allow four nursery size's
1075 of major heap growth between major collections.
1077 \fBevacuation-threshold=\fIthreshold\fR
1078 Sets the evacuation threshold in percent. This option is only available
1079 on the Mark&Sweep major collectors. The value must be an
1080 integer in the range 0 to 100. The default is 66. If the sweep phase of
1081 the collection finds that the occupancy of a specific heap block type is
1082 less than this percentage, it will do a copying collection for that block
1083 type in the next major collection, thereby restoring occupancy to close
1084 to 100 percent. A value of 0 turns evacuation off.
1086 \fB(no-)lazy-sweep\fR
1087 Enables or disables lazy sweep for the Mark&Sweep collector. If
1088 enabled, the sweep phase of the garbage collection is done piecemeal
1089 whenever the need arises, typically during nursery collections. Lazy
1090 sweeping is enabled by default.
1092 \fBstack-mark=\fImark-mode\fR
1093 Specifies how application threads should be scanned. Options are
1094 `precise` and `conservative`. Precise marking allow the collector
1095 to know what values on stack are references and what are not.
1096 Conservative marking threats all values as potentially references
1097 and leave them untouched. Precise marking reduces floating garbage
1098 and can speed up nursery collection and allocation rate, it has
1099 the downside of requiring a significant extra memory per compiled
1100 method. The right option, unfortunately, requires experimentation.
1102 \fBsave-target-ratio=\fIratio\fR
1103 Specifies the target save ratio for the major collector. The collector
1104 lets a given amount of memory to be promoted from the nursery due to
1105 minor collections before it triggers a major collection. This amount
1106 is based on how much memory it expects to free. It is represented as
1107 a ratio of the size of the heap after a major collection.
1108 Valid values are between 0.1 and 2.0. The default is 0.5.
1109 Smaller values will keep the major heap size smaller but will trigger
1110 more major collections. Likewise, bigger values will use more memory
1111 and result in less frequent major collections.
1112 This option is EXPERIMENTAL, so it might disappear in later versions of mono.
1114 \fBdefault-allowance-ratio=\fIratio\fR
1115 Specifies the default allocation allowance when the calculated size
1116 is too small. The allocation allowance is how much memory the collector
1117 let be promoted before triggered a major collection.
1118 It is a ratio of the nursery size.
1119 Valid values are between 1.0 and 10.0. The default is 4.0.
1120 Smaller values lead to smaller heaps and more frequent major collections.
1121 Likewise, bigger values will allow the heap to grow faster but use
1122 more memory when it reaches a stable size.
1123 This option is EXPERIMENTAL, so it might disappear in later versions of mono.
1125 \fBminor=\fIminor-collector\fR
1126 Specifies which minor collector to use. Options are 'simple' which
1127 promotes all objects from the nursery directly to the old generation
1128 and 'split' which lets object stay longer on the nursery before promoting.
1130 \fBalloc-ratio=\fIratio\fR
1131 Specifies the ratio of memory from the nursery to be use by the alloc space.
1132 This only can only be used with the split minor collector.
1133 Valid values are integers between 1 and 100. Default is 60.
1135 \fBpromotion-age=\fIage\fR
1136 Specifies the required age of an object must reach inside the nursery before
1137 been promoted to the old generation. This only can only be used with the
1138 split minor collector.
1139 Valid values are integers between 1 and 14. Default is 2.
1141 \fB(no-)cementing\fR
1142 Enables or disables cementing. This can dramatically shorten nursery
1143 collection times on some benchmarks where pinned objects are referred
1144 to from the major heap.
1149 When using Mono with the SGen garbage collector this environment
1150 variable can be used to turn on various debugging features of the
1151 collector. The value of this variable is a comma separated list of
1152 words. Do not use these options in production.
1157 Sets the debug level to the specified number.
1159 \fBprint-allowance\fR
1160 After each major collection prints memory consumption for before and
1161 after the collection and the allowance for the minor collector, i.e. how
1162 much the heap is allowed to grow from minor collections before the next
1163 major collection is triggered.
1166 Gathers statistics on the classes whose objects are pinned in the
1167 nursery and for which global remset entries are added. Prints those
1168 statistics when shutting down.
1170 \fBcollect-before-allocs\fR
1172 \fBcheck-at-minor-collections\fR
1173 This performs a consistency check on minor collections and also clears
1174 the nursery at collection time, instead of the default, when buffers
1175 are allocated (clear-at-gc). The consistency check ensures that
1176 there are no major to minor references that are not on the remembered
1179 \fBmod-union-consistency-check\fR
1180 Checks that the mod-union cardtable is consistent before each
1181 finishing major collection pause. This check is only applicable to
1182 concurrent major collectors.
1184 \fBcheck-mark-bits\fR
1185 Checks that mark bits in the major heap are consistent at the end of
1186 each major collection. Consistent mark bits mean that if an object is
1187 marked, all objects that it had references to must also be marked.
1189 \fBcheck-nursery-pinned\fR
1190 After nursery collections, and before starting concurrent collections,
1191 check whether all nursery objects are pinned, or not pinned -
1192 depending on context. Does nothing when the split nursery collector
1195 \fBxdomain-checks\fR
1196 Performs a check to make sure that no references are left to an
1200 This clears the nursery at GC time instead of doing it when the thread
1201 local allocation buffer (TLAB) is created. The default is to clear
1202 the nursery at TLAB creation time.
1205 Don't do minor collections. If the nursery is full, a major collection
1206 is triggered instead, unless it, too, is disabled.
1209 Don't do major collections.
1211 \fBconservative-stack-mark\fR
1212 Forces the GC to scan the stack conservatively, even if precise
1213 scanning is available.
1215 \fBno-managed-allocator\fR
1216 Disables the managed allocator.
1218 \fBcheck-scan-starts\fR
1219 If set, does a plausibility check on the scan_starts before and after each collection
1221 \fBverify-nursery-at-minor-gc\fR
1222 If set, does a complete object walk of the nursery at the start of each minor collection.
1224 \fBdump-nursery-at-minor-gc\fR
1225 If set, dumps the contents of the nursery at the start of each minor collection. Requires
1226 verify-nursery-at-minor-gc to be set.
1228 \fBheap-dump=\fIfile\fR
1229 Dumps the heap contents to the specified file. To visualize the
1230 information, use the mono-heapviz tool.
1232 \fBbinary-protocol=\fIfile\fR
1233 Outputs the debugging output to the specified file. For this to
1234 work, Mono needs to be compiled with the BINARY_PROTOCOL define on
1235 sgen-gc.c. You can then use this command to explore the output
1237 sgen-grep-binprot 0x1234 0x5678 < file
1242 \fBMONO_GAC_PREFIX\fR
1243 Provides a prefix the runtime uses to look for Global Assembly Caches.
1244 Directories are separated by the platform path separator (colons on
1245 unix). MONO_GAC_PREFIX should point to the top directory of a prefixed
1246 install. Or to the directory provided in the gacutil /gacdir command. Example:
1247 .B /home/username/.mono:/usr/local/mono/
1250 Enables some filename rewriting support to assist badly-written
1251 applications that hard-code Windows paths. Set to a colon-separated
1252 list of "drive" to strip drive letters, or "case" to do
1253 case-insensitive file matching in every directory in a path. "all"
1254 enables all rewriting methods. (Backslashes are always mapped to
1255 slashes if this variable is set to a valid option).
1258 For example, this would work from the shell:
1261 MONO_IOMAP=drive:case
1265 If you are using mod_mono to host your web applications, you can use
1268 directive instead, like this:
1271 MonoIOMAP <appalias> all
1274 See mod_mono(8) for more details.
1276 Additionally. Mono includes a profiler module which allows one to track what
1277 adjustements to file paths IOMAP code needs to do. The tracking code reports
1278 the managed location (full stack trace) from which the IOMAP-ed call was made and,
1279 on process exit, the locations where all the IOMAP-ed strings were created in
1280 managed code. The latter report is only approximate as it is not always possible
1281 to estimate the actual location where the string was created. The code uses simple
1282 heuristics - it analyzes stack trace leading back to the string allocation location
1283 and ignores all the managed code which lives in assemblies installed in GAC as well as in the
1284 class libraries shipped with Mono (since they are assumed to be free of case-sensitivity
1285 issues). It then reports the first location in the user's code - in most cases this will be
1286 the place where the string is allocated or very close to the location. The reporting code
1287 is implemented as a custom profiler module (see the "PROFILING" section) and can be loaded
1288 in the following way:
1293 mono --profile=iomap yourapplication.exe
1296 Note, however, that Mono currently supports only one profiler module
1300 When Mono is using the LLVM code generation backend you can use this
1301 environment variable to pass code generation options to the LLVM
1304 \fBMONO_MANAGED_WATCHER\fR
1305 If set to "disabled", System.IO.FileSystemWatcher will use a file watcher
1306 implementation which silently ignores all the watching requests.
1307 If set to any other value, System.IO.FileSystemWatcher will use the default
1308 managed implementation (slow). If unset, mono will try to use inotify, FAM,
1309 Gamin, kevent under Unix systems and native API calls on Windows, falling
1310 back to the managed implementation on error.
1312 \fBMONO_MESSAGING_PROVIDER\fR
1313 Mono supports a plugin model for its implementation of System.Messaging making
1314 it possible to support a variety of messaging implementations (e.g. AMQP, ActiveMQ).
1315 To specify which messaging implementation is to be used the evironement variable
1316 needs to be set to the full class name for the provider. E.g. to use the RabbitMQ based
1317 AMQP implementation the variable should be set to:
1320 Mono.Messaging.RabbitMQ.RabbitMQMessagingProvider,Mono.Messaging.RabbitMQ
1323 If set causes the mono process to be bound to a single processor. This may be
1324 useful when debugging or working around race conditions.
1327 Disable inlining of thread local accesses. Try setting this if you get a segfault
1328 early on in the execution of mono.
1331 Provides a search path to the runtime where to look for library
1332 files. This is a tool convenient for debugging applications, but
1333 should not be used by deployed applications as it breaks the assembly
1334 loader in subtle ways.
1336 Directories are separated by the platform path separator (colons on unix). Example:
1337 .B /home/username/lib:/usr/local/mono/lib
1339 Alternative solutions to MONO_PATH include: installing libraries into
1340 the Global Assembly Cache (see gacutil(1)) or having the dependent
1341 libraries side-by-side with the main executable.
1343 For a complete description of recommended practices for application
1345 http://www.mono-project.com/Guidelines:Application_Deployment
1348 Experimental RTC support in the statistical profiler: if the user has
1349 the permission, more accurate statistics are gathered. The MONO_RTC
1350 value must be restricted to what the Linux rtc allows: power of two
1351 from 64 to 8192 Hz. To enable higher frequencies like 4096 Hz, run as root:
1354 echo 4096 > /proc/sys/dev/rtc/max-user-freq
1361 MONO_RTC=4096 mono --profiler=default:stat program.exe
1365 \fBMONO_SHARED_DIR\fR
1366 If set its the directory where the ".wapi" handle state is stored.
1367 This is the directory where the Windows I/O Emulation layer stores its
1368 shared state data (files, events, mutexes, pipes). By default Mono
1369 will store the ".wapi" directory in the users's home directory.
1371 \fBMONO_SHARED_HOSTNAME\fR
1372 Uses the string value of this variable as a replacement for the host name when
1373 creating file names in the ".wapi" directory. This helps if the host name of
1374 your machine is likely to be changed when a mono application is running or if
1375 you have a .wapi directory shared among several different computers.
1377 Mono typically uses the hostname to create the files that are used to
1378 share state across multiple Mono processes. This is done to support
1379 home directories that might be shared over the network.
1381 \fBMONO_STRICT_IO_EMULATION\fR
1382 If set, extra checks are made during IO operations. Currently, this
1383 includes only advisory locks around file writes.
1386 The name of the theme to be used by Windows.Forms. Available themes today
1387 include "clearlooks", "nice" and "win32".
1389 The default is "win32".
1391 \fBMONO_TLS_SESSION_CACHE_TIMEOUT\fR
1392 The time, in seconds, that the SSL/TLS session cache will keep it's entry to
1393 avoid a new negotiation between the client and a server. Negotiation are very
1394 CPU intensive so an application-specific custom value may prove useful for
1395 small embedded systems.
1397 The default is 180 seconds.
1399 \fBMONO_THREADS_PER_CPU\fR
1400 The maximum number of threads in the general threadpool will be
1401 20 + (MONO_THREADS_PER_CPU * number of CPUs). The default value for this
1404 \fBMONO_XMLSERIALIZER_THS\fR
1405 Controls the threshold for the XmlSerializer to produce a custom
1406 serializer for a given class instead of using the Reflection-based
1407 interpreter. The possible values are `no' to disable the use of a
1408 custom serializer or a number to indicate when the XmlSerializer
1409 should start serializing. The default value is 50, which means that
1410 the a custom serializer will be produced on the 50th use.
1412 \fBMONO_X509_REVOCATION_MODE\fR
1413 Sets the revocation mode used when validating a X509 certificate chain (https,
1414 ftps, smtps...). The default is 'nocheck', which performs no revocation check
1415 at all. The other possible values are 'offline', which performs CRL check (not
1416 implemented yet) and 'online' which uses OCSP and CRL to verify the revocation
1417 status (not implemented yet).
1418 .SH ENVIRONMENT VARIABLES FOR DEBUGGING
1420 \fBMONO_ASPNET_NODELETE\fR
1421 If set to any value, temporary source files generated by ASP.NET support
1422 classes will not be removed. They will be kept in the user's temporary
1426 If set, enables some features of the runtime useful for debugging.
1427 This variable should contain a comma separated list of debugging options.
1428 Currently, the following options are supported:
1432 \fBbreak-on-unverified\fR
1433 If this variable is set, when the Mono VM runs into a verification
1434 problem, instead of throwing an exception it will break into the
1435 debugger. This is useful when debugging verifier problems
1438 This option can be used to get more detailed information from
1439 InvalidCast exceptions, it will provide information about the types
1442 \fBcollect-pagefault-stats\fR
1443 Collects information about pagefaults. This is used internally to
1444 track the number of page faults produced to load metadata. To display
1445 this information you must use this option with "--stats" command line
1448 \fBdont-free-domains\fR
1449 This is an Optimization for multi-AppDomain applications (most
1450 commonly ASP.NET applications). Due to internal limitations Mono,
1451 Mono by default does not use typed allocations on multi-appDomain
1452 applications as they could leak memory when a domain is unloaded.
1454 Although this is a fine default, for applications that use more than
1455 on AppDomain heavily (for example, ASP.NET applications) it is worth
1456 trading off the small leaks for the increased performance
1457 (additionally, since ASP.NET applications are not likely going to
1458 unload the application domains on production systems, it is worth
1459 using this feature).
1461 \fBdyn-runtime-invoke\fR
1462 Instructs the runtime to try to use a generic runtime-invoke wrapper
1463 instead of creating one invoke wrapper.
1466 Equivalent to setting the \fBMONO_XDEBUG\fR variable, this emits
1467 symbols into a shared library as the code is JITed that can be loaded
1468 into GDB to inspect symbols.
1470 \fBgen-seq-points\fR
1471 Automatically generates sequence points where the
1472 IL stack is empty. These are places where the debugger can set a
1475 \fBexplicit-null-checks\fR
1476 Makes the JIT generate an explicit NULL check on variable dereferences
1477 instead of depending on the operating system to raise a SIGSEGV or
1478 another form of trap event when an invalid memory location is
1482 Captures the interrupt signal (Control-C) and displays a stack trace
1483 when pressed. Useful to find out where the program is executing at a
1484 given point. This only displays the stack trace of a single thread.
1487 Instructs the runtime to initialize the stack with
1488 some known values (0x2a on x86-64) at the start of a method to assist
1489 in debuggin the JIT engine.
1491 \fBkeep-delegates\fR
1492 This option will leak delegate trampolines that are no longer
1493 referenced as to present the user with more information about a
1494 delegate misuse. Basically a delegate instance might be created,
1495 passed to unmanaged code, and no references kept in managed code,
1496 which will garbage collect the code. With this option it is possible
1497 to track down the source of the problems.
1499 \fBreverse-pinvoke-exceptions
1500 This option will cause mono to abort with a descriptive message when
1501 during stack unwinding after an exception it reaches a native stack
1502 frame. This happens when a managed delegate is passed to native code,
1503 and the managed delegate throws an exception. Mono will normally try
1504 to unwind the stack to the first (managed) exception handler, and it
1505 will skip any native stack frames in the process. This leads to
1506 undefined behaviour (since mono doesn't know how to process native
1507 frames), leaks, and possibly crashes too.
1509 \fBno-gdb-backtrace\fR
1510 This option will disable the GDB backtrace emitted by the runtime
1511 after a SIGSEGV or SIGABRT in unmanaged code.
1513 \fBsuspend-on-sigsegv\fR
1514 This option will suspend the program when a native SIGSEGV is received.
1515 This is useful for debugging crashes which do not happen under gdb,
1516 since a live process contains more information than a core file.
1520 \fBMONO_LOG_LEVEL\fR
1521 The logging level, possible values are `error', `critical', `warning',
1522 `message', `info' and `debug'. See the DEBUGGING section for more
1526 Controls the domain of the Mono runtime that logging will apply to.
1527 If set, the log mask is changed to the set value. Possible values are
1528 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
1529 (garbage collector), "cfg" (config file loader), "aot" (precompiler),
1530 "security" (e.g. Moonlight CoreCLR support) and "all".
1531 The default value is "all". Changing the mask value allows you to display only
1532 messages for a certain component. You can use multiple masks by comma
1533 separating them. For example to see config file messages and assembly loader
1534 messages set you mask to "asm,cfg".
1537 Used for runtime tracing of method calls. The format of the comma separated
1546 disabled Trace output off upon start.
1549 You can toggle trace output on/off sending a SIGUSR2 signal to the program.
1551 \fBMONO_TRACE_LISTENER\fR
1552 If set, enables the System.Diagnostics.DefaultTraceListener, which will
1553 print the output of the System.Diagnostics Trace and Debug classes.
1554 It can be set to a filename, and to Console.Out or Console.Error to display
1555 output to standard output or standard error, respectively. If it's set to
1556 Console.Out or Console.Error you can append an optional prefix that will
1557 be used when writing messages like this: Console.Error:MyProgramName.
1558 See the System.Diagnostics.DefaultTraceListener documentation for more
1561 \fBMONO_WCF_TRACE\fR
1562 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.
1564 \fBMONO_XEXCEPTIONS\fR
1565 This throws an exception when a X11 error is encountered; by default a
1566 message is displayed but execution continues
1568 \fBMONO_XMLSERIALIZER_DEBUG\fR
1569 Set this value to 1 to prevent the serializer from removing the
1570 temporary files that are created for fast serialization; This might
1571 be useful when debugging.
1574 This is used in the System.Windows.Forms implementation when running
1575 with the X11 backend. This is used to debug problems in Windows.Forms
1576 as it forces all of the commands send to X11 server to be done
1577 synchronously. The default mode of operation is asynchronous which
1578 makes it hard to isolate the root of certain problems.
1580 \fBMONO_GENERIC_SHARING\fR
1581 This environment variable controls the kind of generic sharing used.
1582 This variable is used by internal JIT developers and should not be
1583 changed in production. Do not use it.
1585 The variable controls which classes will have generic code sharing
1588 Permissible values are:
1592 All generated code can be shared.
1595 Only the classes in System.Collections.Generic will have its code
1596 shared (this is the default value).
1599 Only code in corlib will have its code shared.
1602 No generic code sharing will be performed.
1605 Generic code sharing by default only applies to collections. The
1606 Mono JIT by default turns this on.
1609 When the the MONO_XDEBUG env var is set, debugging info for JITted
1610 code is emitted into a shared library, loadable into gdb. This enables,
1611 for example, to see managed frame names on gdb backtraces.
1613 \fBMONO_VERBOSE_METHOD\fR
1614 Enables the maximum JIT verbosity for the specified method. This is
1615 very helpfull to diagnose a miscompilation problems of a specific
1618 If you want to use Valgrind, you will find the file `mono.supp'
1619 useful, it contains the suppressions for the GC which trigger
1620 incorrect warnings. Use it like this:
1622 valgrind --suppressions=mono.supp mono ...
1625 On some platforms, Mono can expose a set of DTrace probes (also known
1626 as user-land statically defined, USDT Probes).
1628 They are defined in the file `mono.d'.
1630 .B ves-init-begin, ves-init-end
1632 Begin and end of runtime initialization.
1634 .B method-compile-begin, method-compile-end
1636 Begin and end of method compilation.
1637 The probe arguments are class name, method name and signature,
1638 and in case of method-compile-end success or failure of compilation.
1642 Begin and end of Garbage Collection.
1644 To verify the availability of the probes, run:
1646 dtrace -P mono'$target' -l -c mono
1649 Mono's Ping implementation for detecting network reachability can
1650 create the ICMP packets itself without requiring the system ping
1651 command to do the work. If you want to enable this on Linux for
1652 non-root users, you need to give the Mono binary special permissions.
1654 As root, run this command:
1656 # setcap cap_net_raw=+ep /usr/bin/mono
1659 On Unix assemblies are loaded from the installation lib directory. If you set
1660 `prefix' to /usr, the assemblies will be located in /usr/lib. On
1661 Windows, the assemblies are loaded from the directory where mono and
1664 .B ~/.mono/aot-cache
1666 The directory for the ahead-of-time compiler demand creation
1667 assemblies are located.
1669 .B /etc/mono/config, ~/.mono/config
1671 Mono runtime configuration file. See the mono-config(5) manual page
1672 for more information.
1674 .B ~/.config/.mono/certs, /usr/share/.mono/certs
1676 Contains Mono certificate stores for users / machine. See the certmgr(1)
1677 manual page for more information on managing certificate stores and
1678 the mozroots(1) page for information on how to import the Mozilla root
1679 certificates into the Mono certificate store.
1681 .B ~/.mono/assemblies/ASSEMBLY/ASSEMBLY.config
1683 Files in this directory allow a user to customize the configuration
1684 for a given system assembly, the format is the one described in the
1685 mono-config(5) page.
1687 .B ~/.config/.mono/keypairs, /usr/share/.mono/keypairs
1689 Contains Mono cryptographic keypairs for users / machine. They can be
1690 accessed by using a CspParameters object with DSACryptoServiceProvider
1691 and RSACryptoServiceProvider classes.
1693 .B ~/.config/.isolatedstorage, ~/.local/share/.isolatedstorage, /usr/share/.isolatedstorage
1695 Contains Mono isolated storage for non-roaming users, roaming users and
1696 local machine. Isolated storage can be accessed using the classes from
1697 the System.IO.IsolatedStorage namespace.
1699 .B <assembly>.config
1701 Configuration information for individual assemblies is loaded by the
1702 runtime from side-by-side files with the .config files, see the
1703 http://www.mono-project.com/Config for more information.
1705 .B Web.config, web.config
1707 ASP.NET applications are configured through these files, the
1708 configuration is done on a per-directory basis. For more information
1709 on this subject see the http://www.mono-project.com/Config_system.web
1712 Mailing lists are listed at the
1713 http://www.mono-project.com/Mailing_Lists
1715 http://www.mono-project.com
1718 certmgr(1), csharp(1), mcs(1), mdb(1), monocov(1), monodis(1),
1719 mono-config(5), mozroots(1), mprof-report(1), pdb2mdb(1), xsp(1), mod_mono(8).
1721 For more information on AOT:
1722 http://www.mono-project.com/AOT
1724 For ASP.NET-related documentation, see the xsp(1) manual page
projects / mono.git / blob