Miscellaneous small edits to RST docs
[krb5.git] / src / man / ktutil.1
1 .TH "KTUTIL" "1" "January 06, 2012" "0.0.1" "MIT Kerberos"
2 .SH NAME
3 ktutil \- Kerberos keytab file maintenance utility
4 .
5 .nr rst2man-indent-level 0
6 .
7 .de1 rstReportMargin
8 \\$1 \\n[an-margin]
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11 -
12 \\n[rst2man-indent0]
13 \\n[rst2man-indent1]
14 \\n[rst2man-indent2]
15 ..
16 .de1 INDENT
17 .\" .rstReportMargin pre:
18 . RS \\$1
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
22 ..
23 .de UNINDENT
24 . RE
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30 ..
31 .\" Man page generated from reStructeredText.
32 .
33 .SH SYNOPSIS
34 .sp
35 \fBktutil\fP
36 .SH DESCRIPTION
37 .sp
38 The \fIktutil\fP command invokes a subshell from which an administrator can read, write, or edit entries in a Kerberos V5 keytab or V4 srvtab file.
39 .SH COMMANDS
40 .INDENT 0.0
41 .INDENT 3.5
42 .INDENT 0.0
43 .TP
44 .B \fBlist\fP
45 .sp
46 Displays the current keylist.
47 .sp
48 Alias: \fBl\fP
49 .TP
50 .B \fBread_kt\fP \fIkeytab\fP
51 .sp
52 Read the Kerberos V5 keytab file \fIkeytab\fP into the current keylist.
53 .sp
54 Alias: \fBrkt\fP
55 .TP
56 .B \fBread_st\fP \fIsrvtab\fP
57 .sp
58 Read the Kerberos V4 srvtab file \fIsrvtab\fP into the current keylist.
59 .sp
60 Alias: \fBrst\fP
61 .TP
62 .B \fBwrite_kt\fP \fIkeytab\fP
63 .sp
64 Write the current keylist into the Kerberos V5 keytab file \fIkeytab\fP.
65 .sp
66 Alias: \fBwkt\fP
67 .TP
68 .B \fBwrite_st\fP \fIsrvtab\fP
69 .sp
70 Write the current keylist into the Kerberos V4 srvtab file \fIsrvtab\fP.
71 .sp
72 Alias: \fBwst\fP
73 .TP
74 .B \fBclear_list\fP
75 .sp
76 Clear the current keylist.
77 .sp
78 Alias: \fBclear\fP
79 .TP
80 .B \fBdelete_entry\fP \fIslot\fP
81 .sp
82 Delete the entry in slot number \fIslot\fP from the current keylist.
83 .sp
84 Alias: \fIdelent\fP
85 .TP
86 .B \fBadd_entry\fP (\fB\-key | \-password)\fP \fB\-p\fP \fIprincipal\fP \fB\-k\fP \fIkvno\fP \fB\-e\fP \fIenctype\fP
87 .sp
88 Add \fIprincipal\fP to keylist using key or password.
89 .sp
90 Alias: \fBaddent\fP
91 .TP
92 .B \fBlist_requests\fP
93 .sp
94 Displays a listing of available commands.
95 .sp
96 Aliases: \fBlr\fP, \fB?\fP
97 .TP
98 .B \fBquit\fP
99 .sp
100 Quits ktutil.
101 .sp
102 Aliases: \fBexit\fP, \fBq\fP
103 .UNINDENT
104 .UNINDENT
105 .UNINDENT
106 .sp
107 EXAMPLE:
108 .sp
109 .nf
110 .ft C
111 ktutil:  add_entry \-password \-p alice@BLEEP.COM \-k 1 \-e aes128\-cts\-hmac\-sha1\-96
112 Password for alice@BLEEP.COM:
113 ktutil:  add_entry \-password \-p alice@BLEEP.COM \-k 1 \-e aes256\-cts\-hmac\-sha1\-96
114 Password for alice@BLEEP.COM:
115 ktutil:  write_kt keytab
116 ktutil:
117 .ft P
118 .fi
119 .SH SEE ALSO
120 .INDENT 0.0
121 .INDENT 3.5
122 .sp
123 kadmin(8), kdb5_util(8)
124 .UNINDENT
125 .UNINDENT
126 .SH AUTHOR
127 MIT
128 .SH COPYRIGHT
129 2011, MIT
130 .\" Generated by docutils manpage writer.
131 .