doc/user/user_commands/krb5-config.rst

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