From 6304199ec70ebac8c773dbd504022b793e6bd9be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Love=20H=C3=B6rnquist=20=C3=85strand?= Date: Tue, 3 May 2005 13:30:24 +0000 Subject: [PATCH] initial manpage git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@15068 ec53bebd-3082-4978-b11e-865c3cabbd6b --- kcm/kcm.8 | 188 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 188 insertions(+) create mode 100644 kcm/kcm.8 diff --git a/kcm/kcm.8 b/kcm/kcm.8 new file mode 100644 index 000000000..37e97f917 --- /dev/null +++ b/kcm/kcm.8 @@ -0,0 +1,188 @@ +.\" Copyright (c) 2005 Kungliga Tekniska Högskolan +.\" (Royal Institute of Technology, Stockholm, Sweden). +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" 3. Neither the name of the Institute nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $Id$ +.\" +.Dd May 3, 2005 +.Dt KCM 8 +.Os Heimdal +.Sh NAME +.Nm kcm +.Nd +is a process based credential cache for Kerberos tickets. +.Sh SYNOPSIS +.Nm +.Op Fl -cache-name= Ns Ar cachename +.Oo Fl c Ar file \*(Ba Xo +.Fl -config-file= Ns Ar file +.Xc +.Oc +.Oo Fl g Ar group \*(Ba Xo +.Fl -group= Ns Ar group +.Xc +.Oc +.Op Fl -max-request= Ns Ar size +.Op Fl -detach +.Op Fl h | Fl -help +.Oo Fl k Ar principal \*(Ba Xo +.Fl -system-principal= Ns Ar principal +.Xc +.Oc +.Oo Fl l Ar time \*(Ba Xo +.Fl -lifetime= Ns Ar time +.Xc +.Oc +.Oo Fl m Ar mode \*(Ba Xo +.Fl -mode= Ns Ar mode +.Xc +.Oc +.Op Fl n | Fl -no-name-constraints +.Oo Fl r Ar time \*(Ba Xo +.Fl -renewable-life= Ns Ar time +.Xc +.Oc +.Oo Fl s Ar path \*(Ba Xo +.Fl -socket-path= Ns Ar path +.Xc +.Oc +.Oo Fl S Ar principal \*(Ba Xo +.Fl -server= Ns Ar principal +.Xc +.Oc +.Oo Fl t Ar keytab \*(Ba Xo +.Fl -keytab= Ns Ar keytab +.Xc +.Oc +.Oo Fl u Ar user \*(Ba Xo +.Fl -user= Ns Ar user +.Xc +.Oc +.Op Fl v | Fl -version +.Sh DESCRIPTION +.Nm +is a process based credential cache. +To use it, set the +.Ev KRB5CCNAME +enviroment variable to +.Q1 KCM:${uid} +or add the configuration file +.Pa /etc/krb5.conf +stanza [libdefaults]default_cc_name to KCM:${uid} and make sure +.Nm kcm +is started in the system startup files. +.Pp +Supported options: +.Bl -tag -width Ds +.It Xo +.Fl -cache-name= Ns Ar cachename +.Xc +system cache name +.It Xo +.Fl c Ar file , +.Fl -config-file= Ns Ar file +.Xc +location of config file +.It Xo +.Fl g Ar group , +.Fl -group= Ns Ar group +.Xc +system cache group +.It Xo +.Fl -max-request= Ns Ar size +.Xc +max size for a kcm-request +.It Xo +.Fl -detach +.Xc +detach from console +.It Xo +.Fl h , +.Fl -help +.Xc +.It Xo +.Fl k Ar principal , +.Fl -system-principal= Ns Ar principal +.Xc +system principal name +.It Xo +.Fl l Ar time , +.Fl -lifetime= Ns Ar time +.Xc +lifetime of system tickets +.It Xo +.Fl m Ar mode , +.Fl -mode= Ns Ar mode +.Xc +octal mode of system cache +.It Xo +.Fl n , +.Fl -no-name-constraints +.Xc +disable credentials cache name constraints +.It Xo +.Fl r Ar time , +.Fl -renewable-life= Ns Ar time +.Xc +renewable lifetime of system tickets +.It Xo +.Fl s Ar path , +.Fl -socket-path= Ns Ar path +.Xc +path to kcm domain socket +.It Xo +.Fl S Ar principal , +.Fl -server= Ns Ar principal +.Xc +server to get system ticket for +.It Xo +.Fl t Ar keytab , +.Fl -keytab= Ns Ar keytab +.Xc +system keytab name +.It Xo +.Fl u Ar user , +.Fl -user= Ns Ar user +.Xc +system cache owner +.It Xo +.Fl v , +.Fl -version +.Xc +.El +.\".Sh ENVIRONMENT +.\".Sh FILES +.\".Sh EXAMPLES +.\".Sh DIAGNOSTICS +.\".Sh SEE ALSO +.\".Sh STANDARDS +.\".Sh HISTORY +.\".Sh AUTHORS +.\".Sh BUGS