xref: /freebsd/lib/libc/string/string.3 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
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.
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)string.3	8.2 (Berkeley) 12/11/93
35.\" $FreeBSD$
36.\"
37.Dd December 11, 1993
38.Dt STRING 3
39.Os BSD 4
40.Sh NAME
41.Nm strcat ,
42.Nm strncat ,
43.Nm strchr ,
44.Nm strrchr ,
45.Nm strcmp ,
46.Nm strncmp ,
47.Nm strcasecmp,
48.Nm strncasecmp ,
49.Nm strcpy ,
50.Nm strncpy ,
51.Nm strerror ,
52.Nm strlen ,
53.Nm strpbrk ,
54.Nm strsep,
55.Nm strspn ,
56.Nm strcspn ,
57.Nm strstr ,
58.Nm strtok ,
59.Nm index ,
60.Nm rindex
61.Nd string specific functions
62.Sh SYNOPSIS
63.Fd #include <string.h>
64.Ft char *
65.Fn strcat "char *s" "const char * append"
66.Ft char *
67.Fn strncat "char *s" "const char *append" "size_t count"
68.Ft char *
69.Fn strchr "const char *s" "int c"
70.Ft char *
71.Fn strrchr "const char *s" "int c"
72.Ft int
73.Fn strcmp "const char *s1" "const char *s2"
74.Ft int
75.Fn strncmp "const char *s1" "const char *s2" "size_t count"
76.Ft int
77.Fn strcasecmp "const char *s1" "const char *s2"
78.Ft int
79.Fn strncasecmp "const char *s1" "const char *s2" "size_t count"
80.Ft char *
81.Fn strcpy "char *dst" "const char *src"
82.Ft char *
83.Fn strncpy "char *dst" "const char *src" "size_t count"
84.Ft char *
85.Fn strerror "int errno"
86.Ft size_t
87.Fn strlen "const char *s"
88.Ft char *
89.Fn strpbrk "const char *s" "const char *charset"
90.Ft char *
91.Fn strsep "char **stringp" "const char *delim"
92.Ft size_t
93.Fn strspn "const char *s" "const char *charset"
94.Ft size_t
95.Fn strcspn "const char *s" "const char *charset"
96.Ft char *
97.Fn strstr "const char *big" "const char *little"
98.Ft char *
99.Fn strtok "char *s" "const char *delim"
100.Ft char *
101.Fn index "const char *s" "int c"
102.Ft char *
103.Fn rindex "const char *s" "int c"
104.Sh DESCRIPTION
105The string
106functions manipulate strings terminated by a
107null byte.
108.Pp
109See the specific manual pages for more information.
110For manipulating variable length generic objects as byte
111strings (without the null byte check), see
112.Xr bstring 3 .
113.Pp
114Except as noted in their specific manual pages,
115the string functions do not test the destination
116for size limitations.
117.Sh SEE ALSO
118.Xr bstring 3 ,
119.Xr index 3 ,
120.Xr rindex 3 ,
121.Xr strcasecmp 3 ,
122.Xr strcat 3 ,
123.Xr strchr 3 ,
124.Xr strcmp 3 ,
125.Xr strcpy 3 ,
126.Xr strcspn 3 ,
127.Xr strerror 3 ,
128.Xr strlen 3 ,
129.Xr strpbrk 3 ,
130.Xr strrchr 3 ,
131.Xr strsep 3 ,
132.Xr strspn 3 ,
133.Xr strstr 3 ,
134.Xr strtok 3
135.Sh STANDARDS
136The
137.Fn strcat ,
138.Fn strncat ,
139.Fn strchr ,
140.Fn strrchr ,
141.Fn strcmp ,
142.Fn strncmp ,
143.Fn strcpy ,
144.Fn strncpy ,
145.Fn strerror ,
146.Fn strlen ,
147.Fn strpbrk ,
148.Fn strsep ,
149.Fn strspn ,
150.Fn strcspn ,
151.Fn strstr ,
152and
153.Fn strtok
154functions
155conform to
156.St -ansiC .
157