Initial import from FreeBSD RELENG_4:
[games.git] / crypto / heimdal / lib / krb5 / krb5_warn.3
1 .\" Copyright (c) 1997 Kungliga Tekniska Högskolan
2 .\" $Id: krb5_warn.3,v 1.5 2002/08/28 15:30:59 joda Exp $
3 .Dd August 8, 1997
4 .Dt KRB5_WARN 3
5 .Os HEIMDAL
6 .Sh NAME
7 .Nm krb5_warn ,
8 .Nm krb5_warnx ,
9 .Nm krb5_vwarn ,
10 .Nm krb5_vwarnx ,
11 .Nm krb5_err ,
12 .Nm krb5_errx ,
13 .Nm krb5_verr ,
14 .Nm krb5_verrx ,
15 .Nm krb5_set_warn_dest
16 .Nd Heimdal warning and error functions
17 .Sh LIBRARY
18 Kerberos 5 Library (libkrb5, -lkrb5)
19 .Sh SYNOPSIS
20 .Fd #include <krb5.h>
21 .Ft krb5_error_code
22 .Fn krb5_err "krb5_context context" "int eval" "krb5_error_code code" "const char *format" "..."
23 .Ft krb5_error_code
24 .Fn krb5_errx "krb5_context context" "int eval" "const char *format" "..."
25 .Ft krb5_error_code
26 .Fn krb5_verr "krb5_context context" "int eval" "krb5_error_code code" "const char *format" "va_list ap"
27 .Ft krb5_error_code
28 .Fn krb5_verrx "krb5_context context" "int eval" "const char *format" "va_list ap"
29 .Ft krb5_error_code
30 .Fn krb5_vwarn "krb5_context context" "krb5_error_code code" "const char *format" "va_list ap"
31 .Ft krb5_error_code
32 .Fn krb5_vwarnx "krb5_context context" "const char *format" "va_list ap"
33 .Ft krb5_error_code
34 .Fn krb5_warn "krb5_context context" "krb5_error_code code" "const char *format" "..."
35 .Ft krb5_error_code
36 .Fn krb5_warnx "krb5_context context" "const char *format" "..."
37 .Ft krb5_error_code
38 .Fn krb5_set_warn_dest "krb5_context context" "krb5_log_facility *facility"
39 .Sh DESCRIPTION
40 These functions prints a warning message to some destination.
41 .Fa format
42 is a printf style format specifying the message to print. The forms not ending in an
43 .Dq x
44 prints the error string associated with
45 .Fa code
46 along with the message.
47 The
48 .Dq err
49 functions exits with exit status
50 .Fa eval
51 after printing the message.
52 .Pp
53 The
54 .Fn krb5_set_warn_func
55 function sets the destination for warning messages to the specified
56 .Fa facility .
57 Messages logged with the
58 .Dq warn
59 functions have a log level of 1, while the
60 .Dq err
61 functions logs with level 0.
62 .Sh SEE ALSO
63 .Xr krb5_openlog 3