diff options
author | ajacoutot <> | 2013-05-13 10:37:02 +0000 |
---|---|---|
committer | ajacoutot <> | 2013-05-13 10:37:02 +0000 |
commit | 98bb27acd3973a0296efccfb907ccac300de8996 (patch) | |
tree | 4d8e9c368301d9076531324bf9aded39c3bd5201 /src/lib/libc/string/memmem.3 | |
parent | 88297475d30909ea98bfdcf7b87ac8dc0a377cc4 (diff) | |
download | openbsd-98bb27acd3973a0296efccfb907ccac300de8996.tar.gz openbsd-98bb27acd3973a0296efccfb907ccac300de8996.tar.bz2 openbsd-98bb27acd3973a0296efccfb907ccac300de8996.zip |
Add an implementation of memmem() -- from FreeBSD with some tweaks.
Requires a libc minor bump, committing now so that we have up-to-date
snapshots for the upcoming hackathon.
joint work with millert@
man page bits ok jmc@
input and ok millert@, guenther@, deraadt@
Diffstat (limited to 'src/lib/libc/string/memmem.3')
-rw-r--r-- | src/lib/libc/string/memmem.3 | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/src/lib/libc/string/memmem.3 b/src/lib/libc/string/memmem.3 new file mode 100644 index 0000000000..944bfe02fb --- /dev/null +++ b/src/lib/libc/string/memmem.3 | |||
@@ -0,0 +1,77 @@ | |||
1 | .\" $OpenBSD: memmem.3,v 1.1 2013/05/13 10:37:02 ajacoutot Exp $ | ||
2 | .\" | ||
3 | .\" Copyright (c) 2005 Pascal Gloor <pascal.gloor@spale.com> | ||
4 | .\" | ||
5 | .\" Redistribution and use in source and binary forms, with or without | ||
6 | .\" modification, are permitted provided that the following conditions | ||
7 | .\" are met: | ||
8 | .\" 1. Redistributions of source code must retain the above copyright | ||
9 | .\" notice, this list of conditions and the following disclaimer. | ||
10 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
11 | .\" notice, this list of conditions and the following disclaimer in the | ||
12 | .\" documentation and/or other materials provided with the distribution. | ||
13 | .\" 3. The name of the author may not be used to endorse or promote | ||
14 | .\" products derived from this software without specific prior written | ||
15 | .\" permission. | ||
16 | .\" | ||
17 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | ||
18 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
19 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
20 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | ||
21 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
22 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
23 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
24 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
25 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
26 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
27 | .\" SUCH DAMAGE. | ||
28 | .\" | ||
29 | .Dd $Mdocdate: May 13 2013 $ | ||
30 | .Dt MEMMEM 3 | ||
31 | .Os | ||
32 | .Sh NAME | ||
33 | .Nm memmem | ||
34 | .Nd locate a byte substring in a byte string | ||
35 | .Sh SYNOPSIS | ||
36 | .In string.h | ||
37 | .Ft "void *" | ||
38 | .Fo memmem | ||
39 | .Fa "const void *big" "size_t big_len" | ||
40 | .Fa "const void *little" "size_t little_len" | ||
41 | .Fc | ||
42 | .Sh DESCRIPTION | ||
43 | The | ||
44 | .Fn memmem | ||
45 | function | ||
46 | locates the first occurrence of the byte string | ||
47 | .Fa little | ||
48 | in the byte string | ||
49 | .Fa big . | ||
50 | .Sh RETURN VALUES | ||
51 | If | ||
52 | .Fa little | ||
53 | is zero length, | ||
54 | .Fa big | ||
55 | is returned; if | ||
56 | .Fa little | ||
57 | occurs nowhere in | ||
58 | .Fa big , | ||
59 | .Dv NULL | ||
60 | is returned; | ||
61 | otherwise a pointer to the first character of the first occurrence of | ||
62 | .Fa little | ||
63 | is returned. | ||
64 | .Sh SEE ALSO | ||
65 | .Xr memchr 3 , | ||
66 | .Xr strchr 3 , | ||
67 | .Xr strstr 3 | ||
68 | .Sh STANDARDS | ||
69 | .Fn memmem | ||
70 | is a GNU extension. | ||
71 | .Sh HISTORY | ||
72 | The | ||
73 | .Fn memmem | ||
74 | function first appeared in | ||
75 | .Ox 5.4 . | ||
76 | .Sh AUTHORS | ||
77 | .An Pascal Gloor Aq pascal.gloor@spale.com | ||