summaryrefslogtreecommitdiffstats
path: root/src/man/kvno.man
diff options
context:
space:
mode:
authorGreg Hudson <ghudson@mit.edu>2012-03-23 16:27:05 +0000
committerGreg Hudson <ghudson@mit.edu>2012-03-23 16:27:05 +0000
commitf309175aeb7cee90bc1537ccc871e5b2221dac87 (patch)
tree2eed62e279a7e039ad1ca5548fd60c8fb563e1fb /src/man/kvno.man
parent84ebeb7e08f4486393c890772fbd87e6b956205b (diff)
downloadkrb5-f309175aeb7cee90bc1537ccc871e5b2221dac87.tar.gz
krb5-f309175aeb7cee90bc1537ccc871e5b2221dac87.tar.xz
krb5-f309175aeb7cee90bc1537ccc871e5b2221dac87.zip
Install path-substituted man pages
Introduce src/doc/Makefile.in, which will eventually subsume doc/Makefile (but will still pull sources from doc). In the rstman target there, create man pages with symbolic path references (like @SBINDIR@). In man/Makefile.in, substitute the path references with the configured paths before installing. Man pages generated from RST source are now checked into the source tree under the name filename.man. This lets us use a single implicit .man.sub rule for the path substitutions. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25786 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'src/man/kvno.man')
-rw-r--r--src/man/kvno.man119
1 files changed, 119 insertions, 0 deletions
diff --git a/src/man/kvno.man b/src/man/kvno.man
new file mode 100644
index 0000000000..38ef7af2d4
--- /dev/null
+++ b/src/man/kvno.man
@@ -0,0 +1,119 @@
+.TH "KVNO" "1" " " "0.0.1" "MIT Kerberos"
+.SH NAME
+kvno \- print key version numbers of Kerberos principals
+.
+.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 SYNOPSIS
+.sp
+\fBkvno\fP
+[\fB\-c\fP \fIccache\fP]
+[\fB\-e\fP \fIetype\fP]
+[\fB\-q\fP]
+[\fB\-h\fP]
+[\fB\-P\fP]
+[\fB\-S\fP \fIsname\fP]
+[\fB\-U\fP \fIfor_user\fP]
+\fIservice1 service2\fP ...
+.SH DESCRIPTION
+.sp
+kvno acquires a service ticket for the specified Kerberos principals
+and prints out the key version numbers of each.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \fB\-c\fP \fIccache\fP
+.sp
+Specifies the name of a credentials cache to use (if not the
+default)
+.TP
+.B \fB\-e\fP \fIetype\fP
+.sp
+Specifies the enctype which will be requested for the session key
+of all the services named on the command line. This is useful in
+certain backward compatibility situations.
+.TP
+.B \fB\-q\fP
+.sp
+Suppress printing output when successful. If a service ticket
+cannot be obtained, an error message will still be printed and
+kvno will exit with nonzero status.
+.TP
+.B \fB\-h\fP
+.sp
+Prints a usage statement and exits.
+.TP
+.B \fB\-P\fP
+.sp
+Specifies that the \fIservice1 service2\fP ... arguments are to be
+treated as services for which credentials should be acquired using
+constrained delegation. This option is only valid when used in
+conjunction with protocol transition.
+.TP
+.B \fB\-S\fP \fIsname\fP
+.sp
+Specifies that the \fIservice1 service2\fP ... arguments are
+interpreted as hostnames, and the service principals are to be
+constructed from those hostnames and the service name \fIsname\fP.
+The service hostnames will be canonicalized according to the usual
+rules for constructing service principals.
+.TP
+.B \fB\-U\fP \fIfor_user\fP
+.sp
+Specifies that protocol transition (S4U2Self) is to be used to
+acquire a ticket on behalf of \fIfor_user\fP. If constrained
+delegation is not requested, the service name must match the
+credentials cache client principal.
+.UNINDENT
+.SH ENVIRONMENT
+.sp
+kvno uses the following environment variable:
+.INDENT 0.0
+.TP
+.B \fBKRB5CCNAME\fP
+.sp
+Location of the credentials (ticket) cache.
+.UNINDENT
+.SH FILES
+.INDENT 0.0
+.TP
+.B \fB/tmp/krb5cc_[uid]\fP
+.sp
+Default location of the credentials cache ([\fIuid\fP] is the decimal
+UID of the user).
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIkinit(1)\fP, \fIkdestroy(1)\fP
+.SH AUTHOR
+MIT
+.SH COPYRIGHT
+2011, MIT
+.\" Generated by docutils manpage writer.
+.