Sync lib/libc/string with FreeBSD:
[dragonfly.git] / lib / libc / string / wmemchr.3
1 .\"     $NetBSD: wmemchr.3,v 1.4 2001/01/02 11:26:23 itojun Exp $
2 .\"
3 .\" Copyright (c) 1990, 1991, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to Berkeley by
7 .\" Chris Torek and the American National Standards Committee X3,
8 .\" on Information Processing Systems.
9 .\"
10 .\" Redistribution and use in source and binary forms, with or without
11 .\" modification, are permitted provided that the following conditions
12 .\" are met:
13 .\" 1. Redistributions of source code must retain the above copyright
14 .\"    notice, this list of conditions and the following disclaimer.
15 .\" 2. Redistributions in binary form must reproduce the above copyright
16 .\"    notice, this list of conditions and the following disclaimer in the
17 .\"    documentation and/or other materials provided with the distribution.
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 .\"     from: @(#)strcpy.3      8.1 (Berkeley) 6/4/93
35 .\"
36 .\" $FreeBSD: src/lib/libc/string/wmemchr.3,v 1.8 2007/01/09 00:28:12 imp Exp $
37 .\" $DragonFly: src/lib/libc/string/wmemchr.3,v 1.2 2003/06/17 04:26:47 dillon Exp $
38 .\"
39 .Dd August 13, 2005
40 .Dt WMEMCHR 3
41 .Os
42 .Sh NAME
43 .Nm wmemchr ,
44 .Nm wmemcmp ,
45 .Nm wmemcpy ,
46 .Nm wmemmove ,
47 .Nm wmemset ,
48 .Nm wcscat ,
49 .Nm wcschr ,
50 .Nm wcscmp ,
51 .Nm wcscpy ,
52 .Nm wcscspn ,
53 .Nm wcsdup ,
54 .Nm wcslcat ,
55 .Nm wcslcpy ,
56 .Nm wcslen ,
57 .Nm wcsncat ,
58 .Nm wcsncmp ,
59 .Nm wcsncpy ,
60 .Nm wcspbrk ,
61 .Nm wcsrchr ,
62 .Nm wcsspn ,
63 .Nm wcsstr
64 .Nd wide character string manipulation operations
65 .Sh LIBRARY
66 .Lb libc
67 .Sh SYNOPSIS
68 .In wchar.h
69 .Ft wchar_t *
70 .Fn wmemchr "const wchar_t *s" "wchar_t c" "size_t n"
71 .Ft int
72 .Fn wmemcmp "const wchar_t *s1" "const wchar_t *s2" "size_t n"
73 .Ft wchar_t *
74 .Fn wmemcpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
75 .Ft wchar_t *
76 .Fn wmemmove "wchar_t *s1" "const wchar_t *s2" "size_t n"
77 .Ft wchar_t *
78 .Fn wmemset "wchar_t *s" "wchar_t c" "size_t n"
79 .Ft wchar_t *
80 .Fn wcscat "wchar_t * restrict s1" "const wchar_t * restrict s2"
81 .Ft wchar_t *
82 .Fn wcschr "const wchar_t *s" "wchar_t c"
83 .Ft int
84 .Fn wcscmp "const wchar_t *s1" "const wchar_t *s2"
85 .Ft wchar_t *
86 .Fn wcscpy "wchar_t * restrict s1" "const wchar_t * restrict s2"
87 .Ft size_t
88 .Fn wcscspn "const wchar_t *s1" "const wchar_t *s2"
89 .Ft wchar_t *
90 .Fn wcsdup "const wchar_t *s"
91 .Ft size_t
92 .Fn wcslcat "wchar_t *s1" "const wchar_t *s2" "size_t n"
93 .Ft size_t
94 .Fn wcslcpy "wchar_t *s1" "const wchar_t *s2" "size_t n"
95 .Ft size_t
96 .Fn wcslen "const wchar_t *s"
97 .Ft wchar_t *
98 .Fn wcsncat "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
99 .Ft int
100 .Fn wcsncmp "const wchar_t *s1" "const wchar_t * s2" "size_t n"
101 .Ft wchar_t *
102 .Fn wcsncpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
103 .Ft wchar_t *
104 .Fn wcspbrk "const wchar_t *s1" "const wchar_t *s2"
105 .Ft wchar_t *
106 .Fn wcsrchr "const wchar_t *s" "wchar_t c"
107 .Ft size_t
108 .Fn wcsspn "const wchar_t *s1" "const wchar_t *s2"
109 .Ft wchar_t *
110 .Fn wcsstr "const wchar_t * restrict s1" "const wchar_t * restrict s2"
111 .Sh DESCRIPTION
112 The functions implement string manipulation operations over wide character
113 strings.
114 For a detailed description, refer to documents for the respective single-byte
115 counterpart, such as
116 .Xr memchr 3 .
117 .Sh SEE ALSO
118 .Xr memchr 3 ,
119 .Xr memcmp 3 ,
120 .Xr memcpy 3 ,
121 .Xr memmove 3 ,
122 .Xr memset 3 ,
123 .Xr strcat 3 ,
124 .Xr strchr 3 ,
125 .Xr strcmp 3 ,
126 .Xr strcpy 3 ,
127 .Xr strcspn 3 ,
128 .Xr strdup 3 ,
129 .Xr strlcat 3 ,
130 .Xr strlcpy 3 ,
131 .Xr strlen 3 ,
132 .Xr strncat 3 ,
133 .Xr strncmp 3 ,
134 .Xr strncpy 3 ,
135 .Xr strpbrk 3 ,
136 .Xr strrchr 3 ,
137 .Xr strspn 3 ,
138 .Xr strstr 3
139 .Sh STANDARDS
140 These functions conform to
141 .St -isoC-99 ,
142 with the exception of
143 .Fn wcsdup ,
144 .Fn wcslcat ,
145 and
146 .Fn wcslcpy ,
147 which are extensions.