Adjust the k5login man page to have a slightly more neutral tone
[krb5.git] / src / gen-manpages / k5login.M
1 .TH .K5LOGIN 5
2 .SH NAME
3 \&.k5login \- Kerberos V5 acl file for host access.
4 .SH DESCRIPTION
5 The
6 .B .k5login
7 file, which resides in a user's home directory, contains a list of the
8 Kerberos principals.  Anyone with valid tickets for a principal in the
9 file is allowed host access with the UID of the user in whose home
10 directory the file resides.  One common use is to place a
11 .B .k5login
12 file in root's home directory, thereby granting system administrators
13 remote root access to the host via Kerberos.
14 .SH EXAMPLES
15 Suppose the user "alice" had a 
16 .B .k5login
17 file in her home directory containing the following line:
18 .sp
19 .nf
20 .in +1i
21 bob@FUBAR.ORG
22 .in -1i
23 .fi
24 .sp
25 This would allow "bob" to use any of the Kerberos network
26 applications, such as
27 .IR telnet (1),
28 .IR rlogin (1),
29 .IR rsh (1),
30 and
31 .IR rcp (1),
32 to access alice's account, using bob's Kerberos tickets.
33 .PP
34 Let us further suppose that "alice" is a system administrator.  Alice
35 and the other system administrators would have their principals in
36 root's
37 .B .k5login
38 file on each host:
39 .sp
40 .nf
41 .in +1i
42 alice@BLEEP.COM
43 joeadmin/root@BLEEP.COM
44 .in -1i
45 .fi
46 .sp
47 This would allow either system administrator to log in to these hosts
48 using their Kerberos tickets instead of having to type the root
49 password.  Note that because "bob" retains the Kerberos tickets for
50 his own principal, "bob@FUBAR.ORG", he would not have any of the
51 privileges that require alice's tickets, such as root access to any of
52 the site's hosts, or the ability to change alice's password.
53 .SH SEE ALSO
54 telnet(1), rlogin(1), rsh(1), rcp(1), ksu(1), telnetd(8), klogind(8)