lib/uuid/uuid_unparse.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_UNPARSE 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
  33 .SH NAME
  34 uuid_unparse \- convert an UUID from binary representation to a string
  35 .SH SYNOPSIS
  36 .nf
  37 .B #include <uuid/uuid.h>
  38 .sp
  39 .BI "void uuid_unparse(uuid_t " uu ", char *" out );
  40 .BI "void uuid_unparse_upper(uuid_t " uu ", char *" out );
  41 .BI "void uuid_unparse_lower(uuid_t " uu ", char *" out );
  42 .fi
  43 .SH DESCRIPTION
  44 The
  45 .B uuid_unparse
  46 function converts the supplied UUID
  47 .I uu
  48 from the binary representation into a 36\-byte string (plus tailing '\\0')
  49 of the form 1b4e28ba\-2fa1\-11d2\-883f\-b9a76 and stores this value in the
  50 character string pointed to by
  51 .IR out .
  52 The case of the hex digits returned by
  53 .B uuid_unparse
  54 may be upper or lower case, and is
  55 dependent on the system-dependent local default.
  56 .PP
  57 If the case of the
  58 hex digits is important then the functions
  59 .B uuid_unparse_upper
  60 and
  61 .B uuid_unparse_lower
  62 may be used.
  63 .SH AUTHOR
  64 .B uuid_unparse
  65 was written by Theodore Y. Ts'o for the ext2 filesystem utilties.
  66 .SH AVAILABILITY
  67 .B uuid_unparse
  68 is part of libuuid from the e2fsprogs package and is available from
  69 http://e2fsprogs.sourceforge.net.
  70 .SH "SEE ALSO"
  71 .BR libuuid (3),
  72 .BR uuid_clear (3),
  73 .BR uuid_generate (3),
  74 .BR uuid_parse (3),
  75 .BR uuid_time (3)