.\" Author:
.\" Miguel de Icaza (miguel@gnu.org)
.\"
-.TH Mono "Mono 2.2"
+.TH Mono "Mono 2.5"
.SH NAME
mono \- Mono's ECMA-CLI native code generator (Just-in-Time and Ahead-of-Time)
.SH SYNOPSIS
This instructs Mono to precompile code that has historically not been
precompiled with AOT.
.TP
+.I outfile=[filename]
+Instructs the AOT compiler to save the output to the specified file.
+.TP
.I write-symbols
Instructs the AOT compiler to emit debug symbol information.
.TP
+.I save-temps,keep-temps
+Instructs the AOT compiler to keep temporary files.
+.TP
+.I threads=[number]
+This is an experimental option for the AOT compiler to use multiple threads
+when compiling the methods.
+.TP
+.I nodebug
+Instructs the AOT compiler to not output any debugging information.
+.TP
+.I ntrampolines=[number]
+When compiling in full aot mode, the method trampolines must be precreated
+in the AOT image. You can add additional method trampolines with this argument.
+Defaults to 1024.
+.TP
+.I nrgctx-trampolines=[number]
+When compiling in full aot mode, the generic sharing trampolines must be precreated
+in the AOT image. You can add additional method trampolines with this argument.
+Defaults to 1024.
+.TP
+.I nimt-trampolines=[number]
+When compiling in full aot mode, the IMT trampolines must be precreated
+in the AOT image. You can add additional method trampolines with this argument.
+Defaults to 128.
+.TP
+.I print-skipped-methods
+If the AOT compiler cannot compile a method for any reason, enabling this flag
+will output the skipped methods to the console.
+.TP
+.I autoreg
+The AOT compiler will emit a (ELF only) library initializer to automatically
+register the aot compiled module with the runtime. This is only useful in static
+mode
+.TP
+.I asmonly
+Instructs the AOT compiler to output assembly code instead of an object file.
+.TP
+.I soft-debug
+This instructs the compiler to generate sequence point checks that
+allow Mono's soft debugger to debug applications even on systems where
+it is not possible to set breakpoints or to single step (certain
+hardware configurations like the cell phones and video gaming
+consoles).
+.TP
.I static
Create an ELF object file (.o) which can be statically linked into an executable
when embedding the mono runtime. When this option is used, the object file needs to
specified in the MONO_CONFIG environment variable, if set. See the
mono-config(5) man page for details on the format of this file.
.TP
+\fB--debugger-agent=[options]\fR
+This instructs the Mono runtime to
+start a debugging agent inside the Mono runtime and connect it to a
+client user interface will control the Mono process.
+This option is typically used by IDEs, like the MonoDevelop IDE.
+.PP
+The
+configuration is specified using one of more of the following options:
+.RS
+.ne 8
+.TP
+.I transport=transport_name
+.Sp
+This is used to specify the transport that the debugger will use to
+communicate. It must be specified and currently requires this to
+be 'dt_socket'.
+.TP
+.I address=host:port
+.Sp
+Use this option to specify the IP address where your debugger client is
+listening to.
+.TP
+.I loglevel=LEVEL
+.Sp
+Specifies the diagnostics log level for
+.TP
+.I logfile=filename
+.Sp
+Used to specify the file where the log will be stored, it defaults to
+standard output.
+.ne
+.RE
+.TP
\fB--desktop\fR
Configures the virtual machine to be better suited for desktop
applications. Currently this sets the GC system to avoid expanding
\fB--help\fR, \fB-h\fR
Displays usage instructions.
.TP
+\fB--llvm\fR
+If the Mono runtime has been compiled with LLVM support (not available
+in all configurations), Mono will use the LLVM optimization and code
+generation engine to JIT or AOT compile. You can also use the
+\fBMONO_USE_LLVM\fR environment variable to turn this on
+.Sp
+For more information, consult: http://www.mono-project.com/Mono_LLVM
+.TP
\fB--optimize=MODE\fR, \fB-O=MODE\fR
MODE is a comma separated list of optimizations. They also allow
optimizations to be turned off by prefixing the optimization name with
Disable some JIT optimizations which are usually only disabled when
running inside the debugger. This can be helpful if you want to attach
to the running process with mdb.
+.TP
+.I gdb
+Generate and register debugging information with gdb. This is only supported on some
+platforms, and only when using gdb 7.0 or later.
.ne
.RE
.TP
mono --trace=M:System.Console:WriteLine app.exe
+.fi
+Exceptions can also be traced, it will cause a stack trace to be
+printed every time an exception of the specified type is thrown.
+The exception type can be specified with or without the namespace,
+and to trace all exceptions, specify 'all' as the type name.
+.nf
+
+ mono --trace=E:System.Exception app.exe
+
.fi
As previously noted, various rules can be specified at once:
.nf
and SIMD variables can be properly aligned. This option turns off the
alignment, which usually saves one intruction per call, but might
result in significantly lower floating point and SIMD performance.
+.TP
+\fB--jitmap\fR
+Generate a JIT method map in a /tmp/perf-PID.map file. This file is then
+used, for example, by the perf tool included in recent Linux kernels.
+Each line in the file has:
+.nf
+
+ HEXADDR HEXSIZE methodname
+
+.fi
+Currently this option is only supported on Linux.
.SH JIT MAINTAINER OPTIONS
The maintainer options are only used by those developing the runtime
itself, and not typically of interest to runtime users or developers.
.B all,
a heap snapshot is taken at each collection.
.PP
-If the value is signal name or a number (one of SIGUSR1, SIGUSR2 and
-SIGPROF, remembering that SIGPROF is not compatible with the
-statistical profiler), every time the application receives this signal
-a garbage collection is forced and a snapshot is taken. The natural way
-to take a heap snapshot is then using the kill command to deliver the
-appropriate signal to the application.
+If the value is an integer
+.B n,
+a snapshot will be taken at the first
+.B n
+collections (like setting
+.B gcd=n
+);
+.PP
+If no additional argument is given to the heap option, the only way to take
+heap snapshots is to requeste them using the runtime socket based command
+interface described below (see "Profiler activity control").
.PP
Heap profiling also enables full allocation profiling (with call
stacks), and each allocation can be related to its corresponding
states the number of snapshots that must be dumped (since the application
starts). Zero means no dumps at all, -1 means dump at all collections.
.TP
-\fIgc-commands=FILE\fR, \fIgc-c=FILE\fR or \fIgcc=FILE\fR
-specify a "command file". The file must contain an integer value in ASCII
-form, and the profiler will stat it at every collection.
-If it has been modified it will interpret its contents as a \fIgcd=N\fR
-option value, and dump the required number of snapshots from that moment
-onwards.
-If the file is present at application startup it takes precedence over an
-eventual \fIgcd=N\fR option.
-.TP
These options exist because it can happen that the user wants to investigate
-what happens during collections but without forcing a collection using a
-signal, because forcing a collection alters the program behavior.
+what happens during collections but without forcing a collection using the
+command interface, because forcing a collection alters the program behavior.
Of course it is possible to simply take a snapshot at every collection, but
in some workloads this is could not be feasible (too much data).
So we have this "garbage collection dumps" counter to control how many
.TP
\fIstart-disabled\fR or \fIsd\fR: start with the profiler inactive.
.TP
-\fItoggle-signal=<SIGNAL>\fR or \fIts=<SIGNAL>\fR (where <SIGNAL>
-is one of SIGUSR1, SIGUSR2 or SIGPROF): Choose a signal that will be used to
-toggle the profiler activity on and off. This way you can decide to profile
-only portions of the applicatopn lifetime (for instance, you can decide to
-avoid profiling an initial setup phase using \fIsd\fR, and enable the
-profiler later delivering the signal to the application).
-.TP
\fIforce-accurate-timer\fR (or \fIfac\fR): the profiler by default uses
rtdsc to acquire timestamps for frequent events, but this can be imprecise;
using this option you force the use of "gettimeofday" at every event, which
is more accurate but much slower.
+.TP
+\fIcommand-port=port\fR or \fIcp=port\fR (where port is an integer between
+1024 nd 65535):
+Choose a TCP port where the profiler will listen for user commands.
+The protocol is ASCII based and line oriented (one line per command), and the
+profiler answers with one line containing either "OK" or "ERROR" to each
+received command.
+.PP
+The user can telnet to this port and give commands manually, or a GUI can
+use this facility to control the profiler at runtime.
+.PP
+The available commands are:
+.TP
+\fIenable\fR: Enables the profiler.
+.TP
+\fIdisable\fR: Disables the profiler.
+.TP
+\fIheap-snapshot\fR: Takes a heap snapshot now (forces a full garbage collection).
+.TP
+\fIheap-snapshot-counter=arg\fR: Set the counter of the next heap snapshots
+that must be taken, where arg can be "all" (take a snapshot at every
+collection), "none" (do not take snapshots), or an integer "n" (take a heap
+snapshot for the next "n" collections).
.ne
.RE
.PP
environment variable to limit the extent of the messages you get:
If set, the log mask is changed to the set value. Possible values are
"asm" (assembly loader), "type", "dll" (native library loader), "gc"
-(garbage collector), "cfg" (config file loader), "aot" (precompiler) and "all".
+(garbage collector), "cfg" (config file loader), "aot" (precompiler),
+"security" (e.g. Moonlight CoreCLR support) and "all".
The default value is "all". Changing the mask value allows you to display only
messages for a certain component. You can use multiple masks by comma
separating them. For example to see config file messages and assembly loader
Turns off the garbage collection in Mono. This should be only used
for debugging purposes
.TP
+\fBLVM_COUNT\fR
+When Mono is compiled with LLVM support, this instructs the runtime to
+stop using LLVM after the specified number of methods are JITed.
+This is a tool used in diagnostics to help isolate problems in the
+code generation backend. For example \fBLLVM_COUNT=10\fR would only
+compile 10 methods with LLVM and then switch to the Mono JIT engine.
+\fBLLVM_COUNT=0\fR would disable the LLVM engine altogether.
+.TP
\fBMONO_AOT_CACHE\fR
If set, this variable will instruct Mono to ahead-of-time compile new
assemblies on demand and store the result into a cache in
~/.mono/aot-cache.
.TP
+\fBMONO_ASPNET_INHIBIT_SETTINGSMAP\fR
+Mono contains a feature which allows modifying settings in the .config files shipped
+with Mono by using config section mappers. The mappers and the mapping rules are
+defined in the $prefix/etc/mono/2.0/settings.map file and, optionally, in the
+settings.map file found in the top-level directory of your ASP.NET application.
+Both files are read by System.Web on application startup, if they are found at the
+above locations. If you don't want the mapping to be performed you can set this
+variable in your environment before starting the application and no action will
+be taken.
+.TP
\fBMONO_CFG_DIR\fR
If set, this variable overrides the default system configuration directory
($PREFIX/etc). It's used to locate machine.config file.
($PREFIX/etc/mono/config). The --config command line options overrides the
environment variable.
.TP
-\fBMONO_DEBUG\fR
-If set, enables some features of the runtime useful for debugging.
-This variable should contain a comma separated list of debugging options.
-Currently, the following options are supported:
-.RS
-.ne 8
-.TP
-\fBbreak-on-unverified\fR
-If this variable is set, when the Mono VM runs into a verification
-problem, instead of throwing an exception it will break into the
-debugger. This is useful when debugging verifier problems
-.TP
-\fBcollect-pagefault-stats\fR
-Collects information about pagefaults. This is used internally to
-track the number of page faults produced to load metadata. To display
-this information you must use this option with "--stats" command line
-option.
-.TP
-\fBdont-free-domains\fR
-This is an Optimization for multi-AppDomain applications (most
-commonly ASP.NET applications). Due to internal limitations Mono,
-Mono by default does not use typed allocations on multi-appDomain
-applications as they could leak memory when a domain is unloaded.
-.Sp
-Although this is a fine default, for applications that use more than
-on AppDomain heavily (for example, ASP.NET applications) it is worth
-trading off the small leaks for the increased performance
-(additionally, since ASP.NET applications are not likely going to
-unload the application domains on production systems, it is worth
-using this feature).
-.TP
-\fBhandle-sigint\fR
-Captures the interrupt signal (Control-C) and displays a stack trace
-when pressed. Useful to find out where the program is executing at a
-given point. This only displays the stack trace of a single thread.
-.TP
-\fBkeep-delegates\fR
-This option will leak delegate trampolines that are no longer
-referenced as to present the user with more information about a
-delegate misuse. Basically a delegate instance might be created,
-passed to unmanaged code, and no references kept in managed code,
-which will garbage collect the code. With this option it is possible
-to track down the source of the problems.
-.TP
-\fBno-gdb-backtrace\fR
-This option will disable the GDB backtrace emitted by the runtime
-after a SIGSEGV or SIGABRT in unmanaged code.
-.TP
-\fBsuspend-on-sigsegv\fR
+\fBMONO_CPU_ARCH\fR
+Override the automatic cpu detection mechanism. Currently used only on arm.
+The format of the value is as follows:
+.nf
-This option will suspend the program when a native SIGSEGV is received.
-This is useful for debugging crashes which do not happen under gdb,
-since a live process contains more information than a core file.
-.ne
-.RE
+ "armvV [thumb]"
+
+.fi
+where V is the architecture number 4, 5, 6, 7 and the options can be currently be
+"thunb". Example:
+.nf
+
+ MONO_CPU_ARCH="armv4 thumb" mono ...
+
+.fi
.TP
\fBMONO_DISABLE_AIO\fR
If set, tells mono NOT to attempt using native asynchronous I/O services. In
members of System.Globalization.CompareInfo class. Collation is
enabled by default.
.TP
+\fBMONO_DISABLE_SHM\fR
+Unix only: If set, disables the shared memory files used for
+cross-process handles: process have only private handles. This means
+that process and thread handles are not available to other processes,
+and named mutexes, named events and named semaphores are not visible
+between processes.
+.Sp
+This is can also be enabled by default by passing the
+"--disable-shared-handles" option to configure.
+.Sp
+This is the default from mono 2.8 onwards.
+.TP
\fBMONO_EGD_SOCKET\fR
For platforms that do not otherwise have a way of obtaining random bytes
this can be set to the name of a file system socket on which an egd or
prngd daemon is listening.
.TP
+\fBMONO_ENABLE_SHM\fR
+Unix only: Enable support for cross-process handles. Cross-process
+handles are used to expose process handles, thread handles, named
+mutexes, named events and named semaphores across Unix processes.
+.TP
\fBMONO_EVENTLOG_TYPE\fR
Sets the type of event log provider to use (for System.Diagnostics.EventLog).
.Sp
list of "drive" to strip drive letters, or "case" to do
case-insensitive file matching in every directory in a path. "all"
enables all rewriting methods. (Backslashes are always mapped to
-slashes if this variable is set to a valid option.)
+slashes if this variable is set to a valid option).
.fi
.Sp
For example, this would work from the shell:
.fi
If you are using mod_mono to host your web applications, you can use
the
-.B MonoSetEnv
-directive, like this:
+.B MonoIOMAP
+directive instead, like this:
+.nf
+
+ MonoIOMAP <appalias> all
+
+.fi
+See mod_mono(8) for more details.
+
+Additionally. Mono includes a profiler module which allows one to track what
+adjustements to file paths IOMAP code needs to do. The tracking code reports
+the managed location (full stack trace) from which the IOMAP-ed call was made and,
+on process exit, the locations where all the IOMAP-ed strings were created in
+managed code. The latter report is only approximate as it is not always possible
+to estimate the actual location where the string was created. The code uses simple
+heuristics - it analyzes stack trace leading back to the string allocation location
+and ignores all the managed code which lives in assemblies installed in GAC as well as in the
+class libraries shipped with Mono (since they are assumed to be free of case-sensitivity
+issues). It then reports the first location in the user's code - in most cases this will be
+the place where the string is allocated or very close to the location. The reporting code
+is implemented as a custom profiler module (see the "PROFILING" section) and can be loaded
+in the following way:
+.fi
+.Sp
.nf
- MonoSetEnv MONO_IOMAP=all
+ mono --profile=iomap yourapplication.exe
.fi
+Note, however, that Mono currently supports only one profiler module at a time.
.TP
\fBMONO_MANAGED_WATCHER\fR
If set to "disabled", System.IO.FileSystemWatcher will use a file watcher
Gamin, kevent under Unix systems and native API calls on Windows, falling
back to the managed implementation on error.
.TP
+\fBMONO_MESSAGING_PROVIDER\fR
+Mono supports a plugin model for its implementation of System.Messaging making
+it possible to support a variety of messaging implementations (e.g. AMQP, ActiveMQ).
+To specify which messaging implementation is to be used the evironement variable
+needs to be set to the full class name for the provider. E.g. to use the RabbitMQ based
+AMQP implementation the variable should be set to:
+
+.nf
+Mono.Messaging.RabbitMQ.RabbitMQMessagingProvider,Mono.Messaging.RabbitMQ
+.TP
\fBMONO_NO_SMP\fR
If set causes the mono process to be bound to a single processor. This may be
useful when debugging or working around race conditions.
.TP
+\fBMONO_NO_TLS\fR
+Disable inlining of thread local accesses. Try setting this if you get a segfault
+early on in the execution of mono.
+.TP
\fBMONO_PATH\fR
Provides a search path to the runtime where to look for library
files. This is a tool convenient for debugging applications, but
libraries side-by-side with the main executable.
.Sp
For a complete description of recommended practices for application
-deployment, see the
-http://www.mono-project.com/Guidelines:Application_Deployment page.
+deployment, see
+http://www.mono-project.com/Guidelines:Application_Deployment
.TP
\fBMONO_RTC\fR
Experimental RTC support in the statistical profiler: if the user has
MONO_RTC=4096 mono --profiler=default:stat program.exe
.fi
-.TP
-\fBMONO_NO_TLS\fR
-Disable inlining of thread local accesses. Try setting this if you get a segfault
-early on in the execution of mono.
.TP
\fBMONO_SHARED_DIR\fR
If set its the directory where the ".wapi" handle state is stored.
If set, extra checks are made during IO operations. Currently, this
includes only advisory locks around file writes.
.TP
-\fBMONO_DISABLE_SHM\fR
-If set, disables the shared memory files used for cross-process
-handles: process have only private handles. This means that process
-and thread handles are not available to other processes, and named
-mutexes, named events and named semaphores are not visible between
-processes.
-.Sp
-This is can also be enabled by default by passing the
-"--disable-shared-handles" option to configure.
-.TP
\fBMONO_THEME\fR
The name of the theme to be used by Windows.Forms. Available themes today
include "clearlooks", "nice" and "win32".
20 + (MONO_THREADS_PER_CPU * number of CPUs). The default value for this
variable is 10.
.TP
+\fBMONO_USE_LLVM\fR
+If the Mono runtime has been compiled with LLVM support (not available
+in all configurations), Mono will use the LLVM optimization and code
+generation engine to JIT or AOT compile. This is equivalent to
+using the \-\-llvm command line option, but is useful for global
+configurations.
+.TP
\fBMONO_XMLSERIALIZER_THS\fR
Controls the threshold for the XmlSerializer to produce a custom
serializer for a given class instead of using the Reflection-based
custom serializer or a number to indicate when the XmlSerializer
should start serializing. The default value is 50, which means that
the a custom serializer will be produced on the 50th use.
-.TP
-\fBMONO_XMLSERIALIZER_DEBUG\fR
-Set this value to 1 to prevent the serializer from removing the
-temporary files that are created for fast serialization; This might
-be useful when debugging.
-.TP
-\fBMONO_ASPNET_INHIBIT_SETTINGSMAP\fR
-Mono contains a feature which allows modifying settings in the .config files shipped
-with Mono by using config section mappers. The mappers and the mapping rules are
-defined in the $prefix/etc/mono/2.0/settings.map file and, optionally, in the
-settings.map file found in the top-level directory of your ASP.NET application.
-Both files are read by System.Web on application startup, if they are found at the
-above locations. If you don't want the mapping to be performed you can set this
-variable in your environment before starting the application and no action will
-be taken.
-.TP
-\fBMONO_MESSAGING_PROVIDER\fR
-Mono supports a plugin model for its implementation of System.Messaging making
-it possible to support a variety of messaging implementations (e.g. AMQP, ActiveMQ).
-To specify which messaging implementation is to be used the evironement variable
-needs to be set to the full class name for the provider. E.g. to use the RabbitMQ based
-AMQP implementation the variable should be set to:
-
-.nf
-Mono.Messaging.RabbitMQ.RabbitMQMessagingProvider,Mono.Messaging.RabbitMQ
.SH ENVIRONMENT VARIABLES FOR DEBUGGING
.TP
\fBMONO_ASPNET_NODELETE\fR
classes will not be removed. They will be kept in the user's temporary
directory.
.TP
+\fBMONO_DEBUG\fR
+If set, enables some features of the runtime useful for debugging.
+This variable should contain a comma separated list of debugging options.
+Currently, the following options are supported:
+.RS
+.ne 8
+.TP
+\fBbreak-on-unverified\fR
+If this variable is set, when the Mono VM runs into a verification
+problem, instead of throwing an exception it will break into the
+debugger. This is useful when debugging verifier problems
+.TP
+\fBcollect-pagefault-stats\fR
+Collects information about pagefaults. This is used internally to
+track the number of page faults produced to load metadata. To display
+this information you must use this option with "--stats" command line
+option.
+.TP
+\fBdont-free-domains\fR
+This is an Optimization for multi-AppDomain applications (most
+commonly ASP.NET applications). Due to internal limitations Mono,
+Mono by default does not use typed allocations on multi-appDomain
+applications as they could leak memory when a domain is unloaded.
+.Sp
+Although this is a fine default, for applications that use more than
+on AppDomain heavily (for example, ASP.NET applications) it is worth
+trading off the small leaks for the increased performance
+(additionally, since ASP.NET applications are not likely going to
+unload the application domains on production systems, it is worth
+using this feature).
+.TP
+\fBhandle-sigint\fR
+Captures the interrupt signal (Control-C) and displays a stack trace
+when pressed. Useful to find out where the program is executing at a
+given point. This only displays the stack trace of a single thread.
+.TP
+\fBkeep-delegates\fR
+This option will leak delegate trampolines that are no longer
+referenced as to present the user with more information about a
+delegate misuse. Basically a delegate instance might be created,
+passed to unmanaged code, and no references kept in managed code,
+which will garbage collect the code. With this option it is possible
+to track down the source of the problems.
+.TP
+\fBno-gdb-backtrace\fR
+This option will disable the GDB backtrace emitted by the runtime
+after a SIGSEGV or SIGABRT in unmanaged code.
+.TP
+\fBsuspend-on-sigsegv\fR
+
+This option will suspend the program when a native SIGSEGV is received.
+This is useful for debugging crashes which do not happen under gdb,
+since a live process contains more information than a core file.
+.ne
+.RE
+.TP
\fBMONO_LOG_LEVEL\fR
The logging level, possible values are `error', `critical', `warning',
`message', `info' and `debug'. See the DEBUGGING section for more
Controls the domain of the Mono runtime that logging will apply to.
If set, the log mask is changed to the set value. Possible values are
"asm" (assembly loader), "type", "dll" (native library loader), "gc"
-(garbage collector), "cfg" (config file loader), "aot" (precompiler) and "all".
+(garbage collector), "cfg" (config file loader), "aot" (precompiler),
+"security" (e.g. Moonlight CoreCLR support) and "all".
The default value is "all". Changing the mask value allows you to display only
messages for a certain component. You can use multiple masks by comma
separating them. For example to see config file messages and assembly loader
This throws an exception when a X11 error is encountered; by default a
message is displayed but execution continues
.TP
+\fBMONO_XMLSERIALIZER_DEBUG\fR
+Set this value to 1 to prevent the serializer from removing the
+temporary files that are created for fast serialization; This might
+be useful when debugging.
+.TP
\fBMONO_XSYNC\fR
This is used in the System.Windows.Forms implementation when running
with the X11 backend. This is used to debug problems in Windows.Forms
.nf
dtrace -P mono'$target' -l -c mono
.fi
+.SH PERMISSIONS
+Mono's Ping implementation for detecting network reachability can
+create the ICMP packets itself without requiring the system ping
+command to do the work. If you want to enable this on Linux for
+non-root users, you need to give the Mono binary special permissions.
+.PP
+As root, run this command:
+.nf
+ # setcap cap_net_raw=+ep /usr/bin/mono
+.fi
.SH FILES
On Unix assemblies are loaded from the installation lib directory. If you set
`prefix' to /usr, the assemblies will be located in /usr/lib. On
.SH SEE ALSO
.PP
certmgr(1), csharp(1), mcs(1), mdb(1), monocov(1), monodis(1),
-mono-config(5), mozroots(1), pdb2mdb(1), xsp(1).
+mono-config(5), mozroots(1), pdb2mdb(1), xsp(1), mod_mono(8).
.PP
For more information on AOT:
http://www.mono-project.com/AOT
projects / mono.git / blobdiff