From 378c18e5f024ac5a8aef4cb40d7c9aa9633d144c Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 16:30:35 +0200 Subject: Adding upstream version 2.38.1. Signed-off-by: Daniel Baumann --- libuuid/man/Makemodule.am | 27 +++++++++ libuuid/man/uuid.3 | 64 +++++++++++++++++++++ libuuid/man/uuid.3.adoc | 80 ++++++++++++++++++++++++++ libuuid/man/uuid_clear.3 | 59 +++++++++++++++++++ libuuid/man/uuid_clear.3.adoc | 75 +++++++++++++++++++++++++ libuuid/man/uuid_compare.3 | 58 +++++++++++++++++++ libuuid/man/uuid_compare.3.adoc | 77 +++++++++++++++++++++++++ libuuid/man/uuid_copy.3 | 62 ++++++++++++++++++++ libuuid/man/uuid_copy.3.adoc | 79 ++++++++++++++++++++++++++ libuuid/man/uuid_generate.3 | 90 +++++++++++++++++++++++++++++ libuuid/man/uuid_generate.3.adoc | 103 ++++++++++++++++++++++++++++++++++ libuuid/man/uuid_generate_random.3 | 1 + libuuid/man/uuid_generate_time.3 | 1 + libuuid/man/uuid_generate_time_safe.3 | 1 + libuuid/man/uuid_is_null.3 | 60 ++++++++++++++++++++ libuuid/man/uuid_is_null.3.adoc | 76 +++++++++++++++++++++++++ libuuid/man/uuid_parse.3 | 71 +++++++++++++++++++++++ libuuid/man/uuid_parse.3.adoc | 87 ++++++++++++++++++++++++++++ libuuid/man/uuid_time.3 | 63 +++++++++++++++++++++ libuuid/man/uuid_time.3.adoc | 80 ++++++++++++++++++++++++++ libuuid/man/uuid_unparse.3 | 69 +++++++++++++++++++++++ libuuid/man/uuid_unparse.3.adoc | 84 +++++++++++++++++++++++++++ 22 files changed, 1367 insertions(+) create mode 100644 libuuid/man/Makemodule.am create mode 100644 libuuid/man/uuid.3 create mode 100644 libuuid/man/uuid.3.adoc create mode 100644 libuuid/man/uuid_clear.3 create mode 100644 libuuid/man/uuid_clear.3.adoc create mode 100644 libuuid/man/uuid_compare.3 create mode 100644 libuuid/man/uuid_compare.3.adoc create mode 100644 libuuid/man/uuid_copy.3 create mode 100644 libuuid/man/uuid_copy.3.adoc create mode 100644 libuuid/man/uuid_generate.3 create mode 100644 libuuid/man/uuid_generate.3.adoc create mode 100644 libuuid/man/uuid_generate_random.3 create mode 100644 libuuid/man/uuid_generate_time.3 create mode 100644 libuuid/man/uuid_generate_time_safe.3 create mode 100644 libuuid/man/uuid_is_null.3 create mode 100644 libuuid/man/uuid_is_null.3.adoc create mode 100644 libuuid/man/uuid_parse.3 create mode 100644 libuuid/man/uuid_parse.3.adoc create mode 100644 libuuid/man/uuid_time.3 create mode 100644 libuuid/man/uuid_time.3.adoc create mode 100644 libuuid/man/uuid_unparse.3 create mode 100644 libuuid/man/uuid_unparse.3.adoc (limited to 'libuuid/man') diff --git a/libuuid/man/Makemodule.am b/libuuid/man/Makemodule.am new file mode 100644 index 0000000..1cdc1b0 --- /dev/null +++ b/libuuid/man/Makemodule.am @@ -0,0 +1,27 @@ + +MANPAGES += \ + libuuid/man/uuid.3 \ + libuuid/man/uuid_clear.3 \ + libuuid/man/uuid_compare.3 \ + libuuid/man/uuid_copy.3 \ + libuuid/man/uuid_generate.3 \ + libuuid/man/uuid_is_null.3 \ + libuuid/man/uuid_parse.3 \ + libuuid/man/uuid_time.3 \ + libuuid/man/uuid_unparse.3 + +dist_noinst_DATA += \ + libuuid/man/uuid.3.adoc \ + libuuid/man/uuid_clear.3.adoc \ + libuuid/man/uuid_compare.3.adoc \ + libuuid/man/uuid_copy.3.adoc \ + libuuid/man/uuid_generate.3.adoc \ + libuuid/man/uuid_is_null.3.adoc \ + libuuid/man/uuid_parse.3.adoc \ + libuuid/man/uuid_time.3.adoc \ + libuuid/man/uuid_unparse.3.adoc + +MANLINKS += \ + libuuid/man/uuid_generate_random.3 \ + libuuid/man/uuid_generate_time.3 \ + libuuid/man/uuid_generate_time_safe.3 diff --git a/libuuid/man/uuid.3 b/libuuid/man/uuid.3 new file mode 100644 index 0000000..3f9819a --- /dev/null +++ b/libuuid/man/uuid.3 @@ -0,0 +1,64 @@ +'\" t +.\" Title: uuid +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-05-11 +.\" Manual: Programmer's Manual +.\" Source: util-linux 2.38.1 +.\" Language: English +.\" +.TH "UUID" "3" "2022-05-11" "util\-linux 2.38.1" "Programmer\(aqs Manual" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +uuid \- DCE compatible Universally Unique Identifier library +.SH "SYNOPSIS" +.sp +\fB#include \fP +.SH "DESCRIPTION" +.sp +The UUID library is used to generate unique identifiers for objects that may be accessible beyond the local system. This library generates UUIDs compatible with those created by the Open Software Foundation (OSF) Distributed Computing Environment (DCE) utility \fBuuidgen\fP(1). +.sp +The UUIDs generated by this library can be reasonably expected to be unique within a system, and unique across all systems. They could be used, for instance, to generate unique HTTP cookies across multiple web servers without communication between the servers, and without fear of a name clash. +.SH "CONFORMING TO" +.sp +This library generates UUIDs compatible with OSF DCE 1.1, and hash based UUIDs V3 and V5 compatible with \c +.URL "https://tools.ietf.org/html/rfc4122" "RFC\-4122" "." +.SH "AUTHORS" +.sp +Theodore Y. Ts\(cqo +.SH "SEE ALSO" +.sp +\fBuuid_clear\fP(3), +\fBuuid_compare\fP(3), +\fBuuid_copy\fP(3), +\fBuuid_generate\fP(3), +\fBuuid_is_null\fP(3), +\fBuuid_parse\fP(3), +\fBuuid_time\fP(3), +\fBuuid_unparse\fP(3) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/util\-linux/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBlibuuid\fP library is part of the util\-linux package since version 2.15.1. It can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "." \ No newline at end of file diff --git a/libuuid/man/uuid.3.adoc b/libuuid/man/uuid.3.adoc new file mode 100644 index 0000000..c8c6d66 --- /dev/null +++ b/libuuid/man/uuid.3.adoc @@ -0,0 +1,80 @@ +//po4a: entry man manual +//// +Copyright 1999 Andreas Dilger (adilger@enel.ucalgary.ca) + +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. + +Created Wed Mar 10 17:42:12 1999, Andreas Dilger +//// += uuid(3) +:doctype: manpage +:man manual: Programmer's Manual +:man source: util-linux {release-version} +:page-layout: base +:lib: libuuid +:firstversion: 2.15.1 + +== NAME + +uuid - DCE compatible Universally Unique Identifier library + +== SYNOPSIS + +*#include * + +== DESCRIPTION + +The UUID library is used to generate unique identifiers for objects that may be accessible beyond the local system. This library generates UUIDs compatible with those created by the Open Software Foundation (OSF) Distributed Computing Environment (DCE) utility *uuidgen*(1). + +The UUIDs generated by this library can be reasonably expected to be unique within a system, and unique across all systems. They could be used, for instance, to generate unique HTTP cookies across multiple web servers without communication between the servers, and without fear of a name clash. + +== CONFORMING TO + +This library generates UUIDs compatible with OSF DCE 1.1, and hash based UUIDs V3 and V5 compatible with link:https://tools.ietf.org/html/rfc4122[RFC-4122]. + +== AUTHORS + +Theodore Y. Ts'o + +== SEE ALSO + +*uuid_clear*(3), +*uuid_compare*(3), +*uuid_copy*(3), +*uuid_generate*(3), +*uuid_is_null*(3), +*uuid_parse*(3), +*uuid_time*(3), +*uuid_unparse*(3) + +include::man-common/bugreports.adoc[] + +include::man-common/footer-lib.adoc[] + +ifdef::translation[] +include::man-common/translation.adoc[] +endif::[] diff --git a/libuuid/man/uuid_clear.3 b/libuuid/man/uuid_clear.3 new file mode 100644 index 0000000..ef4591b --- /dev/null +++ b/libuuid/man/uuid_clear.3 @@ -0,0 +1,59 @@ +'\" t +.\" Title: uuid_clear +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-05-11 +.\" Manual: Programmer's Manual +.\" Source: util-linux 2.38.1 +.\" Language: English +.\" +.TH "UUID_CLEAR" "3" "2022-05-11" "util\-linux 2.38.1" "Programmer\(aqs Manual" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +uuid_clear \- reset value of UUID variable to the NULL value +.SH "SYNOPSIS" +.sp +\fB#include \fP +.sp +\fBvoid uuid_clear(uuid_t \fIuu\fP);\fP +.SH "DESCRIPTION" +.sp +The \fBuuid_clear\fP() function sets the value of the supplied uuid variable \fIuu\fP to the NULL value. +.SH "AUTHORS" +.sp +Theodore Y. Ts\(cqo +.SH "SEE ALSO" +.sp +\fBuuid\fP(3), +\fBuuid_compare\fP(3), +\fBuuid_copy\fP(3), +\fBuuid_generate\fP(3), +\fBuuid_is_null\fP(3), +\fBuuid_parse\fP(3), +\fBuuid_unparse\fP(3) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/util\-linux/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBlibuuid\fP library is part of the util\-linux package since version 2.15.1. It can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "." \ No newline at end of file diff --git a/libuuid/man/uuid_clear.3.adoc b/libuuid/man/uuid_clear.3.adoc new file mode 100644 index 0000000..48c3a59 --- /dev/null +++ b/libuuid/man/uuid_clear.3.adoc @@ -0,0 +1,75 @@ +//po4a: entry man manual +//// +Copyright 1999 Andreas Dilger (adilger@enel.ucalgary.ca) + +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. + +Created Wed Mar 10 17:42:12 1999, Andreas Dilger +//// += uuid_clear(3) +:doctype: manpage +:man manual: Programmer's Manual +:man source: util-linux {release-version} +:page-layout: base +:lib: libuuid +:firstversion: 2.15.1 + +== NAME + +uuid_clear - reset value of UUID variable to the NULL value + +== SYNOPSIS + +*#include * + +*void uuid_clear(uuid_t __uu__);* + +== DESCRIPTION + +The *uuid_clear*() function sets the value of the supplied uuid variable _uu_ to the NULL value. + +== AUTHORS + +Theodore Y. Ts'o + +== SEE ALSO + +*uuid*(3), +*uuid_compare*(3), +*uuid_copy*(3), +*uuid_generate*(3), +*uuid_is_null*(3), +*uuid_parse*(3), +*uuid_unparse*(3) + +include::man-common/bugreports.adoc[] + +include::man-common/footer-lib.adoc[] + +ifdef::translation[] +include::man-common/translation.adoc[] +endif::[] diff --git a/libuuid/man/uuid_compare.3 b/libuuid/man/uuid_compare.3 new file mode 100644 index 0000000..d92eb24 --- /dev/null +++ b/libuuid/man/uuid_compare.3 @@ -0,0 +1,58 @@ +'\" t +.\" Title: uuid_compare +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-05-11 +.\" Manual: Programmer's Manual +.\" Source: util-linux 2.38.1 +.\" Language: English +.\" +.TH "UUID_COMPARE" "3" "2022-05-11" "util\-linux 2.38.1" "Programmer\(aqs Manual" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +uuid_compare \- compare whether two UUIDs are the same +.SH "SYNOPSIS" +.sp +\fB#include \fP +.sp +\fBint uuid_compare(uuid_t \fIuu1\fP, uuid_t \fIuu2\fP)\fP +.SH "DESCRIPTION" +.sp +The \fBuuid_compare\fP() function compares the two supplied uuid variables \fIuu1\fP and \fIuu2\fP to each other. +.SH "RETURN VALUE" +.sp +Returns an integer less than, equal to, or greater than zero if \fIuu1\fP is found, respectively, to be lexicographically less than, equal, or greater than \fIuu2\fP. +.SH "AUTHORS" +.sp +Theodore Y. Ts\(cqo +.SH "SEE ALSO" +.sp +\fBuuid\fP(3), +\fBuuid_clear\fP(3), +\fBuuid_copy\fP(3), +\fBuuid_generate\fP(3), +\fBuuid_is_null\fP(3), +\fBuuid_parse\fP(3), +\fBuuid_unparse\fP(3) +.SH "AVAILABILITY" +.sp +The \fBlibuuid\fP library is part of the util\-linux package since version 2.15.1. It can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "." \ No newline at end of file diff --git a/libuuid/man/uuid_compare.3.adoc b/libuuid/man/uuid_compare.3.adoc new file mode 100644 index 0000000..1d32475 --- /dev/null +++ b/libuuid/man/uuid_compare.3.adoc @@ -0,0 +1,77 @@ +//po4a: entry man manual +//// +Copyright 1999 Andreas Dilger (adilger@enel.ucalgary.ca) + +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. + +Created Wed Mar 10 17:42:12 1999, Andreas Dilger +//// += uuid_compare(3) +:doctype: manpage +:man manual: Programmer's Manual +:man source: util-linux {release-version} +:page-layout: base +:lib: libuuid +:firstversion: 2.15.1 + +== NAME + +uuid_compare - compare whether two UUIDs are the same + +== SYNOPSIS + +*#include * + +*int uuid_compare(uuid_t __uu1__, uuid_t __uu2__)* + +== DESCRIPTION + +The *uuid_compare*() function compares the two supplied uuid variables _uu1_ and _uu2_ to each other. + +== RETURN VALUE + +Returns an integer less than, equal to, or greater than zero if _uu1_ is found, respectively, to be lexicographically less than, equal, or greater than _uu2_. + +== AUTHORS + +Theodore Y. Ts'o + +== SEE ALSO + +*uuid*(3), +*uuid_clear*(3), +*uuid_copy*(3), +*uuid_generate*(3), +*uuid_is_null*(3), +*uuid_parse*(3), +*uuid_unparse*(3) + +include::man-common/footer-lib.adoc[] + +ifdef::translation[] +include::man-common/translation.adoc[] +endif::[] diff --git a/libuuid/man/uuid_copy.3 b/libuuid/man/uuid_copy.3 new file mode 100644 index 0000000..bd856c0 --- /dev/null +++ b/libuuid/man/uuid_copy.3 @@ -0,0 +1,62 @@ +'\" t +.\" Title: uuid_copy +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-07-20 +.\" Manual: Programmer's Manual +.\" Source: util-linux 2.38.1 +.\" Language: English +.\" +.TH "UUID_COPY" "3" "2022-07-20" "util\-linux 2.38.1" "Programmer\(aqs Manual" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +uuid_copy \- copy a UUID value +.SH "SYNOPSIS" +.sp +\fB#include \fP +.sp +\fBvoid uuid_copy(uuid_t \fIdst\fP, uuid_t \fIsrc\fP);\fP +.SH "DESCRIPTION" +.sp +The \fBuuid_copy\fP() function copies the UUID variable \fIsrc\fP to \fIdst\fP. +.SH "RETURN VALUE" +.sp +The copied UUID is returned in the location pointed to by \fIdst\fP. +.SH "AUTHORS" +.sp +Theodore Y. Ts\(cqo +.SH "SEE ALSO" +.sp +\fBuuid\fP(3), +\fBuuid_clear\fP(3), +\fBuuid_compare\fP(3), +\fBuuid_generate\fP(3), +\fBuuid_is_null\fP(3), +\fBuuid_parse\fP(3), +\fBuuid_unparse\fP(3) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/util\-linux/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBlibuuid\fP library is part of the util\-linux package since version 2.15.1. It can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "." \ No newline at end of file diff --git a/libuuid/man/uuid_copy.3.adoc b/libuuid/man/uuid_copy.3.adoc new file mode 100644 index 0000000..fee40d6 --- /dev/null +++ b/libuuid/man/uuid_copy.3.adoc @@ -0,0 +1,79 @@ +//po4a: entry man manual +//// +Copyright 1999 Andreas Dilger (adilger@enel.ucalgary.ca) + +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. + +Created Wed Mar 10 17:42:12 1999, Andreas Dilger +//// += uuid_copy(3) +:doctype: manpage +:man manual: Programmer's Manual +:man source: util-linux {release-version} +:page-layout: base +:lib: libuuid +:firstversion: 2.15.1 + +== NAME + +uuid_copy - copy a UUID value + +== SYNOPSIS + +*#include * + +*void uuid_copy(uuid_t __dst__, uuid_t __src__);* + +== DESCRIPTION + +The *uuid_copy*() function copies the UUID variable _src_ to _dst_. + +== RETURN VALUE + +The copied UUID is returned in the location pointed to by _dst_. + +== AUTHORS + +Theodore Y. Ts'o + +== SEE ALSO + +*uuid*(3), +*uuid_clear*(3), +*uuid_compare*(3), +*uuid_generate*(3), +*uuid_is_null*(3), +*uuid_parse*(3), +*uuid_unparse*(3) + +include::man-common/bugreports.adoc[] + +include::man-common/footer-lib.adoc[] + +ifdef::translation[] +include::man-common/translation.adoc[] +endif::[] diff --git a/libuuid/man/uuid_generate.3 b/libuuid/man/uuid_generate.3 new file mode 100644 index 0000000..3ab2770 --- /dev/null +++ b/libuuid/man/uuid_generate.3 @@ -0,0 +1,90 @@ +'\" t +.\" Title: uuid_generate +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-05-11 +.\" Manual: Programmer's Manual +.\" Source: util-linux 2.38.1 +.\" Language: English +.\" +.TH "UUID_GENERATE" "3" "2022-05-11" "util\-linux 2.38.1" "Programmer\(aqs Manual" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +uuid_generate, uuid_generate_random, uuid_generate_time, uuid_generate_time_safe \- create a new unique UUID value +.SH "SYNOPSIS" +.sp +\fB#include \fP +.sp +\fBvoid uuid_generate(uuid_t \fIout\fP);\fP +.br +\fBvoid uuid_generate_random(uuid_t \fIout\fP);\fP +.br +\fBvoid uuid_generate_time(uuid_t \fIout\fP);\fP +.br +\fBint uuid_generate_time_safe(uuid_t \fIout\fP);\fP +.br +\fBvoid uuid_generate_md5(uuid_t \fIout\fP, const uuid_t \fIns\fP, const char \fI*name\fP, size_t \fIlen\fP);\fP +.br +\fBvoid uuid_generate_sha1(uuid_t \fIout\fP, const uuid_t \fIns\fP, const char \fI*name\fP, size_t \fIlen\fP);\fP +.SH "DESCRIPTION" +.sp +The \fBuuid_generate\fP() function creates a new universally unique identifier (UUID). The uuid will be generated based on high\-quality randomness from \fBgetrandom\fP(2), \fI/dev/urandom\fP, or \fI/dev/random\fP if available. If it is not available, then \fBuuid_generate\fP() 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 \fBuuid_generate_random\fP() function forces the use of the all\-random UUID format, even if a high\-quality random number generator is not available, in which case a pseudo\-random generator will be substituted. Note that the use of a pseudo\-random generator may compromise the uniqueness of UUIDs generated in this fashion. +.sp +The \fBuuid_generate_time\fP() 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 UUIDs, 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 \fBuuid_generate\fP() function only uses this algorithm if a high\-quality source of randomness is not available. To guarantee uniqueness of UUIDs generated by concurrently running processes, the uuid library uses a global clock state counter (if the process has permissions to gain exclusive access to this file) and/or the \fBuuidd\fP(8) daemon, if it is running already or can be spawned by the process (if installed and the process has enough permissions to run it). If neither of these two synchronization mechanisms can be used, it is theoretically possible that two concurrently running processes obtain the same UUID(s). To tell whether the UUID has been generated in a safe manner, use \fBuuid_generate_time_safe\fP. +.sp +The \fBuuid_generate_time_safe\fP() function is similar to \fBuuid_generate_time\fP(), except that it returns a value which denotes whether any of the synchronization mechanisms (see above) has been used. +.sp +The UUID is 16 bytes (128 bits) long, which gives approximately 3.4x10^38 unique values (there are approximately 10^80 elementary particles in the universe according to Carl Sagan\(cqs \fICosmos\fP). 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. +.sp +The \fBuuid_generate_md5\fP() and \fBuuid_generate_sha1\fP() functions generate an MD5 and SHA1 hashed (predictable) UUID based on a well\-known UUID providing the namespace and an arbitrary binary string. The UUIDs conform to V3 and V5 UUIDs per \c +.URL "https://tools.ietf.org/html/rfc4122" "RFC\-4122" "." +.SH "RETURN VALUE" +.sp +The newly created UUID is returned in the memory location pointed to by \fIout\fP. \fBuuid_generate_time_safe\fP() returns zero if the UUID has been generated in a safe manner, \-1 otherwise. +.SH "CONFORMING TO" +.sp +This library generates UUIDs compatible with OSF DCE 1.1, and hash based UUIDs V3 and V5 compatible with \c +.URL "https://tools.ietf.org/html/rfc4122" "RFC\-4122" "." +.SH "AUTHORS" +.sp +Theodore Y. Ts\(cqo +.SH "SEE ALSO" +.sp +\fBuuidgen\fP(1), +\fBuuid\fP(3), +\fBuuid_clear\fP(3), +\fBuuid_compare\fP(3), +\fBuuid_copy\fP(3), +\fBuuid_is_null\fP(3), +\fBuuid_parse\fP(3), +\fBuuid_time\fP(3), +\fBuuid_unparse\fP(3), +\fBuuidd\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/util\-linux/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBlibuuid\fP library is part of the util\-linux package since version 2.15.1. It can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "." \ No newline at end of file diff --git a/libuuid/man/uuid_generate.3.adoc b/libuuid/man/uuid_generate.3.adoc new file mode 100644 index 0000000..420634d --- /dev/null +++ b/libuuid/man/uuid_generate.3.adoc @@ -0,0 +1,103 @@ +//po4a: entry man manual +//// +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 +//// += uuid_generate(3) +:doctype: manpage +:man manual: Programmer's Manual +:man source: util-linux {release-version} +:page-layout: base +:lib: libuuid +:firstversion: 2.15.1 + +== NAME + +uuid_generate, uuid_generate_random, uuid_generate_time, uuid_generate_time_safe - create a new unique UUID value + +== SYNOPSIS + +*#include * + +*void uuid_generate(uuid_t __out__);* + +*void uuid_generate_random(uuid_t __out__);* + +*void uuid_generate_time(uuid_t __out__);* + +*int uuid_generate_time_safe(uuid_t __out__);* + +*void uuid_generate_md5(uuid_t __out__, const uuid_t __ns__, const char __*name__, size_t __len__);* + +*void uuid_generate_sha1(uuid_t __out__, const uuid_t __ns__, const char __*name__, size_t __len__);* + +== DESCRIPTION + +The *uuid_generate*() function creates a new universally unique identifier (UUID). The uuid will be generated based on high-quality randomness from *getrandom*(2), _/dev/urandom_, or _/dev/random_ if available. If it is not available, then *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. + +The *uuid_generate_random*() function forces the use of the all-random UUID format, even if a high-quality random number generator is not available, in which case a pseudo-random generator will be substituted. Note that the use of a pseudo-random generator may compromise the uniqueness of UUIDs generated in this fashion. + +The *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 UUIDs, 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 *uuid_generate*() function only uses this algorithm if a high-quality source of randomness is not available. To guarantee uniqueness of UUIDs generated by concurrently running processes, the uuid library uses a global clock state counter (if the process has permissions to gain exclusive access to this file) and/or the *uuidd*(8) daemon, if it is running already or can be spawned by the process (if installed and the process has enough permissions to run it). If neither of these two synchronization mechanisms can be used, it is theoretically possible that two concurrently running processes obtain the same UUID(s). To tell whether the UUID has been generated in a safe manner, use *uuid_generate_time_safe*. + +The *uuid_generate_time_safe*() function is similar to *uuid_generate_time*(), except that it returns a value which denotes whether any of the synchronization mechanisms (see above) has been used. + +The UUID is 16 bytes (128 bits) long, which gives approximately 3.4x10^38 unique values (there are approximately 10^80 elementary particles in the universe according to Carl Sagan's _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. + +The *uuid_generate_md5*() and *uuid_generate_sha1*() functions generate an MD5 and SHA1 hashed (predictable) UUID based on a well-known UUID providing the namespace and an arbitrary binary string. The UUIDs conform to V3 and V5 UUIDs per link:https://tools.ietf.org/html/rfc4122[RFC-4122]. + +== RETURN VALUE + +The newly created UUID is returned in the memory location pointed to by _out_. *uuid_generate_time_safe*() returns zero if the UUID has been generated in a safe manner, -1 otherwise. + +== CONFORMING TO + +This library generates UUIDs compatible with OSF DCE 1.1, and hash based UUIDs V3 and V5 compatible with link:https://tools.ietf.org/html/rfc4122[RFC-4122]. + +== AUTHORS + +Theodore Y. Ts'o + +== SEE ALSO + +*uuidgen*(1), +*uuid*(3), +*uuid_clear*(3), +*uuid_compare*(3), +*uuid_copy*(3), +*uuid_is_null*(3), +*uuid_parse*(3), +*uuid_time*(3), +*uuid_unparse*(3), +*uuidd*(8) + +include::man-common/bugreports.adoc[] + +include::man-common/footer-lib.adoc[] + +ifdef::translation[] +include::man-common/translation.adoc[] +endif::[] diff --git a/libuuid/man/uuid_generate_random.3 b/libuuid/man/uuid_generate_random.3 new file mode 100644 index 0000000..1e51c4e --- /dev/null +++ b/libuuid/man/uuid_generate_random.3 @@ -0,0 +1 @@ +.so uuid_generate.3 \ No newline at end of file diff --git a/libuuid/man/uuid_generate_time.3 b/libuuid/man/uuid_generate_time.3 new file mode 100644 index 0000000..1e51c4e --- /dev/null +++ b/libuuid/man/uuid_generate_time.3 @@ -0,0 +1 @@ +.so uuid_generate.3 \ No newline at end of file diff --git a/libuuid/man/uuid_generate_time_safe.3 b/libuuid/man/uuid_generate_time_safe.3 new file mode 100644 index 0000000..1e51c4e --- /dev/null +++ b/libuuid/man/uuid_generate_time_safe.3 @@ -0,0 +1 @@ +.so uuid_generate.3 \ No newline at end of file diff --git a/libuuid/man/uuid_is_null.3 b/libuuid/man/uuid_is_null.3 new file mode 100644 index 0000000..57ea5a0 --- /dev/null +++ b/libuuid/man/uuid_is_null.3 @@ -0,0 +1,60 @@ +'\" t +.\" Title: uuid_is_null +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-05-11 +.\" Manual: Programmer's Manual +.\" Source: util-linux 2.38.1 +.\" Language: English +.\" +.TH "UUID_IS_NULL" "3" "2022-05-11" "util\-linux 2.38.1" "Programmer\(aqs Manual" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +uuid_is_null \- compare the value of the UUID to the NULL value +.SH "SYNOPSIS" +.sp +\fB#include \fP +.sp +\fBint uuid_is_null(uuid_t \fIuu\fP);\fP +.SH "DESCRIPTION" +.sp +The \fBuuid_is_null\fP() function compares the value of the supplied UUID variable \fIuu\fP to the NULL value. If the value is equal to the NULL UUID, 1 is returned, otherwise 0 is returned. +.SH "AUTHORS" +.sp +Theodore Y. Ts\(cqo +.SH "SEE ALSO" +.sp +\fBuuid\fP(3), +\fBuuid_clear\fP(3), +\fBuuid_compare\fP(3), +\fBuuid_copy\fP(3), +\fBuuid_generate\fP(3), +\fBuuid_time\fP(3), +\fBuuid_parse\fP(3), +\fBuuid_unparse\fP(3) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/util\-linux/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBlibuuid\fP library is part of the util\-linux package since version 2.15.1. It can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "." \ No newline at end of file diff --git a/libuuid/man/uuid_is_null.3.adoc b/libuuid/man/uuid_is_null.3.adoc new file mode 100644 index 0000000..6fed1d8 --- /dev/null +++ b/libuuid/man/uuid_is_null.3.adoc @@ -0,0 +1,76 @@ +//po4a: entry man manual +//// +Copyright 1999 Andreas Dilger (adilger@enel.ucalgary.ca) + +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. + +Created Wed Mar 10 17:42:12 1999, Andreas Dilger +//// += uuid_is_null(3) +:doctype: manpage +:man manual: Programmer's Manual +:man source: util-linux {release-version} +:page-layout: base +:lib: libuuid +:firstversion: 2.15.1 + +== NAME + +uuid_is_null - compare the value of the UUID to the NULL value + +== SYNOPSIS + +*#include * + +*int uuid_is_null(uuid_t __uu__);* + +== DESCRIPTION + +The *uuid_is_null*() function compares the value of the supplied UUID variable _uu_ to the NULL value. If the value is equal to the NULL UUID, 1 is returned, otherwise 0 is returned. + +== AUTHORS + +Theodore Y. Ts'o + +== SEE ALSO + +*uuid*(3), +*uuid_clear*(3), +*uuid_compare*(3), +*uuid_copy*(3), +*uuid_generate*(3), +*uuid_time*(3), +*uuid_parse*(3), +*uuid_unparse*(3) + +include::man-common/bugreports.adoc[] + +include::man-common/footer-lib.adoc[] + +ifdef::translation[] +include::man-common/translation.adoc[] +endif::[] diff --git a/libuuid/man/uuid_parse.3 b/libuuid/man/uuid_parse.3 new file mode 100644 index 0000000..ae3ab2d --- /dev/null +++ b/libuuid/man/uuid_parse.3 @@ -0,0 +1,71 @@ +'\" t +.\" Title: uuid_parse +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-05-11 +.\" Manual: Programmer's Manual +.\" Source: util-linux 2.38.1 +.\" Language: English +.\" +.TH "UUID_PARSE" "3" "2022-05-11" "util\-linux 2.38.1" "Programmer\(aqs Manual" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +uuid_parse \- convert an input UUID string into binary representation +.SH "SYNOPSIS" +.sp +\fB#include \fP +.sp +\fBint uuid_parse(char *\fIin\fP, uuid_t \fIuu\fP);\fP +.br +\fBint uuid_parse_range(char *\fIin_start\fP, char *\fIin_end\fP, uuid_t \fIuu\fP);\fP +.SH "DESCRIPTION" +.sp +The \fBuuid_parse\fP() function converts the UUID string given by \fIin\fP into the binary representation. The input UUID is a string of the form 1b4e28ba\-2fa1\-11d2\-883f\-b9a761bde3fb (in \fBprintf\fP(3) format "%08x\-%04x\-%04x\-%04x\-%012x", 36 bytes plus the trailing \(aq\(rs0\(aq). +.sp +The \fBuuid_parse_range\fP() function works like \fBuuid_parse\fP() but parses only range in string specified by \fIin_start\fP and \fIin_end\fP pointers. +.SH "RETURN VALUE" +.sp +Upon successfully parsing the input string, 0 is returned, and the UUID is stored in the location pointed to by \fIuu\fP, otherwise \-1 is returned. +.SH "CONFORMING TO" +.sp +This library parses UUIDs compatible with OSF DCE 1.1, and hash based UUIDs V3 and V5 compatible with \c +.URL "https://tools.ietf.org/html/rfc4122" "RFC\-4122" "." +.SH "AUTHORS" +.sp +Theodore Y. Ts\(cqo +.SH "SEE ALSO" +.sp +\fBuuid\fP(3), +\fBuuid_clear\fP(3), +\fBuuid_compare\fP(3), +\fBuuid_copy\fP(3), +\fBuuid_generate\fP(3), +\fBuuid_is_null\fP(3), +\fBuuid_time\fP(3), +\fBuuid_unparse\fP(3) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/util\-linux/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBlibuuid\fP library is part of the util\-linux package since version 2.15.1. It can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "." \ No newline at end of file diff --git a/libuuid/man/uuid_parse.3.adoc b/libuuid/man/uuid_parse.3.adoc new file mode 100644 index 0000000..8129aae --- /dev/null +++ b/libuuid/man/uuid_parse.3.adoc @@ -0,0 +1,87 @@ +//po4a: entry man manual +//// +Copyright 1999 Andreas Dilger (adilger@enel.ucalgary.ca) + +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. + +Created Wed Mar 10 17:42:12 1999, Andreas Dilger +//// += uuid_parse(3) +:doctype: manpage +:man manual: Programmer's Manual +:man source: util-linux {release-version} +:page-layout: base +:lib: libuuid +:firstversion: 2.15.1 + +== NAME + +uuid_parse - convert an input UUID string into binary representation + +== SYNOPSIS + +*#include * + +*int uuid_parse(char *__in__, uuid_t __uu__);* + +*int uuid_parse_range(char *__in_start__, char *__in_end__, uuid_t __uu__);* + +== DESCRIPTION + +The *uuid_parse*() function converts the UUID string given by _in_ into the binary representation. The input UUID is a string of the form 1b4e28ba-2fa1-11d2-883f-b9a761bde3fb (in *printf*(3) format "%08x-%04x-%04x-%04x-%012x", 36 bytes plus the trailing '\0'). + +The *uuid_parse_range*() function works like *uuid_parse*() but parses only range in string specified by _in_start_ and _in_end_ pointers. + +== RETURN VALUE + +Upon successfully parsing the input string, 0 is returned, and the UUID is stored in the location pointed to by _uu_, otherwise -1 is returned. + +== CONFORMING TO + +This library parses UUIDs compatible with OSF DCE 1.1, and hash based UUIDs V3 and V5 compatible with link:https://tools.ietf.org/html/rfc4122[RFC-4122]. + +== AUTHORS + +Theodore Y. Ts'o + +== SEE ALSO + +*uuid*(3), +*uuid_clear*(3), +*uuid_compare*(3), +*uuid_copy*(3), +*uuid_generate*(3), +*uuid_is_null*(3), +*uuid_time*(3), +*uuid_unparse*(3) + +include::man-common/bugreports.adoc[] + +include::man-common/footer-lib.adoc[] + +ifdef::translation[] +include::man-common/translation.adoc[] +endif::[] diff --git a/libuuid/man/uuid_time.3 b/libuuid/man/uuid_time.3 new file mode 100644 index 0000000..3074b6e --- /dev/null +++ b/libuuid/man/uuid_time.3 @@ -0,0 +1,63 @@ +'\" t +.\" Title: uuid_time +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-05-11 +.\" Manual: Programmer's Manual +.\" Source: util-linux 2.38.1 +.\" Language: English +.\" +.TH "UUID_TIME" "3" "2022-05-11" "util\-linux 2.38.1" "Programmer\(aqs Manual" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +uuid_time \- extract the time at which the UUID was created +.SH "SYNOPSIS" +.sp +\fB#include \fP +.sp +\fBtime_t uuid_time(uuid_t \fIuu\fP, struct timeval *\fIret_tv\fP)\fP +.SH "DESCRIPTION" +.sp +The \fBuuid_time\fP() function extracts the time at which the supplied time\-based UUID \fIuu\fP was created. Note that the UUID creation time is only encoded within certain types of UUIDs. This function can only reasonably expect to extract the creation time for UUIDs created with the \fBuuid_generate_time\fP(3) and \fBuuid_generate_time_safe\fP(3) functions. It may or may not work with UUIDs created by other mechanisms. +.SH "RETURN VALUE" +.sp +The time at which the UUID was created, in seconds since January 1, 1970 GMT (the epoch), is returned (see \fBtime\fP(2)). The time at which the UUID was created, in seconds and microseconds since the epoch, is also stored in the location pointed to by \fIret_tv\fP (see \fBgettimeofday\fP(2)). +.SH "AUTHORS" +.sp +Theodore Y. Ts\(cqo +.SH "SEE ALSO" +.sp +\fBuuid\fP(3), +\fBuuid_clear\fP(3), +\fBuuid_compare\fP(3), +\fBuuid_copy\fP(3), +\fBuuid_generate\fP(3), +\fBuuid_is_null\fP(3), +\fBuuid_parse\fP(3), +\fBuuid_unparse\fP(3) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/util\-linux/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBlibuuid\fP library is part of the util\-linux package since version 2.15.1. It can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "." \ No newline at end of file diff --git a/libuuid/man/uuid_time.3.adoc b/libuuid/man/uuid_time.3.adoc new file mode 100644 index 0000000..5497583 --- /dev/null +++ b/libuuid/man/uuid_time.3.adoc @@ -0,0 +1,80 @@ +//po4a: entry man manual +//// +Copyright 1999 Andreas Dilger (adilger@enel.ucalgary.ca) + +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. + +Created Wed Mar 10 17:42:12 1999, Andreas Dilger +//// += uuid_time(3) +:doctype: manpage +:man manual: Programmer's Manual +:man source: util-linux {release-version} +:page-layout: base +:lib: libuuid +:firstversion: 2.15.1 + +== NAME + +uuid_time - extract the time at which the UUID was created + +== SYNOPSIS + +*#include * + +*time_t uuid_time(uuid_t __uu__, struct timeval *__ret_tv__)* + +== DESCRIPTION + +The *uuid_time*() function extracts the time at which the supplied time-based UUID _uu_ was created. Note that the UUID creation time is only encoded within certain types of UUIDs. This function can only reasonably expect to extract the creation time for UUIDs created with the *uuid_generate_time*(3) and *uuid_generate_time_safe*(3) functions. It may or may not work with UUIDs created by other mechanisms. + +== RETURN VALUE + +The time at which the UUID was created, in seconds since January 1, 1970 GMT (the epoch), is returned (see *time*(2)). The time at which the UUID was created, in seconds and microseconds since the epoch, is also stored in the location pointed to by _ret_tv_ (see *gettimeofday*(2)). + +== AUTHORS + +Theodore Y. Ts'o + +== SEE ALSO + +*uuid*(3), +*uuid_clear*(3), +*uuid_compare*(3), +*uuid_copy*(3), +*uuid_generate*(3), +*uuid_is_null*(3), +*uuid_parse*(3), +*uuid_unparse*(3) + +include::man-common/bugreports.adoc[] + +include::man-common/footer-lib.adoc[] + +ifdef::translation[] +include::man-common/translation.adoc[] +endif::[] diff --git a/libuuid/man/uuid_unparse.3 b/libuuid/man/uuid_unparse.3 new file mode 100644 index 0000000..e40c5ee --- /dev/null +++ b/libuuid/man/uuid_unparse.3 @@ -0,0 +1,69 @@ +'\" t +.\" Title: uuid_unparse +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-05-11 +.\" Manual: Programmer's Manual +.\" Source: util-linux 2.38.1 +.\" Language: English +.\" +.TH "UUID_UNPARSE" "3" "2022-05-11" "util\-linux 2.38.1" "Programmer\(aqs Manual" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +uuid_unparse \- convert a UUID from binary representation to a string +.SH "SYNOPSIS" +.sp +\fB#include \fP +.sp +\fBvoid uuid_unparse(uuid_t \fIuu\fP, char *\fIout\fP);\fP +.br +\fBvoid uuid_unparse_upper(uuid_t \fIuu\fP, char *\fIout\fP);\fP +.br +\fBvoid uuid_unparse_lower(uuid_t \fIuu\fP, char *\fIout\fP);\fP +.SH "DESCRIPTION" +.sp +The \fBuuid_unparse\fP() function converts the supplied UUID \fIuu\fP from the binary representation into a 36\-byte string (plus trailing \(aq\(rs0\(aq) of the form 1b4e28ba\-2fa1\-11d2\-883f\-0016d3cca427 and stores this value in the character string pointed to by \fIout\fP. The case of the hex digits returned by \fBuuid_unparse\fP() may be upper or lower case, and is dependent on the system\-dependent local default. +.sp +If the case of the hex digits is important then the functions \fBuuid_unparse_upper\fP() and \fBuuid_unparse_lower\fP() may be used. +.SH "CONFORMING TO" +.sp +This library unparses UUIDs compatible with OSF DCE 1.1. +.SH "AUTHORS" +.sp +Theodore Y. Ts\(cqo +.SH "SEE ALSO" +.sp +\fBuuid\fP(3), +\fBuuid_clear\fP(3), +\fBuuid_compare\fP(3), +\fBuuid_copy\fP(3), +\fBuuid_generate\fP(3), +\fBuuid_time\fP(3), +\fBuuid_is_null\fP(3), +\fBuuid_parse\fP(3) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/util\-linux/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBlibuuid\fP library is part of the util\-linux package since version 2.15.1. It can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "." \ No newline at end of file diff --git a/libuuid/man/uuid_unparse.3.adoc b/libuuid/man/uuid_unparse.3.adoc new file mode 100644 index 0000000..a14dc8c --- /dev/null +++ b/libuuid/man/uuid_unparse.3.adoc @@ -0,0 +1,84 @@ +//po4a: entry man manual +//// +Copyright 1999 Andreas Dilger (adilger@enel.ucalgary.ca) + +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. + +Created Wed Mar 10 17:42:12 1999, Andreas Dilger +//// += uuid_unparse(3) +:doctype: manpage +:man manual: Programmer's Manual +:man source: util-linux {release-version} +:page-layout: base +:lib: libuuid +:firstversion: 2.15.1 + +== NAME + +uuid_unparse - convert a UUID from binary representation to a string + +== SYNOPSIS + +*#include * + +*void uuid_unparse(uuid_t __uu__, char *__out__);* + +*void uuid_unparse_upper(uuid_t __uu__, char *__out__);* + +*void uuid_unparse_lower(uuid_t __uu__, char *__out__);* + +== DESCRIPTION + +The *uuid_unparse*() function converts the supplied UUID _uu_ from the binary representation into a 36-byte string (plus trailing '\0') of the form 1b4e28ba-2fa1-11d2-883f-0016d3cca427 and stores this value in the character string pointed to by _out_. The case of the hex digits returned by *uuid_unparse*() may be upper or lower case, and is dependent on the system-dependent local default. + +If the case of the hex digits is important then the functions *uuid_unparse_upper*() and *uuid_unparse_lower*() may be used. + +== CONFORMING TO + +This library unparses UUIDs compatible with OSF DCE 1.1. + +== AUTHORS + +Theodore Y. Ts'o + +== SEE ALSO + +*uuid*(3), +*uuid_clear*(3), +*uuid_compare*(3), +*uuid_copy*(3), +*uuid_generate*(3), +*uuid_time*(3), +*uuid_is_null*(3), +*uuid_parse*(3) + +include::man-common/bugreports.adoc[] + +include::man-common/footer-lib.adoc[] + +ifdef::translation[] +include::man-common/translation.adoc[] +endif::[] -- cgit v1.2.3