man/monolinker.1

   1 .\"
   2 .\" The Mono Linker manual page.
   3 .\"
   4 .\" Author:
   5 .\"     Jb Evain  <jbevain@novell.com>
   6 .\"
   7 .\" Copyright (C) 2007 Novell, Inc (http://www.novell.com)
   8 .\"
   9
  10 .de Sp
  11 .if t .sp .5v
  12 .if n .sp
  13 .TH CIL Linker "monolinker"
  14 .SH NAME
  15 Mono CIL Linker
  16 .SH SYNOPSIS
  17 .PP
  18 .B monolinker [-o output_directory][-l i18n_assemblies][-c skip | copy | link] -x descriptor | -a assembly | -i info_file ...
  19 .SH DESCRIPTION
  20 \fImonolinker\fP is a CIL Linker.
  21 .PP.
  22 The linker is a tool one can use to only ship the minimal possible set of
  23 functions that a set of programs might require to run as opposed to the full
  24 libraries.
  25 .PP
  26 The linker analyses the intermediate code (CIL) produced by every
  27 compiler targeting the Mono platform like mcs, gmcs, vbnc, booc or
  28 others. It will walk through all the code that it is given to it, and
  29 remove all the unused methods and classes.  This is done using a mark
  30 and sweep operation on all the code that it is referenced.
  31 .PP
  32 The generated output from the monolinker can be later processed by the
  33 .I mkbundle
  34 tool to generate small native self-contained executables.
  35 .PP
  36 Do not confuse this with the Assembly Linker (al) which creates
  37 assemblies from manifests, modules and resource files.
  38 .SH OPTIONS
  39 .TP
  40 .I "-d search_directory"
  41 Specify a directory to the linker where to look for assemblies.
  42 .TP
  43 .I "-o output_directory"
  44 Specify the output directory, default is 'output'.
  45 .Sp
  46 If you specify the directory `.', please ensure that you won't write over
  47 important assemblies of yours.
  48 .TP
  49 .I "-l i18n_assemblies"
  50 Specify what to do with the region specific assemblies
  51 .Sp
  52 Mono have a few assemblies which contains everything region specific:
  53 .nf
  54         I18N.CJK.dll
  55         I18N.MidEast.dll
  56         I18N.Other.dll
  57         I18N.Rare.dll
  58         I18N.West.dll
  59 .fi
  60 .Sp
  61 By default, they will all be copied to the output directory, but you can
  62 specify which one you want using this command. The choice can
  63 either be: none, all, cjk, mideast, other, rare or west. You can
  64 combine the values with a comma.
  65 .TP
  66 .I "-c action"
  67 Specify the action to apply to the core assemblies.
  68 .Sp
  69 Core assemblies are the assemblies that belongs to the base class library,
  70 like mscorlib.dll, System.dll or System.Windows.Forms.dll.
  71 .Sp
  72 The linker supports three operations on these assemblies, you can
  73 specify one of the following actions:
  74 .RS
  75 .ne 8
  76 .TP
  77 .I skip
  78 This instructs the linker to skip them and do nothing with them.
  79 .TP
  80 .I copy
  81 This instructs the linker to copy them to the output directory,
  82 .TP
  83 .I link
  84 This instructs the linker to apply the linking process and reduce
  85 their size.
  86 .ne
  87 .RE
  88 .Sp
  89 .TP "-p action assembly"
  90 .I
  91 Specify per assembly which action to apply.
  92 .TP
  93 .I "-x descriptor"
  94 Use an XML descriptor as a source for the linker.
  95 .Sp
  96 Here is an example that shows all the possibilities of this format:
  97 .Sp
  98 .nf
  99 <linker>
 100         <assembly fullname="Library">
 101                 <type fullname="Foo" />
 102                 <type fullname="Bar" preserve="nothing" required="false" />
 103                 <type fullname="Baz" preserve="fields" required="false" />
 104                 <type fullname="Gazonk">
 105                         <method signature="System.Void .ctor(System.String)" />
 106                         <field signature="System.String _blah" />
 107                 </type>
 108         </assembly>
 109 </linker>
 110 .fi
 111 .Sp
 112 In this example, the linker will link the types Foo, Bar, Baz and Gazonk.
 113 .Sp
 114 The preserve attribute ensures that all the fields of the type Baz will be
 115 always be linked, not matter if they are used or not, but that neither the
 116 fields or the methods of Bar will be linked if they are not used. Not
 117 specifying a preserve attribute implies that we are preserving everything in
 118 the specified type.
 119 .Sp
 120 The required attribute specifies that if the type is not marked, during the
 121 mark operation, it will not be linked.
 122 .Sp
 123 The type Gazonk will be linked, as well as its constructor taking a string as a
 124 parameter, and it's _blah field.
 125 .Sp
 126 You can have multiple assembly nodes.
 127 .TP
 128 .I "-a assemblies"
 129 use an assembly as a source for the linker.
 130 .Sp
 131 The linker will walk through all the methods of the assembly to generate only what
 132 is necessary for this assembly to run.
 133 .TP
 134 .I "-i info_file"
 135 use a .info xml file as a source for the linker.
 136 .Sp
 137 An info file is a file produced by the tool mono-api-info. The linker will use it to
 138 generate an assembly that contains only what the public API defined in he info file
 139 needs. It will also adjust the visibility of the types that have to be present in the
 140 assembly, but that are not visibile from the public API.
 141 .TP
 142 .I "-s [StepBefore:]StepFullName,StepAssembly[:StepAfter]"
 143 .Sp
 144 You can ask the linker to execute custom steps by using the -s command. This command
 145 takes the standard TypeFullName,Assembly format to locate the step. You can customize
 146 its position in the pipeline by either adding it before a step, or after.
 147 .Sp
 148 Example:
 149 .Sp
 150 .nf
 151 using System;
 152
 153 using Mono.Linker;
 154 using Mono.Linker.Steps;
 155
 156 namespace Foo {
 157
 158         public class FooStep : IStep {
 159
 160                 public void Process (LinkContext context)
 161                 {
 162                         foreach (IStep step in context.Pipeline.GetSteps ()) {
 163                                 Console.WriteLine (step.GetType ().Name);
 164                         }
 165                 }
 166         }
 167 }
 168 .fi
 169 .Sp
 170 If you compile this custom against monolinker to a Foo.dll assembly, you
 171 can use the
 172 .I -s
 173 switch as follows.   To add the FooStep at the end of the pipeline:
 174 .Sp
 175 .nf
 176         monolinker -s Foo.FooStep,Foo -a program.exe
 177 .fi
 178 .Sp
 179 This commanand will add the FooStep after the MarkStep:
 180 .Sp
 181 .nf
 182         monolinker -s MarkStep:Foo.FooStep,Foo -a program.exe
 183 .fi
 184 .Sp
 185 This command will add the FooStep before the MarkStep:
 186 .Sp
 187 .nf
 188         monolinker -s Foo.FooStep,Foo:MarkStep -a program.exe
 189 .fi
 190 .Sp
 191 This command will add the FooStep before the MarkStep
 192 .SH COPYRIGHT
 193 Copyright (C) 2007 Novell, Inc (http://www.novell.com)
 194 .SH BUGS
 195 Bugs report are welcome at http://bugzilla.ximian.com
 196 .PP
 197 Product Mono Tools, Component linker.
 198 .SH MAILING LISTS
 199 Mailing lists are listed at http://www.mono-project.com/Mailing_Lists
 200 .SH WEB SITE
 201 http://www.mono-project.com/Linker
 202 .SH AUTHORS
 203 The linker has been written by Jb Evain, and have been partially founded by
 204 the Google Summer of Code.
 205 .SH LICENSE
 206 The linker is licensed under the MIT/X11 license. Please read the accompayning
 207 MIT.X11 file for details.
 208 .SH SEE ALSO
 209 .BR al(1),mkbundle(1),mono(1),mcs(1).