From e20a3066df11b853df27cc5acecb78324fcc0e6e Mon Sep 17 00:00:00 2001
From: Johan Danielsson <joda@pdc.kth.se>
Date: Mon, 22 Apr 2002 16:05:25 +0000
Subject: [PATCH] make it clear that _lrealm modifies the principal

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@10947 ec53bebd-3082-4978-b11e-865c3cabbd6b
---
 lib/krb5/krb5_verify_user.3 | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/lib/krb5/krb5_verify_user.3 b/lib/krb5/krb5_verify_user.3
index 255b530db..b45fbebaa 100644
--- a/lib/krb5/krb5_verify_user.3
+++ b/lib/krb5/krb5_verify_user.3
@@ -43,7 +43,11 @@ The
 function does the same, except that it ignores the realm in
 .Fa principal
 and tries all the local realms (see
-.Xr krb5.conf 5 ) .
+.Xr krb5.conf 5 ) . 
+After a successful return, the principal is set to the authenticated
+realm. If the call fails, the principal will not be meaningful, and
+should only be freed with
+.Xr krb5_free_principal 3 .
 .Sh EXAMPLE
 Here is a example program that verifies a password. it uses the
 .Ql host/`hostname`
@@ -80,6 +84,7 @@ main(int argc, char **argv)
 .Ed
 .Sh SEE ALSO
 .Xr krb5_err 3 ,
+.Xr krb5_free_principal 3 ,
 .Xr krb5_init_context 3 ,
 .Xr krb5_kt_default 3 ,
 .Xr krb5.conf 5