summaryrefslogtreecommitdiff
path: root/src/lib/libc/string/strcat.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libc/string/strcat.3')
-rw-r--r--src/lib/libc/string/strcat.3137
1 files changed, 137 insertions, 0 deletions
diff --git a/src/lib/libc/string/strcat.3 b/src/lib/libc/string/strcat.3
new file mode 100644
index 0000000000..7591423f96
--- /dev/null
+++ b/src/lib/libc/string/strcat.3
@@ -0,0 +1,137 @@
1.\" Copyright (c) 1990, 1991 The Regents of the University of California.
2.\" 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.\" $OpenBSD: strcat.3,v 1.5 1999/03/06 23:41:13 millert Exp $
37.\"
38.Dd July 8, 1997
39.Dt STRCAT 3
40.Os
41.Sh NAME
42.Nm strcat
43.Nd concatenate strings
44.Sh SYNOPSIS
45.Fd #include <string.h>
46.Ft char *
47.Fn strcat "char *s" "const char *append"
48.Ft char *
49.Fn strncat "char *s" "const char *append" "size_t count"
50.Sh DESCRIPTION
51The
52.Fn strcat
53and
54.Fn strncat
55functions
56append a copy of the null-terminated string
57.Fa append
58to the end of the null-terminated string
59.Fa s ,
60then add a terminating
61.Ql \e0 .
62The string
63.Fa s
64must have sufficient space to hold the result.
65.Pp
66The
67.Fn strncat
68function
69appends not more than
70.Fa count
71characters where space for the terminating
72.Ql \e0
73should not be included in
74.Fa count .
75.Sh RETURN VALUES
76The
77.Fn strcat
78and
79.Fn strncat
80functions
81return the pointer
82.Fa s .
83.Sh EXAMPLES
84The following appends
85.Dq Li abc
86to
87.Dq Li chararray :
88.Bd -literal -offset indent
89char *letters = "abcdefghi";
90
91(void)strncat(chararray, letters, 3);
92.Ed
93.Pp
94The following example shows how to use
95.Fn strncat
96safely in conjunction with
97.Xr strncpy 3 .
98.Bd -literal -offset indent
99char buf[BUFSIZ];
100char *input, *suffix;
101
102(void)strncpy(buf, input, sizeof(buf) - 1);
103buf[sizeof(buf) - 1] = '\e0';
104(void)strncat(buf, suffix, sizeof(buf) - 1 - strlen(buf));
105.Ed
106.Pp
107The above will copy as many characters from
108.Dq Li input
109to
110.Dq Li buf
111as will
112fit. It then appends as many characters from suffix as will fit (or none
113if there is no space). For operations like this, the
114.Xr strlcpy 3
115and
116.Xr strlcat 3
117functions are a better choice, as shown below.
118.Bd -literal -offset indent
119(void)strlcpy(buf, input, sizeof(buf));
120(void)strlcat(buf, suffix, sizeof(buf));
121.Ed
122.Sh SEE ALSO
123.Xr bcopy 3 ,
124.Xr memccpy 3 ,
125.Xr memcpy 3 ,
126.Xr memmove 3 ,
127.Xr strcpy 3 ,
128.Xr strlcat 3 ,
129.Xr strlcpy 3
130.Sh STANDARDS
131The
132.Fn strcat
133and
134.Fn strncat
135functions
136conform to
137.St -ansiC .