home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / i18nv102.zip / SAMPLE / INSTALL / READ.ME < prev   
Text File  |  1995-08-28  |  11KB  |  247 lines
  1.  
  2. ===============================================================================
  3.       Internationalization (I18N) For OS/2                 March 31, 1995
  4. ===============================================================================
  5.  
  6.                    Copyright IBM Corporation -- 1993, 1995
  7.  
  8. DISCLAIMER: This I18N package has been made available solely to gauge OS/2
  9. developer interest in the industry standard XPG4 internationalization
  10. programming model. This does not mean that IBM will introduce a product based
  11. on the contents of this package. This package is not a full implementation of
  12. the X/Open XPG4 specification and does not make any claims of XPG4 branding.
  13. It implements only the portions of the XPG4 specification which deal with
  14. internationalization.
  15.  
  16. X/Open is a trademark of the X/Open Company Limited.
  17.  
  18. ===============================================================================
  19.  
  20.  
  21. /************************/
  22. /***     Contents     ***/
  23. /************************/
  24.  
  25. 1.  Overview
  26. 2.  Installation prerequisites
  27. 3.  Optional parameters
  28. 4.  Files in this directory
  29. 5.  How to run the sample program
  30. 6.  How to compile the sample program
  31.  
  32.  
  33. 1.  Overview
  34. ============
  35.  
  36. This sample program demonstrates how to package and install the I18N files
  37. required for the runtime environment and how to configure the CONFIG.SYS
  38. information.
  39.  
  40. This program's high level functions include:
  41.  
  42.     A.  Determine if this version of the I18N package should be installed:
  43.           1)  Install if the I18N runtime routines are not accessible on the
  44.               system.
  45.           2)  Install if the diskette I18N runtime routines are the same or
  46.               more current than the system I18N runtime routines.
  47.     B.  Determine the drive on which to install the I18N package.  If the I18N
  48.         package is already installed, the default drive will be the drive on
  49.         which it is already installed.  The program calling this install program
  50.         can specify a parameter to set the default drive.  The user can select
  51.         any of the available drives on which to install this package.
  52.     C.  Create all of the required I18N directories if they do not already
  53.         exist.
  54.     D.  Install the I18N runtime code (setloc.dll) from the PKZIP2 diskette
  55.         file.
  56.     E.  Install the I18N locale files (*.dll) from the PKZIP2 diskette file(s).
  57.     F.  Determine whether CONFIG.SYS should be updated with the necessary
  58.         I18N information.  If yes, allow the user to select the desired LANG
  59.         value to be used, create a backup of the CONFIG.SYS file, and add the
  60.         I18N values for LANG (using user's selection), LIBPATH, LOCPATH, and
  61.         NLSPATH (using installation path information).
  62.  
  63. This program uses a Presentation Manager environment to control the installation
  64. of the I18N runtime environment.  PM windows are presented to allow the user to:
  65.  
  66.     A.  Select the drive on which to install the I18N files.
  67.     B.  See progress data as to which file is currently being installed.
  68.     C.  Select whether CONFIG.SYS should be updated with I18N values.
  69.     D.  Select the LANG variable value to be set in the CONFIG.SYS file.
  70.     E.  Be notified of error conditions and take actions to those situations.
  71.  
  72.  
  73. 2.  Installation prerequisites
  74. ==============================
  75.  
  76. This program assumes that PKUNZIP2 is available and that the installation is
  77. occurring from one or two diskettes, which contain these files:
  78.  
  79.  #1  INSTALL.EXE     This program resides on the 1st diskette.
  80.  #1  I18NDLL.ZIP     Contains the SETLOC.DLL file packaged using PKZIP2:
  81.                            PKZIP2  -P  I18NDLL.ZIP  c:\i18n\dll\setloc.dll
  82.  #1  I18NLOC1.ZIP    Contains all or a some of the I18N locale files packaged
  83.                      using PKZIP2 (whatever will fit on the 1st diskette):
  84.                            PKZIP2  -P  I18NLOC1.ZIP  c:\i18n\locale\*.dll
  85.  #2  I18NLOC2.ZIP    Contains the rest of the I18N locale files which would not
  86.                      fit on the 1st diskette in the I18NLOC1.ZIP file:
  87.                            PKZIP2  -P  I18NLOC2.ZIP  c:\i18n\locale\*.dll
  88.  
  89. This program can be customized to install from whatever set of diskette files
  90. your application has defined.  There are several #DEFINE statements in the
  91. INSTALL.C source which should be reviewed and modified as needed:
  92.  
  93.     A.  Do not add or remove any of the #DEFINE statements without modifying
  94.         the associated C statements referencing those values.
  95.  
  96.     B.  INSTALL_ZIP_NUM defines the number of PKZIP2 files which exist on
  97.         the diskette which contain the I18N files.  This is used to determine
  98.         how many of the INSTALL_ZIPn values will be used.  For example, to
  99.         define that there are three diskette files to be used:
  100.                        #define  INSTALL_ZIP_NUM  3
  101.  
  102.     C.  INSTALL_ZIPn defines the name of the "nth" diskette file.
  103.  
  104.         INSTALL_ZIP1 must define the name of the diskette file containing the
  105.         I18N runtime code (setloc.dll).  This name must contain the letters
  106.         "DLL".  For example:
  107.                        #define  INSTALL_ZIP1   "\\I18NDLL.ZIP"
  108.  
  109.         INSTALL_ZIP2 must define the name of the diskette file containing all
  110.         or the 1st part of the I18N locale files (*.dll).  This name must
  111.         contain the letters "LOC".  For example:
  112.                        #define  INSTALL_ZIP2   "\\I18NLOC1.ZIP"
  113.  
  114.         INSTALL_ZIP3 and INSTALL_ZIP4 may be used to define the name of the
  115.         diskette file containing the rest of the I18N locale files (*.dll).
  116.         This name must contain the letters "LOC".  For example:
  117.                        #define  INSTALL_ZIP3   "\\I18NLOC2.ZIP"
  118.                        #define  INSTALL_ZIP4   ""
  119.  
  120.     D.  Recompile INSTALL.C to incorporate your changes into your version of
  121.         the INSTALL.EXE program.
  122.  
  123.  
  124. 3.  Optional parameters
  125. =======================
  126.  
  127. This install program can be invoked directly from your application's install
  128. program.  When this is done, parameters are available to allow you to customize
  129. the execution of this install program to fit into your install process.
  130.  
  131. When the program is invoked without any parameters, the following default values
  132. are used:
  133.     1st parm:   C       (Default drive C:)
  134.     2nd parm:   none    (Do not force to a specific drive)
  135.     3rd parm:   If LANG value is currently set, use its value as default.
  136.                 Otherwise, use "enus437".
  137.     4th parm:   Y       (Show PM user interface)
  138.     5th parm:   Y       (Ask user if install drive is OK)
  139.     6th parm:   A       (Ask user if to update CONFIG.SYS)
  140.  
  141.  
  142. The following optional parameters can be specified.  The values are order
  143. dependent.  If you do not want to specify a specific value, use a
  144. non-alphabetic character in that position (like a period ".").
  145.  
  146.     1st parm:  The default drive letter on which to install the I18N package if
  147.                the I18N runtime routines are not already accessible.  This must
  148.                be an alphabetic letter, C-Z.  If "A", "B" or non-alphabetic,
  149.                will use the default value.
  150.  
  151.     2nd parm:  The default drive letter on which to force the installation of
  152.                the I18N package, regardless of whether the package is already
  153.                installed. This could be used if you are installing the package
  154.                on a server drive and already have package installed on a local
  155.                drive. This must be an alphabetic letter, C-Z.  If "A", "B" or
  156.                non-alphabetic, will use the default value specified by the
  157.                1st parameter.
  158.  
  159.     3rd parm:  The default LANG variable value to use when updating CONFIG.SYS.
  160.                The first letter must be alphabetic, else the default value
  161.                will be used.
  162.  
  163.     4th parm:  Whether the PM user interface is to be shown during processing.
  164.                  If "N", do not show any PM windows, except if error conditions
  165.                     are encountered.
  166.                  If not "N", the normal PM interface is shown.
  167.  
  168.     5th parm:  Whether to ask the user to select the drive on which to install
  169.                the I18N package.
  170.                  If "N", do not ask the user.  Use the default value defined by
  171.                     the 1st and 2nd parameters.
  172.                  If "U", ask the user only when the I18N package has never
  173.                     been installed before.  If the I18N package exists, do not
  174.                     ask the user.
  175.                  If not "N" or "U", the user will be shown a PM window and
  176.                     asked to select a drive.
  177.  
  178.     6th parm:  Whether to update the CONFIG.SYS file with I18N information
  179.                (LANG, PATH, LOCPATH, NLSPATH).
  180.                  If "A", ask the user whether to update CONFIG.SYS.
  181.                  If "Y", update CONFIG.SYS with I18N information.
  182.                  If not "A" or "Y", CONFIG.SYS will not be updated.
  183.  
  184.  
  185. 4.  Files in this directory
  186. ===========================
  187.  
  188. File            Purpose
  189. ------------------------------------------------------------------------------
  190. install.c       Source code for the install sample program.
  191. install.h       Include file for the program.
  192. install.rc      Resource file for the program.
  193. install.dlg     Dialog definitions for all panels used by the program.
  194. install.def     Definition file needed for compiling the program.
  195. install.mak     Make file used to compile the sample.
  196. install.exe     Compiled version of the install sample.
  197.  
  198. build.cmd       A command file which will compile and link the sample program.
  199. read.me         This file.
  200.  
  201.  
  202. 5.  How to run the sample program
  203. =================================
  204.  
  205. The following steps show how the program can be run.
  206.  
  207.      1) Copy the install.exe program from this directory to a diskette.
  208.  
  209.                 copy  install.exe  a:
  210.  
  211.      2) Use PKZIP2 to create a ZIP file containing the I18N runtime files.
  212.  
  213.                 PKZIP2  -P  I18NDLL.ZIP  c:\i18n\dll\setloc.dll
  214.  
  215.      3) Copy the zipped I18N runtime file to a diskette.
  216.  
  217.                 copy  I18NDLL.ZIP  a:
  218.  
  219.      4) Use PKZIP2 to create a ZIP file containing the I18N locale files.
  220.  
  221.                 PKZIP2  -P  I18NLOC1.ZIP  c:\i18n\locale\*.dll
  222.  
  223.      5) Copy the zipped I18N locale file to a diskette.
  224.  
  225.                 copy  I18NLOC1.ZIP  a:
  226.  
  227.      6) Execute the install.exe program from the diskette.
  228.  
  229.                 a:install
  230.  
  231.  
  232. 6.  How to compile the sample program
  233. =====================================
  234.  
  235. NOTE: The sample program is already compiled for you.  If you want to see the
  236.  behavior of the program, you can just run it.  The following instructions
  237.  are needed only if you want to modify the program and recompile it.
  238.  
  239. To compile the sample application:
  240.  
  241.      1) Make sure that the CSET/2 compiler and OS/2 toolkit are installed
  242.         correctly on your system.
  243.  
  244.      2) cd to the directory which contains the info source files.
  245.  
  246.      3) Type "build" at the command prompt.
  247.