xref: /freebsd/crypto/krb5/doc/user/user_commands/krb5-config.rst (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1*7f2fe78bSCy Schubert.. _krb5-config(1):
2*7f2fe78bSCy Schubert
3*7f2fe78bSCy Schubertkrb5-config
4*7f2fe78bSCy Schubert===========
5*7f2fe78bSCy Schubert
6*7f2fe78bSCy SchubertSYNOPSIS
7*7f2fe78bSCy Schubert--------
8*7f2fe78bSCy Schubert
9*7f2fe78bSCy Schubert**krb5-config**
10*7f2fe78bSCy Schubert[**-**\ **-help** | **-**\ **-all** | **-**\ **-version** | **-**\ **-vendor** | **-**\ **-prefix** | **-**\ **-exec-prefix** | **-**\ **-defccname** | **-**\ **-defktname** | **-**\ **-defcktname** | **-**\ **-cflags** | **-**\ **-libs** [*libraries*]]
11*7f2fe78bSCy Schubert
12*7f2fe78bSCy Schubert
13*7f2fe78bSCy SchubertDESCRIPTION
14*7f2fe78bSCy Schubert-----------
15*7f2fe78bSCy Schubert
16*7f2fe78bSCy Schubertkrb5-config tells the application programmer what flags to use to compile
17*7f2fe78bSCy Schubertand link programs against the installed Kerberos libraries.
18*7f2fe78bSCy Schubert
19*7f2fe78bSCy Schubert
20*7f2fe78bSCy SchubertOPTIONS
21*7f2fe78bSCy Schubert-------
22*7f2fe78bSCy Schubert
23*7f2fe78bSCy Schubert**-**\ **-help**
24*7f2fe78bSCy Schubert    prints a usage message.  This is the default behavior when no options
25*7f2fe78bSCy Schubert    are specified.
26*7f2fe78bSCy Schubert
27*7f2fe78bSCy Schubert**-**\ **-all**
28*7f2fe78bSCy Schubert    prints the version, vendor, prefix, and exec-prefix.
29*7f2fe78bSCy Schubert
30*7f2fe78bSCy Schubert**-**\ **-version**
31*7f2fe78bSCy Schubert    prints the version number of the Kerberos installation.
32*7f2fe78bSCy Schubert
33*7f2fe78bSCy Schubert**-**\ **-vendor**
34*7f2fe78bSCy Schubert    prints the name of the vendor of the Kerberos installation.
35*7f2fe78bSCy Schubert
36*7f2fe78bSCy Schubert**-**\ **-prefix**
37*7f2fe78bSCy Schubert    prints the prefix for which the Kerberos installation was built.
38*7f2fe78bSCy Schubert
39*7f2fe78bSCy Schubert**-**\ **-exec-prefix**
40*7f2fe78bSCy Schubert    prints the prefix for executables for which the Kerberos installation
41*7f2fe78bSCy Schubert    was built.
42*7f2fe78bSCy Schubert
43*7f2fe78bSCy Schubert**-**\ **-defccname**
44*7f2fe78bSCy Schubert    prints the built-in default credentials cache location.
45*7f2fe78bSCy Schubert
46*7f2fe78bSCy Schubert**-**\ **-defktname**
47*7f2fe78bSCy Schubert    prints the built-in default keytab location.
48*7f2fe78bSCy Schubert
49*7f2fe78bSCy Schubert**-**\ **-defcktname**
50*7f2fe78bSCy Schubert    prints the built-in default client (initiator) keytab location.
51*7f2fe78bSCy Schubert
52*7f2fe78bSCy Schubert**-**\ **-cflags**
53*7f2fe78bSCy Schubert    prints the compilation flags used to build the Kerberos installation.
54*7f2fe78bSCy Schubert
55*7f2fe78bSCy Schubert**-**\ **-libs** [*library*]
56*7f2fe78bSCy Schubert    prints the compiler options needed to link against *library*.
57*7f2fe78bSCy Schubert    Allowed values for *library* are:
58*7f2fe78bSCy Schubert
59*7f2fe78bSCy Schubert    ============  ===============================================
60*7f2fe78bSCy Schubert    krb5          Kerberos 5 applications (default)
61*7f2fe78bSCy Schubert    gssapi        GSSAPI applications with Kerberos 5 bindings
62*7f2fe78bSCy Schubert    kadm-client   Kadmin client
63*7f2fe78bSCy Schubert    kadm-server   Kadmin server
64*7f2fe78bSCy Schubert    kdb           Applications that access the Kerberos database
65*7f2fe78bSCy Schubert    ============  ===============================================
66*7f2fe78bSCy Schubert
67*7f2fe78bSCy SchubertEXAMPLES
68*7f2fe78bSCy Schubert--------
69*7f2fe78bSCy Schubert
70*7f2fe78bSCy Schubertkrb5-config is particularly useful for compiling against a Kerberos
71*7f2fe78bSCy Schubertinstallation that was installed in a non-standard location.  For example,
72*7f2fe78bSCy Schuberta Kerberos installation that is installed in ``/opt/krb5/`` but uses
73*7f2fe78bSCy Schubertlibraries in ``/usr/local/lib/`` for text localization would produce
74*7f2fe78bSCy Schubertthe following output::
75*7f2fe78bSCy Schubert
76*7f2fe78bSCy Schubert    shell% krb5-config --libs krb5
77*7f2fe78bSCy Schubert    -L/opt/krb5/lib -Wl,-rpath -Wl,/opt/krb5/lib -L/usr/local/lib -lkrb5 -lk5crypto -lcom_err
78*7f2fe78bSCy Schubert
79*7f2fe78bSCy Schubert
80*7f2fe78bSCy SchubertSEE ALSO
81*7f2fe78bSCy Schubert--------
82*7f2fe78bSCy Schubert
83*7f2fe78bSCy Schubert:ref:`kerberos(7)`, cc(1)
84