man/mcs.1

   1 .TH mcs 1 "6 January 2001"
   2 .SH NAME
   3 mcs \- Mono Compiler Suite.
   4 .SH SYNOPSIS
   5 .B mcs
   6 [option] [source-files]
   7 .SH DESCRIPTION
   8 mcs is the Mono C# compiler, an implementation of the ECMA-334
   9 language specification.  You can pass one or more options to drive the
  10 compiler, and a set of source files.  Extra options or arguments can
  11 be provided in a response file.  Response files are referenced by
  12 prepending the @ symbol to the response file name.
  13 .PP
  14 The Mono C# compiler accepts the same options than the Microsoft C#
  15 compiler does.  Those options can start with a slash or a dash
  16 (/checked is the same as -checked).  Additionally to this, the
  17 GNU-like options are supported, those begin with "--".  All
  18 MCS-specific flags which are not available in the Microsoft C#
  19 compiler are available only with the GNU-style options.
  20 .PP
  21 C# source files must end with a ".cs" extension.  Compilation of C#
  22 source code requires all the files that make up a library, module or
  23 executable to be provided on the command line.  There is no support
  24 for partial compilation.  To achieve the benefits of partial
  25 compilation, you should compile programs into their own assemblies,
  26 and later reference them with the "-r" flag.
  27 .PP
  28 The Mono C# compiler generates images (.exe files) that contain CIL
  29 byte code that can be executed by any system that implements a Common
  30 Language Infrastructure virtual machine such as the Microsoft .NET
  31 runtime engine on Windows or the Mono runtime engine on Unix systems.
  32 Executables are not bound to a specific CPU or operating system.
  33 .PP
  34 .SH OPTIONS
  35 .TP
  36 .I \-\-about
  37 Displays information about the Mono C# compiler
  38 .TP
  39 .I \-\-addmodule:MODULE1[,MODULE2]
  40 Includes the specified modules in the resulting assembly.
  41 .TP
  42 .I -checked, -checked+
  43 Sets the default compilation mode to `checked'.  This makes all
  44 the math operations checked (the default is unchecked).
  45 .TP
  46 .I -checked-
  47 Sets the default compilation mode to `unchecked'.  This makes all
  48 the math operations unchecked (this is the default).
  49 .TP
  50 .I -codepage:ID
  51 Specifies the code page used to process the input files from the
  52 point it is specified on.  By default files will be processed in the
  53 Latin-1 code page.  The compiler will also automatically detect
  54 Unicode files that have an embedded byte mark at the beginning.   The
  55 special ID "utf8" can be used to switch to utf8 and the ID "reset"
  56 restores the automatic handling of code pages.
  57 .TP
  58 .I \-define:SYMLIST, -d:SYMLIST
  59 Defines the symbol listed by the semi-colon separeted list SYMLIST
  60 SYMBOL.  This can be tested in the source code by the pre-processor,
  61 or can be used by methods that have been tagged with the Conditional
  62 attribute.
  63 .TP
  64 .I \-debug, \-debug+, \-g
  65 Generate debugging information.  To obtain stack traces with debugging
  66 information, you need to invoke the mono runtime with the `--debug'
  67 flag.  This debugging information is stored inside the assembly as a
  68 resource.
  69 .TP
  70 .I \-debug-
  71 Do not generate debugging information.
  72 .TP
  73 .I \-delaysign+
  74 Only embed the strongname public key into the assembly. The actual
  75 signing must be done in a later stage using the SN tool. This is useful
  76 to protect the private key during development. Note that delay signing
  77 can only be done using a strongname key file (not a key container). The
  78 option is equivalent to including [assembly: AssemblyDelaySign (true)]
  79 in your source code. Compiler option takes precedence over the
  80 attributes.
  81 .TP
  82 .I \-delaysign-
  83 Default. Strongname (sign) the assembly using the strong name key file
  84 (or container). The option is equivalent to including [assembly:
  85 AssemblyDelaySign (false)] in your source code. Compiler option takes
  86 precedence over the attributes.
  87 .TP
  88 .I \-\-expect-error X L
  89 The compiler will expect the code to generate an error
  90 named `X' in line `L'.  This is only used by the test suite.
  91 .TP
  92 .I \-\-fatal
  93 This is used for debugging the compiler.  This makes the error emission
  94 generate an exception that can be caught by a debugger.
  95 .TP
  96 .I \-keyfile:KEYFILE
  97 Strongname (sign) the output assembly using the key pair present in
  98 the specified strong name key file (snk). A full key pair is required
  99 by default (or when using delaysign-). A file containing only the
 100 public key can be used with delaysign+. The option is equivalent to
 101 including [assembly: AssemblyKeyFile ("KEYFILE")] in your source code.
 102 Compiler option takes precedence over the attributes.
 103 .TP
 104 .I \-keycontainer:CONTAINER
 105 Strongname (sign) the output assembly using the key pair present in
 106 the specified container. Note that delaysign+ is ignored when using
 107 key containers. The option is equivalent to including [assembly:
 108 AssemblyKeyName ("CONTAINER")] in your source code. Compiler option
 109 takes precedence over the attributes.
 110 .TP
 111 .I -lib:PATHLIST
 112 Each path specified in the comma-separated list will direct the
 113 compiler to look for libraries in that specified path.
 114 .TP
 115 .I \-L PATH
 116 Directs the compiler to look for libraries in the specified path.
 117 Multiple paths can be provided by using the option multiple times.
 118 .TP
 119 .I \-main:CLASS
 120 Tells the compiler which CLASS contains the entry point. Useful when
 121 you are compiling several classes with a Main method.
 122 .TP
 123 .I \-nostdlib, -nostdlib+
 124 Use this flag if you want to compile the core library.  This makes the
 125 compiler load its internal types from the assembly being compiled.
 126 .TP
 127 .I \-noconfig, \-noconfig+
 128 Disables the default compiler configuration to be loaded.  The
 129 compiler by default has references to the system assemblies.
 130 .TP
 131 .I \-nowarn:WARNLIST
 132 Makes the compiler ignore warnings specified in the comma-separeted
 133 list WARNLIST>
 134 .TP
 135 .I -out:FNAME, -o FNAME
 136 Names the output file to be generated.
 137 .TP
 138 .I \-\-parse
 139 Used for benchmarking.  The compiler will only parse its input files.
 140 .TP
 141 .I \-pkg:package1[,packageN]
 142 The compiler will invoke pkg-config --libs on the set of packages
 143 specified on the command line to obtain libraries and directories to
 144 compile the code.
 145 .PP
 146 This is typically used with third party components, like this:
 147 .nf
 148                 $ mcs -pkg:gtk-sharp demo.cs
 149 .fi
 150 .TP
 151 .I -resource:RESOURCE[,ID]
 152 Embeds to the given resource file.  The optional ID can be used to
 153 give a different name to the resource.  If not specified, the resource
 154 name will be the file name.
 155 .TP
 156 .I -linkresource:RESOURCE[,ID]
 157 Links to the specified RESOURCE.  The optional ID can be used to give
 158 a name to the linked resource.
 159 .TP
 160 .I -r:ASSEMBLY1[,ASSEMBLY2], \-r ASSEMBLY1[,ASSEMBLY2]
 161 Reference the named assemblies.  Use this to use classes from the named
 162 assembly in your program.  The assembly will be loaded from either the
 163 system directory where all the assemblies live, or from the path
 164 explicitly given with the -L option.
 165 .PP
 166 You can also use a semicolon to separate the assemblies instead of a
 167 comma.
 168 .TP
 169 .I \-recurse:PATTERN, --recurse PATTERN
 170 Does recursive compilation using the specified pattern.  In Unix the
 171 shell will perform globbing, so you migth want to use it like this:
 172 .PP
 173 .nf
 174                 $ mcs -recurse:'*.cs'
 175 .fi
 176 .TP
 177 .I \-\-stacktrace
 178 Generates a stack trace at the time the error is reported, useful for
 179 debugging the compiler.
 180 .TP
 181 .I \-target:KIND, \-t:KIND
 182 Used to specify the desired target.  The possible values are: exe
 183 (plain executable), winexe (Windows.Forms executable), library
 184 (component libraries) and module (partial library).
 185 .TP
 186 .I \-\-timestamp
 187 Another debugging flag.  Used to display the times at various points
 188 in the compilation process.
 189 .TP
 190 .I \-unsafe, -unsafe+
 191 Enables compilation of unsafe code.
 192 .TP
 193 .I \-v
 194 Debugging. Turns on verbose yacc parsing.
 195 .TP
 196 .I \-v2
 197 Turns on C# 2.0 language features.
 198 .TP
 199 .I \-\-version
 200 Shows the compiler version.
 201 .TP
 202 .I \-warnaserror, \-warnaserror+
 203 Treat warnings as errors.
 204 .TP
 205 .I \-warn:LEVEL
 206 Sets the warning level.  0 is the lowest warning level, and 4 is the
 207 highest.  The default is 2.
 208 .TP
 209 .I \-win32res:FILE
 210 Specifies a Win32 resource file (.res) to be bundled into the
 211 resulting assembly.
 212 .TP
 213 .I \-win32icon:FILE
 214 Attaches the icon specified in FILE on the output into the resulting
 215 assembly.
 216 .TP
 217 .I \-\-
 218 Use this to stop option parsing, and allow option-looking parameters
 219 to be passed on the command line.
 220 .PP
 221 .SH SPECIAL DEFINES
 222 The
 223 .B TRACE
 224 and
 225 .B DEBUG
 226 defines have a special meaning to the compiler.
 227 .PP
 228 By default calls to methods and properties in the
 229 System.Diagnostics.Trace class are not generated unless the TRACE
 230 symbol is defined (either through a "#define TRACE") in your source
 231 code, or by using the
 232 .I "--define TRACE"
 233 in the command line.
 234 .PP
 235 By default calls to methods and properties in the
 236 System.Diagnostics.Debug class are not generated unless the DEBUG
 237 symbol is defined (either through a "#define DEBUG") in your source
 238 code, or by using the
 239 .I "--define DEBUG"
 240 in the command line.
 241 .PP
 242 Note that the effect of defining TRACE and DEBUG is a global setting,
 243 even if they are only defined in a single file.
 244 .PP
 245 .SH DEBUGGING SUPPORT
 246 When use the "--debug" or "-g" flag, MCS will create an assembler file
 247 FILE-debug.s containing debugging information where FILE is the name of
 248 the generated assembly. You need to run this file through the assembler
 249 to get a object file FILE-debug.o.  See mono's "--dwarf-plus" argument
 250 for details on how to use this file.
 251 .SH NOTES
 252 During compilation the MCS compiler defines the __MonoCS__ symbol,
 253 this can be used by pre-processor instructions to compile Mono C#
 254 compiler specific code.   Please note that this symbol is only to test
 255 for the compiler, and is not useful to distinguish compilation or
 256 deployment platforms.
 257 .SH AUTHORS
 258 The Mono C# Compiler was written by Miguel de Icaza, Ravi Pratap and
 259 Martin Baulig at Ximian.
 260 .PP
 261 .SH LICENSE
 262 The Mono Compiler Suite is released under the terms of the GNU GPL.
 263 Please read the accompanying `COPYING' file for details.  Alternative
 264 licenses are available from Ximian.
 265 .PP
 266 .SH SEE ALSO
 267 mono(1), mint(1), sn(1)
 268 .PP
 269 .SH BUGS
 270 To report bugs in the compiler, you can use `bug-buddy', or you can
 271 file bug reports in our bug tracking system:
 272 http://bugzilla.ximian.com.
 273 .SH MAILING LIST
 274 The Mono Mailing List is available at: mono-list-request@ximian.com
 275 .SH MORE INFORMATION
 276 The Mono C# compiler is developed by Ximian, Inc
 277 (http://www.ximian.com) (http://www.ximian.com) and is based on the
 278 ECMA C# language standard available here:
 279 http://www.ecma.ch/ecma1/STAND/ecma-334.htm
 280
 281