Libc-1439.40.11.tar.gz

[apple/libc.git] / string / FreeBSD / strcpy.3

diff --git a/string/FreeBSD/strcpy.3 b/string/FreeBSD/strcpy.3
index 138bace16a1f77b360f5b0013b0cbaabf31be994..fda6eb44b479658f4576fc507dceb1b84d9b1e2d 100644 (file)
--- a/string/FreeBSD/strcpy.3
+++ b/string/FreeBSD/strcpy.3
@@ -13,11 +13,7 @@
 .\" 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
+.\" 3. 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.
 .\"
@@ -34,24 +30,26 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)strcpy.3   8.1 (Berkeley) 6/4/93
-.\" $FreeBSD: src/lib/libc/string/strcpy.3,v 1.24 2002/12/19 09:40:24 ru Exp $
+.\" $FreeBSD$
 .\"
-.Dd August 9, 2001
+.Dd February 28, 2009
 .Dt STRCPY 3
 .Os
 .Sh NAME
-.Nm strcpy , strncpy
+.Nm stpcpy, stpncpy, strcpy , strncpy
 .Nd copy strings
 .Sh LIBRARY
 .Lb libc
 .Sh SYNOPSIS
 .In string.h
 .Ft char *
-.Fn stpcpy "char *dst" "const char *src"
+.Fn stpcpy "char * dst" "const char * src"
 .Ft char *
-.Fn strcpy "char * restrict dst" "const char * restrict src"
+.Fn stpncpy "char * dst" "const char * src" "size_t len"
 .Ft char *
-.Fn strncpy "char * restrict dst" "const char * restrict src" "size_t len"
+.Fn strcpy "char * dst" "const char * src"
+.Ft char *
+.Fn strncpy "char * dst" "const char * src" "size_t len"
 .Sh DESCRIPTION
 The
 .Fn stpcpy
@@ -67,8 +65,10 @@ to
 character.)
 .Pp
 The
+.Fn stpncpy
+and
 .Fn strncpy
-function copies at most
+functions copy at most
 .Fa len
 characters from
 .Fa src
@@ -89,6 +89,9 @@ Otherwise,
 is
 .Em not
 terminated.
+.Pp
+The source and destination strings should not overlap, as the
+behavior is undefined.
 .Sh RETURN VALUES
 The
 .Fn strcpy
@@ -99,10 +102,21 @@ return
 .Fa dst .
 The
 .Fn stpcpy
-function returns a pointer to the terminating
+and
+.Fn stpncpy
+functions return a pointer to the terminating
 .Ql \e0
 character of
 .Fa dst .
+If
+.Fn stpncpy
+does not terminate
+.Fa dst
+with a
+.Dv NUL
+character, it instead returns a pointer to
+.Li dst[n]
+(which does not necessarily refer to a valid memory location.)
 .Sh EXAMPLES
 The following sets
 .Va chararray
@@ -163,27 +177,13 @@ Note that because
 .Xr strlcpy 3
 is not defined in any standards, it should
 only be used when portability is not a concern.
-.Sh SECURITY CONSIDERATIONS
-The
-.Fn strcpy
-function is easily misused in a manner which enables malicious users
-to arbitrarily change a running program's functionality through a
-buffer overflow attack.
-(See
-the FSA
-and
-.Sx EXAMPLES . )
 .Sh SEE ALSO
 .Xr bcopy 3 ,
 .Xr memccpy 3 ,
 .Xr memcpy 3 ,
 .Xr memmove 3 ,
-.Xr strlcpy 3
-.Rs
-.%T "The FreeBSD Security Architecture"
-.Re
-(See
-.Pa "/usr/share/doc/{to be decided}" . )
+.Xr strlcpy 3 ,
+.Xr wcscpy 3
 .Sh STANDARDS
 The
 .Fn strcpy
@@ -194,14 +194,22 @@ conform to
 .St -isoC .
 The
 .Fn stpcpy
-function is an MS-DOS and GNUism.
-The
-.Fn stpcpy
-function
-conforms to no standard.
+and
+.Fn stpncpy
+functions conform to
+.St -p1003.1-2008 .
 .Sh HISTORY
 The
 .Fn stpcpy
 function first appeared in
 .Fx 4.4 ,
-coming from 1998-vintage Linux.
+and
+.Fn stpncpy
+was added in
+.Fx 8.0 .
+.Sh SECURITY CONSIDERATIONS
+The
+.Fn strcpy
+function is easily misused in a manner which enables malicious users
+to arbitrarily change a running program's functionality through a
+buffer overflow attack.