xref: /netbsd/lib/libc/string/strcpy.3 (revision bf9ec67e)
1.\" Copyright (c) 1990, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Chris Torek and the American National Standards Committee X3,
6.\" on Information Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     from: @(#)strcpy.3	8.1 (Berkeley) 6/4/93
37.\"	$NetBSD: strcpy.3,v 1.10 2002/02/07 07:00:32 ross Exp $
38.\"
39.Dd June 4, 1993
40.Dt STRCPY 3
41.Os
42.Sh NAME
43.Nm strcpy ,
44.Nm strncpy
45.Nd copy strings
46.Sh LIBRARY
47.Lb libc
48.Sh SYNOPSIS
49.Fd #include \*[Lt]string.h\*[Gt]
50.Ft char *
51.Fn strcpy "char * restrict dst" "const char * restrict src"
52.Ft char *
53.Fn strncpy "char * restrict dst" "const char * restrict src" "size_t len"
54.Sh DESCRIPTION
55The
56.Fn strcpy
57and
58.Fn strncpy
59functions
60copy the string
61.Fa src
62to
63.Fa dst
64(including the terminating
65.Ql \e0
66character).
67.Pp
68The
69.Fn strncpy
70copies not more than
71.Fa len
72characters into
73.Fa dst ,
74appending
75.Ql \e0
76characters if
77.Fa src
78is less than
79.Fa len
80characters long, and
81.Em not
82terminating
83.Fa dst
84if
85.Fa src
86is more than
87.Fa len
88characters long.
89.Sh RETURN VALUES
90The
91.Fn strcpy
92and
93.Fn strncpy
94functions
95return
96.Fa dst .
97.Sh EXAMPLES
98The following sets
99.Dq Li chararray
100to
101.Dq Li abc\e0\e0\e0 :
102.Bd -literal -offset indent
103(void)strncpy(chararray, "abc", 6).
104.Ed
105.Pp
106The following sets
107.Dq Li chararray
108to
109.Dq Li abcdef :
110.Bd -literal -offset indent
111(void)strncpy(chararray, "abcdefgh", 6);
112.Ed
113.Sh SEE ALSO
114.Xr bcopy 3 ,
115.Xr memccpy 3 ,
116.Xr memcpy 3 ,
117.Xr memmove 3 ,
118.Xr strlcpy 3
119.Sh STANDARDS
120The
121.Fn strcpy
122and
123.Fn strncpy
124functions
125conform to
126.St -isoC99 .
127