xref: /freebsd/lib/libc/string/string.3 (revision 8269e8c887accbffa1e193394fc22fde8d0973e3)
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
40.Sh NAME
41.Nm stpcpy ,
42.Nm strcat ,
43.Nm strncat ,
44.Nm strchr ,
45.Nm strrchr ,
46.Nm strcmp ,
47.Nm strncmp ,
48.Nm strcasecmp ,
49.Nm strncasecmp ,
50.Nm strcpy ,
51.Nm strncpy ,
52.Nm strerror ,
53.Nm strlen ,
54.Nm strpbrk ,
55.Nm strsep ,
56.Nm strspn ,
57.Nm strcspn ,
58.Nm strstr ,
59.Nm strtok ,
60.Nm index ,
61.Nm rindex
62.Nd string specific functions
63.Sh LIBRARY
64.Lb libc
65.Sh SYNOPSIS
66.In string.h
67.Ft char *
68.Fn stpcpy "char *dst" "const char *src"
69.Ft char *
70.Fn strcat "char *s" "const char * append"
71.Ft char *
72.Fn strncat "char *s" "const char *append" "size_t count"
73.Ft char *
74.Fn strchr "const char *s" "int c"
75.Ft char *
76.Fn strrchr "const char *s" "int c"
77.Ft int
78.Fn strcmp "const char *s1" "const char *s2"
79.Ft int
80.Fn strncmp "const char *s1" "const char *s2" "size_t count"
81.Ft int
82.Fn strcasecmp "const char *s1" "const char *s2"
83.Ft int
84.Fn strncasecmp "const char *s1" "const char *s2" "size_t count"
85.Ft char *
86.Fn strcpy "char *dst" "const char *src"
87.Ft char *
88.Fn strncpy "char *dst" "const char *src" "size_t count"
89.Ft char *
90.Fn strerror "int errno"
91.Ft size_t
92.Fn strlen "const char *s"
93.Ft char *
94.Fn strpbrk "const char *s" "const char *charset"
95.Ft char *
96.Fn strsep "char **stringp" "const char *delim"
97.Ft size_t
98.Fn strspn "const char *s" "const char *charset"
99.Ft size_t
100.Fn strcspn "const char *s" "const char *charset"
101.Ft char *
102.Fn strstr "const char *big" "const char *little"
103.Ft char *
104.Fn strtok "char *s" "const char *delim"
105.Ft char *
106.Fn index "const char *s" "int c"
107.Ft char *
108.Fn rindex "const char *s" "int c"
109.Sh DESCRIPTION
110The string
111functions manipulate strings terminated by a
112null byte.
113.Pp
114See the specific manual pages for more information.
115For manipulating variable length generic objects as byte
116strings (without the null byte check), see
117.Xr bstring 3 .
118.Pp
119Except as noted in their specific manual pages,
120the string functions do not test the destination
121for size limitations.
122.Sh SEE ALSO
123.Xr bstring 3 ,
124.Xr index 3 ,
125.Xr rindex 3 ,
126.Xr stpcpy 3 ,
127.Xr strcasecmp 3 ,
128.Xr strcat 3 ,
129.Xr strchr 3 ,
130.Xr strcmp 3 ,
131.Xr strcpy 3 ,
132.Xr strcspn 3 ,
133.Xr strerror 3 ,
134.Xr strlen 3 ,
135.Xr strpbrk 3 ,
136.Xr strrchr 3 ,
137.Xr strsep 3 ,
138.Xr strspn 3 ,
139.Xr strstr 3 ,
140.Xr strtok 3
141.Sh STANDARDS
142The
143.Fn strcat ,
144.Fn strncat ,
145.Fn strchr ,
146.Fn strrchr ,
147.Fn strcmp ,
148.Fn strncmp ,
149.Fn strcpy ,
150.Fn strncpy ,
151.Fn strerror ,
152.Fn strlen ,
153.Fn strpbrk ,
154.Fn strsep ,
155.Fn strspn ,
156.Fn strcspn ,
157.Fn strstr ,
158and
159.Fn strtok
160functions
161conform to
162.St -isoC .
163