summaryrefslogtreecommitdiffstats
path: root/crypto/heimdal/lib/krb5/krb5_openlog.3
diff options
context:
space:
mode:
Diffstat (limited to 'crypto/heimdal/lib/krb5/krb5_openlog.3')
-rw-r--r--crypto/heimdal/lib/krb5/krb5_openlog.346
1 files changed, 24 insertions, 22 deletions
diff --git a/crypto/heimdal/lib/krb5/krb5_openlog.3 b/crypto/heimdal/lib/krb5/krb5_openlog.3
index 5576475..8ed94fc 100644
--- a/crypto/heimdal/lib/krb5/krb5_openlog.3
+++ b/crypto/heimdal/lib/krb5/krb5_openlog.3
@@ -1,5 +1,5 @@
.\" Copyright (c) 1997 Kungliga Tekniska Högskolan
-.\" $Id: krb5_openlog.3,v 1.5 2001/01/26 22:43:22 assar Exp $
+.\" $Id: krb5_openlog.3,v 1.7 2002/08/28 15:30:55 joda Exp $
.Dd August 6, 1997
.Dt KRB5_OPENLOG 3
.Os HEIMDAL
@@ -12,14 +12,16 @@
.Nm krb5_log ,
.Nm krb5_vlog ,
.Nm krb5_log_msg ,
-.Nm krb5_vlog_msg
+.Nm krb5_vlog_msg
.Nd Heimdal logging functions
+.Sh LIBRARY
+Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
.Fd #include <krb5.h>
.Ft "typedef void"
-.Fn "\*(lp*krb5_log_log_func_t\*(rp" "const char *time" "const char *message" "void *data"
+.Fn "\*(lp*krb5_log_log_func_t\*(rp" "const char *time" "const char *message" "void *data"
.Ft "typedef void"
-.Fn "\*(lp*krb5_log_close_func_t\*(rp" "void *data"
+.Fn "\*(lp*krb5_log_close_func_t\*(rp" "void *data"
.Ft krb5_error_code
.Fn krb5_addlog_dest "krb5_context context" "krb5_log_facility *facility" "const char *destination"
.Ft krb5_error_code
@@ -43,7 +45,7 @@ These functions logs messages to one or more destinations.
.Pp
The
.Fn krb5_openlog
-function creates a logging
+function creates a logging
.Fa facility ,
that is used to log messages. A facility consists of one or more
destinations (which can be files or syslog or some other device). The
@@ -59,7 +61,7 @@ configuration file. If no entry is found for
the entry for
.Li default
is used, or if that is missing too,
-.Li SYSLOG
+.Li SYSLOG
will be used as destination.
.Pp
To close a logging facility, use the
@@ -72,7 +74,7 @@ To log a message to a facility use one of the functions
.Fn krb5_vlog ,
or
.Fn krb5_vlog_msg .
-The functions ending in
+The functions ending in
.Li _msg
return in
.Fa reply
@@ -81,45 +83,45 @@ and should be freed with
.Fn free .
The
.Fa format
-is a standard
+is a standard
.Fn printf
style format string (but see the BUGS section).
.Pp
-If you want better control of where things gets logged, you can instead of using
+If you want better control of where things gets logged, you can instead of using
.Fn krb5_openlog
-call
+call
.Fn krb5_initlog ,
which just initializes a facility, but doesn't define any actual logging
destinations. You can then add destinations with the
.Fn krb5_addlog_dest
and
-.Fn krb5_addlog_func
+.Fn krb5_addlog_func
functions. The first of these takes a string specifying a logging
destination, and adds this to the facility. If you want to do some
non-standard logging you can use the
.Fn krb5_addlog_func
function, which takes a function to use when logging.
-The
+The
.Fa log
function is called for each message with
.Fa time
being a string specifying the current time, and
.Fa message
-the message to log.
+the message to log.
.Fa close
-is called when the facility is closed. You can pass application specific data in the
-.Fa data
+is called when the facility is closed. You can pass application specific data in the
+.Fa data
parameter. The
.Fa min
-and
+and
.Fa max
parameter are the same as in a destination (defined below). To specify a
max of infinity, pass -1.
.Pp
.Fn krb5_openlog
-calls
+calls
.Fn krb5_initlog
-and then calls
+and then calls
.Fn krb5_addlog_dest
for each destination found.
.Ss Destinations
@@ -148,9 +150,9 @@ get the name for one of these, you take the name of the macro passed
to
.Xr syslog 3 ,
and remove the leading
-.Li LOG_
+.Li LOG_
.No ( Li LOG_NOTICE
-becomes
+becomes
.Li NOTICE ) .
The default values (as well as the values used for unrecognised
values), are
@@ -182,8 +184,8 @@ specified value. If no range is specified, all messages gets logged.
default = STDERR
.Ed
.Pp
-This will log all messages from the
-.Nm kdc
+This will log all messages from the
+.Nm kdc
program with level 0 to
.Pa /var/log/kdc.log ,
other messages will be logged to syslog with priority
OpenPOWER on IntegriCloud