Merge pull request #5714 from alexischr/update_bockbuild
[mono.git] / man / macpack.1
index 464465e9a200068d317c8b70635198165c783a6f..34c52691bd6a126c1ef5e883527a6869623a798f 100644 (file)
@@ -8,47 +8,65 @@
 .if t .sp .5v
 .if n .sp
 ..
-.TH macpack "Mono 1.0"
+.TH Mono "macpack"
 .SH NAME
 macpack \- Macintosh OS X Packager for managed gui assemblies
 .SH SYNOPSIS
 .PP
-.B macpack [options] 
+.B macpack [options] assembly
 .SH DESCRIPTION
 \fImacpack\fP is a tool used to package managed assemblies (like
 System.Windows.Forms or Cocoa#) that require gui availability for deployment
 on Mac OS X.
 .PP
 macpack will prepare a OS X compatible bundle from the provided assembly 
-and resources.
+and resources.  The bundle will include the specified assembly as well
+as any of the provided resources (specified with the -resource: switch).
+.PP
+Developers can specify the kind of application to produce using the
+-mode: argument.  This controls how the environment in the Mono class
+libraries is setup.
 .PP
 .SH OPTIONS
-.I "-a" <assembly location>
+.I "-a assembly"
 .Sp
 This option tells macpack where the managed assembly that you
 want to bundle resides.  This option is also used to point to the shell
 script to launch in the case of a X11/Gtk# application.
 .Sp
-.I "-m" <mode>
+This is the same as just passing the assembly as an argument. 
+.Sp
+.I "-m [winforms,x11,console,cocoa]"
+or
+.I "-mode:[winforms,x11,console,cocoa]"
 .Sp
-An integer parameter of the mode (Cocoa# or System.Windows.Forms or X11).
-System.Windows.Forms = 1
-Cocoa# = 2
-Gtk#/X11 = 3
+A value indicating the kind of application: WinForms is a Winforms
+application running on Quartz;  X11 is an application that requires
+the X11 server to run;  console is a non-graphical application;  cocoa
+is an application based on Cocoa#
 .Sp
-.I "-n" <application name>
+.I "-n NAME"
+or
+.I "-appname:NAME"
 .Sp
 This option specifies the application name of the emitted bundle.
 This is what you will see in Finder.
 .Sp
-.I "-o" <output path>
+.I "-o DIRECTORY"
+or
+.I "-output:DIRECTORY"
 .Sp
 This option specifies the path to output the generated Application.
 .Sp
-.I "-r" <resource>
+.I "-r RESOURCE"
+or 
+.I "-resource:RESOURCE"
 .Sp
 This option can be specified multiple times.  It will place a copy of each resource
-into the bundles resources directory.
+into the bundles resources directory.  Alternatively, you can use a
+comma separated list of resources.
 .fi
+.SH AUTHOR
+Geoff Norton
 .SH WEB SITE
 Visit: http://www.mono-project.com for details