[mini] Factor out function for emitting write barriers.
[mono.git] / man / mcs.1
1 .de Sp \" Vertical space (when we can't use .PP)
2 .if t .sp .5v
3 .if n .sp
4 ..
5 .TH mcs 1 "6 January 2001"
6 .SH NAME 
7 mcs, gmcs, smcs \- Mono C# Compiler (1.0, 2.0, Moonlight)
8 .SH SYNOPSIS
9 .B mcs 
10 [option] [source-files]
11 .SH DESCRIPTION
12 mcs is the Mono C# compiler, an implementation of the ECMA-334
13 language specification.  You can pass one or more options to drive the
14 compiler, and a set of source files.  Extra options or arguments can
15 be provided in a response file.  Response files are referenced by
16 prepending the @ symbol to the response file name.
17 .PP
18 The 
19 .I mcs
20 compiler is used to compile against the 1.x profile and implements
21 C# 1.0 and parts of C# 2.0 and C# 3.0 specification which do not depend
22 on generics.
23 .PP
24 The
25 .I gmcs
26 compiler is used to compile against the 2.0 profile and implements
27 the complete C# 3.0 specification.
28 .PP
29 The
30 .I smcs
31 compiler is used to compile against the Silverlight/Moonlight profile.
32 This profile is designed to be used for creating Silverlight/Moonlight
33 applications that will run on a web browser.   The API exposed by this
34 profile is a small subset of the 3.5 API (even if it is commonly
35 referred as the 2.1 API, this API is a small subset of 2.0 with a few
36 extensions).
37 .PP
38 See the section on packages for more information.
39 .PP
40 The Mono C# compiler accepts the same command line options that the
41 Microsoft C# compiler does.  Those options can start with a slash or a
42 dash (/checked is the same as -checked).  Additionally some GNU-like
43 options are supported, those begin with "--".  All MCS-specific flags
44 which are not available in the Microsoft C# compiler are available
45 only with the GNU-style options.
46 .PP
47 C# source files must end with a ".cs" extension.  Compilation of C#
48 source code requires all the files that make up a library, module or
49 executable to be provided on the command line.  There is no support
50 for partial compilation.  To achieve the benefits of partial
51 compilation, you should compile programs into their own assemblies,
52 and later reference them with the "-r" flag.
53 .PP
54 The Mono C# compiler generates images (.exe files) that contain CIL
55 byte code that can be executed by any system that implements a Common
56 Language Infrastructure virtual machine such as the Microsoft .NET
57 runtime engine on Windows or the Mono runtime engine on Unix systems.
58 Executables are not bound to a specific CPU or operating system.
59 .PP
60 The Mono C# compiler by default only references three assemblies:
61 mscorlib.dll, System.dll and System.Xml.dll.   If you want to
62 reference extra libraries you must manually specify them using the
63 -pkg: command line option or the -r: command line option.
64 Alternatively if you want to get all of the System libraries, you can
65 use the -pkg:dotnet command line option.
66 .PP
67 .SH OPTIONS
68 .TP
69 .I \-\-about
70 Displays information about the Mono C# compiler
71 .TP
72 .I \-\-addmodule:MODULE1[,MODULE2]
73 Includes the specified modules in the resulting assembly.  Modules are
74 created by calling the compiler with the -target:module option
75 .TP
76 .I -checked, -checked+
77 Sets the default compilation mode to `checked'.  This makes all
78 the math operations checked (the default is unchecked).
79 .TP
80 .I -checked-
81 Sets the default compilation mode to `unchecked'.  This makes all
82 the math operations unchecked (this is the default).
83 .TP
84 .I -clscheck-, -clscheck+
85 Disables or enables the Common Language Specification (CLS) checks (it
86 is enabled by default). 
87 .Sp
88 The Common Language Specification (CLS) defines an interoperable
89 subset of types as well as conventions that compilers (CLS producers)
90 and developers must follow to expose code to other programming
91 languages (CLS consumers).  
92 .TP
93 .I -codepage:ID
94 Specifies the code page used to process the input files from the
95 point it is specified on.  By default files will be processed in the
96 environment-dependent native code page.  The compiler will also automatically
97 detect Unicode files that have an embedded byte mark at the beginning.   
98 .Sp
99 Other popular encodings are 28591 (Latin1), 1252 (iso-8859-1) and 65001 (UTF-8).
100 .Sp
101 MCS supports a couple of shorthands: "utf8" can be used to specify utf-8 instead
102 of using the cryptic 65001 and "reset" restores the automatic handling of
103 code pages.  These shorthands are not available on the Microsoft compiler.
104 .TP
105 .I \-define:SYMLIST, -d:SYMLIST
106 Defines the symbol listed by the semi-colon separated list SYMLIST
107 SYMBOL.  This can be tested in the source code by the pre-processor,
108 or can be used by methods that have been tagged with the Conditional
109 attribute. 
110 .TP
111 .I \-debug, \-debug+
112 Generate debugging information.  To obtain stack traces with debugging
113 information, you need to invoke the mono runtime with the `--debug'
114 flag.  This debugging information is stored inside the assembly as a
115 resource.
116 .TP
117 .I \-debug-
118 Do not generate debugging information.
119 .TP
120 .I \-delaysign+
121 Only embed the strongname public key into the assembly. The actual 
122 signing must be done in a later stage using the SN tool. This is useful
123 to protect the private key during development. Note that delay signing
124 can only be done using a strongname key file (not a key container). The
125 option is equivalent to including [assembly: AssemblyDelaySign (true)] 
126 in your source code. Compiler option takes precedence over the 
127 attributes.
128 .TP
129 .I \-delaysign-
130 Default. Strongname (sign) the assembly using the strong name key file
131 (or container). The option is equivalent to including [assembly: 
132 AssemblyDelaySign (false)] in your source code. Compiler option takes
133 precedence over the attributes.
134 .TP
135 .I \-doc:FILE
136 Extracts the C#/XML documentation from the source code and stores in in
137 the given FILE.
138 .TP
139 .I \-errorreport
140 This flag is ignored by Mono's C# compiler and is present only to
141 allow MCS to be used as a CSC replacement for msbuild/xbuild.
142 .TP
143 .I \-\-fatal 
144 This is used for debugging the compiler.  This makes the error emission
145 generate an exception that can be caught by a debugger.
146 .TP
147 .I \-filealign
148 This flag is ignored by Mono's C# compiler and is present only to
149 allow MCS to be used as a CSC replacement for msbuild/xbuild.
150 .TP
151 .I \-keyfile:KEYFILE
152 Strongname (sign) the output assembly using the key pair present in 
153 the specified strong name key file (snk). A full key pair is required
154 by default (or when using delaysign-). A file containing only the
155 public key can be used with delaysign+. The option is equivalent to 
156 including [assembly: AssemblyKeyFile ("KEYFILE")] in your source code.
157 Compiler option takes precedence over the attributes.
158 .TP
159 .I \-keycontainer:CONTAINER
160 Strongname (sign) the output assembly using the key pair present in 
161 the specified container. Note that delaysign+ is ignored when using 
162 key containers. The option is equivalent to including [assembly: 
163 AssemblyKeyName ("CONTAINER")] in your source code. Compiler option 
164 takes precedence over the attributes.
165 .TP
166 .I \-langversion:TEXT
167 The option specifies the version of the language to use. The feature
168 set is different in each C# version. This switch can be used to force
169 the compiler to allow only a subset of the features.
170 The possible values are:
171 .RS
172 .ne 8
173 .TP
174 .I "Default"
175 Instruct compiler to use the latest version. Equivalent is to omit the
176 switch (this currently defaults to the C# 3.0 language specification).
177 .TP
178 .I "ISO-1"
179 Restrict compiler to use only first ISO standardized features.
180 The usage of features such as generics, static classes, anonymous
181 methods will lead to error.
182 .TP
183 .I "ISO-2"
184 Restrict compiler to use only the second ISO standardized features.
185 This allows the use of generics, static classes, iterators and
186 anonymous methods for example.
187 .TP
188 .I "3"
189 Restrict the compiler to use only the features available in C# 3.0
190 (a superset of ISO-1 and ISO-2).
191 .TP
192 .I "future"
193 Enables features from upcoming versions of the language.   As of
194 May 2009 this includes support for C# 4 as released in Visual Studio 2010 beta 1.
195 .PP
196 Notice that this flag only controls the language features available to
197 the programmer, it does not control the kind of assemblies produced.
198 Programs compiled with mcs will reference the 1.1 APIs, Programs
199 compiled with gmcs reference the 2.0 APIs.
200 .ne
201 .RE
202 .TP
203 .I -lib:PATHLIST
204 Each path specified in the comma-separated list will direct the
205 compiler to look for libraries in that specified path.
206 .TP
207 .I \-L PATH
208 Directs the compiler to look for libraries in the specified path.
209 Multiple paths can be provided by using the option multiple times.
210 .TP
211 .I \-main:CLASS
212 Tells the compiler which CLASS contains the entry point. Useful when
213 you are compiling several classes with a Main method.
214 .TP
215 .I \-nostdlib, -nostdlib+
216 Use this flag if you want to compile the core library.  This makes the
217 compiler load its internal types from the assembly being compiled.
218 .TP
219 .I \-noconfig, \-noconfig+
220 Disables the default compiler configuration to be loaded.  The
221 compiler by default has references to the system assemblies. 
222 .TP
223 .I \-nowarn:WARNLIST
224 Makes the compiler ignore warnings specified in the comma-separated
225 list WARNLIST>
226 .TP
227 .I -optimize, -optimize+, -optimize-
228 Controls whether to perform optimizations on the code.   -optimize and
229 -optimize+ will turn on optimizations, -optimize- will turn it off.
230 The default in mcs is to optimize+.
231 .TP
232 .I -out:FNAME, -o FNAME
233 Names the output file to be generated.
234 .TP
235 .I \-\-parse
236 Used for benchmarking.  The compiler will only parse its input files.
237 .TP
238 .I \-pkg:package1[,packageN]
239 Reference assemblies for the given packages.
240 .Sp
241 The compiler will invoke pkg-config --libs on the set of packages
242 specified on the command line to obtain libraries and directories to
243 compile the code.
244 .Sp
245 This is typically used with third party components, like this:
246 .nf
247
248                 $ mcs -pkg:gtk-sharp demo.cs
249 .fi
250 .RS
251 .ne 8
252 .TP
253 .I \-pkg:dotnet
254 This will instruct the compiler to reference the System.* libraries
255 available on a typical dotnet framework installation, notice that this
256 does not include all of the Mono libraries, only the System.* ones.  This
257 is a convenient shortcut for those porting code.
258 .TP
259 .I \-pkg:olive
260 Use this to reference the "Olive" libraries (the 3.0 and 3.5 extended
261 libraries).
262 .TP
263 .I \-pkg:silver
264 References the assemblies for creating Moonlight/Silverlight
265 applications.  This is automatically used when using the 
266 .I smcs 
267 compiler, but it is here when developers want to use it with the
268 .I gmcs
269 compiler.
270 .TP
271 .I \-pkg:silverdesktop
272 Use this option to create Moonlight/Silverlight applications that
273 target the desktop.   This option allows developers to consume the
274 Silverlight APIs with the full 2.0 profile API available to them,
275 unlike 
276 .I smcs 
277 it gives full access to all the APIs that are part of Mono.  The only
278 downside is that applications created with silverdesktop will not run
279 on the browser.   Typically these applications will be launched
280 with the 
281 .I mopen
282 command line tool.
283 .TP
284 For more details see the PACKAGE section in this document
285 .ne
286 .RE
287 .TP
288 .I \-platform:ARCH
289 Used to specify the target platform. The possible values are: anycpu,
290 x86, x64 or itanium. As of June 2009, the Mono runtime only have support
291 to emit anycpu and x86 assemblies.
292 .TP
293 .I -resource:RESOURCE[,ID]
294 Embeds to the given resource file.  The optional ID can be used to
295 give a different name to the resource.  If not specified, the resource
296 name will be the file name.
297 .TP
298 .I -linkresource:RESOURCE[,ID]
299 Links to the specified RESOURCE.  The optional ID can be used to give
300 a name to the linked resource.
301 .TP
302 .I -r:ASSEMBLY1[,ASSEMBLY2], \-reference ASSEMBLY1[,ASSEMBLY2]
303 Reference the named assemblies.  Use this to use classes from the named
304 assembly in your program.  The assembly will be loaded from either the
305 system directory where all the assemblies live, or from the path
306 explicitly given with the -L option.
307 .Sp
308 You can also use a semicolon to separate the assemblies instead of a
309 comma. 
310 .TP
311 .I -reference:ALIAS=ASSEMBLY
312 Extern alias reference support for C#.
313 .Sp
314 If you have different assemblies that provide the same types, the
315 extern alias support allows you to provide names that your software
316 can use to tell those appart.    The types from ASSEMBLY will be
317 exposed as ALIAS, then on the C# source code, you need to do:
318 .Sp
319 .nf
320         extern alias ALIAS;
321 .fi
322 To bring it into your namespace.   For example, to cope with two
323 graphics libraries that define "Graphics.Point", one in
324 "OpenGL.dll" and one in "Postscript.dll", you would invoke the
325 compiler like this:
326 .Sp
327 .nf
328         mcs -r:Postscript=Postscript.dll -r:OpenGL=OpenGL.dll
329 .fi
330 .Sp
331 And in your source code, you would write:
332 .Sp
333 .nf
334         extern alias Postscript;
335         extern alias OpenGL;
336
337         class X {
338                 // This is a Graphics.Point from Postscrip.dll
339                 Postscript.Point p = new Postscript.Point ();
340
341                 // This is a Graphics.Point from OpenGL.dll
342                 OpenGL.Point p = new OpenGL.Point ();
343         }
344 .fi
345 .TP
346 .I \-recurse:PATTERN, --recurse PATTERN
347 Does recursive compilation using the specified pattern.  In Unix the
348 shell will perform globbing, so you might want to use it like this:
349 .PP
350 .nf
351                 $ mcs -recurse:'*.cs' 
352 .fi
353 .TP
354 .I \-\-shell
355 Starts up the compiler in interactive mode, providing a C# shell for
356 statements and expressions.   A shortcut is to use the
357 .I csharp
358 command directly.
359 .TP
360 .I \-\-stacktrace
361 Generates a stack trace at the time the error is reported, useful for
362 debugging the compiler.
363 .TP
364 .I \-target:KIND, \-t:KIND
365 Used to specify the desired target.  The possible values are: exe
366 (plain executable), winexe (Windows.Forms executable), library
367 (component libraries) and module (partial library).
368 .TP
369 .I \-\-timestamp
370 Another debugging flag.  Used to display the times at various points
371 in the compilation process.
372 .TP
373 .I \-unsafe, -unsafe+
374 Enables compilation of unsafe code.
375 .TP
376 .I \-v 
377 Debugging. Turns on verbose yacc parsing.
378 .TP
379 .I \-\-version
380 Shows the compiler version.
381 .TP
382 .I \-warnaserror, \-warnaserror+
383 All compilers warnings will be reported as errors.
384 .TP
385 .I \-warnaserror:W1,[Wn], -warnaserror+:W1,[Wn]
386 Treats one or more compiler warnings as errors.
387 .TP
388 .I \-warnaserror-:W1,[Wn]
389 Sets one or more compiler warnings to be always threated as warnings.
390 Becomes useful when used together with -warnaserror.
391 .TP
392 .I \-warn:LEVEL
393 Sets the warning level.  0 is the lowest warning level, and 4 is the
394 highest.  The default is 4.
395 .TP
396 .I \-win32res:FILE
397 Specifies a Win32 resource file (.res) to be bundled into the
398 resulting assembly.
399 .TP
400 .I \-win32icon:FILE
401 Attaches the icon specified in FILE on the output into the resulting
402 assembly.
403 .TP
404 .I \-\-
405 Use this to stop option parsing, and allow option-looking parameters
406 to be passed on the command line.
407 .PP
408 .SH PACKAGES AND LIBRARIES
409 When referencing an assembly, if the name of the assembly is a path,
410 the compiler will try to load the assembly specified in the path.   If
411 it does not, then the compiler will try loading the assembly from the
412 current directory, the compiler base directory and if the assembly is
413 not found in any of those places in the directories specified as
414 arguments to the -lib: command argument.
415 .PP
416 Depending on the invocation for the C# compiler (mcs, gmcs, or smcs)
417 you will get a default set of libraries and versions of those
418 libraries that are referenced.
419 .PP
420 The compiler uses the library path to locate libraries, and is able to
421 reference libraries from a particular package if that directory is
422 used.  To simplify the use of packages, the C# compiler includes the
423 -pkg: command line option that is used to load specific collections of
424 libraries. 
425 .PP 
426 Libraries visible to the compiler are stored relative to the
427 installation prefix under PREFIX/lib/mono/ called the PACKAGEBASE and the
428 defaults for mcs, gmcs and smcs are as follows:
429 .TP 
430 .I mcs
431 References the PACKAGEBASE/1.0 directory
432 .TP
433 .I gmcs
434 References the PACKAGEBASE/2.0 directory
435 .TP
436 .I smcs
437 References the PACKAGEBASE/2.1 directory
438 .PP
439 Those are the only runtime profiles that exist.  Although other
440 directories exist (like 3.0 and 3.5) those are not really runtime
441 profiles, they are merely placeholders for extra libraries that build
442 on the 2.0 foundation.
443 .PP
444 Software providers will distribute software that is installed relative
445 to the PACKAGEBASE directory.  This is integrated into the 
446 .I gacutil
447 tool that not only installs public assemblies into the Global Assembly
448 Cache (GAC) but also installs them into the PACKAGEBASE/PKG directory
449 (where PKG is the name passed to the -package flag to gacutil).
450 .PP
451 As a developer, if you want to consume the Gtk# libraries, you would
452 invoke the compiler like this:
453 .nf
454
455         $ mcs -pkg:gtk-sharp-2.0 main.cs
456
457 .fi
458 The -pkg: option instructs the compiler to fetch the definitions for
459 gtk-sharp-2.0 from pkg-config, this is equivalent to passing to the C#
460 compiler the output of:
461 .nf
462
463         $ pkg-config --libs gtk-sharp-2.0
464
465 .fi
466 Usually this merely references the libraries from PACKAGEBASE/PKG.
467 .PP
468 Although there are directory names for 3.0 and 3.5, that does not mean
469 that there are 3.0 and 3.5 compiler editions or profiles.   Those are
470 merely new libraries that must be manually referenced either with the
471 proper -pkg: invocation, or by referencing the libraries directly. 
472 .PP
473 .SH SPECIAL DEFINES
474 The 
475 .B TRACE
476 and
477 .B DEBUG
478 defines have a special meaning to the compiler.
479 .PP
480 By default calls to methods and properties in the
481 System.Diagnostics.Trace class are not generated unless the TRACE
482 symbol is defined (either through a "#define TRACE") in your source
483 code, or by using the
484 .I "--define TRACE"
485 in the command line.
486 .PP
487 By default calls to methods and properties in the
488 System.Diagnostics.Debug class are not generated unless the DEBUG
489 symbol is defined (either through a "#define DEBUG") in your source
490 code, or by using the
491 .I "--define DEBUG"
492 in the command line.
493 .PP
494 Note that the effect of defining TRACE and DEBUG is a global setting,
495 even if they are only defined in a single file.
496 .PP
497 .SH DEBUGGING SUPPORT
498 When using the "-debug" flag, MCS will generate a file with the
499 extension .mdb that contains the debugging information for the
500 generated assembly.  This file is consumed by the Mono debugger (mdb).
501 .SH ENVIRONMENT VARIABLES
502 .TP
503 .I "MCS_COLORS"
504 If this variable is set, it contains a string in the form
505 "foreground,background" that specifies which color to use to display
506 errors on some terminals.  
507 .Sp
508 The background is optional and defaults to your terminal current
509 background.   The possible colors for foreground are:
510 .B black, red, brightred, green, brightgreen, yellow, brightyellow,
511 blue, brightblue, magenta, brightmagenta, cyan, brightcyan, grey,
512 white and brightwhite.
513 .Sp
514 The possible colors for background are: black, red, green, yellow,
515 blue, magenta, cyan, grey and white.
516 .Sp 
517 For example, you could set these variable from your shell:
518 .nf
519         export MCS_COLORS
520         MCS_COLORS=errors=brightwhite,red
521 .fi
522 .Sp
523 You can disable the built-in color scheme by setting this variable to
524 "disable".
525 .SH NOTES
526 During compilation the MCS compiler defines the __MonoCS__ symbol,
527 this can be used by pre-processor instructions to compile Mono C#
528 compiler specific code.   Please note that this symbol is only to test
529 for the compiler, and is not useful to distinguish compilation or
530 deployment platforms.  
531 .SH AUTHORS
532 The Mono C# Compiler was written by Miguel de Icaza, Ravi Pratap,
533 Martin Baulig, Marek Safar and Raja Harinath.  The development was
534 funded by Ximian, Novell and Marek Safar.
535 .PP
536 .SH LICENSE
537 The Mono Compiler Suite is released under the terms of the GNU GPL or
538 the MIT X11.  Please read the accompanying `COPYING' file for details.
539 Alternative licensing for the compiler is available from Novell.
540 .PP
541 .SH SEE ALSO
542 csharp(1), mdb(1), mono(1), mopen(1), mint(1), pkg-config(1),sn(1)
543 .PP
544 .SH BUGS
545 To report bugs in the compiler, you must file them on our bug tracking
546 system, at:
547 http://www.mono-project.com/Bugs 
548 .SH MAILING LIST
549 The Mono Mailing lists are listed at http://www.mono-project.com/Mailing_Lists
550 .SH MORE INFORMATION
551 The Mono C# compiler was developed by Novell, Inc
552 (http://www.novell.com, http) and is based on the
553 ECMA C# language standard available here:
554 http://www.ecma.ch/ecma1/STAND/ecma-334.htm
555 .PP
556 The home page for the Mono C# compiler is at http://www.mono-project.com/CSharp_Compiler