From adbc56332dfae5a1bdffd37f0a5a26326fb1cfc7 Mon Sep 17 00:00:00 2001 From: phantom Date: Mon, 4 Sep 2000 13:20:56 +0000 Subject: * move $FreeBSD$ tag to its usual place (bottom of copyright) * mdoc cleanup * document missing errno values (ERRORS section) Reviewed by: sheldonh --- lib/libc/nls/catclose.3 | 16 ++++++++++++++-- lib/libc/nls/catgets.3 | 5 ++--- lib/libc/nls/catopen.3 | 19 ++++++++++++++----- 3 files changed, 30 insertions(+), 10 deletions(-) diff --git a/lib/libc/nls/catclose.3 b/lib/libc/nls/catclose.3 index d62aa13..b469b55 100644 --- a/lib/libc/nls/catclose.3 +++ b/lib/libc/nls/catclose.3 @@ -1,5 +1,3 @@ -.\" $FreeBSD$ -.\" .\" Copyright (c) 1994 Winning Strategies, Inc. .\" All rights reserved. .\" @@ -28,6 +26,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" +.\" $FreeBSD$ .Dd May 29, 1994 .Dt CATCLOSE 3 .Os @@ -45,6 +44,19 @@ The .Fn catclose function closes the message catalog specified by the argument .Fa catd . +.Sh RETURN VALUES +Upon successful completion, +.Fn catclose +returns 0. +Otherwise, -1 is returned and +.Va errno +is set to indicate the error. +.Sh ERRORS +.Bl -tag -width Er +.It Bq Er EBADF +An invalid message catalog descriptor was passed by the +.Fa catd +argument. .Sh SEE ALSO .Xr gencat 1 , .Xr catgets 3 , diff --git a/lib/libc/nls/catgets.3 b/lib/libc/nls/catgets.3 index b55d708..fda5f36 100644 --- a/lib/libc/nls/catgets.3 +++ b/lib/libc/nls/catgets.3 @@ -1,5 +1,3 @@ -.\" $FreeBSD$ -.\" .\" Copyright (c) 1994 Winning Strategies, Inc. .\" All rights reserved. .\" @@ -28,6 +26,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" +.\" $FreeBSD$ .Dd May 29, 1994 .Dt CATGETS 3 .Os @@ -53,7 +52,7 @@ The argument .Fa s points to a default message which is returned if the function is unable to retrieve the specified message. -.Sh RETURN VALUE +.Sh RETURN VALUES If the specified message was retrieved successfully, .Fn catgets returns a pointer to an internal buffer containing the message string; diff --git a/lib/libc/nls/catopen.3 b/lib/libc/nls/catopen.3 index 17958f6..4e1f98a 100644 --- a/lib/libc/nls/catopen.3 +++ b/lib/libc/nls/catopen.3 @@ -1,5 +1,3 @@ -.\" $FreeBSD$ -.\" .\" Copyright (c) 1994 Winning Strategies, Inc. .\" All rights reserved. .\" @@ -28,6 +26,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" +.\" $FreeBSD$ .Dd May 29, 1994 .Dt CATOPEN 3 .Os @@ -80,10 +79,10 @@ environment variable determines the message catalog locale. .Pp A message catalog descriptor -remains valid in a process until that process closes it, or a -successful call to one of the +remains valid in a process until that process closes it, or +until a successful call to one of the .Xr exec 3 -functions. +function. .Sh RETURN VALUE Upon successful completion, .Fn catopen @@ -93,6 +92,16 @@ Otherwise, (nl_catd) -1 is returned and is set to indicate the error. .Sh ERRORS .Bl -tag -width Er +.It Bq Er EINVAL +Argument +.Fa name +does not point to a valid message catalog. +.It Bq Er ENAMETOOLONG +An entire path to the message catalog exceeded 1024 characters. +.It Bq Er ENOENT +The named message catalog does not exists, or the +.Fa name +argument points to an empty string. .It Bq Er ENOMEM Insufficient memory is available. .El -- cgit v1.1