crypto/dist/heimdal/lib/krb5/krb5_unparse_name.3

   1 .\" Copyright (c) 1997 Kungliga Tekniska Högskolan
   2 .\" (Royal Institute of Technology, Stockholm, Sweden).
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" 3. Neither the name of the Institute nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $Heimdal: krb5_unparse_name.3 12329 2003-05-26 14:09:04Z lha $
  33 .\" $NetBSD$
  34 .\"
  35 .Dd August 8, 1997
  36 .Dt KRB5_UNPARSE_NAME 3
  37 .Os
  38 .Sh NAME
  39 .Nm krb5_unparse_name
  40 .\" .Nm krb5_unparse_name_ext
  41 .Nd principal to string conversion
  42 .Sh LIBRARY
  43 Kerberos 5 Library (libkrb5, -lkrb5)
  44 .Sh SYNOPSIS
  45 .In krb5/krb5.h
  46 .Ft krb5_error_code
  47 .Fn krb5_unparse_name "krb5_context context" "krb5_principal principal" "char **name"
  48 .\" .Ft krb5_error_code
  49 .\" .Fn krb5_unparse_name_ext "krb5_context context" "krb5_const_principal principal" "char **name" "size_t *size"
  50 .Sh DESCRIPTION
  51 This function takes a
  52 .Fa principal ,
  53 and will convert in to a printable representation with the same syntax
  54 as described in
  55 .Xr krb5_parse_name 3 .
  56 .Fa *name
  57 will point to allocated data and should be freed by the caller.
  58 .Sh SEE ALSO
  59 .Xr krb5_425_conv_principal 3 ,
  60 .Xr krb5_build_principal 3 ,
  61 .Xr krb5_free_principal 3 ,
  62 .Xr krb5_parse_name 3 ,
  63 .Xr krb5_sname_to_principal 3