[apple/libc.git] / string / string.3

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