Return kinit output in k5test's K5Realm.kinit
[krb5.git] / src / krb5-config.M
1 .\" krb5-config.M
2 .\"
3 .\" Copyright 1990 by the Massachusetts Institute of Technology.
4 .\"
5 .\" Export of this software from the United States of America may
6 .\"   require a specific license from the United States Government.
7 .\"   It is the responsibility of any person or organization contemplating
8 .\"   export to obtain such a license before exporting.
9 .\"
10 .\" WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
11 .\" distribute this software and its documentation for any purpose and
12 .\" without fee is hereby granted, provided that the above copyright
13 .\" notice appear in all copies and that both that copyright notice and
14 .\" this permission notice appear in supporting documentation, and that
15 .\" the name of M.I.T. not be used in advertising or publicity pertaining
16 .\" to distribution of the software without specific, written prior
17 .\" permission.  Furthermore if you modify this software you must label
18 .\" your software as modified software and not distribute it in such a
19 .\" fashion that it might be confused with the original M.I.T. software.
20 .\" M.I.T. makes no representations about the suitability of
21 .\" this software for any purpose.  It is provided "as is" without express
22 .\" or implied warranty.
23 .\" "
24 .TH KRB5-CONFIG 1
25 .SH NAME
26 krb5-config \- tool for linking against MIT Kerberos libraries
27 .SH SYNOPSIS
28 .B krb5-config
29 [ \fB--help\fP | \fB--all\fP | \fB--version\fP | \fB--vendor\fP | \fB--prefix\fP | 
30 \fB--exec-prefix\fP | \fB--cflags\fP | \fB--libs\fP libraries ]
31 .br
32 .SH DESCRIPTION
33 .I krb5-config
34 tells the application programmer what special flags to use to compile
35 and link programs against the installed Kerberos libraries.
36 .SH OPTIONS
37 .TP
38 \fB\--help\fP
39 print usage message.  This is the default.
40 .TP
41 \fB\--all\fP
42 prints version, vendor, prefix and exec-prefix.
43 .TP
44 \fB\--version\fP
45 prints the version of the installed Kerberos implementation.
46 .TP
47 \fB\--vendor\fP
48 prints the vendor of the installed Kerberos implementation.
49 .TP
50 \fB\--prefix\fP 
51 prints the prefix with which Kerberos was built.
52 .TP
53 \fB\--exec-prefix\fP 
54 prints the exec-prefix with which Kerberos was built.
55 .TP
56 \fB\--cflags\fP 
57 prints the compiler flags with which Kerberos was built.
58 .TP
59 \fB\--libs\fP \fIlibraries\fP 
60 list compiler options required to link with \fIlibraries\fP.  Possible 
61 values for \fIlibraries\fP are:
62 .sp
63 .nf
64 .in +.5i
65 krb5         Kerberos 5 application
66 gssapi       GSSAPI application with Kerberos 5 bindings
67 kadm-client  Kadmin client
68 kadm-server  Kadmin server
69 kdb          Application that accesses the kerberos database
70 .in -.5i
71 .fi
72 .SH SEE ALSO
73 kerberos(1), cc(1)