Add strnlen()/wcsnlen() documentation (from FreeBSD).
authorSascha Wildner <saw@online.de>
Thu, 23 Apr 2009 08:56:48 +0000 (10:56 +0200)
committerSascha Wildner <saw@online.de>
Thu, 23 Apr 2009 09:00:12 +0000 (11:00 +0200)
lib/libc/string/Makefile.inc
lib/libc/string/strlen.3
lib/libc/string/wmemchr.3

index 5600533..cb52808 100644 (file)
@@ -54,6 +54,7 @@ MLINKS+=strerror.3 perror.3 \
        strerror.3 sys_errlist.3 \
        strerror.3 sys_nerr.3
 MLINKS+=strlcpy.3 strlcat.3
+MLINKS+=strlen.3 strnlen.3
 MLINKS+=strstr.3 strcasestr.3 \
        strstr.3 strnstr.3
 MLINKS+=strtok.3 strtok_r.3
@@ -69,6 +70,7 @@ MLINKS+=wmemchr.3 wcscat.3 \
        wmemchr.3 wcsncat.3 \
        wmemchr.3 wcsncmp.3 \
        wmemchr.3 wcsncpy.3 \
+       wmemchr.3 wcsnlen.3 \
        wmemchr.3 wcspbrk.3 \
        wmemchr.3 wcsrchr.3 \
        wmemchr.3 wcsspn.3 \
index fcfd854..34bbe81 100644 (file)
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)strlen.3   8.1 (Berkeley) 6/4/93
-.\" $FreeBSD: src/lib/libc/string/strlen.3,v 1.7 2007/01/09 00:28:12 imp Exp $
+.\" $FreeBSD: src/lib/libc/string/strlen.3,v 1.9 2009/04/07 13:42:53 trasz Exp $
 .\" $DragonFly: src/lib/libc/string/strlen.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
 .\"
-.Dd June 4, 1993
+.Dd April 23, 2009
 .Dt STRLEN 3
 .Os
 .Sh NAME
-.Nm strlen
+.Nm strlen ,
+.Nm strnlen
 .Nd find length of string
 .Sh LIBRARY
 .Lb libc
 .In string.h
 .Ft size_t
 .Fn strlen "const char *s"
+.Ft size_t
+.Fn strnlen "const char *s" "size_t maxlen"
 .Sh DESCRIPTION
 The
 .Fn strlen
 function
 computes the length of the string
 .Fa s .
+The
+.Fn strnlen
+function attempts to compute the length of
+.Fa s ,
+but never scans beyond the first
+.Fa maxlen
+bytes of
+.Fa s .
 .Sh RETURN VALUES
 The
 .Fn strlen
@@ -61,10 +72,16 @@ terminating
 .Dv NUL
 character.
 .Sh SEE ALSO
-.Xr string 3
+.Xr string 3 ,
+.Xr wcslen 3 ,
+.Xr wcswidth 3
 .Sh STANDARDS
 The
 .Fn strlen
 function
 conforms to
 .St -isoC .
+The
+.Fn strnlen
+function conforms to
+.St -p1003.1-2008 .
index 1a3624a..5528943 100644 (file)
@@ -36,7 +36,7 @@
 .\" $FreeBSD: src/lib/libc/string/wmemchr.3,v 1.8 2007/01/09 00:28:12 imp Exp $
 .\" $DragonFly: src/lib/libc/string/wmemchr.3,v 1.2 2003/06/17 04:26:47 dillon Exp $
 .\"
-.Dd August 13, 2005
+.Dd April 23, 2009
 .Dt WMEMCHR 3
 .Os
 .Sh NAME
@@ -57,6 +57,7 @@
 .Nm wcsncat ,
 .Nm wcsncmp ,
 .Nm wcsncpy ,
+.Nm wcsnlen ,
 .Nm wcspbrk ,
 .Nm wcsrchr ,
 .Nm wcsspn ,
 .Fn wcsncmp "const wchar_t *s1" "const wchar_t * s2" "size_t n"
 .Ft wchar_t *
 .Fn wcsncpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
+.Ft size_t
+.Fn wcsnlen "const wchar_t *s" "size_t maxlen"
 .Ft wchar_t *
 .Fn wcspbrk "const wchar_t *s1" "const wchar_t *s2"
 .Ft wchar_t *
@@ -120,6 +123,8 @@ counterpart, such as
 .Xr memcpy 3 ,
 .Xr memmove 3 ,
 .Xr memset 3 ,
+.Xr stpcpy 3 ,
+.Xr strcasecmp 3 ,
 .Xr strcat 3 ,
 .Xr strchr 3 ,
 .Xr strcmp 3 ,
@@ -132,6 +137,7 @@ counterpart, such as
 .Xr strncat 3 ,
 .Xr strncmp 3 ,
 .Xr strncpy 3 ,
+.Xr strnlen 3 ,
 .Xr strpbrk 3 ,
 .Xr strrchr 3 ,
 .Xr strspn 3 ,
@@ -141,7 +147,12 @@ These functions conform to
 .St -isoC-99 ,
 with the exception of
 .Fn wcsdup ,
-.Fn wcslcat ,
+and
+.Fn wcsnlen ,
+which conform to
+.St -p1003.1-2008 ;
+and
+.Fn wcslcat
 and
 .Fn wcslcpy ,
 which are extensions.