From 6badb7386189d18ba524dede712b11313f5a1356 Mon Sep 17 00:00:00 2001 From: Zhanna Tsitkov Date: Wed, 3 Aug 2011 18:21:23 +0000 Subject: [PATCH] Added kprop document to Sphinx doc tree git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25070 dc483132-0cff-0310-8789-dd5450dbe970 --- doc/rst_source/conf.py | 2 + .../krb_admins/admin_commands/index.rst | 1 + .../krb_admins/admin_commands/kprop.rst | 46 +++++++++++++++++++ 3 files changed, 49 insertions(+) create mode 100644 doc/rst_source/krb_admins/admin_commands/kprop.rst diff --git a/doc/rst_source/conf.py b/doc/rst_source/conf.py index 0b7574c88..65e76f718 100644 --- a/doc/rst_source/conf.py +++ b/doc/rst_source/conf.py @@ -226,4 +226,6 @@ man_pages = [ ('krb_users/user_commands/ksu', 'ksu', u'Kerberized super-user', [u'MIT'], 1), ('krb_admins/admin_commands/krb5kdc', 'krb5kdc', u'Kerberos V5 KDC', [u'MIT'], 8), ('krb_admins/admin_commands/kadmin_local', 'kadmin.local', u'Kerberos V5 database administration program', [u'MIT'], 8), + ('krb_admins/admin_commands/kadmin', 'kadmin', u'Kerberos V5 database administration program', [u'MIT'], 1), + ('krb_admins/admin_commands/kprop', 'kprop', u'propagate a Kerberos V5 principal database to a slave server', [u'MIT'], 8), ] diff --git a/doc/rst_source/krb_admins/admin_commands/index.rst b/doc/rst_source/krb_admins/admin_commands/index.rst index 70211cb89..8a8ae0fb0 100644 --- a/doc/rst_source/krb_admins/admin_commands/index.rst +++ b/doc/rst_source/krb_admins/admin_commands/index.rst @@ -9,6 +9,7 @@ Administration programs krb5kdc.rst kadmin_local.rst + kprop.rst ------------ diff --git a/doc/rst_source/krb_admins/admin_commands/kprop.rst b/doc/rst_source/krb_admins/admin_commands/kprop.rst new file mode 100644 index 000000000..532634593 --- /dev/null +++ b/doc/rst_source/krb_admins/admin_commands/kprop.rst @@ -0,0 +1,46 @@ +kprop - propagate a Kerberos V5 principal database to a slave server +===================================================================== + +SYNOPSIS +------------- + +**kprop** + [**-r** *realm*] + [**-f** *file*] + [**-d**] + [**-P** *port*] + [**-s** *keytab*] + *slave_host* + +DESCRIPTION +------------- + +*kprop* is used to propagate a Kerberos V5 database dump file from the master Kerberos server to a slave Kerberos server, +which is specfied by *slave_host*. This is done by transmitting the dumped database file to the slave server over an encrypted, secure channel. +The dump file must be created by *kdb5_util*, and is normally *KPROP_DEFAULT_FILE* (/usr/local/var/krb5kdc/slave_datatrans). + +OPTIONS +------------- + + **-r** *realm* + Specifies the realm of the master server; by default the realm returned by krb5_default_local_realm(3) is used. + + **-f** *file* + Specifies the filename where the dumped principal database file is to be found; by default the dumped database file is + *KPROP_DEFAULT_FILE* (normally /usr/local/var/krb5kdc/slave_datatrans). + + **-P** *port* + Specifies the port to use to contact the kpropd server on the remote host. + + **-d** + Prints debugging information. + + **-s** *keytab* + Specifies the location of the keytab file. + + +SEE ALSO +------------- + +kpropd(8), kdb5_util(8), krb5kdc(8) + -- 2.26.2