Updated mailing list and, in some case, the mono web site URLs
[mono.git] / man / mkbundle.1
1 .\" 
2 .\" mkbundle manual page.
3 .\" (C) 2004 Ximian, Inc. 
4 .\" Author:
5 .\"   Miguel de Icaza (miguel@gnu.org)
6 .\"
7 .de Sp \" Vertical space (when we can't use .PP)
8 .if t .sp .5v
9 .if n .sp
10 ..
11 .TH mkbundle "mkbundle 1.0"
12 .SH NAME
13 mkbundle \- Creates a bundled executable.
14 .SH SYNOPSIS
15 .PP
16 .B mkbundle [options] assembly1 [assembly2 ...]
17 .SH DESCRIPTION
18 \fImkbundle\fP generates an executable program that will contain
19 static copies of the assemblies listed on the command line.  By
20 default only the assemblies specified in the command line will be
21 included in the bundle.  To automatically include all of the
22 dependencies referenced, use the "--deps" command line option.
23 .PP
24 For example, to create a bundle for hello world, use the following
25 command:
26 .nf
27         $ mkbundle -o hello hello.exe
28 .fi
29 .PP
30 The above will pull hello.exe native program called "hello".  Notice
31 that the produced image still contains the CIL image and no
32 precompilation is done.
33 .PP
34 In addition, it is possible to control whether mkbundle should compile
35 the resulting executable or not.  This is useful if you want to link
36 additional libraries or control the generated output in more detail.
37 For example, this could be used to link some libraries statically:
38 .nf
39         $ mkbundle -o host.c -oo bundles.o --deps hello.exe
40
41         $ cc host.c bundles.o /usr/lib/libmono.a -lc -lrt
42 .fi
43 .SH OPTIONS
44 .TP
45 .I "-c"
46 Produce the stub file, do not compile the resulting stub.
47 .TP
48 .I "-o filename"
49 Places the output on `out'.  If the flag -c is specified, this is the
50 C host program.  If not, this contains the resulting executable.
51 .TP
52 .I "-oo filename"
53 Specifies the name to be used for the helper object file that contains
54 the bundle.
55 .TP
56 .I "-L path"
57 Adds the `path' do the search list for assemblies.  The rules are the
58 same as for the compiler -lib: or -L flags.
59 .TP
60 .I  "--nodeps"
61 This is the default: mkbundle will only include the assemblies that
62 were specified on the command line to reduce the size of the resulting
63 image created.
64 .TP
65 .I "--deps"
66 This option will bundle all of the referenced assemblies for the
67 assemblies listed on the command line option.  This is useful to
68 distribute a self-contained image.
69 .TP
70 .I "--keeptemp"
71 By default mkbundle will delete the temporary files that it uses to
72 produce the bundle.  This option keeps the file around.
73 .SH FILES
74 This program will load referenced assemblies from the Mono assembly
75 cache. 
76 .SH MAILING LISTS
77 Visit http://lists.ximian.com/mailman/listinfo/mono-devel-list for details.
78 .SH WEB SITE
79 Visit: http://www.mono-project.com for details
80 .SH SEE ALSO
81 .BR mcs(1), mono(1), mono-config(5).
82
83