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