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