update known-issues
[mono.git] / man / mono.1
1 .\" 
2 .\" mono manual page.
3 .\" (C) 2003 Ximian, Inc. 
4 .\" (C) 2004-2005 Novell, Inc. 
5 .\" Author:
6 .\"   Miguel de Icaza (miguel@gnu.org)
7 .\"
8 .de Sp \" Vertical space (when we can't use .PP)
9 .if t .sp .5v
10 .if n .sp
11 ..
12 .TH Mono "Mono 1.0"
13 .SH NAME
14 mono \- Mono's ECMA-CLI native code generator (Just-in-Time and Ahead-of-Time)
15 .SH SYNOPSIS
16 .PP
17 .B mono [options] file [arguments...]
18 .SH DESCRIPTION
19 \fImono\fP is a runtime implementation of the ECMA Common Language
20 Infrastructure.  This can be used to run ECMA and .NET applications.
21 .PP
22 The runtime contains a native code generator that transforms the
23 Common Intermediate Language into native code.
24 .PP
25 The code generator can operate in two modes: just in time compilation
26 (JIT) or ahead of time compilation (AOT).  Since code can be
27 dynamically loaded, the runtime environment and the JIT are always
28 present, even if code is compiled ahead of time.
29 .PP
30 The runtime loads the specified
31 .I file
32 and optionally passes
33 the
34 .I arguments
35 to it.  The 
36 .I file
37 is an ECMA assembly.  They typically have a .exe or .dll extension.
38 .PP
39 The runtime provides a number of configuration options for running
40 applications, for developing and debugging, and for testing and
41 debugging the runtime itself.
42 .SH PORTABILITY
43 On Unix-based systems, Mono provides a mechanism to emulate the 
44 Windows-style file access, this includes providing a case insensitive
45 view of the file system, directory separator mapping (from \\ to /) and
46 stripping the drive letters.
47 .PP
48 This functionality is enabled by setting the 
49 .B MONO_IOMAP 
50 environment variable to one of 
51 .B all, drive
52 and 
53 .B case.
54 .PP
55 See the description for 
56 .B MONO_IOMAP
57 in the environment variables section for more details.
58 .SH RUNTIME OPTIONS
59 The following options are available:
60 .TP
61 .I "--aot"
62 This option is used to precompile the CIL code in the specified
63 assembly to native code.  The generated code is stored in a file with
64 the extension .so.  This file will be automatically picked up by the
65 runtime when the assembly is executed.  
66 .Sp 
67 Ahead-of-Time compilation is most useful if you use it in combination
68 with the -O=all,-shared flag which enables all of the optimizations in
69 the code generator to be performed.  Some of those optimizations are
70 not practical for Just-in-Time compilation since they might be very
71 time consuming.
72 .Sp
73 Unlike the .NET Framework, Ahead-of-Time compilation will not generate
74 domain independent code: it generates the same code that the
75 Just-in-Time compiler would produce.   Since most applications use a
76 single domain, this is fine.   If you want to optimize the generated
77 code for use in multi-domain applications, consider using the
78 -O=shared flag.
79 .Sp
80 This pre-compiles the methods, but the original assembly is still
81 required to execute as this one contains the metadata and exception
82 information which is not available on the generated file.  When
83 precompiling code, you might want to compile with all optimizations
84 (-O=all).  Pre-compiled code is position independent code.
85 .Sp
86 Pre compilation is just a mechanism to reduce startup time, increase
87 code sharing across multiple mono processes and avoid just-in-time
88 compilation program startup costs.  The original assembly must still
89 be present, as the metadata is contained there.
90 .Sp
91 For more information about AOT, see: http://www.mono-project.com/AOT
92 .TP
93 .I "--config filename"
94 Load the specified configuration file instead of the default one(s).
95 The default files are /etc/mono/config and ~/.mono/config or the file
96 specified in the MONO_CONFIG environment variable, if set.  See the
97 mono-config(5) man page for details on the format of this file.
98 .TP
99 .I "--desktop"
100 Configures the virtual machine to be better suited for desktop
101 applications.  Currently this sets the GC system to avoid expanding
102 the heap as much as possible at the expense of slowing down garbage
103 collection a bit.
104 .TP
105 .I "--help", "-h"
106 Displays usage instructions.
107 .TP
108 .I "--optimize=MODE", "-O=MODE"
109 MODE is a comma separated list of optimizations.  They also allow
110 optimizations to be turned off by prefixing the optimization name with
111 a minus sign.
112 .Sp
113 The following optimizations are implemented:
114 .nf
115              all        Turn on all optimizations
116              peephole   Peephole postpass
117              branch     Branch optimizations
118              inline     Inline method calls
119              cfold      Constant folding
120              consprop   Constant propagation
121              copyprop   Copy propagation
122              deadce     Dead code elimination
123              linears    Linear scan global reg allocation
124              cmov       Conditional moves
125              shared     Emit per-domain code
126              sched      Instruction scheduling
127              intrins    Intrinsic method implementations
128              tailc      Tail recursion and tail calls
129              loop       Loop related optimizations
130              fcmov      Fast x86 FP compares
131              leaf       Leaf procedures optimizations
132              aot        Usage of Ahead Of Time compiled code
133              precomp    Precompile all methods before executing Main
134              abcrem     Array bound checks removal
135              ssapre     SSA based Partial Redundancy Elimination
136              sse2       SSE2 instructions on x86
137 .fi
138 .Sp
139 For example, to enable all the optimization but dead code
140 elimination and inlining, you can use:
141 .nf
142         -O=all,-deadce,-inline
143 .fi
144 .TP
145 .I "--runtime=VERSION"
146 Mono supports different runtime versions. The version used depends on the program
147 that is being run or on its configuration file (named program.exe.config). This option
148 can be used to override such autodetection, by forcing a different runtime version
149 to be used. Note that this should only be used to select a later compatible runtime
150 version than the one the program was compiled against. A typical usage is for
151 running a 1.1 program on a 2.0 version:
152 .nf
153          mono --runtime=v2.0.50727 program.exe
154 .fi
155 .TP
156 .I "--security"
157 Activate the security manager (experimental feature in 1.1). This allows 
158 mono to support declarative security attributes (e.g. execution of, CAS 
159 or non-CAS, security demands). The security manager is OFF by default 
160 (experimental).
161 .TP
162 .I "--server"
163 Configures the virtual machine to be better suited for server
164 operations.  
165 .TP
166 .I "-V", "--version"
167 Prints JIT version information.
168
169
170 .SH DEVELOPMENT OPTIONS
171 The following options are used to help when developing a JITed application.
172 .TP
173 .I "--debug"
174 Turns on the debugging mode in the runtime.  If an assembly was
175 compiled with debugging information, it will produce line number
176 information for stack traces. 
177 .TP
178 .I "--profile[=profiler[:profiler_args]]"
179 Turns on profiling.  For more information about profiling applications
180 and code coverage see the sections "PROFILING" and "CODE COVERAGE"
181 below. 
182 .TP
183 .I "--trace[=expression]"
184 Shows method names as they are invoked.  By default all methods are
185 traced. 
186 .Sp
187 The trace can be customized to include or exclude methods, classes or
188 assemblies.  A trace expression is a comma separated list of targets,
189 each target can be prefixed with a minus sign to turn off a particular
190 target.  The words `program', `all' and `disabled' have special
191 meaning.  `program' refers to the main program being executed, and
192 `all' means all the method calls.
193 .Sp
194 The `disabled' option is used to start up with tracing disabled.  It
195 can be enabled at a later point in time in the program by sending the
196 SIGUSR2 signal to the runtime.
197 .Sp
198 Assemblies are specified by their name, for example, to trace all
199 calls in the System assembly, use:
200 .nf
201
202         mono --trace=System app.exe
203
204 .fi
205 Classes are specified with the T: prefix.  For example, to trace all
206 calls to the System.String class, use:
207 .nf
208
209         mono --trace=T:System.String app.exe
210
211 .fi
212 And individual methods are referenced with the M: prefix, and the
213 standard method notation:
214 .nf
215
216         mono --trace=M:System.Console:WriteLine app.exe
217
218 .fi
219 As previously noted, various rules can be specified at once:
220 .nf
221
222         mono --trace=T:System.String,T:System.Random app.exe
223
224 .fi
225 You can exclude pieces, the next example traces calls to
226 System.String except for the System.String:Concat method.
227 .nf
228
229         mono --trace=T:System.String,-M:System.String:Concat
230
231 .fi
232 Finally, namespaces can be specified using the N: prefix:
233 .nf
234
235         mono --trace=N:System.Xml
236
237 .fi
238 .SH JIT MAINTAINER OPTIONS
239 The maintainer options are only used by those developing the runtime
240 itself, and not typically of interest to runtime users or developers.
241 .TP
242 .I "--break method"
243 Inserts a breakpoint before the method whose name is `method'
244 (namespace.class:methodname).  Use `Main' as method name to insert a
245 breakpoint on the application's main method.
246 .TP
247 .I "--breakonex"
248 Inserts a breakpoint on exceptions.  This allows you to debug your
249 application with a native debugger when an exception is thrown.
250 .TP
251 .I "--compile name"
252 This compiles a method (namespace.name:methodname), this is used for
253 testing the compiler performance or to examine the output of the code
254 generator. 
255 .TP
256 .I "--compileall"
257 Compiles all the methods in an assembly.  This is used to test the
258 compiler performance or to examine the output of the code generator
259 .TP 
260 .I "--graph=TYPE METHOD"
261 This generates a postscript file with a graph with the details about
262 the specified method (namespace.name:methodname).  This requires `dot'
263 and ghostview to be installed (it expects Ghostview to be called
264 "gv"). 
265 .Sp
266 The following graphs are available:
267 .nf
268           cfg        Control Flow Graph (CFG)
269           dtree      Dominator Tree
270           code       CFG showing code
271           ssa        CFG showing code after SSA translation
272           optcode    CFG showing code after IR optimizations
273 .fi
274 .Sp
275 Some graphs will only be available if certain optimizations are turned
276 on.
277 .TP
278 .I "--ncompile"
279 Instruct the runtime on the number of times that the method specified
280 by --compile (or all the methods if --compileall is used) to be
281 compiled.  This is used for testing the code generator performance. 
282 .TP 
283 .I "--stats"
284 Displays information about the work done by the runtime during the
285 execution of an application. 
286 .TP
287 .I "--wapi=hps|semdel"
288 Perform maintenance of the process shared data.
289 .Sp
290 semdel will delete the global semaphore.
291 .Sp
292 hps will list the currently used handles.
293 .TP
294 .I "-v", "--verbose"
295 Increases the verbosity level, each time it is listed, increases the
296 verbosity level to include more information (including, for example, 
297 a disassembly of the native code produced, code selector info etc.).
298 .SH PROFILING
299 The mono runtime includes a profiler that can be used to explore
300 various performance related problems in your application.  The
301 profiler is activated by passing the --profile command line argument
302 to the Mono runtime, the format is:
303 .nf
304
305         --profile[=profiler[:profiler_args]]
306
307 .fi
308 Mono has a built-in profiler called 'default' (and is also the default
309 if no arguments are specified), but developers can write custom
310 profilers, see the section "CUSTOM PROFILERS" for more details.
311 .PP
312 If a 
313 .I profiler 
314 is not specified, the default profiler is used.
315 .Sp
316 The 
317 .I profiler_args 
318 is a profiler-specific string of options for the profiler itself.
319 .Sp
320 The default profiler accepts the following options 'alloc' to profile
321 memory consumption by the application; 'time' to profile the time
322 spent on each routine; 'jit' to collect time spent JIT-compiling methods
323 and 'stat' to perform sample statistical profiling.
324 If no options are provided the default is 'alloc,time,jit'. 
325 .PP
326 By default the
327 profile data is printed to stdout: to change this, use the 'file=filename'
328 option to output the data to filename.
329 .Sp
330 For example:
331 .nf
332
333         mono --profile program.exe
334
335 .fi
336 .Sp
337 That will run the program with the default profiler and will do time
338 and allocation profiling.
339 .Sp
340 .nf
341
342         mono --profile=default:stat,alloc,file=prof.out program.exe
343
344 .fi
345 Will do  sample statistical profiling and allocation profiling on
346 program.exe. The profile data is put in prof.out.
347 .Sp
348 Note that the statistical profiler has a very low overhead and should
349 be the preferred profiler to use (for better output use the full path
350 to the mono binary when running and make sure you have installed the
351 addr2line utility that comes from the binutils package).
352 .SH PROFILERS
353 There are a number of external profilers that have been developed for
354 Mono, we will update this section to contain the profilers.
355 .PP
356 The heap Shot profiler can track all live objects, and references to
357 these objects, and includes a GUI tool, this is our recommended
358 profiler.
359 To install you must download the profiler
360 from Mono's SVN:
361 .nf
362         svn co svn://svn.myrealbox.com/source/trunk/heap-shot
363         cd heap-shot
364         ./autogen
365         make
366         make install
367 .fi
368 .PP
369 See the included documentation for details on using it.
370 .PP
371 The Live Type profiler shows at every GC iteration all of the live
372 objects of a given type.   To install you must download the profiler
373 from Mono's SVN:
374 .nf
375         svn co svn://svn.myrealbox.com/source/trunk/heap-prof
376         cd heap-prof
377         ./autogen
378         make
379         make install
380 .fi
381 .PP
382 To use the profiler, execute:
383 .nf
384         mono --profile=desc-heap program.exe
385 .fi
386 .PP
387 The output of this profiler looks like this:
388 .nf
389         Checkpoint at 102 for heap-resize
390            System.MonoType : 708
391            System.Threading.Thread : 352
392            System.String : 3230
393            System.String[] : 104
394            Gnome.ModuleInfo : 112
395            System.Object[] : 160
396            System.Collections.Hashtable : 96
397            System.Int32[] : 212
398            System.Collections.Hashtable+Slot[] : 296
399            System.Globalization.CultureInfo : 108
400            System.Globalization.NumberFormatInfo : 144
401 .fi
402 .PP
403 The first line describes the iteration number for the GC, in this case
404 checkpoint 102.
405 .PP
406 Then on each line the type is displayed as well as the number of bytes
407 that are being consumed by live instances of this object.
408 .PP 
409 The AOT profiler is used to feed back information to the AOT compiler
410 about how to order code based on the access patterns for pages.  To
411 use it, use:
412 .nf
413         mono --profile=aot program.exe
414 .fi
415 The output of this profile can be fed back into Mono's AOT compiler to
416 order the functions on the disk to produce precompiled images that
417 have methods in sequential pages.
418 .SH CUSTOM PROFILERS
419 Mono provides a mechanism for loading other profiling modules which in
420 the form of shared libraries.  These profiling modules can hook up to
421 various parts of the Mono runtime to gather information about the code
422 being executed.
423 .PP
424 To use a third party profiler you must pass the name of the profiler
425 to Mono, like this:
426 .nf
427
428         mono --profile=custom program.exe
429
430 .fi
431 .PP
432 In the above sample Mono will load the user defined profiler from the
433 shared library `mono-profiler-custom.so'.  This profiler module must
434 be on your dynamic linker library path.
435 .PP 
436 A list of other third party profilers is available from Mono's web
437 site (www.mono-project.com/Performance_Tips)
438 .PP
439 Custom profiles are written as shared libraries.  The shared library
440 must be called `mono-profiler-NAME.so' where `NAME' is the name of
441 your profiler.
442 .PP
443 For a sample of how to write your own custom profiler look in the
444 Mono source tree for in the samples/profiler.c.
445 .SH CODE COVERAGE
446 Mono ships with a code coverage module.  This module is activated by
447 using the Mono --profile=cov option.  The format is:
448 .I "--profile=cov[:assembly-name[/namespace]] test-suite.exe"
449 .PP
450 By default code coverage will default to all the assemblies loaded,
451 you can limit this by specifying the assembly name, for example to
452 perform code coverage in the routines of your program use, for example
453 the following command line limits the code coverage to routines in the
454 "demo" assembly:
455 .nf
456
457         mono --profile=cov:demo demo.exe
458
459 .fi
460 .PP
461 Notice that the 
462 .I assembly-name
463 does not include the extension.
464 .PP
465 You can further restrict the code coverage output by specifying a
466 namespace:
467 .nf
468
469         mono --profile=cov:demo/My.Utilities demo.exe
470
471 .fi
472 .PP
473 Which will only perform code coverage in the given assembly and
474 namespace.  
475 .PP
476 Typical output looks like this:
477 .nf
478
479         Not covered: Class:.ctor ()
480         Not covered: Class:A ()
481         Not covered: Driver:.ctor ()
482         Not covered: Driver:method ()
483         Partial coverage: Driver:Main ()
484                 offset 0x000a
485
486 .fi
487 .PP
488 The offsets displayed are IL offsets.
489 .PP
490 A more powerful coverage tool is available in the module `monocov'.
491 See the monocov(1) man page for details.
492 .SH DEBUGGING
493 It is possible to obtain a stack trace of all the active threads in
494 Mono by sending the QUIT signal to Mono, you can do this from the
495 command line, like this:
496 .nf
497
498         kill -QUIT pid
499
500 .fi
501 Where pid is the Process ID of the Mono process you want to examine.
502 The process will continue running afterwards, but its state is not
503 guaranteed.
504 .PP
505 .B Important:
506 this is a last-resort mechanism for debugging applications and should
507 not be used to monitor or probe a production application.  The
508 integrity of the runtime after sending this signal is not guaranteed
509 and the application might crash or terminate at any given point
510 afterwards.   
511 .PP
512 You can use the MONO_LOG_LEVEL and MONO_LOG_MASK environment variables
513 to get verbose debugging output about the execution of your
514 application within Mono.
515 .PP
516 The 
517 .I MONO_LOG_LEVEL
518 environment variable if set, the logging level is changed to the set
519 value. Possible values are "error", "critical", "warning", "message",
520 "info", "debug". The default value is "error". Messages with a logging
521 level greater then or equal to the log level will be printed to
522 stdout/stderr.
523 .PP
524 Use "info" to track the dynamic loading of assemblies.
525 .PP
526 .PP
527 Use the 
528 .I MONO_LOG_MASK
529 environment variable to limit the extent of the messages you get: 
530 If set, the log mask is changed to the set value. Possible values are
531 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
532 (garbage collector), "cfg" (config file loader), "aot" (precompiler) and "all". 
533 The default value is "all". Changing the mask value allows you to display only 
534 messages for a certain component. You can use multiple masks by comma 
535 separating them. For example to see config file messages and assembly loader
536 messages set you mask to "asm,cfg".
537 .PP
538 The following is a common use to track down problems with P/Invoke:
539 .nf
540
541         $ MONO_LOG_LEVEL="debug" MONO_LOG_MASK="dll" mono glue.exe
542
543 .fi
544 .PP
545 .SH SERIALIZATION
546 Mono's XML serialization engine by default will use a reflection-based
547 approach to serialize which might be slow for continuous processing
548 (web service applications).  The serialization engine will determine
549 when a class must use a hand-tuned serializer based on a few
550 parameters and if needed it will produce a customized C# serializer
551 for your types at runtime.  This customized serializer then gets
552 dynamically loaded into your application.
553 .PP
554 You can control this with the MONO_XMLSERIALIZER_THS environment
555 variable.
556 .PP
557 The possible values are 
558 .B `no' 
559 to disable the use of a C# customized
560 serializer, or an integer that is the minimum number of uses before
561 the runtime will produce a custom serializer (0 will produce a
562 custom serializer on the first access, 50 will produce a serializer on
563 the 50th use). Mono will fallback to an interpreted serializer if the
564 serializer generation somehow fails. This behavior can be disabled
565 by setting the option
566 .B `nofallback'
567 (for example: MONO_XMLSERIALIZER_THS=0,nofallback).
568 .SH ENVIRONMENT VARIABLES
569 .TP
570 .I "GC_DONT_GC"
571 Turns off the garbage collection in Mono.  This should be only used
572 for debugging purposes
573 .TP
574 .I "MONO_AOT_CACHE"
575 If set, this variable will instruct Mono to ahead-of-time compile new
576 assemblies on demand and store the result into a cache in
577 ~/.mono/aot-cache. 
578 .TP
579 .I "MONO_CFG_DIR"
580 If set, this variable overrides the default system configuration directory
581 ($PREFIX/etc). It's used to locate machine.config file.
582 .TP
583 .I "MONO_CONFIG"
584 If set, this variable overrides the default runtime configuration file
585 ($PREFIX/etc/mono/config). The --config command line options overrides the
586 environment variable.
587 .TP
588 .I "MONO_DEBUG"
589 If set, enables some features of the runtime useful for debugging.
590 This variable should contain a comma separated list of debugging options.
591 Currently, the following options are supported:
592 .RS
593 .ne 8
594 .TP
595 .I "collect-pagefault-stats"
596 Collects information about pagefaults.   This is used internally to
597 track the number of page faults produced to load metadata.  To display
598 this information you must use this option with "--stats" command line option.
599 .TP
600 .I "handle-sigint"
601 Captures the interrupt signal (Control-C) and displays a stack trace
602 when pressed.  Useful to find out where the program is executing at a
603 given point.  This only displays the stack trace of a single thread. 
604 .TP
605 .I "keep-delegates"
606 This option will leak delegate trampolines that are no longer
607 referenced as to present the user with more information about a
608 delegate misuse.  Basically a delegate instance might be created,
609 passed to unmanaged code, and no references kept in managed code,
610 which will garbage collect the code.  With this option it is possible
611 to track down the source of the problems. 
612 .TP
613 .I "break-on-unverified"
614 If this variable is set, when the Mono VM runs into a verification
615 problem, instead of throwing an exception it will break into the
616 debugger.  This is useful when debugging verifier problems
617 .ne
618 .RE
619 .TP
620 .I "MONO_DISABLE_AIO"
621 If set, tells mono NOT to attempt using native asynchronous I/O services. In
622 that case, a default select/poll implementation is used. Currently only epoll()
623 is supported.
624 .TP
625 .I "MONO_DISABLE_MANAGED_COLLATION"
626 If this environment variable is `yes', the runtime uses unmanaged
627 collation (which actually means no culture-sensitive collation). It
628 internally disables managed collation functionality invoked via the
629 members of System.Globalization.CompareInfo class. Collation is
630 enabled by default.
631 .TP
632 .I "MONO_EGD_SOCKET"
633 For platforms that do not otherwise have a way of obtaining random bytes
634 this can be set to the name of a file system socket on which an egd or
635 prngd daemon is listening.
636 .TP
637 .I "MONO_EVENTLOG_TYPE"
638 Sets the type of event log provider to use (for System.Diagnostics.EventLog).
639 .Sp
640 Possible values are:
641 .RS
642 .TP
643 .I "local[:path]"
644 .Sp
645 Persists event logs and entries to the local file system.
646 .Sp
647 The directory in which to persist the event logs, event sources and entries
648 can be specified as part of the value.
649 .Sp
650 If the path is not explicitly set, it defaults to "/var/lib/mono/eventlog"
651 on unix and "%APPDATA%\mono\eventlog" on Windows.
652 .TP
653 .I "win32"
654 .Sp
655 .B 
656 Uses the native win32 API to write events and registers event logs and
657 event sources in the registry.   This is only available on Windows. 
658 .Sp
659 On Unix, the directory permission for individual event log and event source
660 directories is set to 777 (with +t bit) allowing everyone to read and write
661 event log entries while only allowing entries to be deleted by the user(s)
662 that created them.
663 .TP
664 .I "null"
665 .Sp
666 Silently discards any events.
667 .ne
668 .PP
669 The default is "null" on Unix (and versions of Windows before NT), and 
670 "win32" on Windows NT (and higher).
671 .RE
672 .TP
673 .I "MONO_EXTERNAL_ENCODINGS"
674 If set, contains a colon-separated list of text encodings to try when
675 turning externally-generated text (e.g. command-line arguments or
676 filenames) into Unicode.  The encoding names come from the list
677 provided by iconv, and the special case "default_locale" which refers
678 to the current locale's default encoding.
679 .IP
680 When reading externally-generated text strings UTF-8 is tried first,
681 and then this list is tried in order with the first successful
682 conversion ending the search.  When writing external text (e.g. new
683 filenames or arguments to new processes) the first item in this list
684 is used, or UTF-8 if the environment variable is not set.
685 .IP
686 The problem with using MONO_EXTERNAL_ENCODINGS to process your
687 files is that it results in a problem: although its possible to get
688 the right file name it is not necessarily possible to open the file.
689 In general if you have problems with encodings in your filenames you
690 should use the "convmv" program.
691 .TP
692 .I "MONO_GAC_PREFIX"
693 Provides a prefix the runtime uses to look for Global Assembly Caches.
694 Directories are separated by the platform path separator (colons on
695 unix). MONO_GAC_PREFIX should point to the top directory of a prefixed
696 install. Or to the directory provided in the gacutil /gacdir command. Example:
697 .B /home/username/.mono:/usr/local/mono/
698 .TP
699 .I "MONO_IOMAP"
700 Enables some filename rewriting support to assist badly-written
701 applications that hard-code Windows paths.  Set to a colon-separated
702 list of "drive" to strip drive letters, or "case" to do
703 case-insensitive file matching in every directory in a path.  "all"
704 enables all rewriting methods.  (Backslashes are always mapped to
705 slashes if this variable is set to a valid option.)
706 .fi
707 .Sp
708 For example, this would work from the shell:
709 .nf
710
711         MONO_IOMAP=drive:case
712         export MONO_IOMAP
713
714 .fi
715 If you are using mod_mono to host your web applications, you can use
716 the 
717 .B MonoSetEnv
718 directive, like this:
719 .nf
720
721         MonoSetEnv MONO_IOMAP=all
722
723 .fi
724 .TP
725 .I "MONO_MANAGED_WATCHER"
726 If set to any value, System.IO.FileSystemWatcher will use the default
727 managed implementation (slow). If unset, mono will try to use FAM under
728 Unix systems and native API calls on Windows, falling back to the
729 managed implementation on error.
730 .TP
731 .I "MONO_NO_SMP"
732 If set causes the mono process to be bound to a single processor. This may be
733 useful when debugging or working around race conditions.
734 .TP
735 .I "MONO_PATH"
736 Provides a search path to the runtime where to look for library
737 files.   This is a tool convenient for debugging applications, but
738 should not be used by deployed applications as it breaks the assembly
739 loader in subtle ways. 
740 .Sp
741 Directories are separated by the platform path separator (colons on unix). Example:
742 .B /home/username/lib:/usr/local/mono/lib
743 .Sp
744 Alternative solutions to MONO_PATH include: installing libraries into
745 the Global Assembly Cache (see gacutil(1)) or having the dependent
746 libraries side-by-side with the main executable.
747 .Sp
748 For a complete description of recommended practices for application
749 deployment, see the
750 http://www.mono-project.com/Guidelines:Application_Deployment page. 
751 .TP
752 .I "MONO_RTC"
753 Experimental RTC support in the statistical profiler: if the user has
754 the permission, more accurate statistics are gathered.  The MONO_RTC
755 value must be restricted to what the Linux rtc allows: power of two
756 from 64 to 8192 Hz. To enable higher frequencies like 4096 Hz, run as root:
757 .nf
758
759         echo 4096 > /proc/sys/dev/rtc/max-user-freq
760
761 .fi
762 .Sp
763 For example:
764 .nf
765
766         MONO_RTC=4096 mono --profiler=default:stat program.exe
767
768 .fi
769 .TP
770 .I "MONO_NO_TLS"
771 Disable inlining of thread local accesses. Try setting this if you get a segfault
772 early on in the execution of mono.
773 .TP 
774 .I "MONO_SHARED_DIR"
775 If set its the directory where the ".wapi" handle state is stored.
776 This is the directory where the Windows I/O Emulation layer stores its
777 shared state data (files, events, mutexes, pipes).  By default Mono
778 will store the ".wapi" directory in the users's home directory.
779 .TP 
780 .I "MONO_SHARED_HOSTNAME"
781 Uses the string value of this variable as a replacement for the host name when
782 creating file names in the ".wapi" directory. This helps if the host name of
783 your machine is likely to be changed when a mono application is running or if
784 you have a .wapi directory shared among several different computers.
785 .Sp
786 Mono typically uses the hostname to create the files that are used to
787 share state across multiple Mono processes.  This is done to support
788 home directories that might be shared over the network.
789 .TP
790 .I "MONO_STRICT_IO_EMULATION"
791 If set, extra checks are made during IO operations.  Currently, this
792 includes only advisory locks around file writes.
793 .TP
794 .I "MONO_DISABLE_SHM"
795 If set, disables the shared memory files used for cross-process
796 handles: process have only private handles.  This means that process
797 and thread handles are not available to other processes, and named
798 mutexes, named events and named semaphores are not visible between
799 processes.
800 .Sp
801 This is can also be enabled by default by passing the
802 "--disable-shared-handles" option to configure.
803 .TP
804 .I "MONO_THEME"
805 The name of the theme to be used by Windows.Forms.   Available themes today
806 include "clearlooks", "nice" and "win32".
807 .Sp
808 The default is "win32".  
809 .TP
810 .I "MONO_TLS_SESSION_CACHE_TIMEOUT"
811 The time, in seconds, that the SSL/TLS session cache will keep it's entry to
812 avoid a new negotiation between the client and a server. Negotiation are very
813 CPU intensive so an application-specific custom value may prove useful for 
814 small embedded systems.
815 .Sp
816 The default is 180 seconds.
817 .TP
818 .I "MONO_THREADS_PER_CPU"
819 The maximum number of threads in the general threadpool will be
820 20 + (MONO_THREADS_PER_CPU * number of CPUs). The default value for this
821 variable is 5.
822 .TP
823 .I "MONO_XMLSERIALIZER_THS"
824 Controls the threshold for the XmlSerializer to produce a custom
825 serializer for a given class instead of using the Reflection-based
826 interpreter.  The possible values are `no' to disable the use of a
827 custom serializer or a number to indicate when the XmlSerializer
828 should start serializing.   The default value is 50, which means that
829 the a custom serializer will be produced on the 50th use.
830 .TP
831 .I "MONO_XMLSERIALIZER_DEBUG"
832 Set this value to 1 to prevent the serializer from removing the
833 temporary files that are created for fast serialization;  This might
834 be useful when debugging.
835 .SH ENVIRONMENT VARIABLES FOR DEBUGGING
836 .TP
837 .I "MONO_ASPNET_NODELETE"
838 If set to any value, temporary source files generated by ASP.NET support
839 classes will not be removed. They will be kept in the user's temporary
840 directory.
841 .TP
842 .I "MONO_LOG_LEVEL"
843 The logging level, possible values are `error', `critical', `warning',
844 `message', `info' and `debug'.  See the DEBUGGING section for more
845 details.
846 .TP
847 .I "MONO_LOG_MASK"
848 Controls the domain of the Mono runtime that logging will apply to. 
849 If set, the log mask is changed to the set value. Possible values are
850 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
851 (garbage collector), "cfg" (config file loader), "aot" (precompiler) and "all". 
852 The default value is "all". Changing the mask value allows you to display only 
853 messages for a certain component. You can use multiple masks by comma 
854 separating them. For example to see config file messages and assembly loader
855 messages set you mask to "asm,cfg".
856 .TP
857 .I "MONO_TRACE"
858 Used for runtime tracing of method calls. The format of the comma separated
859 trace options is:
860 .nf
861
862         [-]M:method name
863         [-]N:namespace
864         [-]T:class name
865         [-]all
866         [-]program
867         disabled                Trace output off upon start.
868
869 .fi
870 You can toggle trace output on/off sending a SIGUSR2 signal to the program.
871 .TP
872 .I "MONO_TRACE_LISTENER"
873 If set, enables the System.Diagnostics.DefaultTraceListener, which will 
874 print the output of the System.Diagnostics Trace and Debug classes.  
875 It can be set to a filename, and to Console.Out or Console.Error to display
876 output to standard output or standard error, respectively. If it's set to
877 Console.Out or Console.Error you can append an optional prefix that will
878 be used when writing messages like this: Console.Error:MyProgramName.
879 See the System.Diagnostics.DefaultTraceListener documentation for more
880 information.
881 .TP
882 .I "MONO_XEXCEPTIONS"
883 This throws an exception when a X11 error is encountered; by default a
884 message is displayed but execution continues
885 .TP
886 .I "MONO_XSYNC"
887 This is used in the System.Windows.Forms implementation when running
888 with the X11 backend.  This is used to debug problems in Windows.Forms
889 as it forces all of the commands send to X11 server to be done
890 synchronously.   The default mode of operation is asynchronous which
891 makes it hard to isolate the root of certain problems.
892 .SH VALGRIND
893 If you want to use Valgrind, you will find the file `mono.supp'
894 useful, it contains the suppressions for the GC which trigger
895 incorrect warnings.  Use it like this:
896 .nf
897     valgrind --suppressions=mono.supp mono ...
898 .fi
899 .SH FILES
900 On Unix assemblies are loaded from the installation lib directory.  If you set
901 `prefix' to /usr, the assemblies will be located in /usr/lib.  On
902 Windows, the assemblies are loaded from the directory where mono and
903 mint live.
904 .TP
905 .B ~/.mono/aot-cache
906 .Sp
907 The directory for the ahead-of-time compiler demand creation
908 assemblies are located. 
909 .TP
910 .B /etc/mono/config, ~/.mono/config
911 .Sp
912 Mono runtime configuration file.  See the mono-config(5) manual page
913 for more information.
914 .TP
915 .B ~/.config/.mono/certs, /usr/share/.mono/certs
916 .Sp
917 Contains Mono certificate stores for users / machine. See the certmgr(1) 
918 manual page for more information on managing certificate stores and
919 the mozroots(1) page for information on how to import the Mozilla root
920 certificates into the Mono certificate store. 
921 .TP
922 .B ~/.mono/assemblies/ASSEMBLY/ASSEMBLY.config
923 .Sp
924 Files in this directory allow a user to customize the configuration
925 for a given system assembly, the format is the one described in the
926 mono-config(5) page. 
927 .TP
928 .B ~/.config/.mono/keypairs, /usr/share/.mono/keypairs
929 .Sp
930 Contains Mono cryptographic keypairs for users / machine. They can be 
931 accessed by using a CspParameters object with DSACryptoServiceProvider
932 and RSACryptoServiceProvider classes.
933 .TP
934 .B ~/.config/.isolatedstorage, ~/.local/share/.isolatedstorage, /usr/share/.isolatedstorage
935 .Sp
936 Contains Mono isolated storage for non-roaming users, roaming users and 
937 local machine. Isolated storage can be accessed using the classes from 
938 the System.IO.IsolatedStorage namespace.
939 .TP
940 .B <assembly>.config
941 .Sp
942 Configuration information for individual assemblies is loaded by the
943 runtime from side-by-side files with the .config files, see the
944 http://www.mono-project.com/Config for more information.
945 .TP
946 .B Web.config, web.config
947 .Sp
948 ASP.NET applications are configured through these files, the
949 configuration is done on a per-directory basis.  For more information
950 on this subject see the http://www.mono-project.com/Config_system.web
951 page. 
952 .SH MAILING LISTS
953 Mailing lists are listed at the
954 http://www.mono-project.com/Mailing_Lists
955 .SH WEB SITE
956 http://www.mono-project.com
957 .SH SEE ALSO
958 .PP
959 certmgr(1), mcs(1), monocov(1), monodis(1), mono-config(5), mozroots(1), xsp(1).
960 .PP
961 For more information on AOT:
962 http://www.mono-project.com/AOT
963 .PP
964 For ASP.NET-related documentation, see the xsp(1) manual page