xref: /dragonfly/lib/libc/string/string.3 (revision d6c5ab02)
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. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"     @(#)string.3	8.2 (Berkeley) 12/11/93
31.\" $FreeBSD: src/lib/libc/string/string.3,v 1.14 2007/01/09 00:28:12 imp Exp $
32.\"
33.Dd February 23, 2018
34.Dt STRING 3
35.Os
36.Sh NAME
37.Nm stpcpy ,
38.Nm stpncpy ,
39.Nm strcat ,
40.Nm strlcat ,
41.Nm strncat ,
42.Nm strchr ,
43.Nm strrchr ,
44.Nm strcmp ,
45.Nm strncmp ,
46.Nm strcasecmp ,
47.Nm strncasecmp ,
48.Nm strcpy ,
49.Nm strlcpy ,
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 LIBRARY
63.Lb libc
64.Sh SYNOPSIS
65.In string.h
66.Ft char *
67.Fn stpcpy "char * restrict dst" "const char * restrict src"
68.Ft char *
69.Fn stpncpy "char * restrict dst" "const char * restrict src" "size_t count"
70.Ft char *
71.Fn strcat "char * restrict s" "const char * restrict append"
72.Ft size_t
73.Fn strlcat "char * restrict dst" "const char * restrict src" "size_t count"
74.Ft char *
75.Fn strncat "char * restrict s" "const char * restrict append" "size_t count"
76.Ft char *
77.Fn strchr "const char *s" "int c"
78.Ft char *
79.Fn strrchr "const char *s" "int c"
80.Ft int
81.Fn strcmp "const char *s1" "const char *s2"
82.Ft int
83.Fn strncmp "const char *s1" "const char *s2" "size_t count"
84.Ft int
85.Fn strcasecmp "const char *s1" "const char *s2"
86.Ft int
87.Fn strncasecmp "const char *s1" "const char *s2" "size_t count"
88.Ft char *
89.Fn strcpy "char * restrict dst" "const char * restrict src"
90.Ft size_t
91.Fn strlcpy "char * restrict dst" "const char * restrict src" "size_t count"
92.Ft char *
93.Fn strncpy "char * restrict dst" "const char * restrict src" "size_t count"
94.Ft char *
95.Fn strerror "int errno"
96.Ft size_t
97.Fn strlen "const char *s"
98.Ft char *
99.Fn strpbrk "const char *s" "const char *charset"
100.Ft char *
101.Fn strsep "char **stringp" "const char *delim"
102.Ft size_t
103.Fn strspn "const char *s" "const char *charset"
104.Ft size_t
105.Fn strcspn "const char *s" "const char *charset"
106.Ft char *
107.Fn strstr "const char *big" "const char *little"
108.Ft char *
109.Fn strtok "char * restrict s" "const char *restrict delim"
110.Ft char *
111.Fn strtok_r "char * restrict s" "const char *restrict delim" "char ** restrict last"
112.Ft char *
113.Fn index "const char *s" "int c"
114.Ft char *
115.Fn rindex "const char *s" "int c"
116.Sh DESCRIPTION
117The string
118functions manipulate strings terminated by a
119null byte.
120.Pp
121See the specific manual pages for more information.
122For manipulating variable length generic objects as byte
123strings (without the null byte check), see
124.Xr bstring 3 .
125.Pp
126Except as noted in their specific manual pages,
127the string functions do not test the destination
128for size limitations.
129.Sh SEE ALSO
130.Xr bstring 3 ,
131.Xr index 3 ,
132.Xr rindex 3 ,
133.Xr stpcpy 3 ,
134.Xr stpncpy 3 ,
135.Xr strcasecmp 3 ,
136.Xr strcat 3 ,
137.Xr strchr 3 ,
138.Xr strcmp 3 ,
139.Xr strcpy 3 ,
140.Xr strcspn 3 ,
141.Xr strerror 3 ,
142.Xr strlcat 3 ,
143.Xr strlcpy 3 ,
144.Xr strlen 3 ,
145.Xr strpbrk 3 ,
146.Xr strrchr 3 ,
147.Xr strsep 3 ,
148.Xr strspn 3 ,
149.Xr strstr 3 ,
150.Xr strtok 3 ,
151.Xr strtok_r 3
152.Sh STANDARDS
153The
154.Fn strcat ,
155.Fn strncat ,
156.Fn strchr ,
157.Fn strrchr ,
158.Fn strcmp ,
159.Fn strncmp ,
160.Fn strcpy ,
161.Fn strncpy ,
162.Fn strerror ,
163.Fn strlen ,
164.Fn strpbrk ,
165.Fn strspn ,
166.Fn strcspn ,
167.Fn strstr ,
168and
169.Fn strtok
170functions
171conform to
172.St -isoC .
173