Initial import from FreeBSD RELENG_4:
[dragonfly.git] / lib / libc / string / strcat.3
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 .\"     @(#)strcat.3    8.1 (Berkeley) 6/4/93
37 .\" $FreeBSD: src/lib/libc/string/strcat.3,v 1.5.2.3 2001/12/14 18:33:59 ru Exp $
38 .\"
39 .Dd June 4, 1993
40 .Dt STRCAT 3
41 .Os
42 .Sh NAME
43 .Nm strcat
44 .Nd concatenate strings
45 .Sh LIBRARY
46 .Lb libc
47 .Sh SYNOPSIS
48 .In string.h
49 .Ft char *
50 .Fn strcat "char *s" "const char *append"
51 .Ft char *
52 .Fn strncat "char *s" "const char *append" "size_t count"
53 .Sh DESCRIPTION
54 The
55 .Fn strcat
56 and
57 .Fn strncat
58 functions
59 append a copy of the null-terminated string
60 .Fa append
61 to the end of the null-terminated string
62 .Fa s ,
63 then add a terminating
64 .Ql \e0 .
65 The string
66 .Fa s
67 must have sufficient space to hold the result.
68 .Pp
69 The
70 .Fn strncat
71 function
72 appends not more than
73 .Fa count
74 characters from
75 .Fa append ,
76 and then adds a terminating
77 .Ql \e0 .
78 .Sh RETURN VALUES
79 The
80 .Fn strcat
81 and
82 .Fn strncat
83 functions
84 return the pointer
85 .Fa s .
86 .Sh SEE ALSO
87 .Xr bcopy 3 ,
88 .Xr memccpy 3 ,
89 .Xr memcpy 3 ,
90 .Xr memmove 3 ,
91 .Xr strcpy 3 ,
92 .Xr strlcat 3 ,
93 .Xr strlcpy 3
94 .Sh STANDARDS
95 The
96 .Fn strcat
97 and
98 .Fn strncat
99 functions
100 conform to
101 .St -isoC .