2007-02-20 Frederik Carlier <frederik.carlier@carlier-online.be>

[mono.git] / man / mkbundle.1

diff --git a/man/mkbundle.1 b/man/mkbundle.1
index dec60d9111f39a9c2f2315bcfd426b061ef2ba59..7bf48382f72b7e74a66a5e126a4f0ee9b44bc1c6 100644 (file)
--- a/man/mkbundle.1
+++ b/man/mkbundle.1
@@ -27,19 +27,27 @@ command:
        $ mkbundle -o hello hello.exe
 .fi
 .PP
-The above will pull hello.exe native program called "hello".  Notice
+The above will pull hello.exe into a native program called "hello".  Notice
 that the produced image still contains the CIL image and no
 precompilation is done.
 .PP
 In addition, it is possible to control whether mkbundle should compile
-the resulting executable or not.  This is useful if you want to link
-additional libraries or control the generated output in more detail.
-For example, this could be used to link some libraries statically:
+the resulting executable or not with the -c option.  This is useful if
+you want to link additional libraries or control the generated output
+in more detail. For example, this could be used to link some libraries
+statically:
 .nf
-       $ mkbundle -o host.c -oo bundles.o --deps hello.exe
+       $ mkbundle -c -o host.c -oo bundles.o --deps hello.exe
 
        $ cc host.c bundles.o /usr/lib/libmono.a -lc -lrt
 .fi
+.PP
+You may also use mkbundle to generate a bundle you can use when
+embedding the Mono runtime in a native application.  In that case, use
+both the -c and --nomain options.  The resulting host.c file will
+not have a main() function.  Call mono_mkbundle_init() before
+initializing the JIT in your code so that the bundled assemblies
+are available to the embedded runtime.
 .SH OPTIONS
 .TP
 .I "-c"
@@ -76,20 +84,44 @@ distribute a self-contained image.
 By default mkbundle will delete the temporary files that it uses to
 produce the bundle.  This option keeps the file around.
 .TP
-.I "--static"
-By default mkbundle dynamically links to mono and glib.  This option
-causes it to statically link instead.
+.I "--machine-config FILE"
+Uses the given FILE as the machine.config file for the generated
+application.   
+.TP
+.I "--nomain"
+With the -c option, generate the host stub without a main() function.
 .TP
 .I "--config-dir DIR"
 When passed, DIR will be set for the MONO_CFG_DIR environment variable
 .TP
+.I "--static"
+By default mkbundle dynamically links to mono and glib.  This option
+causes it to statically link instead.
+.TP
 .I "-z"
 Compresses the assemblies before embedding. This results in smaller
 executable files, but increases startup time and requires zlib to be
 installed on the target system.
+.SH WINDOWS
+On Windows systems, it it necessary to have  Unix-like toolchain to be
+installed for mkbundle to work.  You can use cygwin's and install gcc,
+gcc-mingw and as packages. 
+.SH ENVIRONMENT VARIABLES
+.TP
+.I "AS"
+Assembler command. The default is "as".
+.TP
+.I "CC"
+C compiler command. The default is "cc" under Linux and "gcc -mno-cygwin"
+under Windows.
 .SH FILES
 This program will load referenced assemblies from the Mono assembly
 cache. 
+.SH BUGS
+The option "--static" is not supported under Windows.
+Moreover, a full cygwin environment containing at least "gcc" and "as"
+is required for the build process. The generated executable does not
+depend on cygwin.
 .SH MAILING LISTS
 Visit http://lists.ximian.com/mailman/listinfo/mono-devel-list for details.
 .SH WEB SITE