From 44edbf46f3a80f6161fcd3884233ec4f7b26608c Mon Sep 17 00:00:00 2001 From: Assar Westerlund Date: Wed, 27 Aug 1997 23:44:57 +0000 Subject: [PATCH] new man pages git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@3205 ec53bebd-3082-4978-b11e-865c3cabbd6b --- kdc/hprop.8 | 42 ++++++++++++++++++++++++++++++++++++++++++ kdc/hpropd.8 | 27 +++++++++++++++++++++++++++ kdc/kstash.8 | 26 ++++++++++++++++++++++++++ kpasswd/kpasswd.1 | 20 ++++++++++++++++++++ kpasswd/kpasswdd.8 | 25 +++++++++++++++++++++++++ kuser/kdestroy.1 | 25 +++++++++++++++++++++++++ kuser/kinit.1 | 44 ++++++++++++++++++++++++++++++++++++++++++++ kuser/klist.1 | 26 ++++++++++++++++++++++++++ 8 files changed, 235 insertions(+) create mode 100644 kdc/hprop.8 create mode 100644 kdc/hpropd.8 create mode 100644 kdc/kstash.8 create mode 100644 kpasswd/kpasswd.1 create mode 100644 kpasswd/kpasswdd.8 create mode 100644 kuser/kdestroy.1 create mode 100644 kuser/kinit.1 create mode 100644 kuser/klist.1 diff --git a/kdc/hprop.8 b/kdc/hprop.8 new file mode 100644 index 000000000..64e95b252 --- /dev/null +++ b/kdc/hprop.8 @@ -0,0 +1,42 @@ +.\" $Id$ +.\" +.Dd Aug 27, 1997 +.Dt HPROP 8 +.Os HEIMDAL +.Sh NAME +.Nm hprop +.Nd +propagate the KDC database +.Sh SYNOPSIS +.Nm +.Op Fl d Ar file +.Op Fl -database= Ns Ar file +.Op Fl 4 +.Op Fl -v4-db +.Op Fl k Ar keytab +.Op Fl -keytab= Ns Ar keytab +.Ar host ... +.Sh DESCRIPTION +.Nm +propagates the database from a master KDC to a slave. It connects to +all hosts specified on the command by opening a TCP connection to port +4712 (service hprop) and sending over the database in encrypted form. +.Pp +Options supported: +.Bl -tag -width Ds +.It Fl d Ar file +.It Fl -database= Ns Ar file +The database to be propagated. +.It Fl 4 +.It Fl -v4-db +Use a version 4 database. This option is only available if the code is +compiled with Kerberos 4 support. +.It Fl k +.It Fl -keytab= Ns Ar keytab +The keytab to use for fetching the key to be used for authenticating +to the propagation daemon(s). The key +.Pa kadmin/hprop +is used from this keytab. +.El +.Sh SEE ALSO +.Xr hpropd 8 diff --git a/kdc/hpropd.8 b/kdc/hpropd.8 new file mode 100644 index 000000000..a2d802a0b --- /dev/null +++ b/kdc/hpropd.8 @@ -0,0 +1,27 @@ +.\" $Id$ +.\" +.Dd Aug 27, 1997 +.Dt HPROPD 8 +.Os HEIMDAL +.Sh NAME +.Nm hpropd +.Nd +receive a propagated database +.Sh SYNOPSIS +.Nm +.Op Fl d Ar database +.Op Fl -database= Ns Ar database +.Sh DESCRIPTION +.Nm +receives databases sent by +.Nm hprop . +and writes it as a local database. +.Pp +Options supported: +.Bl -tag -width Ds +.It Fl d Ar database +.It Fl -database= Ns Ar database +the database to create. +.El +.Sh SEE ALSO +.Xr hprop 8 diff --git a/kdc/kstash.8 b/kdc/kstash.8 new file mode 100644 index 000000000..b160a597e --- /dev/null +++ b/kdc/kstash.8 @@ -0,0 +1,26 @@ +.\" $Id$ +.\" +.Dd Aug 27, 1997 +.Dt KSTASH 8 +.Os HEIMDAL +.Sh NAME +.Nm kstash +.Nd +Store the KDC master password in a file +.Sh SYNOPSIS +.Nm +.Op Fl k Ar file +.Op Fl -key-file= Ns Ar file +.Sh DESCRIPTION +.Nm +allows you to the master password and store in a file that will be read +by the KDC. +.Pp +Options supported: +.Bl -tag -width Ds +.It Fl k Ar file +.It Fl -key-file= Ns Ar file +Specify what file the master key is stored in. The default is +.Pa m-key . +.Sh SEE ALSO +.Xr kdc 8 diff --git a/kpasswd/kpasswd.1 b/kpasswd/kpasswd.1 new file mode 100644 index 000000000..58fc512bb --- /dev/null +++ b/kpasswd/kpasswd.1 @@ -0,0 +1,20 @@ +.\" $Id$ +.\" +.Dt Aug 27, 1997 +.Dt KPASSWD 1 +.Os HEIMDAL +.Sh NAME +.Nm kpasswd +.Nd +Kerberos 5 password changing program +.Sh SYNOPSIS +.Nm +.Op Ar principal +.Sh DESCRIPTION +.Nm +is the client for changing passwords. +.Sh DIAGNOSTICS +If the password quality check fails or some other error occurs, an +explanation is printed. +.Sh SEE ALSO +.Xr kpasswdd 8 diff --git a/kpasswd/kpasswdd.8 b/kpasswd/kpasswdd.8 new file mode 100644 index 000000000..d81c700f8 --- /dev/null +++ b/kpasswd/kpasswdd.8 @@ -0,0 +1,25 @@ +.\" $Id$ +.\" +.Dd Aug 27, 1997 +.Dt KPASSWDD 8 +.Os HEIMDAL +.Sh NAME +.Nm kpasswdd +.Nd +Kerberos 5 password changing server +.Sh SYNOPSIS +.Nm +.Sh DESCRIPTION +.Nm +servers request for password changes. It listens on UDP port 464 +(service kpasswd) and processes requests when they arrive. It changes +the database directly and should thus only run on the master KDC. +.Sh DIAGNOSTICS +If an error occurs, the error message is returned to the user and/or +logged to syslog. +.Sh BUGS +The password quality checks are too basic. It should probably use +cracklib or something similar. +.Sh SEE ALSO +.Xr kdc 8 , +.Xr kpasswd 1 diff --git a/kuser/kdestroy.1 b/kuser/kdestroy.1 new file mode 100644 index 000000000..3ce480d03 --- /dev/null +++ b/kuser/kdestroy.1 @@ -0,0 +1,25 @@ +.\" $Id$ +.\" +.Dd Aug 27, 1997 +.Dt KDESTROY 1 +.Os HEIMDAL +.Sh NAME +.Nm kdestroy +.Nd +destroy the current ticket file +.Sh SYNOPSIS +.Nm +.Op Fl c Ar cachefile +.Op Fl -cache= Ns Ar cachefile +.Sh DESCRIPTION +.Nm +remove the current set of tickets. +.Pp +.Bl -tag -width Ds +.It Fl c Ar cachefile +.It Fl cache= Ns Ar cachefile +The cache file to remove. +.El +.Sh SEE ALSO +.Xr kinit 1 , +.Xr klist 1 diff --git a/kuser/kinit.1 b/kuser/kinit.1 new file mode 100644 index 000000000..e8f74d82f --- /dev/null +++ b/kuser/kinit.1 @@ -0,0 +1,44 @@ +.\" $Id$ +.\" +.Dd Aug 27, 1997 +.Dt KINIT 1 +.Os HEIMDAL +.Sh NAME +.Nm kinit +.Nd +acquire initial tickets +.Sh SYNOPSIS +.Nm +.Op Fl f +.Op Fl -forwardable +.Op Fl r +.Op Fl -renewable +.Op Fl l Ar lifetime +.Op Fl -lifetime= Ns Ar lifetime +.Op Ar principal +.Sh DESCRIPTION +.Nm +is used to authenticate to the kerberos server as +.Ar principal , +or if none is given, a system generated default, and acquire a ticket +granting ticket that can later be used to obtain tickets for other +services. +.Pp +Options supported: +.Bl -tag -width Ds +.It Fl f +.It Fl -forwardable +Ask for forwardable tickets. +.It Fl r +.It Fl -renewable +Ask for renewable tickets. +.It Fl l Ar lifetime +.It Fl -lifetime= Ns Ar lifetime +Ask for tickets valids for +.Ar lifetime . +The default is in +.Xr /etc/krb5.conf 5 . +.Sh SEE ALSO +.Xr krb5.conf 5 , +.Xr klist 1 , +.Xr kdestroy 1 diff --git a/kuser/klist.1 b/kuser/klist.1 new file mode 100644 index 000000000..75900241c --- /dev/null +++ b/kuser/klist.1 @@ -0,0 +1,26 @@ +.\" $Id$ +.\" +.Dd Aug 27, 1997 +.Dt KLIST 1 +.Os HEIMDAL +.Sh NAME +.Nm klist +.Nd +list the current tickets +.Sh SYNOPSIS +.Nm +.Op Fl v +.Op Fl -verbose +.Sh DESCRIPTION +.Nm +reads and displays the current tickets in the ticket file. +.Pp +Options supported: +.Bl -tag -width Ds +.It Fl v +.It Fl -verbose +Verbose output. Include all information from tickets. +.El +.Sh SEE ALSO +.Xr kinit 1 , +.Xr kdestroy 1