.\" mono manual page.
.\" Copyright 2003 Ximian, Inc.
.\" Copyright 2004-2011 Novell, Inc.
+.\" Copyright 2011-2012 Xamarin Inc
.\" Author:
.\" Miguel de Icaza (miguel@gnu.org)
.\"
.RS
.ne 8
.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 bind-to-runtime-version
.Sp
If specified, forces the generated AOT files to be bound to the
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.
+.I direct-pinvoke
+.Sp
+When this option is specified, P/Invoke methods are invoked directly
+instead of going through the operating system symbol lookup operation.
.TP
-.I write-symbols
-Instructs the AOT compiler to emit debug symbol information.
+.I llvm-path=<PREFIX>
+Same for the llvm tools 'opt' and 'llc'.
.TP
-.I save-temps,keep-temps
-Instructs the AOT compiler to keep temporary files.
+.I mtriple=<TRIPLE>
+Use the GNU style target triple <TRIPLE> to determine some code generation options, i.e.
+--mtriple=armv7-linux-gnueabi will generate code that targets ARMv7. This is currently
+only supported by the ARM backend. In LLVM mode, this triple is passed on to the LLVM
+llc compiler.
.TP
-.I threads=[number]
-This is an experimental option for the AOT compiler to use multiple threads
-when compiling the methods.
+.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 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
+.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 128.
+Defaults to 1024.
+.TP
+.I outfile=[filename]
+Instructs the AOT compiler to save the output to the specified file.
.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
+.I readonly-value=namespace.typename.fieldname=type/value
+Override the value of a static readonly field. Usually, during JIT
+compilation, the static constructor is ran eagerly, so the value of
+a static readonly field is known at compilation time and the compiler
+can do a number of optimizations based on it. During AOT, instead, the static
+constructor can't be ran, so this option can be used to set the value of such
+a field and enable the same set of optimizations.
+Type can be any of i1, i2, i4 for integers of the respective sizes (in bytes).
+Note that signed/unsigned numbers do not matter here, just the storage size.
+This option can be specified multiple times and it doesn't prevent the static
+constructor for the type defining the field to execute with the usual rules
+at runtime (hence possibly computing a different value for the field).
+
.TP
-.I asmonly
-Instructs the AOT compiler to output assembly code instead of an object file.
+.I save-temps,keep-temps
+Instructs the AOT compiler to keep temporary files.
.TP
.I soft-debug
This instructs the compiler to generate sequence point checks that
.fi
.ne
.TP
-.I mtriple=<TRIPLE>
-Use the GNU style target triple <TRIPLE> to determine some code generation options, i.e.
---mtriple=armv7-linux-gnueabi will generate code that targets ARMv7. This is currently
-only supported by the ARM backend. In LLVM mode, this triple is passed on to the LLVM
-llc compiler.
+.I stats
+Print various stats collected during AOT compilation.
+.TP
+.I threads=[number]
+This is an experimental option for the AOT compiler to use multiple threads
+when compiling the methods.
.TP
.I tool-prefix=<PREFIX>
Prepends <PREFIX> to the name of tools ran by the AOT compiler, i.e. 'as'/'ld'. For
example, --tool=prefix=arm-linux-gnueabi- will make the AOT compiler run
'arm-linux-gnueabi-as' instead of 'as'.
.TP
-.I llvm-path=<PREFIX>
-Same for the llvm tools 'opt' and 'llc'.
-.TP
-.I stats
-Print various stats collected during AOT compilation.
-
+.I write-symbols
+Instructs the AOT compiler to emit debug symbol information.
.PP
For more information about AOT, see: http://www.mono-project.com/AOT
.RE
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:
+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
Defaults to yes, with the default option Mono will suspend the vm on startup
until it connects successfully to a debugger front end. If you set it to 'n', in
conjunction with \fBserver=y\fR, it instructs the Mono runtime to run as normal,
-while caching metadata to send to the debugger front end on connection.
+while caching metadata to send to the debugger front end on connection..
+.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'.
.ne
.RE
.TP
mono --trace=T:System.String,-M:System.String:Concat
+.fi
+You can trace managed to unmanaged transitions using
+the wrapper qualifier:
+.nf
+
+ mono --trace=wrapper app.exe
+
.fi
Finally, namespaces can be specified using the N: prefix:
.nf
.Sp
This is the default from mono 2.8 onwards.
.TP
+\fBMONO_DNS\fR
+When set, enables the use of a fully managed DNS resolver instead of the
+regular libc functions. This resolver performs much better when multiple
+queries are run in parallel.
+
+Note that /etc/nsswitch.conf will be ignored.
+.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
to force all of your Mono processes to use LLVM or SGEN without having
to modify any launch scripts.
.TP
+\fBMONO_ENV_OPTIONS\fR
+Used to pass extra options to the debugger agent in the runtime, as they were passed
+using --debugger-agent=.
+.TP
\fBMONO_EVENTLOG_TYPE\fR
Sets the type of event log provider to use (for System.Diagnostics.EventLog).
.Sp
`k', `m' and `g' to specify kilo-, mega- and gigabytes, respectively.
The default is 512 megabytes.
.TP
+\fBsoft-heap-limit=\fIsize\fR
+Once the heap size gets larger than this size, ignore what the default
+major collection trigger metric says and only allow four nursery size's
+of major heap growth between major collections.
+.TP
\fBwbarrier=\fIwbarrier\fR
Specifies which write barrier to use. Options are `cardtable' and
`remset'. The card table barrier is faster but less precise, and only
and can speed up nursery collection and allocation rate, it has
the downside of requiring a significant extra memory per compiled
method. The right option, unfortunately, requires experimentation.
+.TP
+\fBsave-target-ratio=\fIratio\fR
+Specifies the target save ratio for the major collector. The collector
+lets a given amount of memory to be promoted from the nursery due to
+minor collections before it triggers a major collection. This amount
+is based on how much memory it expects to free. It is represented as
+a ratio of the size of the heap after a major collection.
+Valid values are between 0.1 and 2.0. The default is 0.5.
+Smaller values will keep the major heap size smaller but will trigger
+more major collections. Likewise, bigger values will use more memory
+and result in less frequent major collections.
+This option is EXPERIMENTAL, so it might disappear in later versions of mono.
+.TP
+\fBdefault-allowance-ratio=\fIratio\fR
+Specifies the default allocation allowance when the calculated size
+is too small. The allocation allowance is how much memory the collector
+let be promoted before triggered a major collection.
+It is a ratio of the nursery size.
+Valid values are between 1.0 and 10.0. The default is 4.0.
+Smaller values lead to smaller heaps and more frequent major collections.
+Likewise, bigger values will allow the heap to grow faster but use
+more memory when it reaches a stable size.
+This option is EXPERIMENTAL, so it might disappear in later versions of mono.
+.TP
+\fBminor=\fIminor-collector\fR
+Specifies which minor collector to use. Options are 'simple' which
+promotes all objects from the nursery directly to the old generation
+and 'split' which lets object stay longer on the nursery before promoting.
+.TP
+\fBalloc-ratio=\fIratio\fR
+Specifies the ratio of memory from the nursery to be use by the alloc space.
+This only can only be used with the split minor collector.
+Valid values are integers between 1 and 100. Default is 60.
+.TP
+\fBpromotion-age=\fIage\fR
+Specifies the required age of an object must reach inside the nursery before
+been promoted to the old generation. This only can only be used with the
+split minor collector.
+Valid values are integers between 1 and 14. Default is 2.
.ne
.RE
.TP
\fInumber\fR
Sets the debug level to the specified number.
.TP
+\fBprint-allowance\fR
+After each major collection prints memory consumption for before and
+after the collection and the allowance for the minor collector, i.e. how
+much the heap is allowed to grow from minor collections before the next
+major collection is triggered.
+.TP
+\fBprint-pinning\fR
+Gathers statistics on the classes whose objects are pinned in the
+nursery and for which global remset entries are added. Prints those
+statistics when shutting down.
+.TP
\fBcollect-before-allocs\fR
.TP
\fBcheck-at-minor-collections\fR
Forces the GC to scan the stack conservatively, even if precise
scanning is available.
.TP
+\fBno-managed-allocator\fR
+Disables the managed allocator.
+.TP
\fBcheck-scan-starts\fR
If set, does a plausibility check on the scan_starts before and after each collection
.TP
+\fBverify-nursery-at-minor-gc\fR
+If set, does a complete object walk of the nursery at the start of each minor collection.
+.TP
+\fBdump-nursery-at-minor-gc\fR
+If set, dumps the contents of the nursery at the start of each minor collection. Requires
+verify-nursery-at-minor-gc to be set.
+.TP
\fBheap-dump=\fIfile\fR
Dumps the heap contents to the specified file. To visualize the
information, use the mono-heapviz tool.
See the System.Diagnostics.DefaultTraceListener documentation for more
information.
.TP
+\fBMONO_WCF_TRACE\fR
+This eases WCF diagnostics functionality by simply outputs all log messages from WCF engine to "stdout", "stderr" or any file passed to this environment variable. The log format is the same as usual diagnostic output.
+.TP
\fBMONO_XEXCEPTIONS\fR
This throws an exception when a X11 error is encountered; by default a
message is displayed but execution continues
projects / mono.git / blobdiff