Debian Codegraph @

deps/libneon/doc/man/ne_i18n_init.3

raw
1 '\" t
2 .\" Title: ne_i18n_init
3 .\" Author:
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5 .\" Date: 3 May 2011
6 .\" Manual: neon API reference
7 .\" Source: neon 0.29.6
8 .\" Language: English
9 .\"
10 .TH "NE_I18N_INIT" "3" "3 May 2011" "neon 0.29.6" "neon API reference"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 ne_i18n_init \- functions to initialize internationalization support
32 .SH "SYNOPSIS"
33 .sp
34 .ft B
35 .nf
36 #include <ne_i18n\&.h>
37 .fi
38 .ft
39 .HP \w'void\ ne_i18n_init('u
40 .BI "void ne_i18n_init(const\ char\ *" "encoding" ");"
41 .SH "DESCRIPTION"
42 .PP
43 The
44 \fBne_i18n_init\fR
45 function can be used to enable support for translated messages in the neon library\&. The
46 \fIencoding\fR
47 parameter, if non\-NULL, specifies the character encoding required for generated translated string\&. If it is
48 NULL, the appropriate character encoding for the process locale will be used\&.
49 .PP
50 This call is only strictly necessary if either:
51 .sp
52 .RS 4
53 .ie n \{\
54 \h'-04' 1.\h'+01'\c
55 .\}
56 .el \{\
57 .sp -1
58 .IP " 1." 4.2
59 .\}
60 neon has been installed into a different prefix than the
61 gettext
62 implementation on which it depends for i18n purposes, or
63 .RE
64 .sp
65 .RS 4
66 .ie n \{\
67 \h'-04' 2.\h'+01'\c
68 .\}
69 .el \{\
70 .sp -1
71 .IP " 2." 4.2
72 .\}
73 the caller requires that translated messages are in a particular character encoding\&.
74 .RE
75 .PP
76 If
77 \fBne_i18n_init\fR
78 is never called, the message catalogs will not be found if case (a) applies (and so English error messages will be used), and will use the default character encoding specified by the process locale\&. The library will otherwise operate correctly\&.
79 .PP
80 Note that the encoding used is a process\-global setting and so results may be unexpected if other users of neon within the process call
81 \fBne_i18n_init\fR
82 with a different encoding parameter\&.
83 .SH "SEE ALSO"
84 .PP
85 ne_sock_init
86 .SH "AUTHOR"
87 .PP
88 \fBJoe Orton\fR <\&[email protected]\&>
89 .RS 4
90 Author.
91 .RE
92 .SH "COPYRIGHT"
93 .br