1 files changed, 84 insertions, 0 deletions
diff --git a/man3/catgets.3 b/man3/catgets.3
new file mode 100644
index 000000000..b4d0052cc
--- /dev/null
+++ b/man3/catgets.3
@@ -0,0 +1,84 @@
+.\" Copyright 1993 Mitchum DSouza <m.dsouza@mrc-applied-psychology.cambridge.ac.uk>
+.\"
+.\" 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.
+.\"
+.\" Updated, aeb, 980809
+.TH CATGETS 3 1998-08-09 
+.SH NAME
+catgets \- get message from a message catalog
+.SH SYNOPSIS
+.LP
+.nf
+.ft B
+#include <nl_types.h>
+.ft
+.fi
+.LP
+.BI "char *catgets(nl_catd " catalog ", int " set_number ,
+.BI "int " message_number ", const char *" message );
+.SH DESCRIPTION
+.B catgets()
+reads the message
+.IR message_number ,
+in set
+.IR set_number ,
+from the message catalog identified by
+.IR catalog ,
+where
+.I catalog
+is a catalog descriptor returned from an earlier call to
+.BR catopen (3).
+The fourth argument
+.I message
+points to a default message string which will be returned by
+.B catgets()
+if the identified message catalog is not currently available. The
+message-text is contained in an internal buffer area and should be copied by
+the application if it is to be saved or modified. The return string is
+always terminated with a null byte.
+.SH "RETURN VALUE"
+.LP
+On success,
+.B catgets()
+returns a pointer to an internal buffer area
+containing the null-terminated message string.
+On failure,
+.B catgets()
+returns the value
+.IR message .
+.SH NOTES
+These functions are only available in libc.so.4.4.4c and above.
+The Jan 1987 X/Open Portability Guide specifies a more subtle
+error return:
+.I message
+is returned if the message catalog specified by
+.I catalog
+is not available, while an empty string is returned
+when the message catalog is available but does not contain
+the specified message.
+These two possible error returns seem to be discarded in XPG4.2
+in favour of always returning
+.IR message .
+.SH "CONFORMING TO"
+XPG4.2
+.SH "SEE ALSO"
+.BR catopen (3),
+.BR setlocale (3)