Revert the last change, the saving and non-saving code is too tighly interleaved
[mono.git] / man / mono.1
blob563b73ac012f31b2ccd8e0e15afc495f5085be82
1 .\" 
2 .\" mono manual page.
3 .\" Copyright 2003 Ximian, Inc. 
4 .\" Copyright 2004-2009 Novell, Inc. 
5 .\" Author:
6 .\"   Miguel de Icaza (miguel@gnu.org)
7 .\"
8 .TH Mono "Mono 2.2"
9 .SH NAME
10 mono \- Mono's ECMA-CLI native code generator (Just-in-Time and Ahead-of-Time)
11 .SH SYNOPSIS
12 .PP
13 .B mono [options] file [arguments...]
14 .SH DESCRIPTION
15 \fImono\fP is a runtime implementation of the ECMA Common Language
16 Infrastructure.  This can be used to run ECMA and .NET applications.
17 .PP
18 The runtime contains a native code generator that transforms the
19 Common Intermediate Language into native code.
20 .PP
21 The code generator can operate in two modes: just in time compilation
22 (JIT) or ahead of time compilation (AOT).  Since code can be
23 dynamically loaded, the runtime environment and the JIT are always
24 present, even if code is compiled ahead of time.
25 .PP
26 The runtime loads the specified
27 .I file
28 and optionally passes
29 the
30 .I arguments
31 to it.  The 
32 .I file
33 is an ECMA assembly.  They typically have a .exe or .dll extension.
34 .PP
35 The runtime provides a number of configuration options for running
36 applications, for developing and debugging, and for testing and
37 debugging the runtime itself.
38 .SH PORTABILITY
39 On Unix-based systems, Mono provides a mechanism to emulate the 
40 Windows-style file access, this includes providing a case insensitive
41 view of the file system, directory separator mapping (from \\ to /) and
42 stripping the drive letters.
43 .PP
44 This functionality is enabled by setting the 
45 .B MONO_IOMAP 
46 environment variable to one of 
47 .B all, drive
48 and 
49 .B case.
50 .PP
51 See the description for 
52 .B MONO_IOMAP
53 in the environment variables section for more details.
54 .SH RUNTIME OPTIONS
55 The following options are available:
56 .TP
57 \fB--aot\fR, \fB--aot[=options]\fR
58 This option is used to precompile the CIL code in the specified
59 assembly to native code.  The generated code is stored in a file with
60 the extension .so.  This file will be automatically picked up by the
61 runtime when the assembly is executed.  
62 .Sp 
63 Ahead-of-Time compilation is most useful if you use it in combination
64 with the -O=all,-shared flag which enables all of the optimizations in
65 the code generator to be performed.  Some of those optimizations are
66 not practical for Just-in-Time compilation since they might be very
67 time consuming.
68 .Sp
69 Unlike the .NET Framework, Ahead-of-Time compilation will not generate
70 domain independent code: it generates the same code that the
71 Just-in-Time compiler would produce.   Since most applications use a
72 single domain, this is fine.   If you want to optimize the generated
73 code for use in multi-domain applications, consider using the
74 -O=shared flag.
75 .Sp
76 This pre-compiles the methods, but the original assembly is still
77 required to execute as this one contains the metadata and exception
78 information which is not available on the generated file.  When
79 precompiling code, you might want to compile with all optimizations
80 (-O=all).  Pre-compiled code is position independent code.
81 .Sp
82 Pre compilation is just a mechanism to reduce startup time, increase
83 code sharing across multiple mono processes and avoid just-in-time
84 compilation program startup costs.  The original assembly must still
85 be present, as the metadata is contained there.
86 .Sp
87 AOT code typically can not be moved from one computer to another
88 (CPU-specific optimizations that are detected at runtime) so you
89 should not try to move the pre-generated assemblies or package the
90 pre-generated assemblies for deployment.    
91 .Sp
92 A few options are available as a parameter to the 
93 .B --aot 
94 command line option.   The options are separated by commas, and more
95 than one can be specified:
96 .RS
97 .ne 8
98 .TP
99 .I bind-to-runtime-version
101 If specified, forces the generated AOT files to be bound to the
102 runtime version of the compiling Mono.   This will prevent the AOT
103 files from being consumed by a different Mono runtime.
104 .I full
105 This is currently an experimental feature as it is not complete.
106 This instructs Mono to precompile code that has historically not been
107 precompiled with AOT.   
109 .I write-symbols
110 Instructs the AOT compiler to emit debug symbol information.
112 .I static
113 Create an ELF object file (.o) which can be statically linked into an executable
114 when embedding the mono runtime. When this option is used, the object file needs to
115 be registered with the embedded runtime using the mono_aot_register_module function
116 which takes as its argument the mono_aot_module_<ASSEMBLY NAME>_info global symbol 
117 from the object file:
120 extern void *mono_aot_module_hello_info;
122 mono_aot_register_module (mono_aot_module_hello_info);
127 For more information about AOT, see: http://www.mono-project.com/AOT
130 \fB--attach=[options]\fR
131 Currently the only option supported by this command line argument is
132 \fBdisable\fR which disables the attach functionality.
134 \fB--full-aot\fR
135 This is an experimental flag that instructs the Mono runtime to not
136 generate any code at runtime and depend exclusively on the code
137 generated from using mono --aot=full previously.   This is useful for
138 platforms that do not permit dynamic code generation.
140 Notice that this feature will abort execution at runtime if a codepath
141 in your program, or Mono's class libraries attempts to generate code
142 dynamically.  You should test your software upfront and make sure that
143 you do not use any dynamic features.
145 \fB--config filename\fR
146 Load the specified configuration file instead of the default one(s).
147 The default files are /etc/mono/config and ~/.mono/config or the file
148 specified in the MONO_CONFIG environment variable, if set.  See the
149 mono-config(5) man page for details on the format of this file.
151 \fB--desktop\fR
152 Configures the virtual machine to be better suited for desktop
153 applications.  Currently this sets the GC system to avoid expanding
154 the heap as much as possible at the expense of slowing down garbage
155 collection a bit.
157 \fB--help\fR, \fB-h\fR
158 Displays usage instructions.
160 \fB--optimize=MODE\fR, \fB-O=MODE\fR
161 MODE is a comma separated list of optimizations.  They also allow
162 optimizations to be turned off by prefixing the optimization name with
163 a minus sign.
165 In general, Mono has been tuned to use the default set of flags,
166 before using these flags for a deployment setting, you might want to
167 actually measure the benefits of using them.    
169 The following optimizations are implemented:
171              all        Turn on all optimizations
172              peephole   Peephole postpass
173              branch     Branch optimizations
174              inline     Inline method calls
175              cfold      Constant folding
176              consprop   Constant propagation
177              copyprop   Copy propagation
178              deadce     Dead code elimination
179              linears    Linear scan global reg allocation
180              cmov       Conditional moves [arch-dependency]
181              shared     Emit per-domain code
182              sched      Instruction scheduling
183              intrins    Intrinsic method implementations
184              tailc      Tail recursion and tail calls
185              loop       Loop related optimizations
186              fcmov      Fast x86 FP compares [arch-dependency]
187              leaf       Leaf procedures optimizations
188              aot        Usage of Ahead Of Time compiled code
189              precomp    Precompile all methods before executing Main
190              abcrem     Array bound checks removal
191              ssapre     SSA based Partial Redundancy Elimination
192              sse2       SSE2 instructions on x86 [arch-dependency]
193              gshared    Enable generic code sharing.
196 For example, to enable all the optimization but dead code
197 elimination and inlining, you can use:
199         -O=all,-deadce,-inline
202 The flags that are flagged with [arch-dependency] indicate that the
203 given option if used in combination with Ahead of Time compilation
204 (--aot flag) would produce pre-compiled code that will depend on the
205 current CPU and might not be safely moved to another computer. 
207 \fB--runtime=VERSION\fR
208 Mono supports different runtime versions. The version used depends on the program
209 that is being run or on its configuration file (named program.exe.config). This option
210 can be used to override such autodetection, by forcing a different runtime version
211 to be used. Note that this should only be used to select a later compatible runtime
212 version than the one the program was compiled against. A typical usage is for
213 running a 1.1 program on a 2.0 version:
215          mono --runtime=v2.0.50727 program.exe
218 \fB--security\fR, \fB--security=mode\fR
219 Activate the security manager, a currently experimental feature in
220 Mono and it is OFF by default. The new code verifier can be enabled
221 with this option as well.
223 .ne 8
225 Using security without parameters is equivalent as calling it with the
226 "cas" parameter.  
228 The following modes are supported:
230 .I cas
231 This allows mono to support declarative security attributes,
232 e.g. execution of Code Access Security (CAS) or non-CAS demands.
233 .TP 
234 .I core-clr
235 Enables the core-clr security system, typically used for
236 Moonlight/Silverlight applications.  It provides a much simpler
237 security system than CAS, see http://www.mono-project.com/Moonlight
238 for more details and links to the descriptions of this new system. 
240 .I validil
241 Enables the new verifier and performs basic verification for code
242 validity.  In this mode, unsafe code and P/Invoke are allowed. This
243 mode provides a better safety guarantee but it is still possible
244 for managed code to crash Mono. 
246 .I verifiable
247 Enables the new verifier and performs full verification of the code
248 being executed.  It only allows verifiable code to be executed.
249 Unsafe code is not allowed but P/Invoke is.  This mode should
250 not allow managed code to crash mono.  The verification is not as
251 strict as ECMA 335 standard in order to stay compatible with the MS
252 runtime.
254 The security system acts on user code: code contained in mscorlib or
255 the global assembly cache is always trusted.
259 \fB--server\fR
260 Configures the virtual machine to be better suited for server
261 operations (currently, a no-op).
263 \fB--verify-all\fR 
264 Verifies mscorlib and assemblies in the global
265 assembly cache for valid IL, and all user code for IL
266 verifiability. 
268 This is different from \fB--security\fR's verifiable
269 or validil in that these options only check user code and skip
270 mscorlib and assemblies located on the global assembly cache.
272 \fB-V\fR, \fB--version\fR
273 Prints JIT version information (system configuration, release number
274 and branch names if available). 
277 .SH DEVELOPMENT OPTIONS
278 The following options are used to help when developing a JITed application.
280 \fB--debug\fR, \fB--debug=OPTIONS\fR
281 Turns on the debugging mode in the runtime.  If an assembly was
282 compiled with debugging information, it will produce line number
283 information for stack traces. 
285 .ne 8
287 The optional OPTIONS argument is a comma separated list of debugging
288 options.  These options are turned off by default since they generate
289 much larger and slower code at runtime.
291 The following options are supported:
293 .I casts
294 Produces a detailed error when throwing a InvalidCastException.   This
295 option needs to be enabled as this generates more verbose code at
296 execution time. 
298 .I mdb-optimizations
299 Disable some JIT optimizations which are usually only disabled when
300 running inside the debugger.  This can be helpful if you want to attach
301 to the running process with mdb.
305 \fB--profile[=profiler[:profiler_args]]\fR
306 Turns on profiling.  For more information about profiling applications
307 and code coverage see the sections "PROFILING" and "CODE COVERAGE"
308 below. 
310 \fB--trace[=expression]\fR
311 Shows method names as they are invoked.  By default all methods are
312 traced. 
314 The trace can be customized to include or exclude methods, classes or
315 assemblies.  A trace expression is a comma separated list of targets,
316 each target can be prefixed with a minus sign to turn off a particular
317 target.  The words `program', `all' and `disabled' have special
318 meaning.  `program' refers to the main program being executed, and
319 `all' means all the method calls.
321 The `disabled' option is used to start up with tracing disabled.  It
322 can be enabled at a later point in time in the program by sending the
323 SIGUSR2 signal to the runtime.
325 Assemblies are specified by their name, for example, to trace all
326 calls in the System assembly, use:
329         mono --trace=System app.exe
332 Classes are specified with the T: prefix.  For example, to trace all
333 calls to the System.String class, use:
336         mono --trace=T:System.String app.exe
339 And individual methods are referenced with the M: prefix, and the
340 standard method notation:
343         mono --trace=M:System.Console:WriteLine app.exe
346 As previously noted, various rules can be specified at once:
349         mono --trace=T:System.String,T:System.Random app.exe
352 You can exclude pieces, the next example traces calls to
353 System.String except for the System.String:Concat method.
356         mono --trace=T:System.String,-M:System.String:Concat
359 Finally, namespaces can be specified using the N: prefix:
362         mono --trace=N:System.Xml
366 \fB--no-x86-stack-align\fR
367 Don't align stack frames on the x86 architecture.  By default, Mono
368 aligns stack frames to 16 bytes on x86, so that local floating point
369 and SIMD variables can be properly aligned.  This option turns off the
370 alignment, which usually saves one intruction per call, but might
371 result in significantly lower floating point and SIMD performance.
372 .SH JIT MAINTAINER OPTIONS
373 The maintainer options are only used by those developing the runtime
374 itself, and not typically of interest to runtime users or developers.
376 \fB--break method\fR
377 Inserts a breakpoint before the method whose name is `method'
378 (namespace.class:methodname).  Use `Main' as method name to insert a
379 breakpoint on the application's main method.
381 \fB--breakonex\fR
382 Inserts a breakpoint on exceptions.  This allows you to debug your
383 application with a native debugger when an exception is thrown.
385 \fB--compile name\fR
386 This compiles a method (namespace.name:methodname), this is used for
387 testing the compiler performance or to examine the output of the code
388 generator. 
390 \fB--compileall\fR
391 Compiles all the methods in an assembly.  This is used to test the
392 compiler performance or to examine the output of the code generator
393 .TP 
394 \fB--graph=TYPE METHOD\fR
395 This generates a postscript file with a graph with the details about
396 the specified method (namespace.name:methodname).  This requires `dot'
397 and ghostview to be installed (it expects Ghostview to be called
398 "gv"). 
400 The following graphs are available:
402           cfg        Control Flow Graph (CFG)
403           dtree      Dominator Tree
404           code       CFG showing code
405           ssa        CFG showing code after SSA translation
406           optcode    CFG showing code after IR optimizations
409 Some graphs will only be available if certain optimizations are turned
412 \fB--ncompile\fR
413 Instruct the runtime on the number of times that the method specified
414 by --compile (or all the methods if --compileall is used) to be
415 compiled.  This is used for testing the code generator performance. 
416 .TP 
417 \fB--stats\fR
418 Displays information about the work done by the runtime during the
419 execution of an application. 
421 \fB--wapi=hps|semdel\fR
422 Perform maintenance of the process shared data.
424 semdel will delete the global semaphore.
426 hps will list the currently used handles.
428 \fB-v\fR, \fB--verbose\fR
429 Increases the verbosity level, each time it is listed, increases the
430 verbosity level to include more information (including, for example, 
431 a disassembly of the native code produced, code selector info etc.).
432 .SH ATTACH SUPPORT
433 The Mono runtime allows external processes to attach to a running
434 process and load assemblies into the running program.   To attach to
435 the process, a special protocol is implemented in the Mono.Management
436 assembly. 
438 With this support it is possible to load assemblies that have an entry
439 point (they are created with -target:exe or -target:winexe) to be
440 loaded and executed in the Mono process.
442 The code is loaded into the root domain, and it starts execution on
443 the special runtime attach thread.    The attached program should
444 create its own threads and return after invocation.
446 This support allows for example debugging applications by having the
447 csharp shell attach to running processes.
448 .SH PROFILING
449 The mono runtime includes a profiler that can be used to explore
450 various performance related problems in your application.  The
451 profiler is activated by passing the --profile command line argument
452 to the Mono runtime, the format is:
455         --profile[=profiler[:profiler_args]]
458 Mono has a built-in profiler called 'default' (and is also the default
459 if no arguments are specified), but developers can write custom
460 profilers, see the section "CUSTOM PROFILERS" for more details.
462 If a 
463 .I profiler 
464 is not specified, the default profiler is used.
466 The 
467 .I profiler_args 
468 is a profiler-specific string of options for the profiler itself.
470 The default profiler accepts the following options 'alloc' to profile
471 memory consumption by the application; 'time' to profile the time
472 spent on each routine; 'jit' to collect time spent JIT-compiling methods
473 and 'stat' to perform sample statistical profiling.
474 If no options are provided the default is 'alloc,time,jit'. 
476 By default the
477 profile data is printed to stdout: to change this, use the 'file=filename'
478 option to output the data to filename.
480 For example:
483         mono --profile program.exe
487 That will run the program with the default profiler and will do time
488 and allocation profiling.
492         mono --profile=default:stat,alloc,file=prof.out program.exe
495 Will do  sample statistical profiling and allocation profiling on
496 program.exe. The profile data is put in prof.out.
498 Note that the statistical profiler has a very low overhead and should
499 be the preferred profiler to use (for better output use the full path
500 to the mono binary when running and make sure you have installed the
501 addr2line utility that comes from the binutils package).
502 .SH LOGGING PROFILER
505 .I logging profiler
506 is a general purpose profiler that can track many different kinds of
507 events and logs those into a file as the program executes.   This is
508 different than previous profilers in Mono that kept the information in
509 memory and rendered a summary of the results when the program shut
510 down.
512 Using the logging profiler means that useful information can be
513 gathered for long-running applications, applications that terminate
514 abormally (crashes, segfaults, complicated tear down processes) or
515 when no data about the shutdown is required.
517 The data collected by the running threads is kept independent of each
518 other to minimize the runtime overhead and the information dumped into
519 the log at regular intervals. 
521 A sample use is very simple:
523         $ mono --profile=logging program.exe
525         $ mprof-decoder program.mprof
528 In the above example the logging profiler is used in its default mode
529 that merely records GC statistics for the execution of program.exe.
530 The profiling data collected is stored in the file program.mprof.  The
531 mprof-decoder tool is then used to analyze the data.
533 You can instruct the logging profiler to record different one or more
534 sets of events.   These are the modes supported:
536 .I Statistical Profiling (stat)
537 the program instruction pointer is periodically sampled to determine
538 where the program is spending most of its time.   Statistical
539 profiling has a very low impact on a running application and it is
540 very useful to get a general picture of where time is being spent on a
541 program.   
542 .IP 
543 If call chains are requested, for each sample the profiler gets a
544 partial stack trace (limited by the specified depth) so that
545 caller-callee information is available.
547 .I Instrumenting:
548 each method enter and exit is logged with a timestamp; further processing of
549 the data can show the methods that took the longer to execute, with complete
550 accounting for callers and callees. However, this way of profiling is rather
551 intrusive and slows down the application significantly.
553 .I Allocation:
554 each allocation is logged.
556 .I Allocation summary:
557 shows, for each collection, a summary of the heap contents broken down by
558 class (for each class the number of allocated and released objects is
559 given, together with their aggregated size in bytes).
561 .I Heap snapshot mode:
562 dumps the whole heap contents at every collection (or at user specified
563 collections). It is also possible to request a collection and snapshot dump
564 with a signal.
566 Moreover, other events can be logged and analyzed, like jit time for each
567 method, load and unload for assemblies, modules and and individual classes,
568 and appdomain and thread creation and destruction.
570 This profiler is activated passing the \fB--profile=logging\fR option to
571 the mono runtime, and is controlled attaching further options, like
572 \fB--profile=logging:statistical\fR for doing statistical profiling (multiple
573 options are separated by commas).
575 As a quick primer, here are a few examples of the most common usage modes:
577 To perform statistical profiling:
580         mono --profile=logging:stat program.exe
583 To perform statistical profiling, inspecting call chains up to depth 8:
586         mono --profile=logging:stat=8 program.exe
589 To profile allocations (by default the call stack will be analized for
590 each allocation, producing detailed caller method attribution infornation):
593         mono --profile=logging:allocations program.exe
596 To profile garbage collection activity at a high level (collection time and objects freed
597 at each collection for each class are reported, but heap snapshots are not saved to disk):
600         mono --profile=logging:allocations-summary program.exe
603 To perform heap profiling taking heap snapshots:
606         mono --profile=logging:heap=all program.exe
609 To write the resulting data to a different file:
612         mono --profile=logging:output=mydata.mprof program.exe
615 Then you would need to invoke the decoder \fImprof-decoder(1)\fR
616 on the output file to see the profiling results, or to examine heap
617 snapshots and allocations in detail \fImprof-heap-viewer(1)\fR.
619 The operating modes described above are the default ones, and are sufficient
620 to use the profiler.
622 To further customize the profiler behavior there are more options, described
623 below.
625 These options can be individually enabled and disabled prefixing them
626 with an (optional) '+' character or a '-' character.  For instance,
627 the "allocations" option by default records also the full call stack
628 at each allocation.  If only the caller is wanted, one should use
629 "allocations,-save-allocation-stack", or to disable call tracking
630 completely (making the profiler less intrusive)
631 "allocations,-save-allocation-caller,-save-allocation-stack".  In
632 practice the "allocation" option by default behaves like
633 "allocations,save-allocation-caller,save-allocation-stack", but the
634 user can tune this to his needs.
636 These are all the available options, organized by category:
638 \fBExecution profiling modes\fR
640 .ne 8
642 \fIstatistical\fR, \fIstat\fR or \fIs\fR
643 Performs statistical profiling.   This is a lightweight profiling
644 mechanism and it has a much lower overhead than the \fIenter-leave\fR
645 profiling as it works by sampling where the program is spending its
646 time by using a timer.
647 If specified with \fIs=<number>\fR, also inspect call chains up to level
648 <number>.
650 \fIenter-leave\fR, \fIcalls\fR or \fIc\fR
651 Measure the time spent inside each method call, this is done by
652 logging the time when a method enters and when the method leaves.
653 This can be a time consuming operation. 
655 \fIjit\fR, \fIj\fR
656 Collect information about time spent by the JIT engine compiling
657 methods. 
661 \fBAllocation profiling modes\fR
663 .ne 8
665 \fIallocations\fR, \fIalloc\fR or \fIa\fR
666 Collect information about each allocation (object class and size).
667 By default this also implies "+save-allocation-caller" and
668 "+save-allocation-stack".
670 \fIsave-allocation-caller\fR, \fIsac\fR
671 Save the direct caller of each allocation. The profiler filters out wrapper
672 methods, and also recognizes if the allocation has been performed by the
673 runtime while jitting a method.
675 \fIsave-allocation-stack\fR, \fIsas\fR
676 Save the full managed execution stack at each allocation.
677 While the "sac" option saves the direct caller, this one records the whole
678 stack trace.
679 Note that in the call stack the wrapper methods are not filtered out.
680 Anyway the "sac" and "sas" options can be combined, and the decoder will
681 attribute the allocation to the correct method even if the wrapper is at the
682 top of the stack trace.
684 \fIallocations-summary\fR or \fIas\fR
685 At each collection dump a summary
686 of the heap contents (for each class, the number and collective size of all
687 live and freed heap objects). This very lightweight compared to full heap
688 snapshots.
690 \fIunreachable\fR, \fIfree\fR or \fIf\fR
691 Performs a lightweight profile of the garbage collector.  On each
692 collection performed by the GC, the list of unreachable objects is
693 recorded, and for each object the class and size is provided.  This
694 information can be used to compute the heap size broken down by class
695 (combined with "a" can give the same information of "as", but the log
696 file contains info about each individual object, while in "as" the
697 processing is done directly at runtime and the log file contains only
698 the summarized data broken down by class).
700 \fIgc\fR or \fIg\fR
701 Measure the time spent in each collection, and also trace heap resizes.
703 \fIheap-shot[=ARG]\fR, \fIheap[=ARG]\fR or \fIh[=ARH]\fR
704 Performs full heap profiling.   In this case on each
705 collection a full heap snapshot is recorded to disk.
706 Inside the snapshots, each object reference is still represented so
707 that it's possible to investigate who is responsible for keeping objects
708 alive.
710 If the value of ARG is 
711 .B all, 
712 a heap snapshot is taken at each collection.  
714 If the value is signal name or a number (one of SIGUSR1, SIGUSR2 and
715 SIGPROF, remembering that SIGPROF is not compatible with the
716 statistical profiler), every time the application receives this signal
717 a garbage collection is forced and a snapshot is taken. The natural way
718 to take a heap snapshot is then using the kill command to deliver the
719 appropriate signal to the application.
721 Heap profiling also enables full allocation profiling (with call
722 stacks), and each allocation can be related to its corresponding
723 object in the snapshots, enabling investigations like "find all
724 objects of a given class allocated by a given method and still live at
725 a given collection, and then find all objects referencing them".
727 This kind of heap snapshot analysis is performed using the mprof-heap-viewer(1)
728 application.
730 The number of heap snapshots taken (and the moment in which they are taken)
731 can be further customized with the following options: 
733 \fIgc-dumps=N\fR, \fIgc-d=N\fR, \fIgcd=N\fR
734 states the number of snapshots that must be dumped (since the application
735 starts).  Zero means no dumps at all, -1 means dump at all collections.
737 \fIgc-commands=FILE\fR, \fIgc-c=FILE\fR or \fIgcc=FILE\fR 
738 specify a "command file". The file must contain an integer value in ASCII
739 form, and the profiler will stat it at every collection.
740 If it has been modified it will interpret its contents as a \fIgcd=N\fR
741 option value, and dump the required number of snapshots from that moment
742 onwards.
743 If the file is present at application startup it takes precedence over an
744 eventual \fIgcd=N\fR option.
746 These options exist because it can happen that the user wants to investigate
747 what happens during collections but without forcing a collection using a
748 signal, because forcing a collection alters the program behavior.
749 Of course it is possible to simply take a snapshot at every collection, but
750 in some workloads this is could not be feasible (too much data).
751 So we have this "garbage collection dumps" counter to control how many
752 snapshots to take.
756 \fBProfiler activity control\fR
758 .ne 8
760 \fIoutput=FILE\fR, \fIout=FILE\fR or \fIo=FILE\fR
761 Use this option to provide the output file name for the profile log.
762 If this option is not specified, it will default to "<program-name>.mprof".
764 \fIoutput-suffix=SUFFIX\fR, \fIsuffix=SUFFIX\fR or \fIos=SUFFIX\fR: makes
765 the output file name equals to "<program-name>-SUFFIX.mprof".
767 \fIstart-enabled\fR or \fIse\fR: start with the profiler active
768 (which is the default).
770 \fIstart-disabled\fR or \fIsd\fR: start with the profiler inactive.
772 \fItoggle-signal=<SIGNAL>\fR or \fIts=<SIGNAL>\fR (where <SIGNAL>
773 is one of SIGUSR1, SIGUSR2 or SIGPROF): Choose a signal that will be used to
774 toggle the profiler activity on and off. This way you can decide to profile
775 only portions of the applicatopn lifetime (for instance, you can decide to
776 avoid profiling an initial setup phase using \fIsd\fR, and enable the
777 profiler later delivering the signal to the application).
779 \fIforce-accurate-timer\fR (or \fIfac\fR): the profiler by default uses
780 rtdsc to acquire timestamps for frequent events, but this can be imprecise;
781 using this option you force the use of "gettimeofday" at every event, which
782 is more accurate but much slower.
786 \fBInternal buffer sizes\fR
788 .ne 8
790 \fIper-thread-buffer-size=N\fR, \fItbs=N\fR
791 Use to specify the number of events that a thread buffer
792 can hold.   When the thread buffer is full, a log block is
793 written to disk.
795 This defaults to tbs=10000.
797 \fIstatistical-thread-buffer-size=N\fR, \fIsbs=N\fR
798 The number of statistical samples that
799 are held in memory before they are dumped to disk (the system does
800 double-buffering and the statistical samples are written by a helper
801 thread, so the statistical profiler never stops and is able to profile
802 the profiler itself).  
804 This defaults to sbs=10000.
806 \fIwrite-buffer-size\fR, \fIwbs\fR
807 Specifies the size in bytes of the internal write buffers.
809 This defaults to wbs=1024.
813 In its current state, this profiler can also perform heap analysis
814 like the HeapShot profiler, but there is no UI to process this
815 information. 
817 Another known issue is that if the timer is not strictly monotonic (like
818 rtdsc), differences between times can underflow (they are handled as
819 unsigned integers) and weird numbers can show up in the logs.
821 Finally, it can happen that when exceptions are thrown the profiler temporarily
822 loses track of the execution stack and misattributes the caller for a few
823 allocations (and method execution time).
825 The output file contains compressed events, to process the data you should
826 use tools like the "Mono.Profiler" tool provided on the Mono SVN
827 repository.  
829 More explanations are provided here: "http://www.mono-project.com/LoggingProfiler".
830 .SH EXTERNAL PROFILERS
831 There are a number of external profilers that have been developed for
832 Mono, we will update this section to contain the profilers.
834 The heap Shot profiler can track all live objects, and references to
835 these objects, and includes a GUI tool, this is our recommended
836 profiler.
837 To install you must download the profiler
838 from Mono's SVN:
840         svn co svn://anonsvn.mono-project.com/source/trunk/heap-shot
841         cd heap-shot
842         ./autogen
843         make
844         make install
847 See the included documentation for details on using it.
849 The Live Type profiler shows at every GC iteration all of the live
850 objects of a given type.   To install you must download the profiler
851 from Mono's SVN:
853         svn co svn://anonsvn.mono-project.com/source/trunk/heap-prof
854         cd heap-prof
855         ./autogen
856         make
857         make install
860 To use the profiler, execute:
862         mono --profile=desc-heap program.exe
865 The output of this profiler looks like this:
867         Checkpoint at 102 for heap-resize
868            System.MonoType : 708
869            System.Threading.Thread : 352
870            System.String : 3230
871            System.String[] : 104
872            Gnome.ModuleInfo : 112
873            System.Object[] : 160
874            System.Collections.Hashtable : 96
875            System.Int32[] : 212
876            System.Collections.Hashtable+Slot[] : 296
877            System.Globalization.CultureInfo : 108
878            System.Globalization.NumberFormatInfo : 144
881 The first line describes the iteration number for the GC, in this case
882 checkpoint 102.
884 Then on each line the type is displayed as well as the number of bytes
885 that are being consumed by live instances of this object.
886 .PP 
887 The AOT profiler is used to feed back information to the AOT compiler
888 about how to order code based on the access patterns for pages.  To
889 use it, use:
891         mono --profile=aot program.exe
893 The output of this profile can be fed back into Mono's AOT compiler to
894 order the functions on the disk to produce precompiled images that
895 have methods in sequential pages.
896 .SH CUSTOM PROFILERS
897 Mono provides a mechanism for loading other profiling modules which in
898 the form of shared libraries.  These profiling modules can hook up to
899 various parts of the Mono runtime to gather information about the code
900 being executed.
902 To use a third party profiler you must pass the name of the profiler
903 to Mono, like this:
906         mono --profile=custom program.exe
910 In the above sample Mono will load the user defined profiler from the
911 shared library `mono-profiler-custom.so'.  This profiler module must
912 be on your dynamic linker library path.
913 .PP 
914 A list of other third party profilers is available from Mono's web
915 site (www.mono-project.com/Performance_Tips)
917 Custom profiles are written as shared libraries.  The shared library
918 must be called `mono-profiler-NAME.so' where `NAME' is the name of
919 your profiler.
921 For a sample of how to write your own custom profiler look in the
922 Mono source tree for in the samples/profiler.c.
923 .SH CODE COVERAGE
924 Mono ships with a code coverage module.  This module is activated by
925 using the Mono --profile=cov option.  The format is:
926 \fB--profile=cov[:assembly-name[/namespace]] test-suite.exe\fR
928 By default code coverage will default to all the assemblies loaded,
929 you can limit this by specifying the assembly name, for example to
930 perform code coverage in the routines of your program use, for example
931 the following command line limits the code coverage to routines in the
932 "demo" assembly:
935         mono --profile=cov:demo demo.exe
939 Notice that the 
940 .I assembly-name
941 does not include the extension.
943 You can further restrict the code coverage output by specifying a
944 namespace:
947         mono --profile=cov:demo/My.Utilities demo.exe
951 Which will only perform code coverage in the given assembly and
952 namespace.  
954 Typical output looks like this:
957         Not covered: Class:.ctor ()
958         Not covered: Class:A ()
959         Not covered: Driver:.ctor ()
960         Not covered: Driver:method ()
961         Partial coverage: Driver:Main ()
962                 offset 0x000a
966 The offsets displayed are IL offsets.
968 A more powerful coverage tool is available in the module `monocov'.
969 See the monocov(1) man page for details.
970 .SH DEBUGGING AIDS
971 To debug managed applications, you can use the 
972 .B mdb
973 command, a command line debugger.  
975 It is possible to obtain a stack trace of all the active threads in
976 Mono by sending the QUIT signal to Mono, you can do this from the
977 command line, like this:
980         kill -QUIT pid
983 Where pid is the Process ID of the Mono process you want to examine.
984 The process will continue running afterwards, but its state is not
985 guaranteed.
987 .B Important:
988 this is a last-resort mechanism for debugging applications and should
989 not be used to monitor or probe a production application.  The
990 integrity of the runtime after sending this signal is not guaranteed
991 and the application might crash or terminate at any given point
992 afterwards.   
994 The \fB--debug=casts\fR option can be used to get more detailed
995 information for Invalid Cast operations, it will provide information
996 about the types involved.   
998 You can use the MONO_LOG_LEVEL and MONO_LOG_MASK environment variables
999 to get verbose debugging output about the execution of your
1000 application within Mono.
1002 The 
1003 .I MONO_LOG_LEVEL
1004 environment variable if set, the logging level is changed to the set
1005 value. Possible values are "error", "critical", "warning", "message",
1006 "info", "debug". The default value is "error". Messages with a logging
1007 level greater then or equal to the log level will be printed to
1008 stdout/stderr.
1010 Use "info" to track the dynamic loading of assemblies.
1013 Use the 
1014 .I MONO_LOG_MASK
1015 environment variable to limit the extent of the messages you get: 
1016 If set, the log mask is changed to the set value. Possible values are
1017 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
1018 (garbage collector), "cfg" (config file loader), "aot" (precompiler) and "all". 
1019 The default value is "all". Changing the mask value allows you to display only 
1020 messages for a certain component. You can use multiple masks by comma 
1021 separating them. For example to see config file messages and assembly loader
1022 messages set you mask to "asm,cfg".
1024 The following is a common use to track down problems with P/Invoke:
1027         $ MONO_LOG_LEVEL="debug" MONO_LOG_MASK="dll" mono glue.exe
1031 .SH SERIALIZATION
1032 Mono's XML serialization engine by default will use a reflection-based
1033 approach to serialize which might be slow for continuous processing
1034 (web service applications).  The serialization engine will determine
1035 when a class must use a hand-tuned serializer based on a few
1036 parameters and if needed it will produce a customized C# serializer
1037 for your types at runtime.  This customized serializer then gets
1038 dynamically loaded into your application.
1040 You can control this with the MONO_XMLSERIALIZER_THS environment
1041 variable.
1043 The possible values are 
1044 .B `no' 
1045 to disable the use of a C# customized
1046 serializer, or an integer that is the minimum number of uses before
1047 the runtime will produce a custom serializer (0 will produce a
1048 custom serializer on the first access, 50 will produce a serializer on
1049 the 50th use). Mono will fallback to an interpreted serializer if the
1050 serializer generation somehow fails. This behavior can be disabled
1051 by setting the option
1052 .B `nofallback'
1053 (for example: MONO_XMLSERIALIZER_THS=0,nofallback).
1054 .SH ENVIRONMENT VARIABLES
1056 \fBGC_DONT_GC\fR
1057 Turns off the garbage collection in Mono.  This should be only used
1058 for debugging purposes
1060 \fBMONO_AOT_CACHE\fR
1061 If set, this variable will instruct Mono to ahead-of-time compile new
1062 assemblies on demand and store the result into a cache in
1063 ~/.mono/aot-cache. 
1065 \fBMONO_CFG_DIR\fR
1066 If set, this variable overrides the default system configuration directory
1067 ($PREFIX/etc). It's used to locate machine.config file.
1069 \fBMONO_COM\fR
1070 Sets the style of COM interop.  If the value of this variable is "MS"
1071 Mono will use string marhsalling routines from the liboleaut32 for the
1072 BSTR type library, any other values will use the mono-builtin BSTR
1073 string marshalling.
1075 \fBMONO_CONFIG\fR
1076 If set, this variable overrides the default runtime configuration file
1077 ($PREFIX/etc/mono/config). The --config command line options overrides the
1078 environment variable.
1080 \fBMONO_DEBUG\fR
1081 If set, enables some features of the runtime useful for debugging.
1082 This variable should contain a comma separated list of debugging options.
1083 Currently, the following options are supported:
1085 .ne 8
1087 \fBbreak-on-unverified\fR
1088 If this variable is set, when the Mono VM runs into a verification
1089 problem, instead of throwing an exception it will break into the
1090 debugger.  This is useful when debugging verifier problems
1092 \fBcollect-pagefault-stats\fR
1093 Collects information about pagefaults.   This is used internally to
1094 track the number of page faults produced to load metadata.  To display
1095 this information you must use this option with "--stats" command line
1096 option.
1098 \fBdont-free-domains\fR
1099 This is an Optimization for multi-AppDomain applications (most
1100 commonly ASP.NET applications).  Due to internal limitations Mono,
1101 Mono by default does not use typed allocations on multi-appDomain
1102 applications as they could leak memory when a domain is unloaded. 
1104 Although this is a fine default, for applications that use more than
1105 on AppDomain heavily (for example, ASP.NET applications) it is worth
1106 trading off the small leaks for the increased performance
1107 (additionally, since ASP.NET applications are not likely going to
1108 unload the application domains on production systems, it is worth
1109 using this feature). 
1111 \fBhandle-sigint\fR
1112 Captures the interrupt signal (Control-C) and displays a stack trace
1113 when pressed.  Useful to find out where the program is executing at a
1114 given point.  This only displays the stack trace of a single thread. 
1116 \fBkeep-delegates\fR
1117 This option will leak delegate trampolines that are no longer
1118 referenced as to present the user with more information about a
1119 delegate misuse.  Basically a delegate instance might be created,
1120 passed to unmanaged code, and no references kept in managed code,
1121 which will garbage collect the code.  With this option it is possible
1122 to track down the source of the problems. 
1124 \fBno-gdb-backtrace\fR
1125 This option will disable the GDB backtrace emitted by the runtime
1126 after a SIGSEGV or SIGABRT in unmanaged code.
1128 \fBsuspend-on-sigsegv\fR
1130 This option will suspend the program when a native SIGSEGV is received.
1131 This is useful for debugging crashes which do not happen under gdb,
1132 since a live process contains more information than a core file.
1136 \fBMONO_DISABLE_AIO\fR
1137 If set, tells mono NOT to attempt using native asynchronous I/O services. In
1138 that case, a default select/poll implementation is used. Currently only epoll()
1139 is supported.
1141 \fBMONO_DISABLE_MANAGED_COLLATION\fR
1142 If this environment variable is `yes', the runtime uses unmanaged
1143 collation (which actually means no culture-sensitive collation). It
1144 internally disables managed collation functionality invoked via the
1145 members of System.Globalization.CompareInfo class. Collation is
1146 enabled by default.
1148 \fBMONO_EGD_SOCKET\fR
1149 For platforms that do not otherwise have a way of obtaining random bytes
1150 this can be set to the name of a file system socket on which an egd or
1151 prngd daemon is listening.
1153 \fBMONO_EVENTLOG_TYPE\fR
1154 Sets the type of event log provider to use (for System.Diagnostics.EventLog).
1156 Possible values are:
1159 .I "local[:path]"
1161 Persists event logs and entries to the local file system.
1163 The directory in which to persist the event logs, event sources and entries
1164 can be specified as part of the value.
1166 If the path is not explicitly set, it defaults to "/var/lib/mono/eventlog"
1167 on unix and "%APPDATA%\mono\eventlog" on Windows.
1169 .I "win32"
1171 .B 
1172 Uses the native win32 API to write events and registers event logs and
1173 event sources in the registry.   This is only available on Windows. 
1175 On Unix, the directory permission for individual event log and event source
1176 directories is set to 777 (with +t bit) allowing everyone to read and write
1177 event log entries while only allowing entries to be deleted by the user(s)
1178 that created them.
1180 .I "null"
1182 Silently discards any events.
1185 The default is "null" on Unix (and versions of Windows before NT), and 
1186 "win32" on Windows NT (and higher).
1189 \fBMONO_EXTERNAL_ENCODINGS\fR
1190 If set, contains a colon-separated list of text encodings to try when
1191 turning externally-generated text (e.g. command-line arguments or
1192 filenames) into Unicode.  The encoding names come from the list
1193 provided by iconv, and the special case "default_locale" which refers
1194 to the current locale's default encoding.
1196 When reading externally-generated text strings UTF-8 is tried first,
1197 and then this list is tried in order with the first successful
1198 conversion ending the search.  When writing external text (e.g. new
1199 filenames or arguments to new processes) the first item in this list
1200 is used, or UTF-8 if the environment variable is not set.
1202 The problem with using MONO_EXTERNAL_ENCODINGS to process your
1203 files is that it results in a problem: although its possible to get
1204 the right file name it is not necessarily possible to open the file.
1205 In general if you have problems with encodings in your filenames you
1206 should use the "convmv" program.
1208 \fBMONO_GAC_PREFIX\fR
1209 Provides a prefix the runtime uses to look for Global Assembly Caches.
1210 Directories are separated by the platform path separator (colons on
1211 unix). MONO_GAC_PREFIX should point to the top directory of a prefixed
1212 install. Or to the directory provided in the gacutil /gacdir command. Example:
1213 .B /home/username/.mono:/usr/local/mono/
1215 \fBMONO_IOMAP\fR
1216 Enables some filename rewriting support to assist badly-written
1217 applications that hard-code Windows paths.  Set to a colon-separated
1218 list of "drive" to strip drive letters, or "case" to do
1219 case-insensitive file matching in every directory in a path.  "all"
1220 enables all rewriting methods.  (Backslashes are always mapped to
1221 slashes if this variable is set to a valid option.)
1224 For example, this would work from the shell:
1227         MONO_IOMAP=drive:case
1228         export MONO_IOMAP
1231 If you are using mod_mono to host your web applications, you can use
1232 the 
1233 .B MonoSetEnv
1234 directive, like this:
1237         MonoSetEnv MONO_IOMAP=all
1241 \fBMONO_MANAGED_WATCHER\fR
1242 If set to "disabled", System.IO.FileSystemWatcher will use a file watcher 
1243 implementation which silently ignores all the watching requests.
1244 If set to any other value, System.IO.FileSystemWatcher will use the default
1245 managed implementation (slow). If unset, mono will try to use inotify, FAM, 
1246 Gamin, kevent under Unix systems and native API calls on Windows, falling 
1247 back to the managed implementation on error.
1249 \fBMONO_NO_SMP\fR
1250 If set causes the mono process to be bound to a single processor. This may be
1251 useful when debugging or working around race conditions.
1253 \fBMONO_PATH\fR
1254 Provides a search path to the runtime where to look for library
1255 files.   This is a tool convenient for debugging applications, but
1256 should not be used by deployed applications as it breaks the assembly
1257 loader in subtle ways. 
1259 Directories are separated by the platform path separator (colons on unix). Example:
1260 .B /home/username/lib:/usr/local/mono/lib
1262 Alternative solutions to MONO_PATH include: installing libraries into
1263 the Global Assembly Cache (see gacutil(1)) or having the dependent
1264 libraries side-by-side with the main executable.
1266 For a complete description of recommended practices for application
1267 deployment, see the
1268 http://www.mono-project.com/Guidelines:Application_Deployment page. 
1270 \fBMONO_RTC\fR
1271 Experimental RTC support in the statistical profiler: if the user has
1272 the permission, more accurate statistics are gathered.  The MONO_RTC
1273 value must be restricted to what the Linux rtc allows: power of two
1274 from 64 to 8192 Hz. To enable higher frequencies like 4096 Hz, run as root:
1277         echo 4096 > /proc/sys/dev/rtc/max-user-freq
1281 For example:
1284         MONO_RTC=4096 mono --profiler=default:stat program.exe
1288 \fBMONO_NO_TLS\fR
1289 Disable inlining of thread local accesses. Try setting this if you get a segfault
1290 early on in the execution of mono.
1291 .TP 
1292 \fBMONO_SHARED_DIR\fR
1293 If set its the directory where the ".wapi" handle state is stored.
1294 This is the directory where the Windows I/O Emulation layer stores its
1295 shared state data (files, events, mutexes, pipes).  By default Mono
1296 will store the ".wapi" directory in the users's home directory.
1297 .TP 
1298 \fBMONO_SHARED_HOSTNAME\fR
1299 Uses the string value of this variable as a replacement for the host name when
1300 creating file names in the ".wapi" directory. This helps if the host name of
1301 your machine is likely to be changed when a mono application is running or if
1302 you have a .wapi directory shared among several different computers.
1304 Mono typically uses the hostname to create the files that are used to
1305 share state across multiple Mono processes.  This is done to support
1306 home directories that might be shared over the network.
1308 \fBMONO_STRICT_IO_EMULATION\fR
1309 If set, extra checks are made during IO operations.  Currently, this
1310 includes only advisory locks around file writes.
1312 \fBMONO_DISABLE_SHM\fR
1313 If set, disables the shared memory files used for cross-process
1314 handles: process have only private handles.  This means that process
1315 and thread handles are not available to other processes, and named
1316 mutexes, named events and named semaphores are not visible between
1317 processes.
1319 This is can also be enabled by default by passing the
1320 "--disable-shared-handles" option to configure.
1322 \fBMONO_THEME\fR
1323 The name of the theme to be used by Windows.Forms.   Available themes today
1324 include "clearlooks", "nice" and "win32".
1326 The default is "win32".  
1328 \fBMONO_TLS_SESSION_CACHE_TIMEOUT\fR
1329 The time, in seconds, that the SSL/TLS session cache will keep it's entry to
1330 avoid a new negotiation between the client and a server. Negotiation are very
1331 CPU intensive so an application-specific custom value may prove useful for 
1332 small embedded systems.
1334 The default is 180 seconds.
1336 \fBMONO_THREADS_PER_CPU\fR
1337 The maximum number of threads in the general threadpool will be
1338 20 + (MONO_THREADS_PER_CPU * number of CPUs). The default value for this
1339 variable is 10.
1341 \fBMONO_XMLSERIALIZER_THS\fR
1342 Controls the threshold for the XmlSerializer to produce a custom
1343 serializer for a given class instead of using the Reflection-based
1344 interpreter.  The possible values are `no' to disable the use of a
1345 custom serializer or a number to indicate when the XmlSerializer
1346 should start serializing.   The default value is 50, which means that
1347 the a custom serializer will be produced on the 50th use.
1349 \fBMONO_XMLSERIALIZER_DEBUG\fR
1350 Set this value to 1 to prevent the serializer from removing the
1351 temporary files that are created for fast serialization;  This might
1352 be useful when debugging.
1354 \fBMONO_ASPNET_INHIBIT_SETTINGSMAP\fR
1355 Mono contains a feature which allows modifying settings in the .config files shipped
1356 with Mono by using config section mappers. The mappers and the mapping rules are
1357 defined in the $prefix/etc/mono/2.0/settings.map file and, optionally, in the
1358 settings.map file found in the top-level directory of your ASP.NET application.
1359 Both files are read by System.Web on application startup, if they are found at the
1360 above locations. If you don't want the mapping to be performed you can set this
1361 variable in your environment before starting the application and no action will
1362 be taken.
1364 \fBMONO_MESSAGING_PROVIDER\fR
1365 Mono supports a plugin model for its implementation of System.Messaging making
1366 it possible to support a variety of messaging implementations (e.g. AMQP, ActiveMQ).
1367 To specify which messaging implementation is to be used the evironement variable
1368 needs to be set to the full class name for the provider.  E.g. to use the RabbitMQ based
1369 AMQP implementation the variable should be set to:
1372 Mono.Messaging.RabbitMQ.RabbitMQMessagingProvider,Mono.Messaging.RabbitMQ
1373 .SH ENVIRONMENT VARIABLES FOR DEBUGGING
1375 \fBMONO_ASPNET_NODELETE\fR
1376 If set to any value, temporary source files generated by ASP.NET support
1377 classes will not be removed. They will be kept in the user's temporary
1378 directory.
1380 \fBMONO_LOG_LEVEL\fR
1381 The logging level, possible values are `error', `critical', `warning',
1382 `message', `info' and `debug'.  See the DEBUGGING section for more
1383 details.
1385 \fBMONO_LOG_MASK\fR
1386 Controls the domain of the Mono runtime that logging will apply to. 
1387 If set, the log mask is changed to the set value. Possible values are
1388 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
1389 (garbage collector), "cfg" (config file loader), "aot" (precompiler) and "all". 
1390 The default value is "all". Changing the mask value allows you to display only 
1391 messages for a certain component. You can use multiple masks by comma 
1392 separating them. For example to see config file messages and assembly loader
1393 messages set you mask to "asm,cfg".
1395 \fBMONO_TRACE\fR
1396 Used for runtime tracing of method calls. The format of the comma separated
1397 trace options is:
1400         [-]M:method name
1401         [-]N:namespace
1402         [-]T:class name
1403         [-]all
1404         [-]program
1405         disabled                Trace output off upon start.
1408 You can toggle trace output on/off sending a SIGUSR2 signal to the program.
1410 \fBMONO_TRACE_LISTENER\fR
1411 If set, enables the System.Diagnostics.DefaultTraceListener, which will 
1412 print the output of the System.Diagnostics Trace and Debug classes.  
1413 It can be set to a filename, and to Console.Out or Console.Error to display
1414 output to standard output or standard error, respectively. If it's set to
1415 Console.Out or Console.Error you can append an optional prefix that will
1416 be used when writing messages like this: Console.Error:MyProgramName.
1417 See the System.Diagnostics.DefaultTraceListener documentation for more
1418 information.
1420 \fBMONO_XEXCEPTIONS\fR
1421 This throws an exception when a X11 error is encountered; by default a
1422 message is displayed but execution continues
1424 \fBMONO_XSYNC\fR
1425 This is used in the System.Windows.Forms implementation when running
1426 with the X11 backend.  This is used to debug problems in Windows.Forms
1427 as it forces all of the commands send to X11 server to be done
1428 synchronously.   The default mode of operation is asynchronous which
1429 makes it hard to isolate the root of certain problems.
1431 \fBMONO_GENERIC_SHARING\fR
1432 This environment variable controls the kind of generic sharing used.
1433 This variable is used by internal JIT developers and should not be
1434 changed in production.  Do not use it.
1436 The variable controls which classes will have generic code sharing
1437 enabled.
1439 Permissible values are:
1441 .TP 
1442 .I "all" 
1443 All generated code can be shared. 
1445 .I "collections" 
1446 Only the classes in System.Collections.Generic will have its code
1447 shared (this is the default value).
1449 .I "corlib"
1450 Only code in corlib will have its code shared.
1452 .I "none"
1453 No generic code sharing will be performed.
1456 Generic code sharing by default only applies to collections.   The
1457 Mono JIT by default turns this on.
1459 \fBMONO_XDEBUG\fR
1460 When the the MONO_XDEBUG env var is set, debugging info for JITted
1461 code is emitted into a shared library, loadable into gdb. This enables,
1462 for example, to see managed frame names on gdb backtraces.
1464 \fBMONO_VERBOSE_METHOD\fR
1465 Enables the maximum JIT verbosity for the specified method. This is
1466 very helpfull to diagnose a miscompilation problems of a specific
1467 method.
1468 .SH VALGRIND
1469 If you want to use Valgrind, you will find the file `mono.supp'
1470 useful, it contains the suppressions for the GC which trigger
1471 incorrect warnings.  Use it like this:
1473     valgrind --suppressions=mono.supp mono ...
1475 .SH DTRACE
1476 On some platforms, Mono can expose a set of DTrace probes (also known
1477 as user-land statically defined, USDT Probes).
1479 They are defined in the file `mono.d'.
1481 .B ves-init-begin, ves-init-end
1483 Begin and end of runtime initialization.
1485 .B method-compile-begin, method-compile-end
1487 Begin and end of method compilation.
1488 The probe arguments are class name, method name and signature,
1489 and in case of method-compile-end success or failure of compilation.
1491 .B gc-begin, gc-end
1493 Begin and end of Garbage Collection.
1495 To verify the availability of the probes, run:
1497     dtrace -P mono'$target' -l -c mono
1499 .SH FILES
1500 On Unix assemblies are loaded from the installation lib directory.  If you set
1501 `prefix' to /usr, the assemblies will be located in /usr/lib.  On
1502 Windows, the assemblies are loaded from the directory where mono and
1503 mint live.
1505 .B ~/.mono/aot-cache
1507 The directory for the ahead-of-time compiler demand creation
1508 assemblies are located. 
1510 .B /etc/mono/config, ~/.mono/config
1512 Mono runtime configuration file.  See the mono-config(5) manual page
1513 for more information.
1515 .B ~/.config/.mono/certs, /usr/share/.mono/certs
1517 Contains Mono certificate stores for users / machine. See the certmgr(1) 
1518 manual page for more information on managing certificate stores and
1519 the mozroots(1) page for information on how to import the Mozilla root
1520 certificates into the Mono certificate store. 
1522 .B ~/.mono/assemblies/ASSEMBLY/ASSEMBLY.config
1524 Files in this directory allow a user to customize the configuration
1525 for a given system assembly, the format is the one described in the
1526 mono-config(5) page. 
1528 .B ~/.config/.mono/keypairs, /usr/share/.mono/keypairs
1530 Contains Mono cryptographic keypairs for users / machine. They can be 
1531 accessed by using a CspParameters object with DSACryptoServiceProvider
1532 and RSACryptoServiceProvider classes.
1534 .B ~/.config/.isolatedstorage, ~/.local/share/.isolatedstorage, /usr/share/.isolatedstorage
1536 Contains Mono isolated storage for non-roaming users, roaming users and 
1537 local machine. Isolated storage can be accessed using the classes from 
1538 the System.IO.IsolatedStorage namespace.
1540 .B <assembly>.config
1542 Configuration information for individual assemblies is loaded by the
1543 runtime from side-by-side files with the .config files, see the
1544 http://www.mono-project.com/Config for more information.
1546 .B Web.config, web.config
1548 ASP.NET applications are configured through these files, the
1549 configuration is done on a per-directory basis.  For more information
1550 on this subject see the http://www.mono-project.com/Config_system.web
1551 page. 
1552 .SH MAILING LISTS
1553 Mailing lists are listed at the
1554 http://www.mono-project.com/Mailing_Lists
1555 .SH WEB SITE
1556 http://www.mono-project.com
1557 .SH SEE ALSO
1559 certmgr(1), csharp(1), mcs(1), mdb(1), monocov(1), monodis(1),
1560 mono-config(5), mozroots(1), pdb2mdb(1), xsp(1).
1562 For more information on AOT:
1563 http://www.mono-project.com/AOT
1565 For ASP.NET-related documentation, see the xsp(1) manual page