BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / string / string.3

diff --git a/usr/src/lib/libc/string/string.3 b/usr/src/lib/libc/string/string.3
index 5abb12f..3371a45 100644 (file)
--- a/usr/src/lib/libc/string/string.3
+++ b/usr/src/lib/libc/string/string.3
@@ -1,121 +1,155 @@
-.\" Copyright (c) 1990 The Regents of the University of California.
+.\" Copyright (c) 1990, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" Chris Torek.
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" Chris Torek.

+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.\"    @(#)string.3    6.8 (Berkeley) 6/24/90
+.\"     @(#)string.3   6.9 (Berkeley) 4/19/91

 .\"
 .\"

-.TH STRING 3 "June 24, 1990"
-.UC 4
-.SH NAME
-strcat, strncat, strchr, strrchr, strcmp, strncmp, strcasecmp,
-strncasecmp, strcpy, strncpy, strerror, strlen, strpbrk, strsep,
-strspn, strcspn, strstr, strtok, index, rindex \- string operations
-.SH SYNOPSIS
-.nf
-.ft B
-#include <string.h>
-
-char *
-strcat(char *s, const char * append);
-
-char *
-strncat(char *s, const char *append, size_t count);
-
-char *
-strchr(const char *s, int c);
-
-char *
-strrchr(const char *s, int c);
-
-strcmp(const char *s1, const char *s2);
-
-strncmp(const char *s1, const char *s2, size_t count);
-
-strcasecmp(const char *s1, const char *s2);
-
-strncasecmp(const char *s1, const char *s2, size_t count);
-
-char *
-strcpy(char *dst, const char *src);
-
-char *
-strncpy(char *dst, const char *src, size_t count);
-
-char *
-strerror(int errno);
-
-size_t
-strlen(const char *s);
-
-char *
-strpbrk(const char *s, const char *charset);
-
-char *
-strsep(char **stringp, const char *delim);
-
-size_t
-strspn(const char *s, const char *charset);
-
-size_t
-strcspn(const char *s, const char *charset);
-
-char *
-strstr(const char *big, const char *little);
-
-char *
-strtok(char *s, const char *delim);
-
-char *
-index(const char *s, int c);
-
-char *
-rindex(const char *s, int c);
-.ft R
-.fi
-.SH DESCRIPTION
-These functions operate on null-terminated strings.
-.PP
+.Dd April 19, 1991
+.Dt STRING 3
+.Os BSD 4
+.Sh NAME
+.Nm strcat ,
+.Nm strncat ,
+.Nm strchr ,
+.Nm strrchr ,
+.Nm strcmp ,
+.Nm strncmp ,
+.Nm strcasecmp,
+.Nm strncasecmp ,
+.Nm strcpy ,
+.Nm strncpy ,
+.Nm strerror ,
+.Nm strlen ,
+.Nm strpbrk ,
+.Nm strsep,
+.Nm strspn ,
+.Nm strcspn ,
+.Nm strstr ,
+.Nm strtok ,
+.Nm index ,
+.Nm rindex
+.Nd string specific functions
+.Sh SYNOPSIS
+.Fd #include <string.h>
+.Ft char *
+.Fn strcat "char *s" "const char * append"
+.Ft char *
+.Fn strncat "char *s" "const char *append" "size_t count"
+.Ft char *
+.Fn strchr "const char *s" "int c"
+.Ft char *
+.Fn strrchr "const char *s" "int c"
+.Ft int
+.Fn strcmp "const char *s1" "const char *s2"
+.Ft int
+.Fn strncmp "const char *s1" "const char *s2" "size_t count"
+.Ft int
+.Fn strcasecmp "const char *s1" "const char *s2"
+.Ft int
+.Fn strncasecmp "const char *s1" "const char *s2" "size_t count"
+.Ft char *
+.Fn strcpy "char *dst" "const char *src"
+.Ft char *
+.Fn strncpy "char *dst" "const char *src" "size_t count"
+.Ft char *
+.Fn strerror "int errno"
+.Ft size_t
+.Fn strlen "const char *s"
+.Ft char *
+.Fn strpbrk "const char *s" "const char *charset"
+.Ft char *
+.Fn strsep "char **stringp" "const char *delim"
+.Ft size_t
+.Fn strspn "const char *s" "const char *charset"
+.Ft size_t
+.Fn strcspn "const char *s" "const char *charset"
+.Ft char *
+.Fn strstr "const char *big" "const char *little"
+.Ft char *
+.Fn strtok "char *s" "const char *delim"
+.Ft char *
+.Fn index "const char *s" "int c"
+.Ft char *
+.Fn rindex "const char *s" "int c"
+.Sh DESCRIPTION
+The string functions
+functions manipulate strings terminated by a
+null byte.
+.Pp

 See the specific manual pages for more information.
 See the specific manual pages for more information.

-.PP
+For manipulating variable length generic objects as byte
+strings (without the null byte check), see
+.Xr bstring 3 .
+.Pp

 Except as noted in their specific manual pages,
 Except as noted in their specific manual pages,

-they do not check for overflow of any destination
-string.
-.SH SEE\ ALSO
-index(3), strcat(3), strchr(3), strrchr(3), strcmp(3), strcasecmp(3),
-strcpy(3), strerror(3), strlen(3), strpbrk(3), strsep(3), strspn(3),
-strcspn(3), strstr(3), strtok(3), rindex(3)
-.SH STANDARDS
-.IR Strcat ,
-.IR strncat ,
-.IR strchr ,
-.IR strrchr ,
-.IR strcmp ,
-.IR strncmp ,
-.IR strcpy ,
-.IR strncpy ,
-.IR strerror ,
-.IR strlen ,
-.IR strpbrk ,
-.IR strsep ,
-.IR strspn ,
-.IR strcspn ,
-.IR strstr ,
+the string functions do not test the destination
+for size limitations.
+.Sh SEE ALSO
+.Xr index 3 ,
+.Xr strcat 3 ,
+.Xr strchr 3 ,
+.Xr strrchr 3 ,
+.Xr strcmp 3 ,
+.Xr strcasecmp 3 ,
+.Xr strcpy 3 ,
+.Xr strerror 3 ,
+.Xr strlen 3 ,
+.Xr strpbrk 3 ,
+.Xr strsep 3 ,
+.Xr strspn 3 ,
+.Xr strcspn 3 ,
+.Xr strstr 3 ,
+.Xr strtok 3 ,
+.Xr rindex 3
+.Xr bstring 3
+.Sh STANDARDS
+The
+.Fn strcat ,
+.Fn strncat ,
+.Fn strchr ,
+.Fn strrchr ,
+.Fn strcmp ,
+.Fn strncmp ,
+.Fn strcpy ,
+.Fn strncpy ,
+.Fn strerror ,
+.Fn strlen ,
+.Fn strpbrk ,
+.Fn strsep ,
+.Fn strspn ,
+.Fn strcspn ,
+.Fn strstr ,

 and
 and

-.IR strtok
-conform to ANSI X3.159-1989 (``ANSI C'').
+.Fn strtok
+functions
+conform to
+.St -ansiC .