summaryrefslogtreecommitdiffstats
path: root/libuuid/man/uuid_parse.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 14:30:35 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 14:30:35 +0000
commit378c18e5f024ac5a8aef4cb40d7c9aa9633d144c (patch)
tree44dfb6ca500d32cabd450649b322a42e70a30683 /libuuid/man/uuid_parse.3
parentInitial commit. (diff)
downloadutil-linux-378c18e5f024ac5a8aef4cb40d7c9aa9633d144c.tar.xz
util-linux-378c18e5f024ac5a8aef4cb40d7c9aa9633d144c.zip
Adding upstream version 2.38.1.upstream/2.38.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'libuuid/man/uuid_parse.3')
-rw-r--r--libuuid/man/uuid_parse.371
1 files changed, 71 insertions, 0 deletions
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 <uuid.h>\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