third_party/heimdal/tools/krb5-config.1

   1 .\" Copyright (c) 2000 - 2001 Kungliga Tekniska Högskolan
   2 .\" (Royal Institute of Technology, Stockholm, Sweden).
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" 3. Neither the name of the Institute nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .Dd November 30, 2000
  33 .Dt KRB5-CONFIG 1
  34 .Os HEIMDAL
  35 .Sh NAME
  36 .Nm krb5-config
  37 .Nd "give information on how to link code against Heimdal libraries"
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl Fl prefix Ns Op = Ns Ar dir
  41 .Op Fl Fl exec-prefix Ns Op = Ns Ar dir
  42 .Op Fl Fl libs
  43 .Op Fl Fl cflags
  44 .Op Ar libraries
  45 .Sh DESCRIPTION
  46 .Nm
  47 tells the application programmer what special flags to use to compile
  48 and link programs against the libraries installed by Heimdal.
  49 .Pp
  50 Options supported:
  51 .Bl -tag -width Ds
  52 .It Fl Fl prefix Ns Op = Ns Ar dir
  53 Print the prefix if no
  54 .Ar dir
  55 is specified, otherwise set prefix to
  56 .Ar dir .
  57 .It Fl Fl exec-prefix Ns Op = Ns Ar dir
  58 Print the exec-prefix if no
  59 .Ar dir
  60 is specified, otherwise set exec-prefix to
  61 .Ar dir .
  62 .It Fl Fl libs
  63 Output the set of libraries that should be linked against.  This also
  64 includes rpath flags with the expectation that the C compiler is used
  65 for final link-edits.
  66 .It Fl Fl cflags
  67 Output the set of flags to give to the C compiler when using the
  68 Heimdal libraries.
  69 .El
  70 .Pp
  71 By default
  72 .Nm
  73 will output the set of flags and libraries to be used by a normal
  74 program using the krb5 API.  The user can also supply a library to be
  75 used, the supported ones are:
  76 .Bl -tag -width Ds
  77 .It krb5
  78 (the default)
  79 .It gssapi
  80 use the krb5 gssapi mechanism
  81 .It kadm-client
  82 use the client-side kadmin libraries
  83 .It kadm-server
  84 use the server-side kadmin libraries
  85 .El
  86 .Sh SEE ALSO
  87 .Xr cc 1
  88 .Sh HISTORY
  89 .Nm
  90 appeared in Heimdal 0.3d.