[apple/icu.git] / icuSources / samples / ucnv / readme.txt

Copyright (C) 2016 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html#License

Copyright (C) 2002-2010, International Business Machines
Corporation and others.  All Rights Reserved.

convsamp: a sample program which demonstrates using ICU conversion

This sample demonstrates
         Opening and closing converters using the C api
         String manipulation in C 
         Writing a custom conversion callback function

         
Files:
    convsamp.c                 Main source file
    flagcb.h                   codepage output convenience header
    flagcb.c                   codepage output convenience implementation
    ucnv.sln                   Windows MSVC workspace.  Double-click this to get started.
    ucnv.vcproj                Windows MSVC project file

To Build ucnv on Windows
    1.  Install and build ICU
    2.  In MSVC, open the workspace file icu\samples\ucnv\ucnv.sln
    3.  Choose a Debug or Release build.
    4.  Build.
	
To Run on Windows
    1.  Start a command shell window
    2.  Add ICU's bin directory to the path, e.g.
            set PATH=c:\icu\bin;%PATH%
        (Use the path to where ever ICU is on your system.)
    3.  cd into the ufortune directory, e.g.
            cd c:\icu\source\samples\ucnv\debug
    4.  Run it
            ucnv
    WARNING: The .bin and .txt files must be in the same directory as the executable, which is not the case by default on some systems.

To Build on Unixes
    1.  Build ICU.  
        Specify an ICU install directory when running configure,
        using the --prefix option.  The steps to build ICU will look something
        like this:
           cd <icu directory>/source
           runConfigureICU <platform-name> --prefix <icu install directory> [other options]
           gmake all
           
    2.  Install ICU, 
           gmake install

    3.  Build 
           set the variable ICU_PREFIX=<icu install>
           gmake all
           
 To Run on Unixes
           cd <icu directory>/source/samples/ucnv
           
           gmake check
               -or- 

           export LD_LIBRARY_PATH=<icu install directory>/lib:.:$LD_LIBRARY_PATH
           convsamp
           
           
 Note:  The name of the LD_LIBRARY_PATH variable is different on some systems.
        If in doubt, run the sample using "gmake check", and note the name of
        the variable that is used there.  LD_LIBRARY_PATH is the correct name
        for Linux and Solaris.
Commit	Line	Data
f3c0d7a5 A	1	Copyright (C) 2016 and later: Unicode, Inc. and others.
	2	License & terms of use: http://www.unicode.org/copyright.html#License
	3
729e4ab9	4	Copyright (C) 2002-2010, International Business Machines
b75a7d8f A	5	Corporation and others. All Rights Reserved.
	6
	7	convsamp: a sample program which demonstrates using ICU conversion
	8
	9	This sample demonstrates
	10	Opening and closing converters using the C api
	11	String manipulation in C
	12	Writing a custom conversion callback function
	13
	14
	15	Files:
	16	convsamp.c Main source file
	17	flagcb.h codepage output convenience header
	18	flagcb.c codepage output convenience implementation
73c04bcf A	19	ucnv.sln Windows MSVC workspace. Double-click this to get started.
73c04bcf A	20	ucnv.vcproj Windows MSVC project file
b75a7d8f A	21
	22	To Build ucnv on Windows
	23	1. Install and build ICU
73c04bcf	24	2. In MSVC, open the workspace file icu\samples\ucnv\ucnv.sln
b75a7d8f A	25	3. Choose a Debug or Release build.
	26	4. Build.
	27
	28	To Run on Windows
	29	1. Start a command shell window
	30	2. Add ICU's bin directory to the path, e.g.
	31	set PATH=c:\icu\bin;%PATH%
	32	(Use the path to where ever ICU is on your system.)
	33	3. cd into the ufortune directory, e.g.
	34	cd c:\icu\source\samples\ucnv\debug
	35	4. Run it
	36	ucnv
729e4ab9	37	WARNING: The .bin and .txt files must be in the same directory as the executable, which is not the case by default on some systems.
b75a7d8f A	38
	39	To Build on Unixes
	40	1. Build ICU.
	41	Specify an ICU install directory when running configure,
	42	using the --prefix option. The steps to build ICU will look something
	43	like this:
	44	cd <icu directory>/source
	45	runConfigureICU <platform-name> --prefix <icu install directory> [other options]
	46	gmake all
	47
	48	2. Install ICU,
	49	gmake install
	50
	51	3. Build
	52	set the variable ICU_PREFIX=<icu install>
	53	gmake all
	54
	55	To Run on Unixes
	56	cd <icu directory>/source/samples/ucnv
	57
	58	gmake check
	59	-or-
	60
	61	export LD_LIBRARY_PATH=<icu install directory>/lib:.:$LD_LIBRARY_PATH
	62	convsamp
	63
	64
	65	Note: The name of the LD_LIBRARY_PATH variable is different on some systems.
	66	If in doubt, run the sample using "gmake check", and note the name of
	67	the variable that is used there. LD_LIBRARY_PATH is the correct name
	68	for Linux and Solaris.
	69