summaryrefslogtreecommitdiffstats
path: root/libuuid/man/uuid_parse.3.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'libuuid/man/uuid_parse.3.adoc')
-rw-r--r--libuuid/man/uuid_parse.3.adoc87
1 files changed, 87 insertions, 0 deletions
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 <uuid.h>*
+
+*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::[]