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 \-\-fatal
 140 This is used for debugging the compiler.  This makes the error emission
 141 generate an exception that can be caught by a debugger.
 142 .TP
 143 .I \-keyfile:KEYFILE
 144 Strongname (sign) the output assembly using the key pair present in
 145 the specified strong name key file (snk). A full key pair is required
 146 by default (or when using delaysign-). A file containing only the
 147 public key can be used with delaysign+. The option is equivalent to
 148 including [assembly: AssemblyKeyFile ("KEYFILE")] in your source code.
 149 Compiler option takes precedence over the attributes.
 150 .TP
 151 .I \-keycontainer:CONTAINER
 152 Strongname (sign) the output assembly using the key pair present in
 153 the specified container. Note that delaysign+ is ignored when using
 154 key containers. The option is equivalent to including [assembly:
 155 AssemblyKeyName ("CONTAINER")] in your source code. Compiler option
 156 takes precedence over the attributes.
 157 .TP
 158 .I \-langversion:TEXT
 159 The option specifies the version of the language to use. The feature
 160 set is different in each C# version. This switch can be used to force
 161 the compiler to allow only a subset of the features.
 162 The possible values are:
 163 .RS
 164 .ne 8
 165 .TP
 166 .I "Default"
 167 Instruct compiler to use the latest version. Equivalent is to omit the
 168 switch (this currently defaults to the C# 3.0 language specification).
 169 .TP
 170 .I "ISO-1"
 171 Restrict compiler to use only first ISO standardized features.
 172 The usage of features such as generics, static classes, anonymous
 173 methods will lead to error.
 174 .TP
 175 .I "ISO-2"
 176 Restrict compiler to use only the second ISO standardized features.
 177 This allows the use of generics, static classes, iterators and
 178 anonymous methods for example.
 179 .PP
 180 Notice that this flag only controls the language features available to
 181 the programmer, it does not control the kind of assemblies produced.
 182 Programs compiled with mcs will reference the 1.1 APIs, Programs
 183 compiled with gmcs reference the 2.0 APIs.
 184 .ne
 185 .RE
 186 .TP
 187 .I -lib:PATHLIST
 188 Each path specified in the comma-separated list will direct the
 189 compiler to look for libraries in that specified path.
 190 .TP
 191 .I \-L PATH
 192 Directs the compiler to look for libraries in the specified path.
 193 Multiple paths can be provided by using the option multiple times.
 194 .TP
 195 .I \-main:CLASS
 196 Tells the compiler which CLASS contains the entry point. Useful when
 197 you are compiling several classes with a Main method.
 198 .TP
 199 .I \-nostdlib, -nostdlib+
 200 Use this flag if you want to compile the core library.  This makes the
 201 compiler load its internal types from the assembly being compiled.
 202 .TP
 203 .I \-noconfig, \-noconfig+
 204 Disables the default compiler configuration to be loaded.  The
 205 compiler by default has references to the system assemblies.
 206 .TP
 207 .I \-nowarn:WARNLIST
 208 Makes the compiler ignore warnings specified in the comma-separated
 209 list WARNLIST>
 210 .TP
 211 .I -optimize, -optimize+, -optimize-
 212 Controls whether to perform optimizations on the code.   -optimize and
 213 -optimize+ will turn on optimizations, -optimize- will turn it off.
 214 The default in mcs is to optimize+.
 215 .TP
 216 .I -out:FNAME, -o FNAME
 217 Names the output file to be generated.
 218 .TP
 219 .I \-\-parse
 220 Used for benchmarking.  The compiler will only parse its input files.
 221 .TP
 222 .I \-pkg:package1[,packageN]
 223 Reference assemblies for the given packages.
 224 .Sp
 225 The compiler will invoke pkg-config --libs on the set of packages
 226 specified on the command line to obtain libraries and directories to
 227 compile the code.
 228 .Sp
 229 This is typically used with third party components, like this:
 230 .nf
 231
 232                 $ mcs -pkg:gtk-sharp demo.cs
 233 .fi
 234 .RS
 235 .ne 8
 236 .TP
 237 .I \-pkg:dotnet
 238 This will instruct the compiler to reference the System.* libraries
 239 available on a typical dotnet framework installation, notice that this
 240 does not include all of the Mono libraries, only the System.* ones.  This
 241 is a convenient shortcut for those porting code.
 242 .TP
 243 .I \-pkg:olive
 244 Use this to reference the "Olive" libraries (the 3.0 and 3.5 extended
 245 libraries).
 246 .TP
 247 .I \-pkg:silver
 248 References the assemblies for creating Moonlight/Silverlight
 249 applications.  This is automatically used when using the
 250 .I smcs
 251 compiler, but it is here when developers want to use it with the
 252 .I gmcs
 253 compiler.
 254 .TP
 255 .I \-pkg:silverdesktop
 256 Use this option to create Moonlight/Silverlight applications that
 257 target the desktop.   This option allows developers to consume the
 258 Silverlight APIs with the full 2.0 profile API available to them,
 259 unlike
 260 .I smcs
 261 it gives full access to all the APIs that are part of Mono.  The only
 262 downside is that applications created with silverdesktop will not run
 263 on the browser.   Typically these applications will be launched
 264 with the
 265 .I mopen
 266 command line tool.
 267 .TP
 268 For more details see the PACKAGE section in this document
 269 .ne
 270 .RE
 271 .TP
 272 .I -resource:RESOURCE[,ID]
 273 Embeds to the given resource file.  The optional ID can be used to
 274 give a different name to the resource.  If not specified, the resource
 275 name will be the file name.
 276 .TP
 277 .I -linkresource:RESOURCE[,ID]
 278 Links to the specified RESOURCE.  The optional ID can be used to give
 279 a name to the linked resource.
 280 .TP
 281 .I -r:ASSEMBLY1[,ASSEMBLY2], \-reference ASSEMBLY1[,ASSEMBLY2]
 282 Reference the named assemblies.  Use this to use classes from the named
 283 assembly in your program.  The assembly will be loaded from either the
 284 system directory where all the assemblies live, or from the path
 285 explicitly given with the -L option.
 286 .Sp
 287 You can also use a semicolon to separate the assemblies instead of a
 288 comma.
 289 .TP
 290 .I -reference:ALIAS=ASSEMBLY
 291 Extern alias reference support for C#.
 292 .Sp
 293 If you have different assemblies that provide the same types, the
 294 extern alias support allows you to provide names that your software
 295 can use to tell those appart.    The types from ASSEMBLY will be
 296 exposed as ALIAS, then on the C# source code, you need to do:
 297 .Sp
 298 .nf
 299         extern alias ALIAS;
 300 .fi
 301 To bring it into your namespace.   For example, to cope with two
 302 graphics libraries that define "Graphics.Point", one in
 303 "OpenGL.dll" and one in "Postscript.dll", you would invoke the
 304 compiler like this:
 305 .Sp
 306 .nf
 307         mcs -r:Postscript=Postscript.dll -r:OpenGL=OpenGL.dll
 308 .fi
 309 .Sp
 310 And in your source code, you would write:
 311 .Sp
 312 .nf
 313         extern alias Postscript;
 314         extern alias OpenGL;
 315
 316         class X {
 317                 // This is a Graphics.Point from Postscrip.dll
 318                 Postscript.Point p = new Postscript.Point ();
 319
 320                 // This is a Graphics.Point from OpenGL.dll
 321                 OpenGL.Point p = new OpenGL.Point ();
 322         }
 323 .fi
 324 .TP
 325 .I \-recurse:PATTERN, --recurse PATTERN
 326 Does recursive compilation using the specified pattern.  In Unix the
 327 shell will perform globbing, so you might want to use it like this:
 328 .PP
 329 .nf
 330                 $ mcs -recurse:'*.cs'
 331 .fi
 332 .TP
 333 .I \-\-shell
 334 Starts up the compiler in interactive mode, providing a C# shell for
 335 statements and expressions.   A shortcut is to use the
 336 .I csharp
 337 command directly.
 338 .TP
 339 .I \-\-stacktrace
 340 Generates a stack trace at the time the error is reported, useful for
 341 debugging the compiler.
 342 .TP
 343 .I \-target:KIND, \-t:KIND
 344 Used to specify the desired target.  The possible values are: exe
 345 (plain executable), winexe (Windows.Forms executable), library
 346 (component libraries) and module (partial library).
 347 .TP
 348 .I \-\-timestamp
 349 Another debugging flag.  Used to display the times at various points
 350 in the compilation process.
 351 .TP
 352 .I \-unsafe, -unsafe+
 353 Enables compilation of unsafe code.
 354 .TP
 355 .I \-v
 356 Debugging. Turns on verbose yacc parsing.
 357 .TP
 358 .I \-\-version
 359 Shows the compiler version.
 360 .TP
 361 .I \-warnaserror, \-warnaserror+
 362 Treat warnings as errors.
 363 .TP
 364 .I \-warnaserror:W1,[Wn]
 365 Treats one or more compiler warnings as errors.
 366 .TP
 367 .I \-warn:LEVEL
 368 Sets the warning level.  0 is the lowest warning level, and 4 is the
 369 highest.  The default is 4.
 370 .TP
 371 .I \-win32res:FILE
 372 Specifies a Win32 resource file (.res) to be bundled into the
 373 resulting assembly.
 374 .TP
 375 .I \-win32icon:FILE
 376 Attaches the icon specified in FILE on the output into the resulting
 377 assembly.
 378 .TP
 379 .I \-\-
 380 Use this to stop option parsing, and allow option-looking parameters
 381 to be passed on the command line.
 382 .PP
 383 .SH PACKAGES
 384 Depending on the invocation for the C# compiler (mcs, gmcs, or smcs)
 385 you will get a default set of libraries and versions of those
 386 libraries that are referenced.
 387 .PP
 388 The compiler uses the library path to locate libraries, and is able to
 389 reference libraries from a particular package if that directory is
 390 used.  To simplify the use of packages, the C# compiler includes the
 391 -pkg: command line option that is used to load specific collections of
 392 libraries.
 393 .PP
 394 Libraries visible to the compiler are stored relative to the
 395 installation prefix under PREFIX/lib/mono/ called the PACKAGEBASE and the
 396 defaults for mcs, gmcs and smcs are as follows:
 397 .TP
 398 .I mcs
 399 References the PACKAGEBASE/1.0 directory
 400 .TP
 401 .I gmcs
 402 References the PACKAGEBASE/2.0 directory
 403 .TP
 404 .I smcs
 405 References the PACKAGEBASE/2.1 directory
 406 .PP
 407 Those are the only runtime profiles that exist.  Although other
 408 directories exist (like 3.0 and 3.5) those are not really runtime
 409 profiles, they are merely placeholders for extra libraries that build
 410 on the 2.0 foundation.
 411 .PP
 412 Software providers will distribute software that is installed relative
 413 to the PACKAGEBASE directory.  This is integrated into the
 414 .I gacutil
 415 tool that not only installs public assemblies into the Global Assembly
 416 Cache (GAC) but also installs them into the PACKAGEBASE/PKG directory
 417 (where PKG is the name passed to the -package flag to gacutil).
 418 .PP
 419 As a developer, if you want to consume the Gtk# libraries, you would
 420 invoke the compiler like this:
 421 .nf
 422
 423         $ mcs -pkg:gtk-sharp-2.0 main.cs
 424
 425 .fi
 426 The -pkg: option instructs the compiler to fetch the definitions for
 427 gtk-sharp-2.0 from pkg-config, this is equivalent to passing to the C#
 428 compiler the output of:
 429 .nf
 430
 431         $ pkg-config --libs gtk-sharp-2.0
 432
 433 .fi
 434 Usually this merely references the libraries from PACKAGEBASE/PKG.
 435 .PP
 436 Although there are directory names for 3.0 and 3.5, that does not mean
 437 that there are 3.0 and 3.5 compiler editions or profiles.   Those are
 438 merely new libraries that must be manually referenced either with the
 439 proper -pkg: invocation, or by referencing the libraries directly.
 440 .PP
 441 .SH SPECIAL DEFINES
 442 The
 443 .B TRACE
 444 and
 445 .B DEBUG
 446 defines have a special meaning to the compiler.
 447 .PP
 448 By default calls to methods and properties in the
 449 System.Diagnostics.Trace class are not generated unless the TRACE
 450 symbol is defined (either through a "#define TRACE") in your source
 451 code, or by using the
 452 .I "--define TRACE"
 453 in the command line.
 454 .PP
 455 By default calls to methods and properties in the
 456 System.Diagnostics.Debug class are not generated unless the DEBUG
 457 symbol is defined (either through a "#define DEBUG") in your source
 458 code, or by using the
 459 .I "--define DEBUG"
 460 in the command line.
 461 .PP
 462 Note that the effect of defining TRACE and DEBUG is a global setting,
 463 even if they are only defined in a single file.
 464 .PP
 465 .SH DEBUGGING SUPPORT
 466 When using the "-debug" flag, MCS will generate a file with the
 467 extension .mdb that contains the debugging information for the
 468 generated assembly.  This file is consumed by the Mono debugger (mdb).
 469 .SH ENVIRONMENT VARIABLES
 470 .TP
 471 .I "MCS_COLORS"
 472 If this variable is set, it contains a string in the form
 473 "foreground,background" that specifies which color to use to display
 474 errors on some terminals.
 475 .Sp
 476 The background is optional and defaults to your terminal current
 477 background.   The possible colors for foreground are:
 478 .B black, red, brightred, green, brightgreen, yellow, brightyellow,
 479 blue, brightblue, magenta, brightmagenta, cyan, brightcyan, grey,
 480 white and brightwhite.
 481 .Sp
 482 The possible colors for background are: black, red, green, yellow,
 483 blue, magenta, cyan, grey and white.
 484 .Sp
 485 For example, you could set these variable from your shell:
 486 .nf
 487         export MCS_COLORS
 488         MCS_COLORS=errors=brightwhite,red
 489 .fi
 490 .Sp
 491 You can disable the built-in color scheme by setting this variable to
 492 "disable".
 493 .SH NOTES
 494 During compilation the MCS compiler defines the __MonoCS__ symbol,
 495 this can be used by pre-processor instructions to compile Mono C#
 496 compiler specific code.   Please note that this symbol is only to test
 497 for the compiler, and is not useful to distinguish compilation or
 498 deployment platforms.
 499 .SH AUTHORS
 500 The Mono C# Compiler was written by Miguel de Icaza, Ravi Pratap,
 501 Martin Baulig, Marek Safar and Raja Harinath.  The development was
 502 funded by Ximian, Novell and Marek Safar.
 503 .PP
 504 .SH LICENSE
 505 The Mono Compiler Suite is released under the terms of the GNU GPL or
 506 the MIT X11.  Please read the accompanying `COPYING' file for details.
 507 Alternative licensing for the compiler is available from Novell.
 508 .PP
 509 .SH SEE ALSO
 510 csharp(1), mdb(1), mono(1), mopen(1), mint(1), pkg-config(1),sn(1)
 511 .PP
 512 .SH BUGS
 513 To report bugs in the compiler, you must file them on our bug tracking
 514 system, at:
 515 http://www.mono-project.com/Bugs
 516 .SH MAILING LIST
 517 The Mono Mailing lists are listed at http://www.mono-project.com/Mailing_Lists
 518 .SH MORE INFORMATION
 519 The Mono C# compiler was developed by Novell, Inc
 520 (http://www.novell.com, http) and is based on the
 521 ECMA C# language standard available here:
 522 http://www.ecma.ch/ecma1/STAND/ecma-334.htm
 523 .PP
 524 The home page for the Mono C# compiler is at http://www.mono-project.com/CSharp_Compiler