Permalink
Browse files

Add a krb5-config man page

Missed when converting the old nroff man pages.
  • Loading branch information...
kaduk committed Apr 3, 2013
1 parent 424bed7 commit 5a6d14918a3b5d003f248b66e88028f1b5e450b7
Showing with 89 additions and 2 deletions.
  1. +1 −0 doc/conf.py
  2. +1 −0 doc/user/user_commands/index.rst
  3. +85 −0 doc/user/user_commands/krb5-config.rst
  4. +2 −2 src/man/Makefile.in
View
@@ -286,6 +286,7 @@
('user/user_commands/kpasswd', 'kpasswd', u'change a user\'s Kerberos password', [u'MIT'], 1),
('user/user_commands/kvno', 'kvno', u'print key version numbers of Kerberos principals', [u'MIT'], 1),
('user/user_commands/ksu', 'ksu', u'Kerberized super-user', [u'MIT'], 1),
+ ('user/user_commands/krb5-config', 'krb5-config', u'tool for linking against MIT Kerberos libraries', [u'MIT'], 1),
('user/user_config/k5login', 'k5login', u'Kerberos V5 acl file for host access', [u'MIT'], 5),
('user/user_config/k5identity', 'k5identity', u'Kerberos V5 client principal selection rules', [u'MIT'], 5),
('admin/admin_commands/krb5kdc', 'krb5kdc', u'Kerberos V5 KDC', [u'MIT'], 8),
@@ -10,6 +10,7 @@ User commands
kinit.rst
klist.rst
kpasswd.rst
+ krb5-config.rst
ksu.rst
kswitch.rst
kvno.rst
@@ -0,0 +1,85 @@
+.. _krb5-config(1):
+
+krb5-config
+===========
+
+SYNOPSIS
+--------
+
+**krb5-config**
+[**-**\ **-help** | **-**\ **-all** | **-**\ **-version** | **-**\ **-vendor** | **-**\ **-prefix** | **-**\ **-exec-prefix** | **-**\ **-defccname** | **-**\ **-defktname** | **-**\ **-defcktname** | **-**\ **-cflags** | **-**\ **-libs** [*libraries*]]
+
+
+DESCRIPTION
+-----------
+
+krb5-config tells the application programmer what flags to use to compile
+and link programs against the installed Kerberos libraries.
+
+
+OPTIONS
+-------
+
+**-**\ **-help**
+ prints a usage message. This is the default behavior when no options
+ are specified.
+
+**-**\ **-all**
+ prints the version, vendor, prefix, and exec-prefix.
+
+**-**\ **-version**
+ prints the version number of the Kerberos installation.
+
+**-**\ **-vendor**
+ prints the name of the vendor of the Kerberos installation.
+
+**-**\ **-prefix**
+ prints the prefix for which the Kerberos installation was built.
+
+**-**\ **-exec-prefix**
+ prints the prefix for executables for which the Kerberos installation
+ was built.
+
+**-**\ **-defccname**
+ prints the built-in default credentials cache location.
+
+**-**\ **-defktname**
+ prints the built-in default keytab location.
+
+**-**\ **-defcktname**
+ prints the built-in default client (initiator) keytab location.
+
+**-**\ **-cflags**
+ prints the compilation flags used to build the Kerberos installation.
+
+**-**\ **-libs** [*library*]
+ prints the compiler options needed to link against *library*.
+ Allowed values for *library* are:
+
+ ============ ===============================================
+ krb5 Kerberos 5 applications (default)
+ gssapi GSSAPI applications with Kerberos 5 bindings
+ kadm-client Kadmin client
+ kadm-server Kadmin server
+ kdb Applications that access the Kerberos database
+ ============ ===============================================
+
+EXAMPLES
+--------
+
+krb5-config is particularly useful for compiling against a Kerberos
+installation that was installed in a non-standard location. For example,
+a Kerberos installation that is installed in ``/opt/krb5/`` but uses
+libraries in ``/usr/local/lib/`` for text localization would produce
+the following output:
+
+ ::
+
+ shell% krb5-config --libs krb5
+ -L/opt/krb5/lib -Wl,-rpath -Wl,/opt/krb5/lib -L/usr/local/lib -lkrb5 -lk5crypto -lcom_err
+
+
+SEE ALSO
+--------
+
+kerberos(1), cc(1)
View
@@ -13,8 +13,8 @@ DEFCKTNAME=@DEFCKTNAME@
MANSUBS=k5identity.sub k5login.sub k5srvutil.sub kadm5.acl.sub kadmin.sub \
kadmind.sub kdb5_ldap_util.sub kdb5_util.sub kdc.conf.sub \
kdestroy.sub kinit.sub klist.sub kpasswd.sub kprop.sub kpropd.sub \
- kproplog.sub krb5.conf.sub krb5kdc.sub ksu.sub kswitch.sub \
- ktutil.sub kvno.sub sclient.sub sserver.sub
+ kproplog.sub krb5.conf.sub krb5-config.sub krb5kdc.sub ksu.sub \
+ kswitch.sub ktutil.sub kvno.sub sclient.sub sserver.sub
docsrc=$(top_srcdir)/../doc

0 comments on commit 5a6d149

Please sign in to comment.