Skip to content

Commit

Permalink
install sphinx-generated manpages
Browse files Browse the repository at this point in the history
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
  • Loading branch information
tlyu committed Jan 9, 2012
1 parent 8cbd9cd commit bde5e9e
Show file tree
Hide file tree
Showing 45 changed files with 6,751 additions and 13 deletions.
14 changes: 14 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
3 changes: 1 addition & 2 deletions doc/rst_source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -225,9 +225,8 @@
('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),
Expand Down
7 changes: 5 additions & 2 deletions src/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ SUBDIRS=util include lib \
@ldap_plugin_dir@ \
plugins/preauth/pkinit \
kdc kadmin slave clients appl tests \
config-files gen-manpages @po@
config-files gen-manpages man @po@
WINSUBDIRS=include util lib ccapi windows clients appl
BUILDTOP=$(REL).
LOCALINCLUDES = -I$(srcdir)
Expand Down Expand Up @@ -54,7 +54,10 @@ world::
INSTALLMKDIRS = $(KRB5ROOT) $(KRB5MANROOT) $(KRB5OTHERMKDIRS) \
$(ADMIN_BINDIR) $(SERVER_BINDIR) $(CLIENT_BINDIR) \
$(ADMIN_MANDIR) $(SERVER_MANDIR) $(CLIENT_MANDIR) \
$(FILE_MANDIR) $(KRB5_LIBDIR) $(KRB5_INCDIR) \
$(FILE_MANDIR) \
$(ADMIN_CATDIR) $(SERVER_CATDIR) $(CLIENT_CATDIR) \
$(FILE_CATDIR) \
$(KRB5_LIBDIR) $(KRB5_INCDIR) \
$(KRB5_DB_MODULE_DIR) $(KRB5_PA_MODULE_DIR) \
$(KRB5_AD_MODULE_DIR) \
$(KRB5_LIBKRB5_MODULE_DIR) \
Expand Down
4 changes: 4 additions & 0 deletions src/clients/kdestroy/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ install-unix::
for f in kdestroy; do \
$(INSTALL_PROGRAM) $$f \
$(DESTDIR)$(CLIENT_BINDIR)/`echo $$f|sed '$(transform)'`; \
done

install-oldman::
for f in kdestroy; do \
$(INSTALL_DATA) $(srcdir)/$$f.M \
$(DESTDIR)$(CLIENT_MANDIR)/`echo $$f|sed '$(transform)'`.1; \
done
4 changes: 4 additions & 0 deletions src/clients/kinit/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ install-unix::
for f in kinit; do \
$(INSTALL_PROGRAM) $$f \
$(DESTDIR)$(CLIENT_BINDIR)/`echo $$f|sed '$(transform)'`; \
done

install-oldman::
for f in kinit; do \
$(INSTALL_DATA) $(srcdir)/$$f.M \
$(DESTDIR)$(CLIENT_MANDIR)/`echo $$f|sed '$(transform)'`.1; \
done
5 changes: 4 additions & 1 deletion src/clients/klist/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,10 @@ install-unix::
for f in klist; do \
$(INSTALL_PROGRAM) $$f \
$(DESTDIR)$(CLIENT_BINDIR)/`echo $$f|sed '$(transform)'`; \
done

install-oldman::
for f in klist; do \
$(INSTALL_DATA) $(srcdir)/$$f.M \
$(DESTDIR)$(CLIENT_MANDIR)/`echo $$f|sed '$(transform)'`.1; \
done

3 changes: 2 additions & 1 deletion src/clients/kpasswd/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,12 @@ clean-unix::

install-all install-kdc install-server install-client install-unix::
$(INSTALL_PROGRAM) kpasswd $(DESTDIR)$(CLIENT_BINDIR)/`echo kpasswd|sed '$(transform)'`

install-oldman::
$(INSTALL_DATA) $(srcdir)/kpasswd.M $(DESTDIR)$(CLIENT_MANDIR)/`echo kpasswd|sed '$(transform)'`.1;

##WIN32##all-windows:: $(KPWD)

##WIN32##$(KPWD): $(OUTPRE)kpasswd.obj $(KLIB) $(CLIB) $(EXERES)
##WIN32## link $(EXE_LINKOPTS) -out:$@ $** $(SCLIB)
##WIN32## $(_VC_MANIFEST_EMBED_EXE)

4 changes: 4 additions & 0 deletions src/clients/ksu/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ install::
-for f in ksu; do \
$(INSTALL_SETUID) $$f \
$(DESTDIR)$(CLIENT_BINDIR)/`echo $$f|sed '$(transform)'`; \
done

install-oldman::
for f in ksu; do \
$(INSTALL_DATA) $(srcdir)/$$f.M \
${DESTDIR}$(CLIENT_MANDIR)/`echo $$f|sed '$(transform)'`.1; \
done
4 changes: 4 additions & 0 deletions src/clients/kvno/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ install-unix::
for f in kvno; do \
$(INSTALL_PROGRAM) $$f \
$(DESTDIR)$(CLIENT_BINDIR)/`echo $$f|sed '$(transform)'`; \
done

install-oldman::
for f in kvno; do \
$(INSTALL_DATA) $(srcdir)/$$f.M \
$(DESTDIR)$(CLIENT_MANDIR)/`echo $$f|sed '$(transform)'`.1; \
done
6 changes: 4 additions & 2 deletions src/config-files/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ BUILDTOP=$(REL)..
all::

install::
$(INSTALL_DATA) $(srcdir)/kdc.conf.M ${DESTDIR}$(FILE_MANDIR)/kdc.conf.5
$(INSTALL_DATA) $(srcdir)/krb5.conf.M ${DESTDIR}$(FILE_MANDIR)/krb5.conf.5
$(INSTALL_DATA) $(srcdir)/kdc.conf ${DESTDIR}$(EXAMPLEDIR)/kdc.conf
$(INSTALL_DATA) $(srcdir)/krb5.conf ${DESTDIR}$(EXAMPLEDIR)/krb5.conf
$(INSTALL_DATA) $(srcdir)/services.append ${DESTDIR}$(EXAMPLEDIR)/services.append

install-oldman::
$(INSTALL_DATA) $(srcdir)/kdc.conf.M ${DESTDIR}$(FILE_MANDIR)/kdc.conf.5
$(INSTALL_DATA) $(srcdir)/krb5.conf.M ${DESTDIR}$(FILE_MANDIR)/krb5.conf.5
4 changes: 4 additions & 0 deletions src/config/pre.in
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,10 @@ ADMIN_MANDIR = $(KRB5MANROOT)/man8
SERVER_MANDIR = $(KRB5MANROOT)/man8
CLIENT_MANDIR = $(KRB5MANROOT)/man1
FILE_MANDIR = $(KRB5MANROOT)/man5
ADMIN_CATDIR = $(KRB5MANROOT)/cat8
SERVER_CATDIR = $(KRB5MANROOT)/cat8
CLIENT_CATDIR = $(KRB5MANROOT)/cat1
FILE_CATDIR = $(KRB5MANROOT)/cat5
KRB5_LIBDIR = @libdir@
KRB5_SHLIBDIR = @libdir@$(SHLIB_TAIL_COMP)
KRB5_INCDIR = @includedir@
Expand Down
4 changes: 3 additions & 1 deletion src/configure.in
Original file line number Diff line number Diff line change
Expand Up @@ -1243,6 +1243,8 @@ AC_SUBST([VERTO_CFLAGS])
AC_SUBST([VERTO_LIBS])
AC_SUBST([VERTO_VERSION])

AC_PATH_PROG(GROFF, groff)

AC_CONFIG_FILES(krb5-config, [chmod +x krb5-config])
V5_AC_OUTPUT_MAKEFILE(.

Expand Down Expand Up @@ -1276,7 +1278,7 @@ dnl lib/krb5/ccache/ccapi

dnl ccapi ccapi/lib ccapi/lib/unix ccapi/server ccapi/server/unix ccapi/test

kdc slave config-files gen-manpages include
kdc slave config-files gen-manpages man include

plugins/locate/python
plugins/kadm5_hook/test
Expand Down
8 changes: 5 additions & 3 deletions src/gen-manpages/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ all::

install::
$(INSTALL_DATA) $(srcdir)/kerberos.M ${DESTDIR}$(CLIENT_MANDIR)/kerberos.1
$(INSTALL_DATA) $(srcdir)/k5login.M ${DESTDIR}$(FILE_MANDIR)/k5login.5
$(INSTALL_DATA) $(srcdir)/dot.k5login.M \
${DESTDIR}$(FILE_MANDIR)/.k5login.5
$(INSTALL_DATA) $(srcdir)/k5identity.M \
${DESTDIR}$(FILE_MANDIR)/k5identity.5
$(INSTALL_DATA) $(srcdir)/dot.k5identity.M \
${DESTDIR}$(FILE_MANDIR)/.k5identity.5

install-oldman::
$(INSTALL_DATA) $(srcdir)/k5login.M ${DESTDIR}$(FILE_MANDIR)/k5login.5
$(INSTALL_DATA) $(srcdir)/dot.k5login.M \
${DESTDIR}$(FILE_MANDIR)/.k5login.5
2 changes: 2 additions & 0 deletions src/kadmin/cli/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ install::
$(INSTALL_PROGRAM) $(PROG).local ${DESTDIR}$(ADMIN_BINDIR)/$(PROG).local
$(INSTALL_PROGRAM) $(PROG) ${DESTDIR}$(CLIENT_BINDIR)/$(PROG)
$(INSTALL_SCRIPT) $(srcdir)/k5srvutil.sh ${DESTDIR}$(CLIENT_BINDIR)/k5srvutil

install-oldman::
$(INSTALL_DATA) $(srcdir)/k5srvutil.M ${DESTDIR}$(CLIENT_MANDIR)/k5srvutil.1
$(INSTALL_DATA) $(srcdir)/$(PROG).M ${DESTDIR}$(CLIENT_MANDIR)/$(PROG).1
$(INSTALL_DATA) $(srcdir)/$(PROG).local.M ${DESTDIR}$(ADMIN_MANDIR)/$(PROG).local.8
Expand Down
2 changes: 2 additions & 0 deletions src/kadmin/dbutil/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ $(OBJS): import_err.h

install::
$(INSTALL_PROGRAM) $(PROG) ${DESTDIR}$(ADMIN_BINDIR)/$(PROG)

install-oldman::
$(INSTALL_DATA) $(srcdir)/$(PROG).M ${DESTDIR}$(ADMIN_MANDIR)/$(PROG).8

clean::
Expand Down
2 changes: 2 additions & 0 deletions src/kadmin/ktutil/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ ktutil: ktutil.o $(OBJS) $(SS_DEPLIB) $(KRB5_BASE_DEPLIBS)

install::
$(INSTALL_PROGRAM) ktutil ${DESTDIR}$(CLIENT_BINDIR)/ktutil

install-oldman::
$(INSTALL_DATA) $(srcdir)/ktutil.M ${DESTDIR}$(CLIENT_MANDIR)/ktutil.1

generate-files-mac: ktutil_ct.c
Expand Down
2 changes: 2 additions & 0 deletions src/kadmin/server/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ $(PROG): $(OBJS) $(KADMSRV_DEPLIBS) $(KRB5_BASE_DEPLIBS) $(APPUTILS_DEPLIB) $(VE

install::
$(INSTALL_PROGRAM) $(PROG) ${DESTDIR}$(SERVER_BINDIR)/$(PROG)

install-oldman::
$(INSTALL_DATA) $(srcdir)/$(PROG).M ${DESTDIR}$(SERVER_MANDIR)/$(PROG).8

clean::
Expand Down
2 changes: 2 additions & 0 deletions src/kdc/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ check-pytests::

install::
$(INSTALL_PROGRAM) krb5kdc ${DESTDIR}$(SERVER_BINDIR)/krb5kdc

install-oldman::
$(INSTALL_DATA) $(srcdir)/krb5kdc.M ${DESTDIR}$(SERVER_MANDIR)/krb5kdc.8

clean::
Expand Down
68 changes: 68 additions & 0 deletions src/man/Makefile.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
mydir=man
BUILDTOP=$(REL)..

GROFF=@GROFF@
GROFF_MAN=$(GROFF) -mtty-char -Tascii -mandoc -c

all::

install:: install-clientman install-fileman install-adminman install-serverman

install-catman:: install-clientcat install-filecat install-admincat install-servercat

install-clientman::
$(INSTALL_DATA) $(srcdir)/k5srvutil.1 ${DESTDIR}$(CLIENT_MANDIR)/k5srvutil.1
$(INSTALL_DATA) $(srcdir)/kadmin.1 ${DESTDIR}$(CLIENT_MANDIR)/kadmin.1
$(INSTALL_DATA) $(srcdir)/kdestroy.1 ${DESTDIR}$(CLIENT_MANDIR)/kdestroy.1
$(INSTALL_DATA) $(srcdir)/kinit.1 ${DESTDIR}$(CLIENT_MANDIR)/kinit.1
$(INSTALL_DATA) $(srcdir)/klist.1 ${DESTDIR}$(CLIENT_MANDIR)/klist.1
$(INSTALL_DATA) $(srcdir)/kpasswd.1 ${DESTDIR}$(CLIENT_MANDIR)/kpasswd.1
$(INSTALL_DATA) $(srcdir)/ksu.1 ${DESTDIR}$(CLIENT_MANDIR)/ksu.1
$(INSTALL_DATA) $(srcdir)/kswitch.1 ${DESTDIR}$(CLIENT_MANDIR)/kswitch.1
$(INSTALL_DATA) $(srcdir)/ktutil.1 ${DESTDIR}$(CLIENT_MANDIR)/ktutil.1
$(INSTALL_DATA) $(srcdir)/kvno.1 ${DESTDIR}$(CLIENT_MANDIR)/kvno.1

install-fileman::
$(INSTALL_DATA) $(srcdir)/dot.k5login.5 ${DESTDIR}$(FILE_MANDIR)/.k5login.5
$(INSTALL_DATA) $(srcdir)/k5login.5 ${DESTDIR}$(FILE_MANDIR)/k5login.5
$(INSTALL_DATA) $(srcdir)/kdc.conf.5 ${DESTDIR}$(FILE_MANDIR)/kdc.conf.5
$(INSTALL_DATA) $(srcdir)/krb5.conf.5 ${DESTDIR}$(FILE_MANDIR)/krb5.conf.5

install-adminman::
$(INSTALL_DATA) $(srcdir)/kadmin.local.8 ${DESTDIR}$(CLIENT_MANDIR)/kadmin.local.8
$(INSTALL_DATA) $(srcdir)/kdb5_ldap_util.8 ${DESTDIR}$(ADMIN_MANDIR)/kdb5_ldap_util.8
$(INSTALL_DATA) $(srcdir)/kdb5_util.8 ${DESTDIR}$(ADMIN_MANDIR)/kdb5_util.8
$(INSTALL_DATA) $(srcdir)/kprop.8 ${DESTDIR}$(ADMIN_MANDIR)/kprop.8
$(INSTALL_DATA) $(srcdir)/kproplog.8 ${DESTDIR}$(ADMIN_MANDIR)/kproplog.8

install-serverman::
$(INSTALL_DATA) $(srcdir)/kadmind.8 ${DESTDIR}$(SERVER_MANDIR)/kadmind.8
$(INSTALL_DATA) $(srcdir)/kpropd.8 ${DESTDIR}$(SERVER_MANDIR)/kpropd.8
$(INSTALL_DATA) $(srcdir)/krb5kdc.8 ${DESTDIR}$(SERVER_MANDIR)/krb5kdc.8

install-clientcat::
$(GROFF_MAN) $(srcdir)/k5srvutil.1 > ${DESTDIR}$(CLIENT_CATDIR)/k5srvutil.1
$(GROFF_MAN) $(srcdir)/kadmin.1 > ${DESTDIR}$(CLIENT_CATDIR)/kadmin.1
$(GROFF_MAN) $(srcdir)/kdestroy.1 > ${DESTDIR}$(CLIENT_CATDIR)/kdestroy.1
$(GROFF_MAN) $(srcdir)/kinit.1 > ${DESTDIR}$(CLIENT_CATDIR)/kinit.1
$(GROFF_MAN) $(srcdir)/klist.1 > ${DESTDIR}$(CLIENT_CATDIR)/klist.1
$(GROFF_MAN) $(srcdir)/kpasswd.1 > ${DESTDIR}$(CLIENT_CATDIR)/kpasswd.1
$(GROFF_MAN) $(srcdir)/ksu.1 > ${DESTDIR}$(CLIENT_CATDIR)/ksu.1
$(GROFF_MAN) $(srcdir)/kswitch.1 > ${DESTDIR}$(CLIENT_CATDIR)/kswitch.1
$(GROFF_MAN) $(srcdir)/ktutil.1 > ${DESTDIR}$(CLIENT_CATDIR)/ktutil.1
$(GROFF_MAN) $(srcdir)/kvno.1 > ${DESTDIR}$(CLIENT_CATDIR)/kvno.1

install-filecat::
$(GROFF_MAN) $(srcdir)/k5login.5 > ${DESTDIR}$(FILE_CATDIR)/k5login.5
($(RM) ${DESTDIR}$(FILE_CATDIR)/.k5login.5; \
$(LN_S) $(FILE_CATDIR)/k5login.5 ${DESTDIR}$(FILE_CATDIR)/.k5login.5)
$(GROFF_MAN) $(srcdir)/kdc.conf.5 > ${DESTDIR}$(FILE_CATDIR)/kdc.conf.5
$(GROFF_MAN) $(srcdir)/krb5.conf.5 > ${DESTDIR}$(FILE_CATDIR)/krb5.conf.5

install-admincat::
($(RM) ${DESTDIR}$(ADMIN_CATDIR)/kadmin.local.8; \
$(LN_S) $(CLIENT_CATDIR)/kadmin.1 ${DESTDIR}$(ADMIN_CATDIR)/kadmin.local.8)
$(GROFF_MAN) $(srcdir)/kdb5_ldap_util.8 > ${DESTDIR}$(ADMIN_CATDIR)/kdb5_ldap_util.8
$(GROFF_MAN) $(srcdir)/kdb5_util.8 > ${DESTDIR}$(ADMIN_CATDIR)/kdb5_util.8
$(GROFF_MAN) $(srcdir)/kprop.8 > ${DESTDIR}$(ADMIN_CATDIR)/kprop.8
$(GROFF_MAN) $(srcdir)/kproplog.8 > ${DESTDIR}$(ADMIN_CATDIR)/kproplog.8
4 changes: 4 additions & 0 deletions src/man/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
The manual page files in this directory are generated from
reStructuredText format from doc/rst_source. Edits made here will not
survive a run of "make rstman" from the doc directory, except for the
files that implement "shadow manpages".
1 change: 1 addition & 0 deletions src/man/deps
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# No dependencies here.
1 change: 1 addition & 0 deletions src/man/dot.k5login.5
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.so man5/k5login.5
74 changes: 74 additions & 0 deletions src/man/k5login.5
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
.TH "K5LOGIN" "5" "January 06, 2012" "0.0.1" "MIT Kerberos"
.SH NAME
k5login \- Kerberos V5 acl file for host access
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.SH DESCRIPTION
.sp
The \fI.k5login\fP file, which resides in a user\(aqs home directory, contains a list of the Kerberos principals.
Anyone with valid tickets for a principal in the file is allowed host access with the UID of the user in whose home directory the file resides.
One common use is to place a \fI.k5login\fP file in root\(aqs home directory, thereby granting system administrators remote root access to the host via Kerberos.
.SH EXAMPLES
.sp
Suppose the user "alice" had a \fI.k5login\fP file in her home directory containing the following line:
.INDENT 0.0
.INDENT 3.5
.sp
bob@FUBAR.ORG
.UNINDENT
.UNINDENT
.sp
This would allow "bob" to use any of the Kerberos network applications, such as telnet(1), rlogin(1), rsh(1), and rcp(1),
to access alice\(aqs account, using bob\(aqs Kerberos tickets.
.sp
Let us further suppose that "alice" is a system administrator.
Alice and the other system administrators would have their principals in root\(aqs \fI.k5login\fP file on each host:
.INDENT 0.0
.INDENT 3.5
.sp
alice@BLEEP.COM
.sp
joeadmin/root@BLEEP.COM
.UNINDENT
.UNINDENT
.sp
This would allow either system administrator to log in to these hosts using their Kerberos tickets instead of having to type the root password.
Note that because "bob" retains the Kerberos tickets for his own principal, "bob@FUBAR.ORG",
he would not have any of the privileges that require alice\(aqs tickets, such as root access to any of the site\(aqs hosts,
or the ability to change alice\(aqs password.
.SH SEE ALSO
.sp
telnet(1), rlogin(1), rsh(1), rcp(1), ksu(1), telnetd(8), klogind(8)
.SH AUTHOR
MIT
.SH COPYRIGHT
2011, MIT
.\" Generated by docutils manpage writer.
.
Loading

0 comments on commit bde5e9e

Please sign in to comment.