From 754fed0c144686ad64205aad5c37d50ca8155fba Mon Sep 17 00:00:00 2001 From: Karel Zak Date: Sat, 16 May 2009 01:01:36 +0200 Subject: libuuid: import UUID library from e2fsprogs Signed-off-by: Karel Zak --- shlibs/uuid/man/uuid_generate.3 | 104 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 shlibs/uuid/man/uuid_generate.3 (limited to 'shlibs/uuid/man/uuid_generate.3') diff --git a/shlibs/uuid/man/uuid_generate.3 b/shlibs/uuid/man/uuid_generate.3 new file mode 100644 index 00000000..d36c1d0d --- /dev/null +++ b/shlibs/uuid/man/uuid_generate.3 @@ -0,0 +1,104 @@ +.\" Copyright 1999 Andreas Dilger (adilger@enel.ucalgary.ca) +.\" +.\" %Begin-Header% +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, and the entire permission notice in its entirety, +.\" including the disclaimer of warranties. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote +.\" products derived from this software without specific prior +.\" written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED +.\" WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ALL OF +.\" WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE +.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT +.\" OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR +.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE +.\" USE OF THIS SOFTWARE, EVEN IF NOT ADVISED OF THE POSSIBILITY OF SUCH +.\" DAMAGE. +.\" %End-Header% +.\" +.\" Created Wed Mar 10 17:42:12 1999, Andreas Dilger +.TH UUID_GENERATE 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" +.SH NAME +uuid_generate, uuid_generate_random, uuid_generate_time \- create a new unique UUID value +.SH SYNOPSIS +.nf +.B #include +.sp +.BI "void uuid_generate(uuid_t " out ); +.BI "void uuid_generate_random(uuid_t " out ); +.BI "void uuid_generate_time(uuid_t " out ); +.fi +.SH DESCRIPTION +The +.B uuid_generate +function creates a new universally unique identifier (UUID). The uuid will +be generated based on high-quality randomness from +.IR /dev/urandom , +if available. If it is not available, then +.B uuid_generate +will use an alternative algorithm which uses the current time, the +local ethernet MAC address (if available), and random data generated +using a pseudo-random generator. +.sp +The +.B uuid_generate_random +function forces the use of the all-random UUID format, even if +a high-quality random number generator (i.e., +.IR /dev/urandom ) +is not available, in which case a pseudo-random +generator will be subsituted. Note that the use of a pseudo-random +generator may compromise the uniqueness of UUID's +generated in this fashion. +.sp +The +.B uuid_generate_time +function forces the use of the alternative algorithm which uses the +current time and the local ethernet MAC address (if available). +This algorithm used to be the default one used to generate UUID, but +because of the use of the ethernet MAC address, it can leak +information about when and where the UUID was generated. This can cause +privacy problems in some applications, so the +.B uuid_generate +function only uses this algorithm if a high-quality source of +randomness is not available. +.sp +The UUID is 16 bytes (128 bits) long, which gives approximately 3.4x10^38 +unique values (there are approximately 10^80 elemntary particles in +the universe according to Carl Sagan's +.IR Cosmos ). +The new UUID can reasonably be considered unique among all UUIDs created +on the local system, and among UUIDs created on other systems in the past +and in the future. +.SH RETURN VALUE +The newly created UUID is returned in the memory location pointed to by +.IR out . +.SH "CONFORMING TO" +OSF DCE 1.1 +.SH AUTHOR +Theodore Y. Ts'o +.SH AVAILABILITY +.UR http://e2fsprogs.sourceforge.net/ +http://e2fsprogs.sourceforge.net/ +.UE +.SH "SEE ALSO" +.BR uuid (3), +.BR uuidgen (1), +.BR uuid_clear (3), +.BR uuid_compare (3), +.BR uuid_copy (3), +.BR uuid_is_null (3), +.BR uuid_parse (3), +.BR uuid_time (3), +.BR uuid_unparse (3) -- cgit v1.2.3 From af610010114de4d8d9ff71b86c778439656e5278 Mon Sep 17 00:00:00 2001 From: Karel Zak Date: Sat, 16 May 2009 01:50:04 +0200 Subject: libuuid: add info about u-l-ng to man pages Signed-off-by: Karel Zak --- shlibs/uuid/man/uuid.3 | 8 ++++---- shlibs/uuid/man/uuid_clear.3 | 7 ++++--- shlibs/uuid/man/uuid_compare.3 | 7 ++++--- shlibs/uuid/man/uuid_copy.3 | 7 ++++--- shlibs/uuid/man/uuid_generate.3 | 7 ++++--- shlibs/uuid/man/uuid_is_null.3 | 7 ++++--- shlibs/uuid/man/uuid_parse.3 | 7 ++++--- shlibs/uuid/man/uuid_time.3 | 7 ++++--- shlibs/uuid/man/uuid_unparse.3 | 7 ++++--- 9 files changed, 36 insertions(+), 28 deletions(-) (limited to 'shlibs/uuid/man/uuid_generate.3') diff --git a/shlibs/uuid/man/uuid.3 b/shlibs/uuid/man/uuid.3 index 0f24e67f..caa22851 100644 --- a/shlibs/uuid/man/uuid.3 +++ b/shlibs/uuid/man/uuid.3 @@ -29,7 +29,7 @@ .\" %End-Header% .\" .\" Created Wed Mar 10 17:42:12 1999, Andreas Dilger -.TH UUID 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" +.TH UUID 3 "May 2009" "util-linux-ng" "Libuuid API" .SH NAME uuid \- DCE compatible Universally Unique Identifier library .SH SYNOPSIS @@ -51,9 +51,9 @@ OSF DCE 1.1 .SH AUTHOR Theodore Y. Ts'o .SH AVAILABILITY -The UUID library is part of the e2fsprogs package and is available from -.UR http://e2fsprogs.sourceforge.net/ -http://e2fsprogs.sourceforge.net/ +.B libuuid +is part of the util-linux-ng package since version 2.15.1 and is available from +ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/. .UE .SH "SEE ALSO" .BR uuid_clear (3), diff --git a/shlibs/uuid/man/uuid_clear.3 b/shlibs/uuid/man/uuid_clear.3 index 46507f08..d2df1b72 100644 --- a/shlibs/uuid/man/uuid_clear.3 +++ b/shlibs/uuid/man/uuid_clear.3 @@ -29,7 +29,7 @@ .\" %End-Header% .\" .\" Created Wed Mar 10 17:42:12 1999, Andreas Dilger -.TH UUID_CLEAR 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" +.TH UUID_CLEAR 3 "May 2009" "util-linux-ng" "Libuuid API" .SH NAME uuid_clear \- reset value of UUID variable to the NULL value .SH SYNOPSIS @@ -47,8 +47,9 @@ to the NULL value. .SH AUTHOR Theodore Y. Ts'o .SH AVAILABILITY -.UR http://e2fsprogs.sourceforge.net/ -http://e2fsprogs.sourceforge.net/ +.B libuuid +is part of the util-linux-ng package since version 2.15.1 and is available from +ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/. .UE .SH "SEE ALSO" .BR uuid (3), diff --git a/shlibs/uuid/man/uuid_compare.3 b/shlibs/uuid/man/uuid_compare.3 index ab6d8c80..3505c0a2 100644 --- a/shlibs/uuid/man/uuid_compare.3 +++ b/shlibs/uuid/man/uuid_compare.3 @@ -29,7 +29,7 @@ .\" %End-Header% .\" .\" Created Wed Mar 10 17:42:12 1999, Andreas Dilger -.TH UUID_COMPARE 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" +.TH UUID_COMPARE 3 "May 2009" "util-linux-ng" "Libuuid API" .SH NAME uuid_compare \- compare whether two UUIDs are the same .SH SYNOPSIS @@ -53,8 +53,9 @@ greater than .SH AUTHOR Theodore Y. Ts'o .SH AVAILABILITY -.UR http://e2fsprogs.sourceforge.net/ -http://e2fsprogs.sourceforge.net/ +.B libuuid +is part of the util-linux-ng package since version 2.15.1 and is available from +ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/. .UE .SH "SEE ALSO" .BR uuid (3), diff --git a/shlibs/uuid/man/uuid_copy.3 b/shlibs/uuid/man/uuid_copy.3 index 2e2126c1..1842a95a 100644 --- a/shlibs/uuid/man/uuid_copy.3 +++ b/shlibs/uuid/man/uuid_copy.3 @@ -29,7 +29,7 @@ .\" %End-Header% .\" .\" Created Wed Mar 10 17:42:12 1999, Andreas Dilger -.TH UUID_COPY 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" +.TH UUID_COPY 3 "May 2009" "util-linux-ng" "Libuuid API" .SH NAME uuid_copy \- copy a UUID value .SH SYNOPSIS @@ -49,8 +49,9 @@ The copied UUID is returned in the location pointed to by .SH AUTHOR Theodore Y. Ts'o .SH AVAILABILITY -.UR http://e2fsprogs.sourceforge.net/ -http://e2fsprogs.sourceforge.net/ +.B libuuid +is part of the util-linux-ng package since version 2.15.1 and is available from +ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/. .UE .SH "SEE ALSO" .BR uuid (3), diff --git a/shlibs/uuid/man/uuid_generate.3 b/shlibs/uuid/man/uuid_generate.3 index d36c1d0d..79f47e85 100644 --- a/shlibs/uuid/man/uuid_generate.3 +++ b/shlibs/uuid/man/uuid_generate.3 @@ -29,7 +29,7 @@ .\" %End-Header% .\" .\" Created Wed Mar 10 17:42:12 1999, Andreas Dilger -.TH UUID_GENERATE 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" +.TH UUID_GENERATE 3 "May 2009" "util-linux-ng" "Libuuid API" .SH NAME uuid_generate, uuid_generate_random, uuid_generate_time \- create a new unique UUID value .SH SYNOPSIS @@ -89,8 +89,9 @@ OSF DCE 1.1 .SH AUTHOR Theodore Y. Ts'o .SH AVAILABILITY -.UR http://e2fsprogs.sourceforge.net/ -http://e2fsprogs.sourceforge.net/ +.B libuuid +is part of the util-linux-ng package since version 2.15.1 and is available from +ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/. .UE .SH "SEE ALSO" .BR uuid (3), diff --git a/shlibs/uuid/man/uuid_is_null.3 b/shlibs/uuid/man/uuid_is_null.3 index 4e92eb05..c05d5401 100644 --- a/shlibs/uuid/man/uuid_is_null.3 +++ b/shlibs/uuid/man/uuid_is_null.3 @@ -29,7 +29,7 @@ .\" %End-Header% .\" .\" Created Wed Mar 10 17:42:12 1999, Andreas Dilger -.TH UUID_IS_NULL 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" +.TH UUID_IS_NULL 3 "May 2009" "util-linux-ng" "Libuuid API" .SH NAME uuid_is_null \- compare the value of the UUID to the NULL value .SH SYNOPSIS @@ -48,8 +48,9 @@ otherwise 0 is returned. .SH AUTHOR Theodore Y. Ts'o .SH AVAILABILITY -.UR http://e2fsprogs.sourceforge.net/ -http://e2fsprogs.sourceforge.net/ +.B libuuid +is part of the util-linux-ng package since version 2.15.1 and is available from +ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/. .UE .SH "SEE ALSO" .BR uuid (3), diff --git a/shlibs/uuid/man/uuid_parse.3 b/shlibs/uuid/man/uuid_parse.3 index 55fbddb8..2a73f1ce 100644 --- a/shlibs/uuid/man/uuid_parse.3 +++ b/shlibs/uuid/man/uuid_parse.3 @@ -29,7 +29,7 @@ .\" %End-Header% .\" .\" Created Wed Mar 10 17:42:12 1999, Andreas Dilger -.TH UUID_PARSE 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" +.TH UUID_PARSE 3 "May 2009" "util-linux-ng" "Libuuid API" .SH NAME uuid_parse \- convert an input UUID string into binary representation .SH SYNOPSIS @@ -57,8 +57,9 @@ OSF DCE 1.1 .SH AUTHOR Theodore Y. Ts'o .SH AVAILABILITY -.UR http://e2fsprogs.sourceforge.net/ -http://e2fsprogs.sourceforge.net/ +.B libuuid +is part of the util-linux-ng package since version 2.15.1 and is available from +ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/. .UE .SH "SEE ALSO" .BR uuid (3), diff --git a/shlibs/uuid/man/uuid_time.3 b/shlibs/uuid/man/uuid_time.3 index d2aa7b53..6b1f1cb3 100644 --- a/shlibs/uuid/man/uuid_time.3 +++ b/shlibs/uuid/man/uuid_time.3 @@ -29,7 +29,7 @@ .\" %End-Header% .\" .\" Created Wed Mar 10 17:42:12 1999, Andreas Dilger -.TH UUID_TIME 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" +.TH UUID_TIME 3 "May 2009" "util-linux-ng" "Libuuid API" .SH NAME uuid_time \- extract the time at which the UUID was created .SH SYNOPSIS @@ -60,8 +60,9 @@ the epoch, is also stored in the location pointed to by .SH AUTHOR Theodore Y. Ts'o .SH AVAILABILITY -.UR http://e2fsprogs.sourceforge.net/ -http://e2fsprogs.sourceforge.net/ +.B libuuid +is part of the util-linux-ng package since version 2.15.1 and is available from +ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/. .UE .SH "SEE ALSO" .BR uuid (3), diff --git a/shlibs/uuid/man/uuid_unparse.3 b/shlibs/uuid/man/uuid_unparse.3 index 5a612ae5..dbbd22d0 100644 --- a/shlibs/uuid/man/uuid_unparse.3 +++ b/shlibs/uuid/man/uuid_unparse.3 @@ -29,7 +29,7 @@ .\" %End-Header% .\" .\" Created Wed Mar 10 17:42:12 1999, Andreas Dilger -.TH UUID_UNPARSE 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" +.TH UUID_UNPARSE 3 "May 2009" "util-linux-ng" "Libuuid API" .SH NAME uuid_unparse \- convert an UUID from binary representation to a string .SH SYNOPSIS @@ -65,8 +65,9 @@ OSF DCE 1.1 .SH AUTHOR Theodore Y. Ts'o .SH AVAILABILITY -.UR http://e2fsprogs.sourceforge.net/ -http://e2fsprogs.sourceforge.net/ +.B libuuid +is part of the util-linux-ng package since version 2.15.1 and is available from +ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/. .UE .SH "SEE ALSO" .BR uuid (3), -- cgit v1.2.3