home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / i18nv104.zip / SAMPLE / SCAN / READ.ME < prev    next >
Text File  |  1996-02-13  |  5KB  |  130 lines
  1.  
  2. ===============================================================================
  3.                   Internationalization (I18N) For OS/2                 
  4. ===============================================================================
  5.  
  6.                 Copyright IBM Corporation -- 1993, 1994, 1995
  7.  
  8. DISCLAIMER: This package is not a full implementation of the X/Open XPG4 
  9. specification and does not make any claims of XPG4 branding. It implements 
  10. only the portions of the XPG4 specification which deal with 
  11. internationalization.
  12.  
  13. X/Open is a trademark of the X/Open Company Limited.
  14.  
  15. ===============================================================================
  16.  
  17.  
  18. /************************/
  19. /***     Contents     ***/
  20. /************************/
  21.  
  22. 1.  Overview
  23. 2.  Files in this directory
  24. 3.  How to run the sample program
  25. 4.  How to compile the sample program
  26. 5.  Notes
  27.  
  28.  
  29. 1.  Overview
  30. ============
  31.  
  32. The sample program in this directory demonstrates the use of the scanf and
  33. printf family of functions for.  The functions (scanf, sscanf, fscanf,
  34. printf, sprintf, and fprintf) have been augmented in three ways.
  35.  
  36.      1. They allow for the scanning/printing of wide characters and strings.
  37.         Use the %C for wide characters and the %S for wide strings.
  38.  
  39.      2. Formatters (such as %f for floating point) have been augmented to
  40.          use the program's locale (set with setlocale).
  41.  
  42.      3. They support positional parameters.  Inserting a string of the form:
  43.         n$ after a '%' in a format string will cause the formatter to be
  44.         positional.  Consider the following printf statement:
  45.  
  46.              printf("%2$s %1$s", "world", "hello");
  47.  
  48.         will print out the string "hello world", because the first formatter
  49.         uses (because of the 2$) the second argument from the argument list.
  50.  
  51.         Positional formatters are crucial for multi-locale programs, since the
  52.         message strings (when translated) often have to move the arguments
  53.         around in the string.  An example of this can be seen in the sample
  54.         program.
  55.  
  56.  
  57. 2.  Files in this directory
  58. ===========================
  59.  
  60. File            Purpose
  61. ------------------------------------------------------------------------------
  62. scan.c          Source code for the scan sample program.
  63. scan.def        Definition file needed for compiling the program.
  64. scan.mak        Make file used to compile the sample.
  65. scan.exe        Compiled version of the scan sample.
  66.  
  67. INPUT           Input for the scan sample program.
  68. OUTPUT          Output from executing the program.
  69. build.cmd       A command file which will compile and link the sample program.
  70. read.me         This file.
  71.  
  72.  
  73. 3.  How to run the sample program
  74. =================================
  75.  
  76. The following steps show how the program can be run.
  77.  
  78.      1) Run the \i18n\bin\new_vars command file (or have the environment
  79.         variables already set).
  80.  
  81.      2) Set the current locale to US English
  82.  
  83.           Ex: set LANG=En_US
  84.  
  85.      3) Execute the scan.exe program.
  86.  
  87.           Ex:   scan
  88.  
  89.      4) This program requires you to enter a character and a wide character.
  90.         Assuming that you enter the character 'a' and wide character L'b',
  91.         the output from the program should be:
  92.  
  93.           Enter a character and a wide character:
  94.           You entered: 'a' and 'b'
  95.  
  96.           This is a culturally formatted floating point: 123.456
  97.  
  98.           Scanned strings are: 'is' and 'a'
  99.  
  100.      5) The contents of the 'OUTPUT' file should be:
  101.  
  102.           Output of positional string: second_string third_string first_string
  103.  
  104.      6) Alter the program as desired to see how the APIs work.
  105.  
  106.  
  107. 4.  How to compile the sample program
  108. =====================================
  109.  
  110. NOTE: The sample program is already compiled for you.  If you want to see the
  111.  behavior of the program, you can just run it.  The following instructions
  112.  are needed only if you want to modify the program and recompile it.
  113.  
  114. To compile the sample application:
  115.  
  116.      1) Make sure that the CSET/2 compiler and OS/2 toolkit are installed
  117.         correctly on your system.
  118.  
  119.      2) cd to the directory which contains the info source files.
  120.  
  121.      3) Type "build" at the command prompt.
  122.  
  123.  
  124. 5.  Notes
  125. =========
  126.  
  127. 1. Note that this sample program is compiled with the /Gm option.  This is a
  128.    requirement of the APIs involved.  Make sure that your programs are compiled
  129.    with this option when needed.
  130.