X-Git-Url: https://git.dlugolecki.net.pl/?a=blobdiff_plain;f=doc%2Fusage.html;fp=doc%2Fusage.html;h=5d36b89c44c46d6dcac2f5dde82ecaca5586b8be;hb=74fde9789d7acaa629a576298d45421953a51bb1;hp=00003be0d0b4484dd762b1c4b4e7c0b174d1065f;hpb=0e044d1efe3ed730e8f0bd20361b27059c6ca7d5;p=gedcom-parse.git
diff --git a/doc/usage.html b/doc/usage.html
index 00003be..5d36b89 100644
--- a/doc/usage.html
+++ b/doc/usage.html
@@ -452,7 +452,43 @@ All strings passed by the GEDCOM parser to the application are in UTF-8 encoding
be able to display it.
The most common case is that the output character set is controlled by the locale
mechanism (i.e. via the LANG
, LC_ALL
or LC_CTYPE
environment variables), which also controls the gettext
- mechanism in the application. For this, the following steps need to
+ mechanism in the application.
+
+
+
+
+
+
+ The source distribution of gedcom-parse
contains an example implementation (utf8-locale.c
and utf8-locale.h
+ in the top directory). Feel free to use it in
+your source code (it is not part of the library, and it isn't installed anywhere,
+so you need to take over the source and header file in your application).
+
+
+
+Its interface is:
+
+ +Both functions return a pointer to a static buffer that is overwritten on +each call. To function properly, the application must first set the +locale using thechar *convert_utf8_to_locale (char *input, int *conv_failures);
char *convert_locale_to_utf8 (char *input);
setlocale
function (the second step detailed below).
+ All other steps given below, including setting up and closing down the conversion
+handles, are transparantly handled by the two functions. NULL
if you are not interested (note that usually, the interesting information is just whether there were
+ conversion failures or not, which is then given by the integer being bigger
+than zero or not). The second function doesn't need this, because any
+locale can be converted to UTF-8.+void convert_set_unknown (const char *unknown);
ic
iconv_close(iconv_handle);
-
-
-
- The source distribution of gedcom-parse
contains an example implementation (utf8-locale.c
and utf8-locale.h
- in the top directory) that grows the output buffer dynamically and outputs
-"?" for characters that can't be converted. Feel free to use it in
-your source code (it is not part of the library, and it isn't installed anywhere,
-so you need to take over the source and header file in your application).
-
-
-Its interface is:
-
- char *convert_utf8_to_locale (char *input);
char *convert_locale_to_utf8 (char *input);
-
-Both functions return a pointer to a static buffer that is overwritten on
-each call. To function properly, the application must first set the
-locale using the setlocale
function (the second step above).
- All other steps, including setting up and closing down the conversion
-handles, are transparantly handled by the two functions.
-
-You can change the "?" that is output for characters that can't be converted
-to any string you want, using the following function before the conversion
-calls:
-
- void convert_set_unknown (const char *unknown);
-
-
+ The example implementation mentioned above grows the output buffer dynamically and outputs
+"?" for characters that can't be converted.
+
+
$Id$
$Name$