share/man/man1/krb5-config.1

   1 '\" te
   2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH KRB5-CONFIG 1 "Aug 24, 2009"
   7 .SH NAME
   8 krb5-config \- link against the installed Kerberos libraries
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBkrb5-config\fR
  13      [\fB--all\fR | \fB--cflags\fR | \fB--exec-prefix\fR | \fB--help\fR | \fB--libs\fR \fIlibrary\fR |
  14       \fB--prefix\fR | \fB--vendor\fR | \fB--version\fR]
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 \fBkrb5-config\fR identifies and displays the special flags that are needed to
  21 compile and link programs against the installed Kerberos libraries.
  22 .SH OPTIONS
  23 .sp
  24 .LP
  25 The following options are supported:
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fB--all\fR\fR
  30 .ad
  31 .RS 18n
  32 Displays the version, vendor, prefix and \fBexec-prefix\fR.
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fB--cflags\fR\fR
  39 .ad
  40 .RS 18n
  41 Displays the compiler flags with which Kerberos was built.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fB--exec-prefix\fR\fR
  48 .ad
  49 .RS 18n
  50 Displays the \fBexec-prefix\fR with which Kerberos was built.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fB--help\fR\fR
  57 .ad
  58 .RS 18n
  59 Displays the usage message.
  60 .sp
  61 This is the default.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fB--libs\fR \fIlibrary\fR\fR
  68 .ad
  69 .RS 18n
  70 Displays compiler options required to link with \fIlibrary\fR.
  71 .sp
  72 The following \fIlibrary\fR values are supported:
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBkrb5\fR\fR
  77 .ad
  78 .RS 8n
  79 Kerberos 5 application
  80 .RE
  81
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fB--prefix\fR\fR
  88 .ad
  89 .RS 18n
  90 Displays the prefix with which Kerberos was built.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fB--vendor\fR\fR
  97 .ad
  98 .RS 18n
  99 Displays the vendor of the installed Kerberos implementation.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fB--version\fR\fR
 106 .ad
 107 .RS 18n
 108 Displays the version of the installed Kerberos implementation.
 109 .RE
 110
 111 .SH EXAMPLES
 112 .LP
 113 \fBExample 1 \fRUsing the \fB--cflags\fR Option
 114 .sp
 115 .LP
 116 The following example displays the C compiler flags needed to use
 117 \fBlibkrb5\fR(3LIB):
 118
 119 .sp
 120 .in +2
 121 .nf
 122 % krb5-config --cflags
 123 -I/usr/include/kerberosv5
 124 .fi
 125 .in -2
 126 .sp
 127
 128 .LP
 129 \fBExample 2 \fRUsing the\fB--libs\fR Option
 130 .sp
 131 .LP
 132 The following example shows the C compiler options needed to link against
 133 \fBlibkrb5\fR(3LIB):
 134
 135 .sp
 136 .in +2
 137 .nf
 138 % krb5-config --libs
 139 -L/usr/lib -R/usr/lib -lkrb5
 140 .fi
 141 .in -2
 142 .sp
 143
 144 .SH EXIT STATUS
 145 .sp
 146 .LP
 147 The following exit values are returned:
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fB0\fR\fR
 152 .ad
 153 .RS 6n
 154 Successful completion.
 155 .RE
 156
 157 .sp
 158 .ne 2
 159 .na
 160 \fB>\fB0\fR\fR
 161 .ad
 162 .RS 6n
 163 An error occurred.
 164 .RE
 165
 166 .SH ATTRIBUTES
 167 .sp
 168 .LP
 169 See \fBattributes\fR(5) for descriptions of the following attributes:
 170 .sp
 171
 172 .sp
 173 .TS
 174 box;
 175 c | c
 176 l | l .
 177 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 178 _
 179 Interface Stability     Volatile
 180 .TE
 181
 182 .SH SEE ALSO
 183 .sp
 184 .LP
 185 \fBlibgss\fR(3LIB), \fBlibkrb5\fR(3LIB), \fBattributes\fR(5)