Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / crypto / kerberosIV / man / kinit.1
1 .\" $Id: kinit.1,v 1.4 1998/12/18 16:57:29 assar Exp $
2 .\" $FreeBSD: src/crypto/kerberosIV/man/kinit.1,v 1.3.2.1 2001/03/04 12:52:51 markm Exp $
3 .\" $DragonFly: src/crypto/kerberosIV/man/Attic/kinit.1,v 1.2 2003/06/17 04:24:36 dillon Exp $
4 .\" Copyright 1989 by the Massachusetts Institute of Technology.
5 .\"
6 .\" For copying and distribution information,
7 .\" please see the file <mit-copyright.h>.
8 .\"
9 .TH KINIT 1 "Kerberos Version 4.0" "MIT Project Athena"
10 .SH NAME
11 kinit \- Kerberos login utility
12 .SH SYNOPSIS
13 .B kinit
14 [
15 .B \-irvlp
16 ]
17 .SH DESCRIPTION
18 The
19 .I kinit
20 command is used to login to the
21 Kerberos
22 authentication and authorization system.
23 Note that only registered
24 Kerberos
25 users can use the
26 Kerberos
27 system.
28 For information about registering as a
29 Kerberos
30 user,
31 see the
32 .I kerberos(1)
33 manual page.
34 .PP
35 If you are using a replaced
36 .I login
37 that already fetches tickets for you, you do not have to use
38 .I kinit.
39 You will need to use
40 .I kinit
41 only in those situations in which
42 your original tickets have expired.
43 (Tickets expire in about a day.)
44 Note as well that the modified
45 .I login
46 will automatically destroy your tickets when you logout from the workstation.
47 .PP
48 When you use
49 .I kinit
50 without options,
51 the utility
52 prompts for your username and Kerberos password,
53 and tries to authenticate your login with the local
54 Kerberos
55 server.
56 .PP
57 If
58 Kerberos
59 authenticates the login attempt,
60 .I kinit
61 retrieves your initial ticket and puts it in the ticket file specified by
62 your KRBTKFILE environment variable.
63 If this variable is undefined,
64 your ticket will be stored in the
65 .IR /tmp
66 directory,
67 in the file
68 .I tktuid ,
69 where
70 .I uid
71 specifies your user identification number.
72 .PP
73 If you have logged in to
74 Kerberos
75 without the benefit of the modified
76 .I login
77 program,
78 make sure you use the
79 .I kdestroy
80 command to destroy any active tickets before you end your login session.
81 You may want to put the
82 .I kdestroy
83 command in your
84 .I \.logout
85 file so that your tickets will be destroyed automatically when you logout.
86 .PP
87 The options to
88 .I kinit
89 are as follows:
90 .TP 7
91 .B \-i
92 .I kinit
93 prompts you for a
94 Kerberos
95 instance.
96 .TP
97 .B \-r
98 .I kinit
99 prompts you for a
100 Kerberos
101 realm.
102 This option lets you authenticate yourself with a remote
103 Kerberos
104 server.
105 .TP
106 .B \-v
107 Verbose mode.
108 .I kinit
109 prints the name of the ticket file used, and
110 a status message indicating the success or failure of
111 your login attempt.
112 .TP
113 .B \-l
114 .I kinit
115 prompts you for a ticket lifetime in minutes.  Due to protocol
116 restrictions in Kerberos Version 4, this value must be between 5 and
117 1275 minutes.
118 .TP
119 .B \-p
120 .I kinit
121 will acquires a ticket for changepw.kerberos.
122 .SH SEE ALSO
123 .PP
124 kerberos(1), kdestroy(1), klist(1), login(1)
125 .SH BUGS
126 The
127 .B \-r
128 option has not been fully implemented.
129 .SH AUTHORS
130 Steve Miller, MIT Project Athena/Digital Equipment Corporation
131 .br
132 Clifford Neuman, MIT Project Athena