xref: /freebsd/crypto/krb5/doc/html/user/user_commands/krb5-config.html (revision b670c9bafc0e31c7609969bf374b2e80bdc00211)
1
2<!DOCTYPE html>
3
4<html>
5  <head>
6    <meta charset="utf-8" />
7    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
8
9    <title>krb5-config &#8212; MIT Kerberos Documentation</title>
10    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
11    <link rel="stylesheet" type="text/css" href="../../_static/agogo.css" />
12    <link rel="stylesheet" type="text/css" href="../../_static/kerb.css" />
13    <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
14    <script src="../../_static/jquery.js"></script>
15    <script src="../../_static/underscore.js"></script>
16    <script src="../../_static/doctools.js"></script>
17    <link rel="author" title="About these documents" href="../../about.html" />
18    <link rel="index" title="Index" href="../../genindex.html" />
19    <link rel="search" title="Search" href="../../search.html" />
20    <link rel="copyright" title="Copyright" href="../../copyright.html" />
21    <link rel="next" title="ksu" href="ksu.html" />
22    <link rel="prev" title="kpasswd" href="kpasswd.html" />
23  </head><body>
24    <div class="header-wrapper">
25        <div class="header">
26
27
28            <h1><a href="../../index.html">MIT Kerberos Documentation</a></h1>
29
30            <div class="rel">
31
32        <a href="../../index.html" title="Full Table of Contents"
33            accesskey="C">Contents</a> |
34        <a href="kpasswd.html" title="kpasswd"
35            accesskey="P">previous</a> |
36        <a href="ksu.html" title="ksu"
37            accesskey="N">next</a> |
38        <a href="../../genindex.html" title="General Index"
39            accesskey="I">index</a> |
40        <a href="../../search.html" title="Enter search criteria"
41            accesskey="S">Search</a> |
42    <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5-config">feedback</a>
43            </div>
44        </div>
45    </div>
46
47    <div class="content-wrapper">
48      <div class="content">
49        <div class="document">
50
51      <div class="documentwrapper">
52        <div class="bodywrapper">
53          <div class="body" role="main">
54
55  <section id="krb5-config">
56<span id="krb5-config-1"></span><h1>krb5-config<a class="headerlink" href="#krb5-config" title="Permalink to this headline">¶</a></h1>
57<section id="synopsis">
58<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
59<p><strong>krb5-config</strong>
60[<strong>-</strong><strong>-help</strong> | <strong>-</strong><strong>-all</strong> | <strong>-</strong><strong>-version</strong> | <strong>-</strong><strong>-vendor</strong> | <strong>-</strong><strong>-prefix</strong> | <strong>-</strong><strong>-exec-prefix</strong> | <strong>-</strong><strong>-defccname</strong> | <strong>-</strong><strong>-defktname</strong> | <strong>-</strong><strong>-defcktname</strong> | <strong>-</strong><strong>-cflags</strong> | <strong>-</strong><strong>-libs</strong> [<em>libraries</em>]]</p>
61</section>
62<section id="description">
63<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
64<p>krb5-config tells the application programmer what flags to use to compile
65and link programs against the installed Kerberos libraries.</p>
66</section>
67<section id="options">
68<h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
69<dl>
70<dt><strong>-</strong><strong>-help</strong></dt><dd><p>prints a usage message.  This is the default behavior when no options
71are specified.</p>
72</dd>
73<dt><strong>-</strong><strong>-all</strong></dt><dd><p>prints the version, vendor, prefix, and exec-prefix.</p>
74</dd>
75<dt><strong>-</strong><strong>-version</strong></dt><dd><p>prints the version number of the Kerberos installation.</p>
76</dd>
77<dt><strong>-</strong><strong>-vendor</strong></dt><dd><p>prints the name of the vendor of the Kerberos installation.</p>
78</dd>
79<dt><strong>-</strong><strong>-prefix</strong></dt><dd><p>prints the prefix for which the Kerberos installation was built.</p>
80</dd>
81<dt><strong>-</strong><strong>-exec-prefix</strong></dt><dd><p>prints the prefix for executables for which the Kerberos installation
82was built.</p>
83</dd>
84<dt><strong>-</strong><strong>-defccname</strong></dt><dd><p>prints the built-in default credentials cache location.</p>
85</dd>
86<dt><strong>-</strong><strong>-defktname</strong></dt><dd><p>prints the built-in default keytab location.</p>
87</dd>
88<dt><strong>-</strong><strong>-defcktname</strong></dt><dd><p>prints the built-in default client (initiator) keytab location.</p>
89</dd>
90<dt><strong>-</strong><strong>-cflags</strong></dt><dd><p>prints the compilation flags used to build the Kerberos installation.</p>
91</dd>
92<dt><strong>-</strong><strong>-libs</strong> [<em>library</em>]</dt><dd><p>prints the compiler options needed to link against <em>library</em>.
93Allowed values for <em>library</em> are:</p>
94<table class="docutils align-default">
95<colgroup>
96<col style="width: 20%" />
97<col style="width: 80%" />
98</colgroup>
99<tbody>
100<tr class="row-odd"><td><p>krb5</p></td>
101<td><p>Kerberos 5 applications (default)</p></td>
102</tr>
103<tr class="row-even"><td><p>gssapi</p></td>
104<td><p>GSSAPI applications with Kerberos 5 bindings</p></td>
105</tr>
106<tr class="row-odd"><td><p>kadm-client</p></td>
107<td><p>Kadmin client</p></td>
108</tr>
109<tr class="row-even"><td><p>kadm-server</p></td>
110<td><p>Kadmin server</p></td>
111</tr>
112<tr class="row-odd"><td><p>kdb</p></td>
113<td><p>Applications that access the Kerberos database</p></td>
114</tr>
115</tbody>
116</table>
117</dd>
118</dl>
119</section>
120<section id="examples">
121<h2>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
122<p>krb5-config is particularly useful for compiling against a Kerberos
123installation that was installed in a non-standard location.  For example,
124a Kerberos installation that is installed in <code class="docutils literal notranslate"><span class="pre">/opt/krb5/</span></code> but uses
125libraries in <code class="docutils literal notranslate"><span class="pre">/usr/local/lib/</span></code> for text localization would produce
126the following output:</p>
127<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">shell</span><span class="o">%</span> <span class="n">krb5</span><span class="o">-</span><span class="n">config</span> <span class="o">--</span><span class="n">libs</span> <span class="n">krb5</span>
128<span class="o">-</span><span class="n">L</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">krb5</span><span class="o">/</span><span class="n">lib</span> <span class="o">-</span><span class="n">Wl</span><span class="p">,</span><span class="o">-</span><span class="n">rpath</span> <span class="o">-</span><span class="n">Wl</span><span class="p">,</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">krb5</span><span class="o">/</span><span class="n">lib</span> <span class="o">-</span><span class="n">L</span><span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span> <span class="o">-</span><span class="n">lkrb5</span> <span class="o">-</span><span class="n">lk5crypto</span> <span class="o">-</span><span class="n">lcom_err</span>
129</pre></div>
130</div>
131</section>
132<section id="see-also">
133<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
134<p><a class="reference internal" href="../user_config/kerberos.html#kerberos-7"><span class="std std-ref">kerberos</span></a>, cc(1)</p>
135</section>
136</section>
137
138
139            <div class="clearer"></div>
140          </div>
141        </div>
142      </div>
143        </div>
144        <div class="sidebar">
145
146    <h2>On this page</h2>
147    <ul>
148<li><a class="reference internal" href="#">krb5-config</a><ul>
149<li><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
150<li><a class="reference internal" href="#description">DESCRIPTION</a></li>
151<li><a class="reference internal" href="#options">OPTIONS</a></li>
152<li><a class="reference internal" href="#examples">EXAMPLES</a></li>
153<li><a class="reference internal" href="#see-also">SEE ALSO</a></li>
154</ul>
155</li>
156</ul>
157
158    <br/>
159    <h2>Table of contents</h2>
160    <ul class="current">
161<li class="toctree-l1 current"><a class="reference internal" href="../index.html">For users</a><ul class="current">
162<li class="toctree-l2"><a class="reference internal" href="../pwd_mgmt.html">Password management</a></li>
163<li class="toctree-l2"><a class="reference internal" href="../tkt_mgmt.html">Ticket management</a></li>
164<li class="toctree-l2"><a class="reference internal" href="../user_config/index.html">User config files</a></li>
165<li class="toctree-l2 current"><a class="reference internal" href="index.html">User commands</a><ul class="current">
166<li class="toctree-l3"><a class="reference internal" href="kdestroy.html">kdestroy</a></li>
167<li class="toctree-l3"><a class="reference internal" href="kinit.html">kinit</a></li>
168<li class="toctree-l3"><a class="reference internal" href="klist.html">klist</a></li>
169<li class="toctree-l3"><a class="reference internal" href="kpasswd.html">kpasswd</a></li>
170<li class="toctree-l3 current"><a class="current reference internal" href="#">krb5-config</a></li>
171<li class="toctree-l3"><a class="reference internal" href="ksu.html">ksu</a></li>
172<li class="toctree-l3"><a class="reference internal" href="kswitch.html">kswitch</a></li>
173<li class="toctree-l3"><a class="reference internal" href="kvno.html">kvno</a></li>
174<li class="toctree-l3"><a class="reference internal" href="sclient.html">sclient</a></li>
175</ul>
176</li>
177</ul>
178</li>
179<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">For administrators</a></li>
180<li class="toctree-l1"><a class="reference internal" href="../../appdev/index.html">For application developers</a></li>
181<li class="toctree-l1"><a class="reference internal" href="../../plugindev/index.html">For plugin module developers</a></li>
182<li class="toctree-l1"><a class="reference internal" href="../../build/index.html">Building Kerberos V5</a></li>
183<li class="toctree-l1"><a class="reference internal" href="../../basic/index.html">Kerberos V5 concepts</a></li>
184<li class="toctree-l1"><a class="reference internal" href="../../formats/index.html">Protocols and file formats</a></li>
185<li class="toctree-l1"><a class="reference internal" href="../../mitK5features.html">MIT Kerberos features</a></li>
186<li class="toctree-l1"><a class="reference internal" href="../../build_this.html">How to build this documentation from the source</a></li>
187<li class="toctree-l1"><a class="reference internal" href="../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
188<li class="toctree-l1"><a class="reference internal" href="../../resources.html">Resources</a></li>
189</ul>
190
191    <br/>
192    <h4><a href="../../index.html">Full Table of Contents</a></h4>
193    <h4>Search</h4>
194    <form class="search" action="../../search.html" method="get">
195      <input type="text" name="q" size="18" />
196      <input type="submit" value="Go" />
197      <input type="hidden" name="check_keywords" value="yes" />
198      <input type="hidden" name="area" value="default" />
199    </form>
200
201        </div>
202        <div class="clearer"></div>
203      </div>
204    </div>
205
206    <div class="footer-wrapper">
207        <div class="footer" >
208            <div class="right" ><i>Release: 1.21.3</i><br />
209                &copy; <a href="../../copyright.html">Copyright</a> 1985-2024, MIT.
210            </div>
211            <div class="left">
212
213        <a href="../../index.html" title="Full Table of Contents"
214            >Contents</a> |
215        <a href="kpasswd.html" title="kpasswd"
216            >previous</a> |
217        <a href="ksu.html" title="ksu"
218            >next</a> |
219        <a href="../../genindex.html" title="General Index"
220            >index</a> |
221        <a href="../../search.html" title="Enter search criteria"
222            >Search</a> |
223    <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5-config">feedback</a>
224            </div>
225        </div>
226    </div>
227
228  </body>
229</html>