0caadd8b18
git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@12329 ec53bebd-3082-4978-b11e-865c3cabbd6b
100 lines
3.6 KiB
Groff
100 lines
3.6 KiB
Groff
.\" Copyright (c) 1997, 2001 - 2003 Kungliga Tekniska Högskolan
|
|
.\" (Royal Institute of Technology, Stockholm, Sweden).
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\"
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\"
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" 3. Neither the name of the Institute nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $Id$
|
|
.\"
|
|
.Dd August 8, 1997
|
|
.Dt KRB5_WARN 3
|
|
.Os HEIMDAL
|
|
.Sh NAME
|
|
.Nm krb5_warn ,
|
|
.Nm krb5_warnx ,
|
|
.Nm krb5_vwarn ,
|
|
.Nm krb5_vwarnx ,
|
|
.Nm krb5_err ,
|
|
.Nm krb5_errx ,
|
|
.Nm krb5_verr ,
|
|
.Nm krb5_verrx ,
|
|
.Nm krb5_set_warn_dest
|
|
.Nd Heimdal warning and error functions
|
|
.Sh LIBRARY
|
|
Kerberos 5 Library (libkrb5, -lkrb5)
|
|
.Sh SYNOPSIS
|
|
.In krb5.h
|
|
.Ft krb5_error_code
|
|
.Fn krb5_err "krb5_context context" "int eval" "krb5_error_code code" "const char *format" "..."
|
|
.Ft krb5_error_code
|
|
.Fn krb5_errx "krb5_context context" "int eval" "const char *format" "..."
|
|
.Ft krb5_error_code
|
|
.Fn krb5_verr "krb5_context context" "int eval" "krb5_error_code code" "const char *format" "va_list ap"
|
|
.Ft krb5_error_code
|
|
.Fn krb5_verrx "krb5_context context" "int eval" "const char *format" "va_list ap"
|
|
.Ft krb5_error_code
|
|
.Fn krb5_vwarn "krb5_context context" "krb5_error_code code" "const char *format" "va_list ap"
|
|
.Ft krb5_error_code
|
|
.Fn krb5_vwarnx "krb5_context context" "const char *format" "va_list ap"
|
|
.Ft krb5_error_code
|
|
.Fn krb5_warn "krb5_context context" "krb5_error_code code" "const char *format" "..."
|
|
.Ft krb5_error_code
|
|
.Fn krb5_warnx "krb5_context context" "const char *format" "..."
|
|
.Ft krb5_error_code
|
|
.Fn krb5_set_warn_dest "krb5_context context" "krb5_log_facility *facility"
|
|
.Ft "char *"
|
|
.Fn krb5_get_err_text "krb5_context context" "krb5_error_code code"
|
|
.Sh DESCRIPTION
|
|
These functions prints a warning message to some destination.
|
|
.Fa format
|
|
is a printf style format specifying the message to print. The forms not ending in an
|
|
.Dq x
|
|
prints the error string associated with
|
|
.Fa code
|
|
along with the message.
|
|
The
|
|
.Dq err
|
|
functions exits with exit status
|
|
.Fa eval
|
|
after printing the message.
|
|
.Pp
|
|
The
|
|
.Fn krb5_set_warn_func
|
|
function sets the destination for warning messages to the specified
|
|
.Fa facility .
|
|
Messages logged with the
|
|
.Dq warn
|
|
functions have a log level of 1, while the
|
|
.Dq err
|
|
functions logs with level 0.
|
|
.Pp
|
|
.Fn krb5_get_err_text
|
|
fetches the human readable strings describing the error-code.
|
|
.Sh SEE ALSO
|
|
.Xr krb5_openlog 3
|