c0a8a01222
tree and verifying that there are no changes). (Also fixed a few bugs that were in the code) svn: r14427
84 lines
3.8 KiB
Racket
84 lines
3.8 KiB
Racket
#lang scribble/doc
|
|
@(require scribble/manual
|
|
"common.ss"
|
|
(for-label scheme/runtime-path))
|
|
|
|
@title[#:tag "exe-dist"]{Distributing Stand-Alone Executables}
|
|
|
|
The command-line flag @DFlag{exe-dir} directs @|mzc| to combine a
|
|
stand-alone executable (created via @DFlag{exe} or @DFlag{gui-exe})
|
|
with all of the shared libraries that are needed to run it, along with
|
|
any run-time files declared via @scheme[define-runtime-path]. The
|
|
resulting package can be moved to other machines that run the same
|
|
operating system.
|
|
|
|
After the @DFlag{exe-dir} flag, supply a directory to contain the
|
|
combined files for a distribution. Each command-line argument is an
|
|
executable to include in the distribution, so multiple executables can
|
|
be packaged together. For example, under Windows,
|
|
|
|
@commandline{mzc --exe-dir geetings hello.exe goodbye.exe}
|
|
|
|
creates a directory @filepath{greetings} (if the directory doesn't
|
|
exist already), and it copies the executables @filepath{hello.exe} and
|
|
@filepath{goodbye.exe} into @filepath{greetings}. It also creates a
|
|
@filepath{lib} sub-directory in @filepath{greetings} to contain DLLs,
|
|
and it adjusts the copied @filepath{hello.exe} and
|
|
@filepath{goodbye.exe} to use the DLLs in @filepath{lib}.
|
|
|
|
The layout of files within a distribution directory is
|
|
platform-specific:
|
|
|
|
@itemize[
|
|
|
|
@item{Under Windows, executables are put directly into the
|
|
distribution directory, and DLLs and other run-time files go
|
|
into a @filepath{lib} sub-directory.}
|
|
|
|
@item{Under Mac OS X, @DFlag{gui-exe} executables go into the
|
|
distribution directory, @DFlag{exe} executables go into a
|
|
@filepath{bin} subdirectory, and frameworks (i.e., shared
|
|
libraries) go into a @filepath{lib} sub-directory along with
|
|
other run-time files. As a special case, if the distribution has
|
|
a single @DFlag{gui-exe} executable, then the @filepath{lib}
|
|
directory is hidden inside the application bundle.}
|
|
|
|
@item{Under Unix, executables go into a @filepath{bin} subdirectory,
|
|
shared libraries (if any) go into a @filepath{lib} subdirectory
|
|
along with other run-time files, and wrapped executables are
|
|
placed into a @filepath{lib/plt} subdirectory with
|
|
version-specific names. This layout is consistent with Unix
|
|
installation conventions; the version-specific names for shared
|
|
libraries and wrapped executables means that distributions can
|
|
be safely unpacked into a standard place on target machines
|
|
without colliding with an existing PLT Scheme installation or
|
|
other executables created by @|mzc|.}
|
|
|
|
]
|
|
|
|
A distribution also has a @filepath{collects} directory that is used
|
|
as the main library collection directory for the packaged executables.
|
|
By default, the directory is empty. Use @|mzc|'s
|
|
@as-index{@DPFlag{copy-collects}} flag to supply a directory whose
|
|
content is copied into the distribution's @filepath{collects}
|
|
directory. The @DPFlag{copy-collects} flag can be used multiple times
|
|
to supply multiple directories.
|
|
|
|
When multiple executables are disrtibuted together, then separately
|
|
creating the executables with @DFlag{exe} and @DFlag{gui-exe} can
|
|
generate multiple copies of collection-based libraries that are used
|
|
by multiple executables. To share the library code, instead, specify a
|
|
target directory for library copies using the
|
|
@as-index{@DFlag{collects-dest}} flag with @DFlag{exe} and
|
|
@DFlag{gui-exe}, and specify the same directory for each executable
|
|
(so that the set of libraries used by all executables are pooled
|
|
together). Finally, when packaging the distribution with
|
|
@DFlag{exe-dir}, use the @DPFlag{copy-collects} flag to include the
|
|
copied libraries in the distribution.
|
|
|
|
|
|
@; ----------------------------------------------------------------------
|
|
|
|
@include-section["dist-api.scrbl"]
|
|
@include-section["bundle-api.scrbl"]
|