Merge pull request #5714 from alexischr/update_bockbuild
[mono.git] / man / monolinker.1
index 9843449ca25a21455da53b79cbf0626736b0db0b..1ec7bcce818492dc70311db2465e85143b0809e2 100644 (file)
@@ -6,10 +6,10 @@
 .\"
 .\" Copyright (C) 2007 Novell, Inc (http://www.novell.com)
 .\"
 .\"
 .\" Copyright (C) 2007 Novell, Inc (http://www.novell.com)
 .\"
-
-.de Sp
+.de Sp \"
 .if t .sp .5v
 .if n .sp
 .if t .sp .5v
 .if n .sp
+..
 .TH CIL Linker "monolinker"
 .SH NAME
 Mono CIL Linker
 .TH CIL Linker "monolinker"
 .SH NAME
 Mono CIL Linker
@@ -29,12 +29,12 @@ others. It will walk through all the code that it is given to it, and
 remove all the unused methods and classes.  This is done using a mark
 and sweep operation on all the code that it is referenced.
 .PP
 remove all the unused methods and classes.  This is done using a mark
 and sweep operation on all the code that it is referenced.
 .PP
-The generated output from the monolinker can be later processed by the 
+The generated output from the monolinker can be later processed by the
 .I mkbundle
 tool to generate small native self-contained executables.
 .PP
 Do not confuse this with the Assembly Linker (al) which creates
 .I mkbundle
 tool to generate small native self-contained executables.
 .PP
 Do not confuse this with the Assembly Linker (al) which creates
-assemblies from manifests, modules and resource files. 
+assemblies from manifests, modules and resource files.
 .SH OPTIONS
 .TP
 .I "-d search_directory"
 .SH OPTIONS
 .TP
 .I "-d search_directory"
@@ -46,6 +46,13 @@ Specify the output directory, default is 'output'.
 If you specify the directory `.', please ensure that you won't write over
 important assemblies of yours.
 .TP
 If you specify the directory `.', please ensure that you won't write over
 important assemblies of yours.
 .TP
+.I "-b true | false"
+Specify whether to generate debug symbols or not, default is false.
+.TP
+.I "-g true | false"
+Specify whether to generate a new guid for each linked module or reuse the
+existing one, default is true.
+.TP
 .I "-l i18n_assemblies"
 Specify what to do with the region specific assemblies
 .Sp
 .I "-l i18n_assemblies"
 Specify what to do with the region specific assemblies
 .Sp
@@ -74,19 +81,22 @@ specify one of the following actions:
 .RS
 .ne 8
 .TP
 .RS
 .ne 8
 .TP
-.I skip 
+.I skip
 This instructs the linker to skip them and do nothing with them.
 .TP
 This instructs the linker to skip them and do nothing with them.
 .TP
-.I copy 
+.I copy
 This instructs the linker to copy them to the output directory,
 .TP
 This instructs the linker to copy them to the output directory,
 .TP
-.I link 
+.I link
 This instructs the linker to apply the linking process and reduce
 their size.
 .ne
 .RE
 .Sp
 .TP
 This instructs the linker to apply the linking process and reduce
 their size.
 .ne
 .RE
 .Sp
 .TP
+.I "-p action assembly"
+Specify per assembly which action to apply.
+.TP
 .I "-x descriptor"
 Use an XML descriptor as a source for the linker.
 .Sp
 .I "-x descriptor"
 Use an XML descriptor as a source for the linker.
 .Sp
@@ -101,6 +111,7 @@ Here is an example that shows all the possibilities of this format:
                <type fullname="Gazonk">
                        <method signature="System.Void .ctor(System.String)" />
                        <field signature="System.String _blah" />
                <type fullname="Gazonk">
                        <method signature="System.Void .ctor(System.String)" />
                        <field signature="System.String _blah" />
+                       <field name="someFieldName" />
                </type>
        </assembly>
 </linker>
                </type>
        </assembly>
 </linker>
@@ -132,9 +143,8 @@ is necessary for this assembly to run.
 use a .info xml file as a source for the linker.
 .Sp
 An info file is a file produced by the tool mono-api-info. The linker will use it to
 use a .info xml file as a source for the linker.
 .Sp
 An info file is a file produced by the tool mono-api-info. The linker will use it to
-generate an assembly that contains only what the public API defined in he info file
-needs. It will also adjust the visibility of the types that have to be present in the
-assembly, but that are not visibile from the public API.
+generate an assembly that contains only what the public API defined in the info file
+needs.
 .TP
 .I "-s [StepBefore:]StepFullName,StepAssembly[:StepAfter]"
 .Sp
 .TP
 .I "-s [StepBefore:]StepFullName,StepAssembly[:StepAfter]"
 .Sp
@@ -165,8 +175,8 @@ namespace Foo {
 .fi
 .Sp
 If you compile this custom against monolinker to a Foo.dll assembly, you
 .fi
 .Sp
 If you compile this custom against monolinker to a Foo.dll assembly, you
-can use the 
-.I -s 
+can use the
+.I -s
 switch as follows.   To add the FooStep at the end of the pipeline:
 .Sp
 .nf
 switch as follows.   To add the FooStep at the end of the pipeline:
 .Sp
 .nf
@@ -186,16 +196,19 @@ This command will add the FooStep before the MarkStep:
 .fi
 .Sp
 This command will add the FooStep before the MarkStep
 .fi
 .Sp
 This command will add the FooStep before the MarkStep
+.TP
+.I "-m CustomParam ParamValue"
+Specify a parameter for a custom step.
 .SH COPYRIGHT
 Copyright (C) 2007 Novell, Inc (http://www.novell.com)
 .SH BUGS
 .SH COPYRIGHT
 Copyright (C) 2007 Novell, Inc (http://www.novell.com)
 .SH BUGS
-Bugs report are welcome at http://bugzilla.ximian.com
+Bugs report are welcome at http://bugzilla.xamarin.com
 .PP
 Product Mono Tools, Component linker.
 .SH MAILING LISTS
 .PP
 Product Mono Tools, Component linker.
 .SH MAILING LISTS
-Mailing lists are listed at http://www.mono-project.com/Mailing_Lists
+Mailing lists are listed at http://www.mono-project.com/community/help/mailing-lists/
 .SH WEB SITE
 .SH WEB SITE
-http://www.mono-project.com/Linker
+http://www.mono-project.com/docs/tools+libraries/tools/linker/
 .SH AUTHORS
 The linker has been written by Jb Evain, and have been partially founded by
 the Google Summer of Code.
 .SH AUTHORS
 The linker has been written by Jb Evain, and have been partially founded by
 the Google Summer of Code.