Merge pull request #5714 from alexischr/update_bockbuild
[mono.git] / man / al.1
1 .TH "al" 1
2 .SH NAME
3 al, al2 \- Mono Assembly Linker
4 .SH SYNOPSIS
5 .B al [option] [source-files]
6 .SH DESCRIPTION
7 AL is the Mono assembly linker. 
8 .PP
9 This linker is used to put together assemblies from a collection of
10 modules (.netmodule files), assembly manifest files and resources.
11 .PP
12 Do not confuse this with the 
13 .B monolinker,
14 which is a tool to reduce the size of assemblies based on the code
15 used. 
16 .PP
17 Use al for processing 1.0 assemblies, use al2 to process 2.0 assemblies.
18 .SH OPTIONS
19 .TP
20 .B @<filename>
21 Read response file for more options.
22 .TP
23 .B -algid:<id>
24 Algorithm used to hash files. The <id> must be specified in hexadecimal.
25 .TP
26 .B -base:<addr> | -baseaddress:<addr>
27 Base address for the library. THIS FEATURE ISN'T IMPLEMENTED.
28 .TP
29 .B -bugreport:<filename>
30 Create a 'Bug Report' file. THIS FEATURE ISN'T IMPLEMENTED.
31 .TP
32 .B -comp:<text> | -company:<text>
33 This inserts the company name into the assembly metadata.
34 This is equivalent to adding the [AssemblyCompany ("<text>")] attribute
35 into C# source code.
36 .TP
37 .B -config:<text> | -configuration:<text>
38 This inserts the configuration string into the assembly metadata.
39 This is equivalent to adding the [AssemblyConfiguration ("<text>")] 
40 attribute into C# source code.
41 .TP
42 .B -copy:<text> | -copyright:<text>
43 This inserts the copyright message into the assembly metadata.
44 This is equivalent to adding the [AssemblyCopyright ("<text>")] 
45 attribute into C# source code.
46 .TP
47 .B -c:<text> | -culture:<text>
48 This inserts the supported culture into the assembly metadata.
49 This is equivalent to adding the [AssemblyCulture ("<text>")] 
50 attribute into C# source code.
51 .TP
52 .B -delay | -delay+ | -delaysign | -delaysign+
53 The generated assembly will be delay signed. 
54 This is equivalent to adding the [AssemblyDelaySignAttribute (true)] 
55 attribute into C# source code.
56 .TP
57 .B -delay- | -delaysign-
58 The generated assembly will be fully signed (i.e. not delay signed).
59 This is the default option when signing (-keyfile or -keyname).
60 .TP
61 .B -descr:<text> | -description:<text>
62 This inserts a description of the assembly into the assembly metadata.
63 This is equivalent to adding the [AssemblyDescription ("<text>")] 
64 attribute into C# source code.
65 .TP
66 .B -e:<filename> | -evidence:<filename>
67 This embed into the assembly the specified file as assembly security
68 evidences.
69 .TP
70 .B -fileversion:<version>
71 Optional Win32 version. This overrides the normal assembly version.
72 .TP
73 .B -flags:<flags>
74 Assembly flags. The <flags> must be specified in hexadecimal.
75 .TP
76 .B -fullpaths
77 Display files using fully-qualified filenames.
78 .TP
79 .B -keyf:<filename> | -keyfile:<filename>
80 Strongname (sign) the output assembly using the key pair present in 
81 the specified strong name key file (snk). A full key pair is required
82 unless the delay signing option is also specified (-delay+).
83 This is equivalent to adding the [AssemblyKeyFile ("<text>")] 
84 attribute into C# source code.
85 .TP
86 .B -keyn:<text> | -keyname:<text>
87 Strongname (sign) the output assembly using the key pair present in 
88 the specified container. Delay signing isn't supported when using key
89 containers.
90 This is equivalent to adding the [AssemblyKeyName ("<text>")] 
91 attribute into C# source code.
92 .TP
93 .B -main:<method>
94 Specifies the method name of the assembly entry point.
95 .TP
96 .B -nologo
97 Suppress the startup banner and copyright message.
98 .TP
99 .B -out:<filename>
100 Output file name for the assembly manifest.
101 .TP
102 .B -prod:<text> | product:<text>
103 This inserts the product name into the assembly metadata.
104 This is equivalent to adding the [AssemblyProduct ("<text>")] 
105 attribute into C# source code.
106 .TP
107 .B -productv[ersion]:<text>
108 This inserts the product version into the assembly metadata.
109 This is equivalent to adding the [AssemblyInformationalVersion ("<text>")] 
110 attribute into C# source code.
111 .TP
112 .B -t[arget]:<target> | -target=<target>
113 Valid <target>s are:
114 .B lib | library
115 to create a library (.dll),
116 .B exe
117 to create a console executable (.exe), and
118 .B win | winexe
119 to create a Windows executable (.exe).
120 .TP
121 .B -template:<filename>
122 Specifies an assembly to get default options from.
123 .TP
124 .B -title:<text>
125 This inserts an assembly title into the assembly metadata.
126 This is equivalent to adding the [AssemblyTitle ("<text>")] 
127 attribute into C# source code.
128 .TP
129 .B -trade:<text> | -trademark:<text>
130 This inserts a trademark message into the assembly metadata.
131 This is equivalent to adding the [AssemblyTrademark ("<text>")] 
132 attribute into C# source code.
133 .TP
134 .B -v:<version> | -version:<version>
135 This inserts the assembly version into the assembly metadata. You can
136 use * to auto-generate remaining numbers.
137 This is equivalent to adding the [AssemblyVersion ("<text>")] 
138 attribute into C# source code.
139 .TP
140 .B -win32icon:<filename>
141 Use this icon for the output.
142 .TP
143 .B -win32res:<filename>
144 Specifies the Win32 resource file.
145 .TP
146 .B -? | -help
147 Display information about AL
148 .PP
149 .SH SEE ALSO
150 sn(1), monolinker(1)
151 .SH COPYRIGHT
152 Copyright (C) 2005 Novell, Inc (http://www.novell.com)
153 .SH MAILING LISTS
154 Visit http://lists.ximian.com/mailman/listinfo/mono-devel-list for details.
155 .SH WEB SITE
156 Visit: http://www.mono-project.com for details