1.\" Copyright (c) 1997 Kungliga Tekniska H�gskolan
2.\" $Id: krb5_parse_name.3,v 1.6 2002/09/02 12:42:00 joda Exp $
3.Dd August 8, 1997
4.Dt KRB5_PARSE_NAME 3
5.Os HEIMDAL
6.Sh NAME
7.Nm krb5_parse_name
8.Nd string to principal conversion
9.Sh LIBRARY
10Kerberos 5 Library (libkrb5, -lkrb5)
11.Sh SYNOPSIS
12.Fd #include <krb5.h>
13.Ft krb5_error_code
14.Fn krb5_parse_name "krb5_context context" "const char *name" "krb5_principal *principal"
15.Sh DESCRIPTION
16.Fn krb5_parse_name
17converts a string representation of a principal name to
18.Nm krb5_principal .
19The
20.Fa principal
21will point to allocated data that should be freed with
22.Fn krb5_free_principal .
23.Pp
24The string should consist of one or more name components separated with slashes
25.Pq Dq / ,
26optionally followed with an
27.Dq @
28and a realm name. A slash or @ may be contained in a name component by
29quoting it with a back-slash
30.Pq Dq \ .
31A realm should not contain slashes or colons.
32.Sh SEE ALSO
33.Xr krb5_425_conv_principal 3 ,
34.Xr krb5_build_principal 3 ,
35.Xr krb5_free_principal 3 ,
36.Xr krb5_sname_to_principal 3 ,
37.Xr krb5_unparse_name 3