[linuxjm/LDP_man-pages.git] / draft / man3 / setlocale.3

.\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
.\" and Copyright 1999 by Bruno Haible (haible@clisp.cons.org)
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" License.
.\" Modified Sat Jul 24 18:20:12 1993 by Rik Faith (faith@cs.unc.edu)
.\" Modified Tue Jul 15 16:49:10 1997 by Andries Brouwer (aeb@cwi.nl)
.\" Modified Sun Jul  4 14:52:16 1999 by Bruno Haible (haible@clisp.cons.org)
.\" Modified Tue Aug 24 17:11:01 1999 by Andries Brouwer (aeb@cwi.nl)
.\" Modified Tue Feb  6 03:31:55 2001 by Andries Brouwer (aeb@cwi.nl)
.\"
.\" Japanese Version Copyright (c) 1998 Tanoshima Hidetohsi
.\"         all rights reserved.
.\" Translated May 29, 1998   Tanoshima Hidetoshi <tano@sainet.or.jp>
.\" Modified Mon Oct  2 11:09:18 JST 2000
.\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
.\" Updated Fri May  4 01:49:48 JST 2001
.\"         by Kentaro Shirakata <argrath@ub32.org>
.\" Updated Sat Oct 12 2002 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\"
.\"WORD:        locale                  ¥í¥±¡¼¥ë
.\"WORD:        portable                ¸ß´¹À­¤Î¤¢¤ë
.\"WORD:        regular expression      Àµµ¬É½¸½
.\"WORD:        range expressions       ÈÏ°Ïɽ¸½
.\"WORD:        equivalence classes     Åù²Á¥¯¥é¥¹
.\"WORD:        collation               ¾È¹ç
.\"WORD:        multibyte character     ¿¥Ð¥¤¥Èʸ»ú
.\"WORD:        wide character          ¥ï¥¤¥Éʸ»ú
.\"WORD:        opaque string           ÆâÉôʸ»úÎó
.\"
.TH SETLOCALE 3  2008-12-05 "GNU" "Linux Programmer's Manual"
.SH ̾Á°
.\"O setlocale \- set the current locale
setlocale \- ¸½ºß¤Î¥í¥±¡¼¥ë (locale) ¤òÀßÄꤹ¤ë
.SH ½ñ¼°
.nf
.B #include <locale.h>
.sp
.BI "char *setlocale(int " category ", const char *" locale );
.fi
.SH ÀâÌÀ
.\"O .BR setlocale ()
.\"O function is used to set or query the program's current locale.
.BR setlocale ()
´Ø¿ô¤Ï¥×¥í¥°¥é¥à¤Î¥«¥ì¥ó¥È¥í¥±¡¼¥ë¤òÀßÄꤷ¤¿¤ê
Ì䤤¹ç¤ï¤»¤¿¤ê¤¹¤ë¤Î¤ËÍѤ¤¤é¤ì¤ë¡£
.PP
.\"O If
.\"O .I locale
.\"O is not NULL,
.\"O the program's current locale is modified according to the arguments.
.I locale
¤¬ NULL ¤Ç¤Ê¤±¤ì¤Ð¡¢¥×¥í¥°¥é¥à¤Î¥«¥ì¥ó¥È¥í¥±¡¼¥ë¤Ï°ú¤­¿ô¤Ë½¾¤Ã¤ÆÊѹ¹¤µ¤ì¤ë¡£
.\"O The argument
.\"O .I category
.\"O determines which parts of the program's current locale should be modified.
°ú¤­¿ô
.I category
¤Ï¥×¥í¥°¥é¥à¤Î¥«¥ì¥ó¥È¥í¥±¡¼¥ë¤Î¤É¤ÎÉôʬ¤òÊѹ¹¤¹¤ë¤«¤ò·è¤á¤ë¡£
.TP
.B LC_ALL
.\"O for all of the locale.
Á´¤Æ¤Î¥í¥±¡¼¥ë
.TP
.B LC_COLLATE
.\"O for regular expression matching (it determines the meaning
.\"O of range expressions and equivalence classes) and string collation.
Àµµ¬É½¸½¤Î¥Þ¥Ã¥Á¥ó¥° (ÈÏ°Ïɽ¸½¤ÈÅù²Á¥¯¥é¥¹¤Î¥Þ¥Ã¥Á¥ó¥°¤ò·èÄꤹ¤ë)
¤Èʸ»úÎó¤Î¾È¹ç (collation)
.TP
.B LC_CTYPE
.\"O for regular expression matching, character classification, conversion,
.\"O case-sensitive comparison, and wide character functions.
Àµµ¬É½¸½¤Î¥Þ¥Ã¥Á¥ó¥°¡¢Ê¸»ú¤ÎʬÎࡢʸ»ú¤ÎÊÑ´¹¡¢Âçʸ»ú¾®Ê¸»úÈæ³Ó¡¢
¥ï¥¤¥Éʸ»ú´Ø¿ô
.TP
.B LC_MESSAGES
.\"O for localizable natural-language messages.
ÃÏ°è²½²Äǽ¤Ê¼«Á³¸À¸ì¥á¥Ã¥»¡¼¥¸
.TP
.B LC_MONETARY
.\"O for monetary formatting.
Ä̲ߤνñ¼°
.TP
.B LC_NUMERIC
.\"O for number formatting (such as the decimal point and the thousands separator).
¿ôÃͤνñ¼° (¾®¿ôÅÀ¤ä 3 ·å¤´¤È¤Î¶èÀÚ¤ê)
.TP
.B LC_TIME
.\"O for time and date formatting.
»þ¹ï¤ÈÆüÉÕ¤±¤Î½ñ¼°
.PP
.\"O The argument
.\"O .I locale
.\"O is a pointer to a character string containing the
.\"O required setting of
.\"O .IR category .
°ú¤­¿ô
.I locale
¤Ï
.I category
¤ËÀßÄꤹ¤ëʸ»úÎó¤Ø¤Î¥Ý¥¤¥ó¥¿¤Ç¤¢¤ë¡£
.\"O Such a string is either a well-known constant like "C" or "da_DK"
.\"O (see below), or an opaque string that was returned by another call of
.\"O .BR setlocale ().
¤³¤Îʸ»úÎó¤Ï¤è¤¯ÃΤé¤ì¤¿Äê¿ô¤Ç¤¢¤ë "C" ¤ä "da_DK" ¤Ê¤É¤Ç¤âÎɤ¤¤·
(°Ê²¼¤ò»²¾È)¡¢Â¾¤Î¤È¤­¤Ë
.BR setlocale ()
¤ò¸Æ¤Ó½Ð¤·¤¿ºÝ¤ËÊÖ¤µ¤ì¤¿¡¢ÆâÉôÍѤÎʸ»úÎó¤Ç¤âÎɤ¤¡£
.PP
.\"O If
.\"O .I locale
.\"O is
.\"O .BR """""" ,
.\"O each part of the locale that should be modified is set according to the
.\"O environment variables.
.\"O The details are implementation-dependent.
.I locale
¤¬ \fB""\fP ¤Î¾ì¹ç¡¢¥í¥±¡¼¥ë¤Î³ÆÉôʬ¤ÎÀßÄê¤Ë¤Ï´Ä¶­ÊÑ¿ô¤¬»²¾È¤µ¤ì¤ë¡£
¤½¤Î¾ÜºÙ¤Ï¼ÂÁõ°Í¸¤Ç¤¢¤ë¡£
.\"O For glibc, first (regardless of
.\"O .IR category ),
.\"O the environment variable
.\"O .B LC_ALL
.\"O is inspected,
.\"O next the environment variable with the same name as the category
.\"O .RB ( LC_COLLATE ,
.\"O .BR LC_CTYPE ,
.\"O .BR LC_MESSAGES ,
.\"O .BR LC_MONETARY ,
.\"O .BR LC_NUMERIC ,
.\"O .BR LC_TIME )
.\"O and finally the environment variable
.\"O .BR LANG .
.\"O The first existing environment variable is used.
.\"O If its value is not a valid locale specification, the locale
.\"O is unchanged, and
.\"O .BR setlocale ()
.\"O returns NULL.
glibc ¤Î¾ì¹ç¡¢¤Þ¤ººÇ½é¤Ë (¤É¤ó¤Ê
.I category
¤ËÂФ·¤Æ¤â) ´Ä¶­ÊÑ¿ô
.B LC_ALL
¤¬¸¡ºº¤µ¤ì¤ë¡£
¼¡¤Ë¥«¥Æ¥´¥ê (category) ¤ÈƱ¤¸Ì¾Á°¤Î´Ä¶­ÊÑ¿ô
.RB ( LC_COLLATE ,
.BR LC_CTYPE ,
.BR LC_MESSAGES ,
.BR LC_MONETARY ,
.BR LC_NUMERIC ,
.BR LC_TIME )
¤¬¸¡ºº¤µ¤ì¡¢ºÇ¸å¤Ë´Ä¶­ÊÑ¿ô
.B LANG
¤¬¸¡ºº¤µ¤ì¤ë¡£
ºÇ½é¤Ë¸«¤Ä¤«¤Ã¤¿´Ä¶­ÊÑ¿ô¤ò»ÈÍѤ¹¤ë¡£
¤½¤ÎÃͤ¬¥í¥±¡¼¥ë»ØÄê¤È¤·¤ÆÀµ¤·¤¯¤Ê¤±¤ì¤Ð¡¢¥í¥±¡¼¥ë¤ÏÊѹ¹¤µ¤ì¤º¡¢
.BR setlocale ()
¤Ï NULL ¤òÊÖ¤¹¡£
.PP
.\"O The locale
.\"O .B """C"""
.\"O or
.\"O .B """POSIX"""
.\"O is a portable locale; its
.\"O .B LC_CTYPE
.\"O part corresponds to the 7-bit ASCII
.\"O character set.
\fB"C"\fP ¥í¥±¡¼¥ë¤ä \fB"POSIX"\fP ¥í¥±¡¼¥ë¤Ï¸ß´¹À­¤Î¤¢¤ë¥í¥±¡¼¥ë¤Ç¤¢¤ë¡£
¤³¤Î
.B LC_CTYPE
¤ÎÉôʬ¤Ï 7 ¥Ó¥Ã¥È ASCII ʸ»ú½¸¹ç¤ËÁêÅö¤·¤Æ¤¤¤ë¡£
.PP
.\"O A locale name is typically of the form
.\"O .IR language "[_" territory "][." codeset "][@" modifier "],"
.\"O where
.\"O .I language
.\"O is an ISO 639 language code,
.\"O .I territory
.\"O is an ISO 3166 country code, and
.\"O .I codeset
.\"O is a character set or encoding identifier like
.\"O .B "ISO-8859-1"
.\"O or
.\"O .BR "UTF-8" .
¥í¥±¡¼¥ë̾¤Î½ñ¼°¤Ï¡¢Ä̾ï
.IR language "[_" territory "][." codeset "][@" modifier "]"
¤È¤¤¤¦¤â¤Î¤Ç¤¢¤ë¡£
¤³¤³¤Ç
.I language
¤Ï ISO 639 ¤Î¸À¸ì¥³¡¼¥É¤Ç¤¢¤ë¡£
.I territory
¤Ï ISO 3166 ¤Î¹ñ̾¥³¡¼¥É¤Ç¤¢¤ë¡£
.I codeset
¤Ï
.B "ISO-8859-1"
¤ä
.B "UTF-8"
¤Î¤è¤¦¤Êʸ»ú½¸¹ç¤äʸ»úÉä¹æ²½¼±Ê̻ҤǤ¢¤ë¡£
.\"O For a list of all supported locales, try "locale \-a", cf.\&
.\"O .BR locale (1).
¥µ¥Ý¡¼¥È¤µ¤ì¤Æ¤¤¤ë¥í¥±¡¼¥ë¤Î°ìÍ÷¤òÆÀ¤ë¤Ë¤Ï¡¢
"locale \-a" ¤ò¼Â¹Ô¤·¤Æ¤ß¤è
.RB ( locale (1)
»²¾È¤Î¤³¤È)¡£
.PP
.\"O If
.\"O .I locale
.\"O is NULL, the current locale is only queried, not modified.
.I locale
¤¬ NULL ¤Ê¤é¤Ð¡¢¸½ºß¤Î¥í¥±¡¼¥ë¤òÌ䤤¹ç¤ï¤»¤ë¤Î¤ß¤ÇÊѹ¹¤Ï¤·¤Ê¤¤¡£
.PP
.\"O On startup of the main program, the portable
.\"O .B """C"""
.\"O locale is selected as default.
main ¥×¥í¥°¥é¥à¤Îµ¯Æ°»þ¤Ë¤Ï¡¢
¸ß´¹À­¤Î¤¢¤ë \fB"C"\fP ¥í¥±¡¼¥ë¤¬¥Ç¥Õ¥©¥ë¥È¤ÇÁªÂò¤µ¤ì¤ë¡£
.\"O A program may be made portable to all locales by calling:
.\"O .nf
.\"O 
.\"O     setlocale(LC_ALL, "");
.\"O 
.\"O .fi
.\"O after program initialization, by using the values returned
.\"O from a
.\"O .BR localeconv (3)
.\"O call
.\"O for locale-dependent information, by using the multibyte and wide
.\"O character functions for text processing if
.\"O .BR "MB_CUR_MAX > 1" ,
.\"O and by using
.\"O .BR strcoll (3),
.\"O .BR wcscoll (3)
.\"O or
.\"O .BR strxfrm (3),
.\"O .BR wcsxfrm (3)
.\"O to compare strings.
¥×¥í¥°¥é¥à¤ò¤¹¤Ù¤Æ¤Î¥í¥±¡¼¥ë¤ËÂФ·¤Æ¸ß´¹¤Ë¤·¤¿¤±¤ì¤Ð¡¢
¥×¥í¥°¥é¥à¤Î½é´ü²½¤Î¸å¤Ë
.nf

    setlocale(LC_ALL, "");

.fi
¤ò¸Æ¤Ó½Ð¤·¡¢¥í¥±¡¼¥ë°Í¸¤Î¾ðÊó¤Ë¤Ï
.BR localeconv (3)
¤ÎÊÖ¤êÃͤòÍѤ¤¡¢
.BR "MB_CUR_MAX > 1"
¤Î¾ì¹ç¤Ë¤Ïʸ»úÎó¤ÎÁàºî¤Ë¤Ï¿¥Ð¥¤¥Èʸ»ú¡¢¥ï¥¤¥Éʸ»ú´Ø¿ô¤ò»ÈÍѤ·¡¢
ʸ»úÎó¤ÎÈæ³Ó¤Ë¤Ï
.BR strcoll (3),
.BR wcscoll (3)
¤ä
.BR strxfrm (3),
.BR wcsxfrm (3)
¤òÍѤ¤¤ë¡£
.SH ÊÖ¤êÃÍ
.\"O A successful call to
.\"O .BR setlocale ()
.\"O returns an opaque string that corresponds to the locale set.
.\"O This string may be allocated in static storage.
.\"O The string returned is such that a subsequent call with that string
.\"O and its associated category will restore that part of the process's
.\"O locale.
.\"O The return value is NULL if the request cannot be honored.
.BR setlocale ()
¤Î¸Æ¤Ó½Ð¤·¤ËÀ®¸ù¤¹¤ë¤È¡¢
¤½¤Î¥í¥±¡¼¥ë½¸¹ç¤ËÂбþ¤¹¤ëÆâÉôʸ»úÎó (opaque string) ¤òÊÖ¤¹¡£
¤³¤Îʸ»úÎó¤ÏÀÅŪ¤Êµ­²±°è¤Ë³ä¤êÅö¤Æ¤é¤ì¤Æ¤¤¤ë¤«¤â¤·¤ì¤Ê¤¤¡£
¤³¤ÎÊ֤äÆÍ褿ʸ»úÎó¤ò¡¢¥«¥Æ¥´¥ê»ØÄê¤È¶¦¤Ë¡¢
¤Î¤Á¤Î setlocale ¤Î¸Æ¤Ó½Ð¤·¤Ë»ØÄꤹ¤ì¤Ð¡¢
¥×¥í¥»¥¹¤Î¤½¤ÎÉôʬ¤Î¥í¥±¡¼¥ë¤¬Éü¸µ¤µ¤ì¤ë¡£
ÀßÄê¤Ë¼ºÇÔ¤·¤¿¾ì¹ç¤Ë¤Ï¡¢ÊÖ¤êÃÍ¤Ï NULL ¤Ë¤Ê¤ë¡£
.SH ½àµò
C89, C99, POSIX.1-2001.
.SH Ãí°Õ
.\"O Linux (that is, glibc) supports the portable locales
Linux (¤È¤¤¤¦¤« glibc) ¤Ï¸ß´¹À­¤Î¤¢¤ë¥í¥±¡¼¥ë¤È¤·¤Æ
\fB"C"\fP ¤È \fB"POSIX"\fP ¤ò¥µ¥Ý¡¼¥È¤·¤Æ¤¤¤ë¡£
.\"O In the good old days there used to be support for
.\"O the European Latin-1
.\"O .B """ISO-8859-1"""
.\"O locale (e.g., in libc-4.5.21 and libc-4.6.27), and the Russian
.\"O .B """KOI-8"""
.\"O (more precisely, "koi-8r") locale (e.g., in libc-4.6.27),
.\"O so that having an environment variable \fILC_CTYPE=ISO-8859-1\fP
.\"O sufficed to make
.\"O .BR isprint (3)
.\"O return the right answer.
.\"O These days non-English speaking Europeans have to work a bit harder,
.\"O and must install actual locale files.
¸Å¤­¤è¤­»þÂå¤Ë¤Ï (Î㤨¤Ð libc-4.5.21 ¤È libc-4.6.27 ¤Ê¤É¤Ç¤Ï)¡¢
European Latin-1 ¸þ¤±¤Ë
\fB"ISO-8859-1"\fP ¥í¥±¡¼¥ë¤¬¥µ¥Ý¡¼¥È¤µ¤ì¤Æ¤ª¤ê¡¢
¥í¥·¥¢¸ì (Russian) ¸þ¤±¤Ë \fB"KOI-8"\fP
(¤è¤êÀµ³Î¤Ë¤Ï "koi-8r") ¥í¥±¡¼¥ë¤¬¥µ¥Ý¡¼¥È¤µ¤ì¤Æ¤¤¤¿¡£
½¾¤Ã¤Æ´Ä¶­ÊÑ¿ô¤ò \fILC_CTYPE=ISO-8859-1\fP ¤È»ØÄꤹ¤ë¤À¤±¤Ç
.BR isprint (3)
¤ÏÀµ¤·¤¤Åú¤¨¤òÊÖ¤·¤¿¡£
ºÇ¶á¤Ç¤Ï¡¢±Ñ¸ì°Ê³°¤ò»È¤¦¥è¡¼¥í¥Ã¥Ñ¿Í¤Ï¤â¤¦¾¯¡¹¤ä¤Ã¤«¤¤¤Êºî¶È¤òɬÍפȤ·¡¢
¼ÂºÝ¤Î¥í¥±¡¼¥ë¥Õ¥¡¥¤¥ë¤ò¥¤¥ó¥¹¥È¡¼¥ë¤·¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
.SH ´ØÏ¢¹àÌÜ
.BR locale (1),
.BR localedef (1),
.BR isalpha (3),
.BR localeconv (3),
.BR nl_langinfo (3),
.BR rpmatch (3),
.BR strcoll (3),
.BR strftime (3),
.BR charsets (7),
.BR locale (7)