Restructure Makefiles to accomodate multiple archs
[dragonfly.git] / crypto / heimdal-0.6.3 / 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 .\" $Id: krb5-config.1,v 1.5 2003/02/16 21:10:32 lha Exp $
33 .\"
34 .Dd November 30, 2000
35 .Dt KRB5-CONFIG 1
36 .Os HEIMDAL
37 .Sh NAME
38 .Nm krb5-config
39 .Nd "give information on how to link code against Heimdal libraries"
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl -prefix Ns Op = Ns Ar dir
43 .Op Fl -exec-prefix Ns Op = Ns Ar dir
44 .Op Fl -libs
45 .Op Fl -cflags
46 .Op Ar libraries
47 .Sh DESCRIPTION
48 .Nm
49 tells the application programmer what special flags to use to compile
50 and link programs against the libraries installed by Heimdal.
51 .Pp
52 Options supported:
53 .Bl -tag -width Ds
54 .It Fl -prefix Ns Op = Ns Ar dir
55 Print the prefix if no
56 .Ar dir
57 is specified, otherwise set prefix to
58 .Ar dir .
59 .It Fl -exec-prefix Ns Op = Ns Ar dir
60 Print the exec-prefix if no
61 .Ar dir
62 is specified, otherwise set exec-prefix to
63 .Ar dir .
64 .It Fl -libs
65 Output the set of libraries that should be linked against.
66 .It 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.