svn-gvsig-desktop / trunk / build / distribution / launcher / izpack-launcher-1.3 / doc / en / manual.xml @ 21757
History | View | Annotate | Download (8.89 KB)
1 |
<?xml version="1.0" encoding="ISO-8859-1"?>
|
---|---|
2 |
|
3 |
<!--
|
4 |
|
5 |
IzPack native launcher manual.
|
6 |
|
7 |
Copyright (c) 2004 Julien PONGE. All Rights Reserved.
|
8 |
|
9 |
http://www.izforge.com/
|
10 |
<julien@izforge.com>
|
11 |
<julien_ponge@yahoo.fr>
|
12 |
|
13 |
-->
|
14 |
|
15 |
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
16 |
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
|
17 |
<!ENTITY launcher-license SYSTEM "../../LICENSE">
|
18 |
<!ENTITY sample-launcher-ini SYSTEM "../../src/launcher.ini">
|
19 |
]>
|
20 |
|
21 |
<book>
|
22 |
|
23 |
<!-- Headers -->
|
24 |
<bookinfo>
|
25 |
<title>IzPack launcher manual</title> |
26 |
<copyright><year>2004</year><holder>Julien PONGE</holder></copyright> |
27 |
<legalnotice>
|
28 |
<title>Legal notice</title> |
29 |
<para>Redistribution and use in source (XML DocBook) and 'compiled' forms (XML,
|
30 |
(X)HTML, PDF, PostScript, RTF and so forth) with or without modification, are |
31 |
permitted provided that the following conditions are met: |
32 |
<orderedlist>
|
33 |
<listitem><para>Redistributions of source code (XML DocBook) must retain the above copyright |
34 |
notice, this list of conditions and the following disclaimer as the first lines |
35 |
of this file unmodified.</para></listitem> |
36 |
<listitem><para>Redistributions in compiled form (transformed to other DTDs, converted to |
37 |
PDF, PostScript, RTF and other formats) must reproduce the above copyright |
38 |
notice, this list of conditions and the following disclaimer in the |
39 |
documentation and/or other materials provided with the distribution.</para></listitem> |
40 |
</orderedlist>
|
41 |
<emphasis>Important:</emphasis> THIS DOCUMENTATION IS PROVIDED BY THE IZPACK PROJECT "AS IS" |
42 |
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
43 |
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
44 |
DISCLAIMED. IN NO EVENT SHALL THE IZPACK PROJECT BE LIABLE FOR |
45 |
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
46 |
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
47 |
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
48 |
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
49 |
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
50 |
DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</para>
|
51 |
</legalnotice>
|
52 |
</bookinfo>
|
53 |
|
54 |
<!-- Chapter 1 -->
|
55 |
<chapter>
|
56 |
<title>Overview</title> |
57 |
|
58 |
<sect1>
|
59 |
|
60 |
<title>Introduction</title> |
61 |
|
62 |
<para>The <ulink url="http://www.izforge.com/izpack/">IzPack</ulink> project |
63 |
allows you to prepare some installers for your applications. Those installers |
64 |
can be used identically no matter what the target operating system is because |
65 |
it has been implemented with the Java technology. This means that the same |
66 |
installer file can be distributed to your Linux, FreeBSD, Win32 and Mac users. |
67 |
While this is already a big advantage over preparing an installer or a package |
68 |
for each platform, it still relies on the hypothesis that your users already |
69 |
have a well installed Java Runtime Environment (JRE) on their systems.</para>
|
70 |
|
71 |
<para>While corporate users should be able to install a JRE by themselves,
|
72 |
this might not always be the case. Worse, the average home user might not know |
73 |
what a JRE is and he might not understand why your installer can't be launched. |
74 |
</para>
|
75 |
|
76 |
</sect1>
|
77 |
|
78 |
<sect1>
|
79 |
|
80 |
<title>What the native launcher solves</title> |
81 |
|
82 |
<para>The IzPack native launcher solves the previous problem by offering
|
83 |
a native executable to your users. Thus, they will launch it instead of directly |
84 |
trying to launch the Java-based installer. What's more, Win32 users will be more |
85 |
familiar with a native executable than a Jar file.</para>
|
86 |
|
87 |
<para>The IzPack launcher will do the following things when executed:
|
88 |
<itemizedlist>
|
89 |
<listitem><para>check for a JVM on the system</para></listitem> |
90 |
<listitem><para>launch the installer if a valid JVM has been found</para></listitem> |
91 |
<listitem><para>offer the following choices in case no JVM could be found: |
92 |
<itemizedlist>
|
93 |
<listitem><para>manually locate a 'java' executable</para></listitem> |
94 |
<listitem><para>(optional) install a JVM that is provided by the package |
95 |
maker, for instance on a CD-ROM</para></listitem> |
96 |
<listitem><para>download a JVM from the internet</para></listitem> |
97 |
</itemizedlist></para></listitem> |
98 |
</itemizedlist></para> |
99 |
|
100 |
<figure>
|
101 |
<title>The JRE detection failure dialog.</title> |
102 |
<mediaobject>
|
103 |
<imageobject><imagedata fileref="failure-dialog.png" format="PNG"/></imageobject> |
104 |
</mediaobject>
|
105 |
</figure>
|
106 |
|
107 |
<para>The IzPack launcher is implemented in C++ and makes use of the portable
|
108 |
<ulink url="http://www.wxwidgets.org/">wxWidgets</ulink> toolkit. Thus, the IzPack |
109 |
launcher can be run on several platforms (*nix, MacOS, Win32). It has been successfully |
110 |
tested on the following platforms configurations: |
111 |
<itemizedlist>
|
112 |
<listitem><para>Linux / wxGTK / GCC</para></listitem> |
113 |
<listitem><para>FreeBSD / wxGTK / GCC</para></listitem> |
114 |
<listitem><para>Win32 / MSW / MinGW</para></listitem> |
115 |
</itemizedlist></para> |
116 |
|
117 |
<para>The IzPack launcher is published under a MIT-style license agreement:
|
118 |
<screen>&launcher-license;</screen> |
119 |
</para>
|
120 |
|
121 |
</sect1>
|
122 |
|
123 |
<sect1>
|
124 |
|
125 |
<title>Getting the IzPack launcher</title> |
126 |
|
127 |
<para>The IzPack launcher can be downloaded from
|
128 |
<ulink url="http://developer.berlios.de/project/showfiles.php?group_id=1408">BerliOS</ulink> |
129 |
of from the <ulink url="http://www.izforge.com/izpack/">IzPack homepage</ulink>.</para> |
130 |
|
131 |
<para>IzPack makes use of <ulink url="http://subversion.tigris.org/">SubVersion</ulink>. |
132 |
You can download the development version ('trunk') by following the instructions at |
133 |
<ulink url="http://developer.berlios.de/svn/?group_id=1408">http://developer.berlios.de/svn/?group_id=1408</ulink> |
134 |
You can also get here the various releases ('tags').</para>
|
135 |
|
136 |
<para>The IzPack launcher archive comes with the full source code, the documentation as well
|
137 |
as a sample configuration file. It also contains a build for the Win32 platform, so that you |
138 |
can use it directly on this platform.</para>
|
139 |
|
140 |
</sect1>
|
141 |
|
142 |
</chapter>
|
143 |
|
144 |
<!-- Chapter 2 -->
|
145 |
<chapter>
|
146 |
<title>Using the launcher</title> |
147 |
|
148 |
<sect1>
|
149 |
|
150 |
<title>Preparing the launcher directory layout</title> |
151 |
|
152 |
<para>First of all, you can put in a fresh directory the Win32 executable that you can find
|
153 |
in the 'dist' directory of the IzPack launcher distribution. You can also pick the |
154 |
manifest file that will make the launcher GUI use the XP look and feel. Then you can also pick |
155 |
the translations that you need by copying the related directories. Finally, you'll need |
156 |
to create a <filename>launcher.ini</filename> configuration file in order to tweak the launcher |
157 |
behaviour.</para>
|
158 |
|
159 |
</sect1>
|
160 |
|
161 |
<sect1>
|
162 |
|
163 |
<title>Preparing the configuration file</title> |
164 |
|
165 |
<para>The configuration file is quite simple. It has groups and entries. The top-level
|
166 |
entries (those not belonging to a group) can be overridden by some operating system ones. |
167 |
To customize the behaviour for a specific operating system, you just have to create a group |
168 |
whose name matches the operating system identifier. Then you can simply override the entries. |
169 |
</para>
|
170 |
|
171 |
<para>The entries are the following:
|
172 |
<itemizedlist>
|
173 |
<listitem><para>jar: specifies the installer Jar file to launch</para></listitem> |
174 |
<listitem><para>jre: the path to a JRE that the user can install if none has been found |
175 |
on his system</para></listitem> |
176 |
<listitem><para>download: the URL to get a JVM from.</para></listitem> |
177 |
</itemizedlist>
|
178 |
The 'jre' entry is not mandatory.</para>
|
179 |
|
180 |
<para>The following operating systems identifiers can be used to make groups:
|
181 |
<itemizedlist>
|
182 |
<listitem><para>win32</para></listitem> |
183 |
<listitem><para>linux</para></listitem> |
184 |
<listitem><para>solaris</para></listitem> |
185 |
<listitem><para>bsd</para></listitem> |
186 |
<listitem><para>mac</para></listitem> |
187 |
</itemizedlist></para> |
188 |
|
189 |
</sect1>
|
190 |
|
191 |
<sect1>
|
192 |
|
193 |
<title>Sample configuration file</title> |
194 |
|
195 |
<programlisting linenumbering="numbered">&sample-launcher-ini;</programlisting> |
196 |
|
197 |
</sect1>
|
198 |
|
199 |
</chapter>
|
200 |
|
201 |
<!-- Appendix -->
|
202 |
<appendix>
|
203 |
<title>Acknowledgements</title> |
204 |
<para>
|
205 |
<itemizedlist>
|
206 |
<listitem><para>Marcus Stursberg (German translation)</para></listitem> |
207 |
<listitem><para>Frank Bille Jensen (Danish translation)</para></listitem> |
208 |
<listitem><para>Elmar Grom (user feedback suggestions)</para></listitem> |
209 |
<listitem><para>Alex Carlos Braga Antao (Brazilian translation)</para></listitem> |
210 |
<listitem><para>David Perez Carmona (Spanish translation)</para></listitem> |
211 |
<listitem><para>Dustin Sacks (Win98 fixes)</para></listitem> |
212 |
<listitem><para>The BerliOS crew</para></listitem> |
213 |
<listitem><para>The wxWidgets crew.</para></listitem> |
214 |
</itemizedlist>
|
215 |
</para>
|
216 |
</appendix>
|
217 |
|
218 |
</book>
|