Whamcloud - gitweb
Change licensing of libuuid man pages from GPL to 3-clause BSD-style,
[tools/e2fsprogs.git] / lib / uuid / uuid_compare.3.in
1 .\" Copyright 1999 Andreas Dilger (adilger@enel.ucalgary.ca)
2 .\"
3 .\" %Begin-Header%
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, and the entire permission notice in its entirety,
9 .\"    including the disclaimer of warranties.
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
15 .\"    written permission.
16 .\" 
17 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
18 .\" WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF
20 .\" WHICH ARE HEREBY DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE
21 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
23 .\" OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
24 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 .\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
27 .\" USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH
28 .\" DAMAGE.
29 .\" %End-Header%
30 .\" 
31 .\" Created  Wed Mar 10 17:42:12 1999, Andreas Dilger
32 .TH UUID_COMPARE 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
33 .SH NAME
34 uuid_compare \- compare whether two UUIDs are the same
35 .SH SYNOPSIS
36 .nf
37 .B #include <uuid/uuid.h>
38 .sp
39 .BI "int uuid_compare(uuid_t " uu1 ", uuid_t " uu2)
40 .fi
41 .SH DESCRIPTION
42 The
43 .B uuid_compare
44 function compares the two supplied uuid variables
45 .IR uu1 " and " uu2
46 to each other.
47 .SH RETURN VALUE
48 Returns an integer less than, equal to, or greater than zero if 
49 .I uu1
50 is found,  respectively, to be lexigraphically less than, equal, or 
51 greater than 
52 .IR uu2 .
53 .SH AUTHOR
54 .B uuid_compare
55 was written by Theodore Y. Ts'o for the ext2 filesystem utilties.
56 .SH AVAILABILITY
57 .B uuid_compare
58 is part of libuuid from the e2fsprogs package and is available from
59 http://e2fsprogs.sourceforge.net.
60 .SH "SEE ALSO"
61 .BR libuuid (3),
62 .BR uuid_clear (3),
63 .BR uuid_copy (3),
64 .BR uuid_generate (3),
65 .BR uuid_is_null (3)