1.\" $FreeBSD$ 2.\" 3.\" Copyright (c) 1994 Winning Strategies, Inc. 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by Winning Strategies, Inc. 17.\" 4. The name of the author may not be used to endorse or promote products 18.\" derived from this software without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 21.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 22.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 23.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 24.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 25.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 29.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30.\" 31.Dd May 29, 1994 32.Dt CATOPEN 3 33.Os 34.Sh NAME 35.Nm catopen 36.Nd open message catalog 37.Sh LIBRARY 38.Lb libc 39.Sh SYNOPSIS 40.Fd #include <nl_types.h> 41.Ft nl_catd 42.Fn catopen "const char *name" "int oflag" 43.Sh DESCRIPTION 44The 45.Fn catopen 46function opens the message catalog specified by 47.Fa name 48and returns a message catalog descriptor. 49If 50.Fa name 51contains a 52.Sq / 53then 54.Fa name 55specifies the full pathname for the message catalog, otherwise the value 56of the environment variable 57.Ev NLSPATH 58is used with 59.Fa name 60substituted for %N. 61.Pp 62If the 63.Fa oflag 64argument is set to the 65.Dv NL_CAT_LOCALE 66constant, 67.Dv LC_MESSAGES 68locale category used to open the message catalog; using 69.Dv NL_CAT_LOCALE 70conforms to the 71.St -xpg4 72standard. 73You can specify 0 for compatibility with 74.St -xpg3 ; 75when 76.Fa oflag 77is set to 0, the 78.Ev LANG 79environment variable 80determines the message catalog locale. 81.Sh RETURN VALUE 82Upon successful completion, 83.Fn catopen 84returns a message catalog descriptor. 85Otherwise, (nl_catd) -1 is returned and 86.Va errno 87is set to indicate the error. 88.Sh ERRORS 89.Bl -tag -width Er 90.It Bq Er ENOMEM 91Insufficient memory is available. 92.El 93.Sh SEE ALSO 94.Xr gencat 1 , 95.Xr catclose 3 , 96.Xr catgets 3 , 97.Xr setlocale 3 98.Sh STANDARDS 99The 100.Fn catopen 101function conforms to 102.St -xpg4 . 103