fix the build
[mono.git] / man / oldmono.1
1 .\" 
2 .\" mono manual page.
3 .\" (C) Ximian, Inc. 
4 .\" Author:
5 .\"   Miguel de Icaza (miguel@gnu.org)
6 .\"
7 .TH Mono "Mono 1.0"
8 .SH NAME
9 mono \- Mono ECMA-CLI Just in Time compiler.
10 .SH SYNOPSIS
11 .PP
12 .B mono
13 [\-\-help] [\-d] [\-\-debug-asm] [\-\-debug-forest] [\-\-trace-calls]
14 [\-\-compile name] [\-\-ncompile num]  [\-\-noinline] [\-\-profile]
15 [\-\-debug=[format]] [\-\-debug-args args] [\-\-break name] [\-\-precompile name]
16 [\-\-config filename]
17 program.exe [arguments...]
18 .SH DESCRIPTION
19 The \fImono\fP program is a Just in Time compiler for ECMA CLI byte
20 codes.  It translates dynamically a CIL stream into native code. 
21 .I program.exe
22 and optionally passes
23 the
24 .I arguments
25 to it. 
26 .SH OPTIONS
27 The following options are supported:
28 .TP
29 .I "--help", "-h"
30 Displays usage instructions.
31 .TP
32 .I "--share-code"
33 This mode makes the LoaderOptimization for Application Domains default
34 to sharing code.  This results in slower code, but enables code
35 sharing across application domains.  The default is to maximize for
36 speed, but disallow JITed code sharing across domains.  See
37 System.LoaderOptimization for more information
38 .TP
39 .I "--config filename"
40 Load the specified configuration file instead of the default one(s).
41 The default files are /etc/mono/config and ~/.mono/config or the file
42 specified in the MONO_CONFIG environment variable, if set.
43 .TP
44 .I "--noinline"
45 Disables the code inliner.
46 .TP
47 .SH DEBUGGING OPTIONS
48 The following options are used to debug, or perfomance test the JIT
49 compiler:
50 .TP
51 .I "--trace-calls"
52 Shows method names as they are invoked.
53 .TP
54 .I "--dump-asm"
55 Displays the generated code as methods are invoked.
56 .TP
57 .I "--dump-forest"
58 Displays the basic blocks and the forest of trees that is 
59 created from a stream of CIL opcodes.
60 .TP
61 .I "--compile name"
62 Compiles the method on the given class (namespace.name:methodname) or
63 all classes in the given image (@imagename).
64 .TP
65 .I "--ncompile"
66 Compiles the method a number of times.  If no argument is specified,
67 the method will be compiled a thousand times.
68 .SH DEVELOPMENT OPTIONS
69 The following options are used to debug a JITed application.  They're
70 only useful when running the JIT in a debugger:
71 .TP
72 .I "--debug"
73 Writes out debug information in the given format or in the default format.
74 See DEBUGGING FORMATS for details.
75 .TP
76 .I "--debug-args args"
77 Comma-separated list of additional arguments for the symbol writer.
78 See DEBUGGING FORMATS for details.
79 .TP
80 .I "--break method"
81 Inserts a breakpoint before the method whose name is `method'
82 (namespace.class:methodname).  Use `Main' as method name to insert a breakpoint on the
83 application's main method.
84 .TP
85 .I "--precompile name"
86 Compiles the given class (namespace.name), method (namespace.name:methodname)
87 or all classes in the given image (@imagename) before executing the main
88 application.
89 .TP
90 .I "--profile"
91 Collect profiling information and dump it at the end of the process.
92 .SH DEBUGGING FORMATS
93 The following debugging formats are currently supported:
94 .TP
95 .I "stabs"
96 Writes out stabs debug information.
97 .TP
98 .I "dwarf"
99 Writes out dwarf debug information.
100 .TP
101 .I "mono"
102 Use a symbol file which has been created by MCS.  It can be used to get
103 source lines in stack traces.
104 .PP
105 The "stabs" and "dwarf" formats support the following options:
106 .TP
107 .I "filename=FILENAME"
108 Write debugging information into FILENAME.  This file must be run through
109 the assembler to create an object file.
110 .TP
111 .I "objfile=FILENAME"
112 When automatically assembling the symbol file, write the resulting object
113 file into FILENAME.
114 .TP
115 .I "dont_assemble"
116 Normally, the symbol file is automatically assembled to an object file
117 when you call "mono_debug_make_symbols".  Use this option to disable this
118 behaviour.
119 .TP
120 .I "install_il_files"
121 Put the generated *.il files in the same directory than the assembly they
122 came from.  The default is to put them into the current working directory.
123 .TP
124 .I "dont_update_il_files"
125 Normally, the *.il files are recreated if their assemblies have changed
126 when you call "mono_debug_make_symbols".  Use this option to disable this
127 behaviour.
128 .TP
129 .I "dont_create_il_files"
130 Update the *.il files if their assemblies have changed, but only if the
131 file already exists.
132 .PP
133 .SH ENVIRONMENT VARIABLES
134 .TP
135 .I "MONO_PATH"
136 Provides a search path to mono and mint where to look for library files.
137 Directories are separated by the platform path separator (colons on unix). Example:
138 .B /home/username/lib:/usr/local/mono/lib
139 .PP
140 .TP
141 .I "MONO_DISABLE_SHM"
142 If this variable is set, it disables the Windows I/O Emulation layer,
143 and handles (files, events, mutexes, pipes) will not be shared across
144 processes.  This option is only available on Unix.
145 .TP
146 .I "MONO_CFG_DIR"
147 If set, this variable overrides the default system configuration directory
148 ($PREFIX/etc). It's used to locate machine.config file.
149 .TP
150 .I "GC_DONT_GC"
151 Turns off the garbage collection in Mono.  This should be only used
152 for debugging purposes
153 .TP
154 .I "MONO_CONFIG"
155 If set, this variable overrides the default runtime configuration file
156 ($PREFIX/etc/mono/config). The --config command line options overrides the
157 environment variable.
158 .SH FILES
159 On Unix assemblies are loaded from the installation lib directory.  If you set
160 `prefix' to /usr, the assemblies will be located in /usr/lib.  On
161 Windows, the assemblies are loaded from the directory where mono and
162 mint live.
163 .PP
164 /etc/mono/config, ~/.mono/config
165 .IP
166 Mono runtime configuration file.  See the mono-config(5) manual page
167 for more information.
168 .SH MAILING LISTS
169 Visit http://lists.ximian.com/mailman/listinfo/mono-list for details.
170 .SH WEB SITE
171 Visit: http://www.go-mono.com for details
172 .SH SEE ALSO
173 .BR mcs(1), mint(1), monodis(1), mono-config(5)
174
175