man/mono.1

   1 .\"
   2 .\" mono manual page.
   3 .\" (C) 2003 Ximian, Inc.
   4 .\" Author:
   5 .\"   Miguel de Icaza (miguel@gnu.org)
   6 .\"
   7 .de Sp \" Vertical space (when we can't use .PP)
   8 .if t .sp .5v
   9 .if n .sp
  10 ..
  11 .TH Mono "Mono 1.0"
  12 .SH NAME
  13 mono \- Mono's ECMA-CLI native code generator (Just-in-Time and Ahead-of-Time)
  14 .SH SYNOPSIS
  15 .PP
  16 .B mono [options] file [arguments...]
  17 .SH DESCRIPTION
  18 \fImono\fP is a runtime implementation of the ECMA Common Language
  19 Infrastructure.  This can be used to run ECMA and .NET applications.
  20 .PP
  21 The runtime contains a native code generator that transforms the
  22 Common Intermediate Language into native code.
  23 .PP
  24 The code generator can operate in two modes: just in time compilation
  25 (JIT) or ahead of time compilation (AOT).  Since code can be
  26 dynamically loaded, the runtime environment and the JIT are always
  27 present, even if code is compiled ahead of time.
  28 .PP
  29 The runtime loads ths specified
  30 .I file
  31 and optionally passes
  32 the
  33 .I arguments
  34 to it.  The
  35 .I file
  36 is an ECMA assembly.  They typically have a .exe or .dll extension.
  37 .PP
  38 The runtime provides a number of configuration options for running
  39 applications, for developping and debugging, and for testing and
  40 debugging the runtime itself.
  41 .SH RUNTIME OPTIONS
  42 The following options are available:
  43 .TP
  44 .I "--aot"
  45 This option is used to precompile the CIL code in the specified
  46 assembly to native code.  The generated code is stored in a file with
  47 the extension .so.  This file will be automatically picked up by the
  48 runtime when the assembly is executed.
  49 .Sp
  50 This pre-compiles the methods, but the original assembly is still
  51 required to execute as this one contains the metadata and exception
  52 information which is not availble on the generated file.  When
  53 precompiling code, you might want to compile with all optimizations
  54 (-O=all).  Pre-compiled code is position independent code.
  55 .Sp
  56 Pre compilation is just a mechanism to reduce startup time, and avoid
  57 just-in-time compilation costs.  The original assembly must still be
  58 present, as the metadata is contained there.
  59 .TP
  60 .I "--config filename"
  61 Load the specified configuration file instead of the default one(s).
  62 The default files are /etc/mono/config and ~/.mono/config or the file
  63 specified in the MONO_CONFIG environment variable, if set.  See the
  64 mono-config(5) man page for details on the format of this file.
  65 .TP
  66 .I "--help", "-h"
  67 Displays usage instructions.
  68 .TP
  69 .I "--optimize=MODE", "-O=mode"
  70 MODE is a comma separated list of optimizations.  They also allow
  71 optimizations to be turned off by prefixing the optimization name with
  72 a minus sign.
  73 .Sp
  74 The following optimizations are implemented:
  75 .nf
  76              all        Turn on all optimizations
  77              peephole   Peephole postpass
  78              branch     Branch optimizations
  79              inline     Inline method calls
  80              cfold      Constant folding
  81              consprop   Constant propagation
  82              copyprop   Copy propagation
  83              deadce     Dead code elimination
  84              linears    Linear scan global reg allocation
  85              cmov       Conditional moves
  86              shared     Emit per-domain code
  87              sched      Instruction scheduling
  88              intrins    Intrinsic method implementations
  89              tailc      Tail recursion and tail calls
  90              loop       Loop related optimizations
  91              leaf       Leaf procedures optimizations
  92              profile    Use profiling information
  93 .fi
  94 .Sp
  95 For example, to enable all the optimization but dead code
  96 elimination and inlining, you can use:
  97 .nf
  98         -O=all,-deadce,-inline
  99 .fi
 100 .TP
 101 .I "-V", "--version"
 102 Prints JIT version information.
 103
 104
 105 .SH DEVELOPMENT OPTIONS
 106 The following options are used to help when developing a JITed application.
 107 .TP
 108 .I "--debug"
 109 Turns on the debugging mode in the runtime.  If an assembly was
 110 compiled with debugging information, it will produce line number
 111 information for stack traces.
 112 .TP
 113 .I "--profile[=profiler[:profiler_args]]"
 114 Instructs the runtime to collect profiling information about execution
 115 times and memory allocation, and dump it at the end of the execution.
 116 If a profiler is not specified, the default profiler is used. profiler_args
 117 is a profiler-specific string of options for the profiler itself.
 118
 119
 120 .SH JIT MAINTAINER OPTIONS
 121 The maintainer options are only used by those developing the runtime
 122 itself, and not typically of interest to runtime users or developers.
 123 .TP
 124 .I "--compile name"
 125 This compiles a method (namespace.name:methodname), this is used for
 126 testing the compiler performance or to examine the output of the code
 127 generator.
 128 .TP
 129 .I "--compileall"
 130 Compiles all the methods in an assembly.  This is used to test the
 131 compiler performance or to examine the output of the code generator
 132 .TP
 133 .I "--graph=TYPE METHOD"
 134 This generates a postscript file with a graph with the details about
 135 the specified method (namespace.name:methodname).  This requires `dot'
 136 and ghostview to be installed (it expects Ghostview to be called
 137 "gv").
 138 .TP
 139 The following graphs are available:
 140 .nf
 141           cfg        Control Flow Graph (CFG)
 142           dtree      Dominator Tree
 143           code       CFG showing code
 144           ssa        CFG showing code after SSA translation
 145           optcode    CFG showing code after IR optimizations
 146 .fi
 147 .Sp
 148 Some graphs will only be available if certain optimizations are turned
 149 on.
 150 .TP
 151 .I "--ncompile"
 152 Instruct the runtime on the number of times that the method specified
 153 by --compile (or all the methods if --compileall is used) to be
 154 compiled.  This is used for testing the code generator performance.
 155 .TP
 156 .I "-v", "--verbose"
 157 Increases the verbosity level, each time it is listed, increases the
 158 verbosity level to include more information (including, for example,
 159 a disassembly of the native code produced, code selector info etc.).
 160 .TP
 161 .I "--break method"
 162 Inserts a breakpoint before the method whose name is `method'
 163 (namespace.class:methodname).  Use `Main' as method name to insert a
 164 breakpoint on the application's main method.
 165 .TP
 166 .I "--breakonex"
 167 Inserts a breakpoint on exceptions.  This allows you to debug your
 168 application with a native debugger when an exception is thrown.
 169 .TP
 170 .I "--trace"
 171 Shows method names as they are invoked.
 172
 173
 174 .SH ENVIRONMENT VARIABLES
 175 .TP
 176 .I "GC_DONT_GC"
 177 Turns off the garbage collection in Mono.  This should be only used
 178 for debugging purposes
 179 .TP
 180 .I "MONO_PATH"
 181 Provides a search path to the runtime where to look for library files.
 182 Directories are separated by the platform path separator (colons on unix). Example:
 183 .B /home/username/lib:/usr/local/mono/lib
 184 .TP
 185 .I "MONO_DISABLE_SHM"
 186 If this variable is set, it disables the Windows I/O Emulation layer,
 187 and handles (files, events, mutexes, pipes) will not be shared across
 188 processes.  This option is only available on Unix.
 189 .TP
 190 .I "MONO_CFG_DIR"
 191 If set, this variable overrides the default system configuration directory
 192 ($PREFIX/etc). It's used to locate machine.config file.
 193 .TP
 194 .I "MONO_CONFIG"
 195 If set, this variable overrides the default runtime configuration file
 196 ($PREFIX/etc/mono/config). The --config command line options overrides the
 197 environment variable.
 198 .SH FILES
 199 On Unix assemblies are loaded from the installation lib directory.  If you set
 200 `prefix' to /usr, the assemblies will be located in /usr/lib.  On
 201 Windows, the assemblies are loaded from the directory where mono and
 202 mint live.
 203 .PP
 204 /etc/mono/config, ~/.mono/config
 205 .PP
 206 Mono runtime configuration file.  See the mono-config(5) manual page
 207 for more information.
 208 .SH MAILING LISTS
 209 Visit http://mail.ximian.com/mailman/mono-list for details.
 210 .SH WEB SITE
 211 Visit: http://www.go-mono.com for details
 212 .SH SEE ALSO
 213 .BR mcs(1), mint(1), monodis(1), mono-config(5)
 214
 215