macro and text revision (-mdoc version 3)
[unix-history] / usr / src / lib / libc / string / memcmp.3
index 16cb27b..13fb480 100644 (file)
@@ -1,42 +1,54 @@
-.\" Copyright (c) 1990 The Regents of the University of California.
+.\" Copyright (c) 1990, 1991 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" Chris Torek.
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" Chris Torek.
-.\"
 .\" %sccs.include.redist.man%
 .\"
 .\" %sccs.include.redist.man%
 .\"
-.\"    @(#)memcmp.3    5.2 (Berkeley) %G%
+.\"     @(#)memcmp.3   5.4 (Berkeley) %G%
 .\"
 .\"
-.TH MEMCMP 3 ""
-.UC 7
-.SH NAME
-memcmp \- compare byte string
-.SH SYNOPSIS
-.nf
-.ft B
-#include <string.h>
-
-int
-memcmp(const void *b1, const void *b2, size_t len);
-.ft R
-.fi
-.SH DESCRIPTION
-.B Memcmp
+.Dd 
+.Dt MEMCMP 3
+.Os
+.Sh NAME
+.Nm memcmp
+.Nd compare byte string
+.Sh SYNOPSIS
+.Fd #include <string.h>
+.Ft int
+.Fn memcmp "const void *b1" "const void *b2" "size_t len"
+.Sh DESCRIPTION
+The
+.Fn memcmp
+function
 compares byte string
 compares byte string
-.I b1
+.Fa b1
 against byte string
 against byte string
-.IR b2 ,
-returning zero if they are identical,
-otherwise returning the difference between the first two differing bytes
-(treated as unsigned char values, so that '\e200' is greater than \&'\e0',
-e.g.).
+.Fa b2 .
 Both strings are assumed to be
 Both strings are assumed to be
-.I len
+.Fa len
 bytes long.
 bytes long.
+.Sh RETURN VALUES
+The
+.Fn memcmp
+function
+returns zero if the the two strings are identical,
+otherwise returns the difference between the first two differing bytes
+(treated as unsigned char values, so that
+.Sq Li \e200
+is greater than
+.Sq Li \&\e0 ,
+for example).
 Zero-length strings are always identical.
 Zero-length strings are always identical.
-.SH SEE ALSO
-bcmp(3), strcasecmp(3), strcmp(3), strcoll(3), strxfrm(3)
-.SH STANDARDS
-.I Memcmp
-conforms to ANSI X3.159-1989 (``ANSI C'').
+.Sh SEE ALSO
+.Xr bcmp 3 ,
+.Xr strcasecmp 3 ,
+.Xr strcmp 3 ,
+.Xr strcoll 3 ,
+.Xr strxfrm 3
+.Sh STANDARDS
+The
+.Fn memcmp
+function
+conforms to
+.St -ansiC .