Current File : //usr/man/man1/krb5-config.1

'\" te
.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
.TH krb5-config 1 "24 Aug 2009" "SunOS 5.11" "User Commands"
.SH NAME
krb5-config \- link against the installed Kerberos libraries
.SH SYNOPSIS
.LP
.nf
\fBkrb5-config\fR 
     [\fB--all\fR | \fB--cflags\fR | \fB--exec-prefix\fR | \fB--help\fR | \fB--libs\fR \fIlibrary\fR | 
      \fB--prefix\fR | \fB--vendor\fR | \fB--version\fR]
.fi

.SH DESCRIPTION
.sp
.LP
\fBkrb5-config\fR identifies and displays the special flags that are needed to compile and link programs against the installed Kerberos libraries.
.SH OPTIONS
.sp
.LP
The following options are supported:
.sp
.ne 2
.mk
.na
\fB\fB--all\fR\fR
.ad
.RS 18n
.rt  
Displays the version, vendor, prefix and \fBexec-prefix\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fB--cflags\fR\fR
.ad
.RS 18n
.rt  
Displays the compiler flags with which Kerberos was built.
.RE

.sp
.ne 2
.mk
.na
\fB\fB--exec-prefix\fR\fR
.ad
.RS 18n
.rt  
Displays the \fBexec-prefix\fR with which Kerberos was built.
.RE

.sp
.ne 2
.mk
.na
\fB\fB--help\fR\fR
.ad
.RS 18n
.rt  
Displays the usage message.
.sp
This is the default.
.RE

.sp
.ne 2
.mk
.na
\fB\fB--libs\fR \fIlibrary\fR\fR
.ad
.RS 18n
.rt  
Displays compiler options required to link with \fIlibrary\fR.
.sp
The following \fIlibrary\fR values are supported:
.sp
.ne 2
.mk
.na
\fB\fBkrb5\fR\fR
.ad
.RS 8n
.rt  
Kerberos 5 application
.RE

.RE

.sp
.ne 2
.mk
.na
\fB\fB--prefix\fR\fR
.ad
.RS 18n
.rt  
Displays the prefix with which Kerberos was built.
.RE

.sp
.ne 2
.mk
.na
\fB\fB--vendor\fR\fR
.ad
.RS 18n
.rt  
Displays the vendor of the installed Kerberos implementation.
.RE

.sp
.ne 2
.mk
.na
\fB\fB--version\fR\fR
.ad
.RS 18n
.rt  
Displays the version of the installed Kerberos implementation.
.RE

.SH EXAMPLES
.LP
\fBExample 1 \fRUsing the \fB--cflags\fR Option
.sp
.LP
The following example displays the C compiler flags needed to use \fBlibkrb5\fR(3LIB):

.sp
.in +2
.nf
% krb5-config --cflags
-I/usr/include/kerberosv5
.fi
.in -2
.sp

.LP
\fBExample 2 \fRUsing the\fB--libs\fR Option
.sp
.LP
The following example shows the C compiler options needed to link against \fBlibkrb5\fR(3LIB):

.sp
.in +2
.nf
% krb5-config --libs
-L/usr/lib -R/usr/lib -lkrb5
.fi
.in -2
.sp

.SH EXIT STATUS
.sp
.LP
The following exit values are returned:
.sp
.ne 2
.mk
.na
\fB\fB0\fR\fR
.ad
.RS 6n
.rt  
Successful completion.
.RE

.sp
.ne 2
.mk
.na
\fB>\fB0\fR\fR
.ad
.RS 6n
.rt  
An error occurred.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Availabilityservice/security/kerberos-5
_
Interface StabilityVolatile
.TE

.SH SEE ALSO
.sp
.LP
\fBlibgss\fR(3LIB), \fBlibkrb5\fR(3LIB), \fBattributes\fR(5)