From 67a6c07f54bd63883f170ca903fae85238e756d2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Love=20H=C3=B6rnquist=20=C3=85strand?= <lha@kth.se>
Date: Tue, 17 Oct 2006 16:50:16 +0000
Subject: [PATCH] Document krb5_parse_name_flags.

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@18532 ec53bebd-3082-4978-b11e-865c3cabbd6b
---
 lib/krb5/krb5_principal.3 | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/lib/krb5/krb5_principal.3 b/lib/krb5/krb5_principal.3
index 56a47c946..802ab6f4f 100644
--- a/lib/krb5/krb5_principal.3
+++ b/lib/krb5/krb5_principal.3
@@ -45,6 +45,7 @@
 .Nm krb5_free_principal ,
 .Nm krb5_make_principal ,
 .Nm krb5_parse_name ,
+.Nm krb5_parse_name_flags ,
 .Nm krb5_princ_realm ,
 .Nm krb5_princ_set_realm ,
 .Nm krb5_principal_compare ,
@@ -73,6 +74,8 @@ Kerberos 5 Library (libkrb5, -lkrb5)
 .Ft krb5_error_code
 .Fn krb5_parse_name "krb5_context context" "const char *name" "krb5_principal *principal"
 .Ft krb5_error_code
+.Fn krb5_parse_name_flags "krb5_context context" "const char *name" "int flags" "krb5_principal *principal"
+.Ft krb5_error_code
 .Fn "krb5_unparse_name" "krb5_context context" "krb5_const_principal principal" "char **name"
 .Ft krb5_error_code
 .Fn krb5_unparse_name_fixed "krb5_context context" "krb5_const_principal principal" "char *name" "size_t len"
@@ -135,9 +138,24 @@ Examples of a principal are
 and
 .Li host/datan.kth.se@KTH.SE .
 .Fn krb5_parse_name
+and
+.Fn krb5_parse_name_flags
 passes a principal name in
 .Fa name
 to the kerberos principal structure.
+.Fn krb5_parse_name_flags
+takes an extra
+.Fa flags
+argument the following flags can be passed in
+.Bl -tag -width Ds
+.It Dv KRB5_PRINCIPAL_PARSE_NO_REALM
+requries the input string to be without a realm, and no realm is
+stored in the
+.Fa principal
+return argument.
+.It Dv KRB5_PRINCIPAL_PARSE_MUST_REALM
+requries the input string to with a realm.
+.El
 .Pp
 .Fn krb5_unparse_name
 prints the principal