Patrick Welche <prlw1@cam.ac.uk>
[netbsd-mini2440.git] / crypto / dist / heimdal / tools / krb5-config.1
blobf152921a3849b9dc4f5bdf500527212748c008eb
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 .\" $Heimdal: krb5-config.1 11648 2003-02-16 21:10:32Z lha $
33 .\" $NetBSD$
34 .\"
35 .Dd November 30, 2000
36 .Dt KRB5-CONFIG 1
37 .Os
38 .Sh NAME
39 .Nm krb5-config
40 .Nd "give information on how to link code against Heimdal libraries"
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl -prefix Ns Op = Ns Ar dir
44 .Op Fl -exec-prefix Ns Op = Ns Ar dir
45 .Op Fl -libs
46 .Op Fl -cflags
47 .Op Ar libraries
48 .Sh DESCRIPTION
49 .Nm
50 tells the application programmer what special flags to use to compile
51 and link programs against the libraries installed by Heimdal.
52 .Pp
53 Options supported:
54 .Bl -tag -width Ds
55 .It Fl -prefix Ns Op = Ns Ar dir
56 Print the prefix if no
57 .Ar dir
58 is specified, otherwise set prefix to
59 .Ar dir .
60 .It Fl -exec-prefix Ns Op = Ns Ar dir
61 Print the exec-prefix if no
62 .Ar dir
63 is specified, otherwise set exec-prefix to
64 .Ar dir .
65 .It Fl -libs
66 Output the set of libraries that should be linked against.
67 .It Fl -cflags
68 Output the set of flags to give to the C compiler when using the
69 Heimdal libraries.
70 .El
71 .Pp
72 By default
73 .Nm
74 will output the set of flags and libraries to be used by a normal
75 program using the krb5 API.  The user can also supply a library to be
76 used, the supported ones are:
77 .Bl -tag -width Ds
78 .It krb5
79 (the default)
80 .It gssapi
81 use the krb5 gssapi mechanism
82 .It kadm-client
83 use the client-side kadmin libraries
84 .It kadm-server
85 use the server-side kadmin libraries
86 .El
87 .Sh SEE ALSO
88 .Xr cc 1
89 .Sh HISTORY
90 .Nm
91 appeared in Heimdal 0.3d.