fuse.4: ffix

[thirdparty/man-pages.git] / man3 / memmem.3

diff --git a/man3/memmem.3 b/man3/memmem.3
index b755133a1812b9818a58a3ada31a26fad7cf36e3..8c258d87fb4c7f7ab221e671fee8871ff49a44ee 100644 (file)
--- a/man3/memmem.3
+++ b/man3/memmem.3
@@ -1,5 +1,6 @@
 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
 .\"
+.\" %%%LICENSE_START(VERBATIM)
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
 .\" preserved on all copies.
@@ -19,52 +20,82 @@
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
 .\" References consulted:
 .\"     Linux libc source code
 .\"     386BSD man pages
 .\" Modified Sat Jul 24 18:50:48 1993 by Rik Faith (faith@cs.unc.edu)
 .\" Interchanged 'needle' and 'haystack'; added history, aeb, 980113.
-.TH MEMMEM 3  1998-01-13 "GNU" "Linux Programmer's Manual"
+.TH MEMMEM 3  2017-03-13 "GNU" "Linux Programmer's Manual"
 .SH NAME
 memmem \- locate a substring
 .SH SYNOPSIS
 .nf
-.B #define _GNU_SOURCE
-.br
+.BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
 .B #include <string.h>
-.sp
+.PP
 .BI "void *memmem(const void *" haystack ", size_t " haystacklen ,
-.in +\w'void *memmem('u
-.BI "const void *" needle ", size_t " needlelen  );
-.in
+.BI "             const void *" needle ", size_t " needlelen  );
 .fi
 .SH DESCRIPTION
 The
 .BR memmem ()
 function finds the start of the first occurrence
-of the substring \fIneedle\fP of length \fIneedlelen\fP in the memory
-area \fIhaystack\fP of length \fIhaystacklen\fP.
-.SH "RETURN VALUE"
+of the substring
+.IR needle
+of length
+.I needlelen
+in the memory
+area
+.I haystack
+of length
+.IR haystacklen .
+.SH RETURN VALUE
 The
 .BR memmem ()
 function returns a pointer to the beginning of the
 substring, or NULL if the substring is not found.
-.SH "CONFORMING TO"
-This function is a GNU extension.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lb
+l l l.
+Interface      Attribute       Value
+T{
+.BR memmem ()
+T}     Thread safety   MT-Safe
+.TE
+.SH CONFORMING TO
+This function is not specified in POSIX.1,
+but is present on a number of other systems.
 .SH BUGS
-This function was broken in Linux libraries up to and including libc 5.0.9;
-there the \fIneedle\fP and \fIhaystack\fP arguments were interchanged,
-and a pointer to the end of the first occurrence of \fIneedle\fP
-was returned.
-Since libc 5.0.9 is still widely used, this is a
-dangerous function to use.
-.br
-Both old and new libc's have the bug that if \fIneedle\fP is empty
-\fIhaystack\-1\fP (instead of \fIhaystack\fP) is returned.
-And glibc 2.0 makes it worse, and returns a pointer to the
-last byte of \fIhaystack\fP.
+.\" This function was broken in Linux libraries up to and including libc 5.0.9;
+.\" there the
+.\" .IR needle
+.\" and
+.\" .I haystack
+.\" arguments were interchanged,
+.\" and a pointer to the end of the first occurrence of
+.\" .I needle
+.\" was returned.
+.\"
+.\" Both old and new libc's have the bug that if
+.\" .I needle
+.\" is empty,
+.\" .I haystack\-1
+.\" (instead of
+.\" .IR haystack )
+.\" is returned.
+In glibc 2.0, if
+.I needle
+is empty,
+.BR memmem ()
+returns a pointer to the last byte of
+.IR haystack .
 This is fixed in glibc 2.1.
-.SH "SEE ALSO"
-.BR strstr (3),
-.BR feature_test_macros (7)
+.SH SEE ALSO
+.BR bstring (3),
+.BR strstr (3)