Seth Woolley's Man Viewer

setlocale(3) - setlocale, setlocale - set the current locale - man 3 setlocale

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

SETLOCALE(3)               Linux Programmer's Manual              SETLOCALE(3)



NAME
       setlocale - set(7,n,1 builtins) the current locale(3,5,7)

SYNOPSIS
       #include <locale.h>

       char *setlocale(int category, const char *locale(3,5,7));

DESCRIPTION
       The  setlocale() function is used to set(7,n,1 builtins) or query the program's current
       locale.

       If locale(3,5,7) is not NULL, the program's current locale(3,5,7) is modified accord-
       ing  to the arguments.  The argument category determines which parts of
       the program's current locale(3,5,7) should be modified.

       LC_ALL for all of the locale.

       LC_COLLATE
              for regular expression matching (it determines  the  meaning  of
              range expressions and equivalence classes) and string(3,n) collation.

       LC_CTYPE
              for regular expression matching, character classification,  con-
              version(1,3,5),  case-sensitive  comparison,  and  wide character func-
              tions.

       LC_MESSAGES
              for localizable natural-language messages.

       LC_MONETARY
              for monetary formatting.

       LC_NUMERIC
              for number formatting (such as the decimal point and  the  thou-
              sands separator).

       LC_TIME
              for time(1,2,n) and date formatting.

       The  argument  locale(3,5,7) is a pointer to a character string(3,n) containing the
       required setting of category.  Such a string(3,n)  is  either  a  well-known
       constant  like "C" or "da_DK" (see below), or an opaque string(3,n) that was
       returned by another call of setlocale.

       If locale(3,5,7) is "", each part of the locale(3,5,7) that should be modified is set(7,n,1 builtins)
       according  to the environment variables. The details are implementation
       dependent.  For glibc, first (regardless of category), the  environment
       variable  LC_ALL  is  inspected, next the environment variable with the
       same name as the category (LC_COLLATE, LC_CTYPE, LC_MESSAGES,  LC_MONE-
       TARY,  LC_NUMERIC,  LC_TIME) and finally the environment variable LANG.
       The first existing environment variable is used.  If its value is not a
       valid  locale(3,5,7)  specification,  the  locale(3,5,7)  is unchanged, and setlocale
       returns NULL.

       The locale(3,5,7) "C" or "POSIX" is a portable locale(3,5,7); its LC_CTYPE part  cor-
       responds to the 7-bit ASCII character set.

       A  locale(3,5,7)  name  is  typically  of the form language[_territory][.code-
       set(7,n,1 builtins)][@modifier], where language is an ISO 639 language code,  territory
       is an ISO 3166 country code, and codeset is a character set(7,n,1 builtins) or encoding(3,n)
       identifier like ISO-8859-1 or UTF-8.   For  a  list  of  all  supported
       locales, try "locale(3,5,7) -a", cf. locale(3,5,7)(1).

       If locale(3,5,7) is NULL, the current locale(3,5,7) is only queried, not modified.

       On  startup of the main program, the portable "C" locale(3,5,7) is selected as
       default.  A program may be made portable to all locales by calling set-
       locale(3,5,7)(LC_ALL,  "" ) after program  initialization, by using the values
       returned from a localeconv() call for locale(3,5,7) -  dependent  information,
       by  using the multi-byte and wide character functions for text process-
       ing if(3,n) MB_CUR_MAX > 1, and by using strcoll(), wcscoll() or  strxfrm(),
       wcsxfrm() to compare strings.

RETURN VALUE
       A  successful  call to setlocale() returns an opaque string(3,n) that corre-
       sponds to the locale(3,5,7) set.  This string(3,n) may be allocated in(1,8) static stor-
       age.   The  string(3,n)  returned  is  such that a subsequent call with that
       string(3,n) and its associated  category  will  restore  that  part  of  the
       process's  locale.  The  return  value is NULL if(3,n) the request cannot be
       honored.

CONFORMING TO
       ANSI C, POSIX.1

NOTES
       Linux (that is,  GNU  libc)  supports  the  portable  locales  "C"  and
       "POSIX".   In  the good old days there used to be support for the Euro-
       pean Latin-1 "ISO-8859-1" locale(3,5,7) (e.g. in(1,8) libc-4.5.21 and libc-4.6.27),
       and  the  Russian  "KOI-8"  (more  precisely, "koi-8r") locale(3,5,7) (e.g. in(1,8)
       libc-4.6.27),    so    that    having    an    environment     variable
       LC_CTYPE=ISO-8859-1 sufficed to make isprint() return the right answer.
       These days non-English speaking Europeans have to work  a  bit  harder,
       and must install actual locale(3,5,7) files.

SEE ALSO
       locale(3,5,7)(1),  localedef(1),  isalpha(3), localeconv(3), strcoll(3), strf-
       time(1,2,n)(3), charsets(4), locale(3,5,7)(7)



GNU                               1999-07-04                      SETLOCALE(3)

References for this manual (incoming links)