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