Backed out changeset 3fe07c50c854 (bug 946316) for bustage. a=backout
[gecko.git] / widget / os2 / README.seamonkey
blobde561add38cdeea3a5724abb8b88931e462503ea
1 ================================================================================
3 = = = = = = = = = = = = = =   SeaMonkey Read Me    = = = = = = = = = = = = = = =
5 ================================================================================
7 SeaMonkey is subject to the terms detailed in the license agreement
8 accompanying it.
10 This Read Me file contains information about system requirements and
11 installation instructions for the OS/2 build of SeaMonkey.
13 For more info on SeaMonkey, see http://www.seamonkey-project.org/
14 For more info on the OS/2 port see http://www.mozilla.org/ports/os2. To submit
15 bugs reports go to Bugzilla at https://bugzilla.mozilla.org.
17 For discussion and help for OS/2 specific problems, please use the newsgroup
18 mozilla.dev.ports.os2 on news.mozilla.org.  You can also get help by pointing
19 your IRC client to the #warpzilla channel on irc.mozilla.org.
22 ================================================================================
24                           Getting SeaMonkey
26 ================================================================================
28 Official Milestone builds of SeaMonkey are published on the release page at
30   http://www.seamonkey-project.org/releases/
32 OS/2 releases are not created by the SeaMonkey Council and may appear on the
33 page http://www.mozilla.org/ports/os2 before the releases page. Be sure to read
34 the release notes linked on the releases page for information on known problems
35 and installation issues.
36 OS/2 specific problems with this version are listed below.
39 ================================================================================
41                          System Requirements on OS/2
43 ================================================================================
45 - This release requires the C runtime DLL (libc063.dll) from
46      ftp://ftp.netlabs.org/pub/gcc/libc-0.6.3-csd3.zip
47   in order to run.  You can unpack them in the same directory as the
48   SeaMonkey executable or somewhere else in your LIBPATH.
50 - Minimum hardware requirements
51   + 400 MHz Pentium class processor
52   + 128 MiB RAM plus 128 MiB free swap space
53   + 40 MiB free harddisk space for installation
54     plus storage space for messages and disk cache
55   + Graphics card and driver capable of displaying more than 256 colors
57 - Recommended hardware for acceptable performance
58   + 1.0 GHz processor
59   + 512 MiB RAM plus 128 MiB free swap space
60     NOTE: SeaMonkey's performance and stability increases the more physical
61     RAM is available.
63 - Software requirements
64   + Installation on a file system supporting long file names
65     (i.e. HPFS or JFS but not FAT)
66   + OS/2 Warp 4 with Fixpack 15 or later (Warp 3 may work but is unsupported)
67   + MPTS version 5.3
68   + TCP/IP version 4.1
69   + INETVER: SOCKETS.SYS=5.3007, AFOS2.SYS=5.3001, AFINET.SYS=5.3006
70     NOTE: Do not attempt to use MPTS & TCP/IP versions below these INETVER
71     levels. Although SeaMonkey may seem to start and run normally with older
72     stacks, some features SeaMonkey needs are not implemented correctly in
73     older MPTS versions, which may result in crashes and data loss.
75   + Convenience Pack 2 or eComStation 1.0 or later meet these requirements
76     out of the box.
78   + Only Java plugins of version 1.4.1 or 1.4.2 are supported.
79     (IBM Java 1.3.1 or earlier will crash the application!)
81 - Useful optional software
82   The following packages enable additional features in SeaMonkey. Download
83   locations are listed below with a detailed description of the features.
84   + Remote Workplace Server (RWS), version 0.8
85   + Doodle's Screen Saver (DSSaver), version 1.8 or later
88 ================================================================================
90                       Installation Instructions
92 ================================================================================
94 Unpack into a clean (new) directory. Installing on top of previously released
95 builds may cause problems with SeaMonkey. It is therefore hightly recommended
96 to follow the instructions under "Separating profiles from installation
97 directory".
99 Note: These instructions do not tell you how to build SeaMonkey.
100 For info on building the SeaMonkey source, see
101   https://developer.mozilla.org/en/Build_Documentation
104 OS/2 Installation Instructions
105 ------------------------------
107 On OS/2, SeaMonkey does not have an installation program. To install it,
108 download the .zip file and follow these steps:
110 1. Click the "Zip" link on the site you're downloading SeaMonkey from to
111    download the ZIP package to your machine. This file is typically called
112    seamonkey-x.x.x.en-US.os2.zip where the "x.x.x" is replaced by the
113    current SeaMonkey version.
115 2. Navigate to where you downloaded the file and unpack it using your favorite
116    unzip tool.
118 3. Keep in mind that the unzip process creates a directory "seamonkey" below
119    the location you point it to, e.g.
120         unzip seamonkey-2.0.en-US.os2.zip -d c:\seamonkey-2.0
121    will unpack SeaMonkey into c:\seamonkey-2.0\seamonkey.
123 4. Make sure that you are _not_ unpacking over an old installation. This is
124    known to cause problems.
126 5. To start SeaMonkey, navigate to the directory you extracted SeaMonkey to,
127    ensure that the C library DLL is copied to the installation directory or
128    installed in the LIBPATH, and then double-click the seamonkey.exe object.
131 ================================================================================
133                       Tips and Problems
135 ================================================================================
137 Running multiple versions concurrently
138 --------------------------------------
140 If you want to run more than one copy of SeaMonkey, you have to use the
141 -no-remote parameter or set MOZ_NO_REMOTE=1 in your environment.
143 Because various members of the Mozilla family (i.e. SeaMonkey, Mozilla, Firefox,
144 Thunderbird, IBM Web Browser) may use different, incompatible versions of the
145 same DLL, some extra steps may be required to run them concurrently.
147 One workaround is the LIBPATHSTRICT variable. To run SeaMonkey one can create
148 a CMD script like the following example (where an installation of SeaMonkey
149 in the directory d:\internet\seamonkey is assumed):
151    set LIBPATHSTRICT=T
152    rem The next line may be needed when a different Mozilla program is listed in LIBPATH
153    rem set BEGINLIBPATH=d:\internet\seamonkey
154    rem The next line is only needed to run two versions of the same program
155    rem set MOZ_NO_REMOTE=1
156    d:
157    cd d:\internet\seamonkey
158    seamonkey.exe %1 %2 %3 %4 %5 %6 %7 %8 %9
160 Similarly, one can create a program object to start SeaMonkey using the
161 following settings:
163    Path and file name: *
164    Parameters:         /c set LIBPATHSTRICT=T & .\seamonkey.exe "%*"
165    Working directory:  d:\internet\seamonkey
167 (One might need to add MOZ_NO_REMOTE and/or BEGINLIBPATH as in the CMD
168 script above depending on the system configuration.)
170 Finally, the simplest method is to use the Run! utility by Rich Walsh that
171 can be found in the Hobbes Software Archive:
173    http://hobbes.nmsu.edu/h-search.php?key=Run!
175 Read its documentation for more information.
178 Separating profiles from installation directory
179 -----------------------------------------------
181 To separate the locations of the user profile(s) (containing the bookmarks and
182 all customizations) from the installation directory to keep your preferences in
183 the case of an update even when using ZIP packages, set the variable
184 MOZILLA_HOME to a directory of your choice. You can do this either in Config.sys
185 or in a script or using a program object as listed above. If you add
187    set MOZILLA_HOME=f:\Data
189 the SeaMonkey user profile will be created in "f:\Data\Mozilla\SeaMonkey".
191 If you are migrating from Mozilla, SeaMonkey's import routine will only find
192 the existing Mozilla profile data if MOZILLA_HOME is correctly set to point to
196 Other important environment variables
197 -------------------------------------
199 There are a few enviroment variables that can be used to control special
200 behavior of SeaMonkey on OS/2:
202 - set NSPR_OS2_NO_HIRES_TIMER=1
203   This causes SeaMonkey not to use OS/2's high resolution timer. Set this if
204   other applications using the high resolution timer (multimedia apps) act
205   strangely.
207 - set MOZ_NO_REMOTE=1
208   Use this to run two instances of SeaMonkey simultaneously (like e.g. debug
209   and optimized version).
211 - set MOZ_NO_RWS=1
212   Use this to disable Remote Workplace Server support (see below).
214 Find more information on this topic and other tips on
215    http://www.os2bbs.com/os2news/Warpzilla.html
218 Support for WPS objects
219 -----------------------
221 SeaMonkey can make use of Rich Walsh's Remote Workplace Server (RWS) library
222 to access Workplace Shell objects from the application. This allows helper
223 applications for downloaded files to be selected based on their default WPS
224 association.
226 To enable this functionality, SeaMonkey has to find the RWS DLLs. They have to
227 be located in a directory on the LIBPATH, in the SeaMonkey directory, or
228 already be registered as a WPS class. For eComStation 2 this is already the
229 case. If RWS is not yet available on your system, download it from
230    http://hobbes.nmsu.edu/h-search.php?key=rws08dll
232 If RWS is found on the system, it is used by SeaMonkey automatically. In case
233 you need to disable RWS support, create an environment variable MOZ_NO_RWS and
234 set it to 1.
237 Idle timer for internal cleanups
238 --------------------------------
240 If Doodle's Screen Saver (DSSaver) v1.8 or later is installed, SeaMonkey can
241 determine how long the user has been inactive. If the user has been inactive
242 for a while, cleanup operations may be performed.
244 DSSaver can be downloaded from
245    ftp://ftp.netlabs.org/pub/dssaver/dssaver_v18.zip
248 Setting the OS/2 default web applications
249 -----------------------------------------
251 The default web browser can be set using WPS URL objects.  The properties
252 notebook of every URL object contains a "Browser" tab where the browser
253 executable can be selected. Any changes to these settings will be stored and
254 reflected in all URL objects once the user presses the "Set Default" button.
255 The default mail, news, and irc applications can be set by editing the USER_INI
256 file.
258 Two small applications make this change a bit easier and provide options to also
259 set default programs for other types of internet-related activities:
261 - ConfigApps
262      http://hobbes.nmsu.edu/h-search.php?key=configapps1_1
264 - Internet Application Integration
265      http://7cities.net/~mckinnis/os2/
268 Changed font handling
269 ---------------------
271 To be able to display text, SeaMonkey cannot make use of normal OS/2 routines
272 but has to use FreeType and FontConfig. This has the advantage that text can
273 be displayed with antialiasing, but at the same time has some caveats:
275 - SeaMonkey cannot make use of OS/2 fonts like WarpSans and others which
276   are not available in Type1 or TrueType format. It is therefore
277   recommended to install the "Workplace Sans" font from
278      http://users.socis.ca/~ataylo00/creative/fonts/
279   or
280      http://hobbes.nmsu.edu/h-search.php?key=wpsu_ttf
281   which SeaMonkey will use as a replacement of WarpSans.
283 - Display of text in some languages (e.g. Arabic) does not yet take into account
284   that different forms of some characters exist.
286 To tweak the appearance of text, you can add two preferences, preferably using
287 about:config.
289 - gfx.os2.font.antialiasing (Boolean)
290   This preference controls whether antialiasing is enabled, and defaults to
291   true.
293 - gfx.os2.font.hinting (Integer)
294   This preference controls the hinting level, and can be between 0 (no hinting)
295   and 3 (full hinting). The default value is 2.
296   Font hinting improves the contrast of displayed text, but may produce poor
297   results for certain characters of some fonts, most notably the OS/2 version
298   of "Times New Roman".
300 Note that these preferences only take effect when a font gets used for the first
301 time, so you may need to restart the application to see the full effect.
304 Known Problems of the OS/2 version
305 ----------------------------------
307 Cross-platform problems are usually listed in the release notes of each
308 milestone release.
310 - Printing to normal OS/2 printer queues had to be disabled. It was slow even
311   for simple pages and used huge amounts of RAM, so that in most cases the
312   application crashed, see https://bugzilla.mozilla.org/show_bug.cgi?id=415522.
313   While the queues are still displayed in the printing dialog, any printing
314   operation will instead create a PDF file. By default this file is placed on
315   the Desktop, with the name SeaMonkey_<date>_<time>.pdf, where <date> and
316   <time> are replaced by the current system time. If you want to use another
317   name, select "Print to file" before pressing the Print button.
318   The resulting PDF file can be printed using applications like Lucide, Acrobat
319   Reader, or GSview.
321 - Fonts with names containing special characters (like Asian Unicode names)
322   will not display correctly in the list of fonts in the Options panel.
324 - SeaMonkey will beep when copying more than 64 kB of text to the clipboard.
325   This is to alert users that many applications (most notably the system
326   editor, EPM, and applications running in VIO windows) cannot paste more
327   than this.
329 Other known problems can be found by following the link "Current Open Warpzilla
330 Bugs" on the OS/2 Mozilla page <http://www.mozilla.org/ports/os2/>.