termios.3: wfix
[man-pages.git] / man3 / bstring.3
blob404fec0b80e27d8781787766aa056a8d0a19ff8b
1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
2 .\"
3 .\" %%%LICENSE_START(VERBATIM)
4 .\" Permission is granted to make and distribute verbatim copies of this
5 .\" manual provided the copyright notice and this permission notice are
6 .\" preserved on all copies.
7 .\"
8 .\" Permission is granted to copy and distribute modified versions of this
9 .\" manual under the conditions for verbatim copying, provided that the
10 .\" entire resulting derived work is distributed under the terms of a
11 .\" permission notice identical to this one.
12 .\"
13 .\" Since the Linux kernel and libraries are constantly changing, this
14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
15 .\" responsibility for errors or omissions, or for damages resulting from
16 .\" the use of the information contained herein.  The author(s) may not
17 .\" have taken the same level of care in the production of this manual,
18 .\" which is licensed free of charge, as they might when working
19 .\" professionally.
20 .\"
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
23 .\" %%%LICENSE_END
24 .\"
25 .\" References consulted:
26 .\"     Linux libc source code
27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
28 .\"     386BSD man pages
29 .\" Modified 1993-04-12, David Metcalfe
30 .\" Modified 1993-07-24, Rik Faith (faith@cs.unc.edu)
31 .\" Modified 2002-01-20, Walter Harms
32 .TH BSTRING 3  2021-03-22 "" "Linux Programmer's Manual"
33 .SH NAME
34 bcmp, bcopy, bzero, memccpy, memchr, memcmp, memcpy, memfrob, memmem,
35 memmove, memset \- byte string operations
36 .SH SYNOPSIS
37 .nf
38 .B #include <string.h>
39 .PP
40 .BI "int bcmp(const void *" s1 ", const void *" s2 ", size_t " n );
41 .PP
42 .BI "void bcopy(const void *" src ", void *" dest ", size_t " n );
43 .PP
44 .BI "void bzero(void *" s ", size_t " n );
45 .PP
46 .BI "void *memccpy(void *" dest ", const void *" src ", int " c ", size_t " n );
47 .PP
48 .BI "void *memchr(const void *" s ", int " c ", size_t " n );
49 .PP
50 .BI "int memcmp(const void *" s1 ", const void *" s2 ", size_t " n );
51 .PP
52 .BI "void *memcpy(void *" dest ", const void *" src ", size_t " n );
53 .PP
54 .BI "void *memfrob(void *" s ", size_t " n );
55 .PP
56 .BI "void *memmem(const void *" haystack ", size_t " haystacklen ,
57 .BI "             const void *" needle ", size_t " needlelen );
58 .PP
59 .BI "void *memmove(void *" dest ", const void *" src ", size_t " n );
60 .PP
61 .BI "void *memset(void *" s ", int " c ", size_t " n );
62 .fi
63 .SH DESCRIPTION
64 The byte string functions perform operations on strings (byte arrays)
65 that are not necessarily null-terminated.
66 See the individual man pages
67 for descriptions of each function.
68 .SH NOTES
69 The functions
70 .BR bcmp (),
71 .BR bcopy (),
72 and
73 .BR bzero ()
74 are obsolete.
75 Use
76 .BR memcmp (),
77 .BR memcpy (),
78 and
79 .BR memset ()
80 instead.
81 .\" The old functions are not even available on some non-GNU/Linux systems.
82 .SH SEE ALSO
83 .BR bcmp (3),
84 .BR bcopy (3),
85 .BR bzero (3),
86 .BR memccpy (3),
87 .BR memchr (3),
88 .BR memcmp (3),
89 .BR memcpy (3),
90 .BR memfrob (3),
91 .BR memmem (3),
92 .BR memmove (3),
93 .BR memset (3),
94 .BR string (3)