diff options
| author | Tom Yu <tlyu@mit.edu> | 2012-01-09 20:13:10 +0000 |
|---|---|---|
| committer | Tom Yu <tlyu@mit.edu> | 2012-01-09 20:13:10 +0000 |
| commit | bde5e9efadbdf0fb0b2d1dd16efcb83e82e433e4 (patch) | |
| tree | e011cae7ec6c47f92ba0473aedf686b6e77b9edc /doc | |
| parent | 8cbd9cd9c5a9663f89f4be8a09efe1a5ad217747 (diff) | |
| download | krb5-bde5e9efadbdf0fb0b2d1dd16efcb83e82e433e4.tar.gz krb5-bde5e9efadbdf0fb0b2d1dd16efcb83e82e433e4.tar.xz krb5-bde5e9efadbdf0fb0b2d1dd16efcb83e82e433e4.zip | |
install sphinx-generated manpages
Install sphinx-generated manpages. Original nroff manpages remain for
reference until proofreading is complete. Modify
doc/rst_source/conf.py to better deal with shadow manpages -- sphinx
will now build k5login.5 instead of .k5login.5, and kadmin.1 instead
of both kadmin.1 and kadmin.local.8.
Proofreaders should ensure that the original nroff manpages (and
associated Makefile rules) are deleted once their reST format
equivalents have been proofread.
ticket: 7064
status: open
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25625 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 14 | ||||
| -rw-r--r-- | doc/rst_source/conf.py | 3 |
2 files changed, 15 insertions, 2 deletions
diff --git a/doc/Makefile b/doc/Makefile index 599da3f6cf..abe953423f 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -27,6 +27,8 @@ MANPAGES=$(SRCDIR)/clients/kdestroy/kdestroy.M $(SRCDIR)/clients/kinit/kinit.M $ USER_GUIDE_INCLUDES=definitions.texinfo copyright.texinfo glossary.texinfo USER_GUIDE_DEPS=user-guide.texinfo $(USER_GUIDE_INCLUDES) +SPHINX_BUILD=sphinx-build + .PHONY: all all:: admin-guide-full install-guide-full user-guide-full clean-temp-ps clean-tex @@ -155,3 +157,15 @@ tgz:: ../NOTICE: notice.texinfo definitions.texinfo copyright.texinfo makeinfo --plaintext -o $@ notice.texinfo + +RSTMAN=k5login.5 k5srvutil.1 kadmin.1 kadmind.8 kdb5_ldap_util.8 kdb5_util.8 \ + kdc.conf.5 kdestroy.1 kinit.1 klist.1 kpasswd.1 kprop.8 kpropd.8 \ + kproplog.8 krb5.conf.5 krb5kdc.8 ksu.1 kswitch.1 ktutil.1 kvno.1 + +# The file editing loop deletes some trailing whitespace that the +# docutils manpage writer outputs near the end of its output files. +rstman:: + $(SPHINX_BUILD) -q -b man rst_source ../src/man + (cd ../src/man && for f in $(RSTMAN); do \ + (echo '$$'; echo '?^.." $$?d'; echo 'w'; echo 'q' ) | ed $$f; \ + done) diff --git a/doc/rst_source/conf.py b/doc/rst_source/conf.py index 58a1522a17..29fd607fe7 100644 --- a/doc/rst_source/conf.py +++ b/doc/rst_source/conf.py @@ -225,9 +225,8 @@ man_pages = [ ('krb_users/user_commands/kpasswd', 'kpasswd', u'change a user\'s Kerberos password', [u'MIT'], 1), ('krb_users/user_commands/kvno', 'kvno', u'print key version numbers of Kerberos principals', [u'MIT'], 1), ('krb_users/user_commands/ksu', 'ksu', u'Kerberized super-user', [u'MIT'], 1), - ('krb_users/user_commands/k5login', '.k5login', u'Kerberos V5 acl file for host access', [u'MIT'], 5), + ('krb_users/user_commands/k5login', 'k5login', u'Kerberos V5 acl file for host access', [u'MIT'], 5), ('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_local', '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), ('krb_admins/admin_commands/kproplog', 'kproplog', u'display the contents of the Kerberos principal update log', [u'MIT'], 8), |