document krb5_add_et_list

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@13554 ec53bebd-3082-4978-b11e-865c3cabbd6b

lib/krb5/krb5_init_context.3

@@ -1,4 +1,4 @@
-.\" Copyright (c) 2001 - 2002 Kungliga Tekniska H<>gskolan
+.\" Copyright (c) 2001 - 2004 Kungliga Tekniska H<>gskolan
 .\" (Royal Institute of Technology, Stockholm, Sweden).
 .\" All rights reserved.
 .\"
@@ -31,13 +31,14 @@
 .\"
 .\" $Id$
 .\"
-.Dd January 21, 2001
+.Dd March 20, 2004
 .Dt KRB5_CONTEXT 3
 .Os HEIMDAL
 .Sh NAME
 .Nm krb5_init_context ,
-.Nm krb5_free_context
-.Nd create and delete krb5_context structures
+.Nm krb5_free_context ,
+.Nm krb5_add_et_list
+.Nd create, modify and delete krb5_context structures
 .Sh LIBRARY
 Kerberos 5 Library (libkrb5, -lkrb5)
 .Sh SYNOPSIS
@@ -46,6 +47,8 @@ Kerberos 5 Library (libkrb5, -lkrb5)
 .Fn krb5_init_context "krb5_context *context"
 .Ft void
 .Fn krb5_free_context "krb5_context context"
+.Ft krb5_error_code
+.Fn krb5_add_et_list "krb5_context context" "void (*func)(struct et_list **)"
 .Sh DESCRIPTION
 The
 .Fn krb5_init_context
@@ -57,7 +60,7 @@ structure and reads the configuration file
 The structure should be freed by calling
 .Fn krb5_free_context
 when it is no longer being used.
-.Sh RETURN VALUES
+.Pp
 .Fn krb5_init_context
 returns 0 to indicate success.
 Otherwise an errno code is returned.
@@ -66,7 +69,19 @@ Failure means either that something bad happened during initialization
 .Bq ENOMEM )
 or that Kerberos should not be used
 .Bq ENXIO .
+.Pp
+.Fn krb5_add_et_list 
+adds a
+.Xr com_err 3
+error-code handler
+.Fa func
+to the specified
+.Fa context .
+The error handler must generated by the the re-rentrant version of the
+.Xr compile_et 3
+program.
 .Sh SEE ALSO
 .Xr errno 2 ,
+.Xr krb5 3 ,
 .Xr krb5_context 3 ,
 .Xr kerberos 8