| 1 | .\" Copyright (c) 2001 Alexey Zelkin <phantom@FreeBSD.org> |
|---|
| 2 | .\" All rights reserved. |
|---|
| 3 | .\" |
|---|
| 4 | .\" Redistribution and use in source and binary forms, with or without |
|---|
| 5 | .\" modification, are permitted provided that the following conditions |
|---|
| 6 | .\" are met: |
|---|
| 7 | .\" 1. Redistributions of source code must retain the above copyright |
|---|
| 8 | .\" notice, this list of conditions and the following disclaimer. |
|---|
| 9 | .\" 2. Redistributions in binary form must reproduce the above copyright |
|---|
| 10 | .\" notice, this list of conditions and the following disclaimer in the |
|---|
| 11 | .\" documentation and/or other materials provided with the distribution. |
|---|
| 12 | .\" |
|---|
| 13 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
|---|
| 14 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|---|
| 15 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
|---|
| 16 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE |
|---|
| 17 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
|---|
| 18 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
|---|
| 19 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
|---|
| 20 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|---|
| 21 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
|---|
| 22 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
|---|
| 23 | .\" SUCH DAMAGE. |
|---|
| 24 | .\" |
|---|
| 25 | .\" $FreeBSD: src/lib/libc/locale/nl_langinfo.3,v 1.4 2002/04/13 04:25:56 dd Exp $ |
|---|
| 26 | .\" |
|---|
| 27 | .Dd May 3, 2001 |
|---|
| 28 | .Dt NL_LANGINFO 3 |
|---|
| 29 | .Os |
|---|
| 30 | .Sh NAME |
|---|
| 31 | .Nm nl_langinfo |
|---|
| 32 | .Nd language information |
|---|
| 33 | .Sh LIBRARY |
|---|
| 34 | .Lb libc |
|---|
| 35 | .Sh SYNOPSIS |
|---|
| 36 | .In langinfo.h |
|---|
| 37 | .Ft char * |
|---|
| 38 | .Fn nl_langinfo "nl_item item" |
|---|
| 39 | .Sh DESCRIPTION |
|---|
| 40 | The |
|---|
| 41 | .Fn nl_langinfo |
|---|
| 42 | function returns a pointer to a string containing information relevant to |
|---|
| 43 | the particular language or cultural area defined in the program's locale. |
|---|
| 44 | The manifest constant names and values of |
|---|
| 45 | .Fa item |
|---|
| 46 | are defined in |
|---|
| 47 | .Aq Pa langinfo.h . |
|---|
| 48 | .Pp |
|---|
| 49 | Calls to |
|---|
| 50 | .Fn setlocale |
|---|
| 51 | with a category corresponding to the category of |
|---|
| 52 | .Fa item , |
|---|
| 53 | or to the |
|---|
| 54 | category |
|---|
| 55 | .Dv LC_ALL , |
|---|
| 56 | may overwrite buffer pointed by the return value. |
|---|
| 57 | .Sh EXAMPLES |
|---|
| 58 | For example: |
|---|
| 59 | .Pp |
|---|
| 60 | .Dl nl_langinfo(ABDAY_1) |
|---|
| 61 | .Pp |
|---|
| 62 | would return a pointer to the string |
|---|
| 63 | .Qq Li Dom |
|---|
| 64 | if the identified language was |
|---|
| 65 | Portuguese, and |
|---|
| 66 | .Qq Li Sun |
|---|
| 67 | if the identified language was English. |
|---|
| 68 | .Sh RETURN VALUES |
|---|
| 69 | In a locale where langinfo data is not defined, |
|---|
| 70 | .Fn nl_langinfo |
|---|
| 71 | returns a pointer to the corresponding string in the |
|---|
| 72 | .Tn POSIX |
|---|
| 73 | locale. |
|---|
| 74 | In all locales, |
|---|
| 75 | .Fn nl_langinfo |
|---|
| 76 | returns a pointer to an empty string if |
|---|
| 77 | .Fa item |
|---|
| 78 | contains an invalid setting. |
|---|
| 79 | .Sh SEE ALSO |
|---|
| 80 | .Xr setlocale 3 |
|---|
| 81 | .Sh STANDARDS |
|---|
| 82 | The |
|---|
| 83 | .Fn nl_langinfo |
|---|
| 84 | function conforms to |
|---|
| 85 | .St -susv2 . |
|---|
| 86 | .Sh HISTORY |
|---|
| 87 | The |
|---|
| 88 | .Fn nl_langinfo |
|---|
| 89 | function first appeared in |
|---|
| 90 | .Fx 4.6 . |
|---|
