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