.\" $Id$
.\"
.\" Copyright (c) 2005 - 2007 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 February 18, 2007
.Dt IPROP-LOG 8
.Os
.Sh NAME
.Nm iprop-log
.Nd examine and maintain the iprop log file
.Sh SYNOPSIS
.Nm
.Op Fl Fl version
.Op Fl h | Fl Fl help
.Ar command
.Pp
.Nm iprop-log truncate
.Oo Fl c Ar file \*(Ba Xo
.Fl Fl config-file= Ns Ar file
.Xc
.Oc
.Oo Fl r Ar string \*(Ba Xo
.Fl Fl realm= Ns Ar string
.Xc
.Oc
.Oo Fl K Ar integer \*(Ba Xo
.Fl Fl keep-entries= Ns Ar integer
.Xc
.Oc
.Oo Fl B Ar integer \*(Ba Xo
.Fl Fl max-bytes= Ns Ar integer
.Xc
.Oc
.Oo Fl R \*(Ba Xo
.Fl Fl reset
.Xc
.Oc
.Op Fl h | Fl Fl help
.Op Ar log-file
.Pp
.Nm iprop-log dump
.Oo Fl c Ar file \*(Ba Xo
.Fl Fl config-file= Ns Ar file
.Xc
.Oc
.Oo Fl r Ar string \*(Ba Xo
.Fl Fl realm= Ns Ar string
.Xc
.Oc
.Oo Fl n \*(Ba Xo
.Fl Fl no-lock
.Xc
.Oc
.Oo Fl R \*(Ba Xo
.Fl Fl reverse
.Xc
.Oc
.Op Fl h | Fl Fl help
.Op Ar log-file
.Pp
.Nm iprop-log replay
.Op Fl Fl start-version= Ns Ar version-number
.Op Fl Fl end-version= Ns Ar version-number
.Oo Fl c Ar file \*(Ba Xo
.Fl Fl config-file= Ns Ar file
.Xc
.Oc
.Oo Fl r Ar string \*(Ba Xo
.Fl Fl realm= Ns Ar string
.Xc
.Oc
.Op Fl h | Fl Fl help
.Op Ar log-file
.Pp
.Nm iprop-log last-version
.Oo Fl c Ar file \*(Ba Xo
.Fl Fl config-file= Ns Ar file
.Xc
.Oc
.Oo Fl r Ar string \*(Ba Xo
.Fl Fl realm= Ns Ar string
.Xc
.Oc
.Oo Fl n \*(Ba Xo
.Fl Fl no-lock
.Xc
.Oc
.Op Fl h | Fl Fl help
.Op Ar log-files
.Pp
.Nm iprop-log signal
.Oo Fl c Ar file \*(Ba Xo
.Fl Fl config-file= Ns Ar file
.Xc
.Oc
.Oo Fl r Ar string \*(Ba Xo
.Fl Fl realm= Ns Ar string
.Xc
.Oc
.Op Fl h | Fl Fl help
.Pp
.Sh DESCRIPTION
Supported options:
.Bl -tag -width Ds
.It Fl Fl version
.It Fl h , Fl Fl help
.El
.Pp
command can be one of the following:
.Bl -tag -width truncate
.It truncate
.Bl -tag -width Ds
.It Fl c Ar file , Fl Fl config-file= Ns Ar file
configuration file
.It Fl r Ar string , Fl Fl realm= Ns Ar string
realm
.It Xo
.Fl K Ar integer ,
.Fl Fl keep-entries= Ns Ar integer
.Xc
.It Xo
.Fl B Ar integer ,
.Fl Fl max-bytes= Ns Ar integer
.Xc
.It Xo
.Fl R ,
.Fl Fl reset
.Xc
.El
.Pp
If
.Fl Fl reset
is given, then the given, configured, or default log file will be
truncated and will start at version 1.  This forces full propagations to
all slave KDCs.
.Pp
Otherwise the log will be truncated but some entries will be preserved,
as specified by the
.Fl Fl keep-entries
and/or
.Fl Fl max-bytes
options.  The largest number of
.Fl Fl keep-entries
entries that are available and fit in the given
.Fl Fl max-bytes
option will be used.  The
.Fl Fl keep-entries option defaults to 100, and the
.Fl Fl max-bytes
option defaults to the
.Ar log-max-size
parameter in the configuration.
.Pp
.It dump
.Bl -tag -width Ds
.It Fl c Ar file , Fl Fl config-file= Ns Ar file
configuration file
.It Xo
.Fl r Ar string ,
.Fl Fl realm= Ns Ar string
.Xc
realm
.It Xo
.Fl n Ar string ,
.Fl Fl no-lock
.Xc
.It Xo
.Fl R Ar string ,
.Fl Fl reverse
.Xc
.El
.Pp
Print out all entries in the given, configured, or default log file to
standard output.  If the
.Fl n
option is used then don't lock the iprop log file.  If the
.Fl R
option is used, then print the entries in reverse order
(this can be useful when the log is very large).
.It replay
.Bl -tag -width Ds
.It Fl Fl start-version= Ns Ar version-number
start replay with this version
.It Xo
.Fl Fl end-version= Ns Ar version-number
.Xc
end replay with this version
.It Fl c Ar file , Fl Fl config-file= Ns Ar file
configuration file
.It Fl r Ar string , Fl Fl realm= Ns Ar string
realm
.El
.Pp
Replay the changes from specified entries (or all if none is specified)
in the given, configured, or default transaction log file to the
database.
.It last-version
.Bl -tag -width Ds
.It Fl c Ar file , Fl Fl config-file= Ns Ar file
configuration file
.It Fl r Ar string , Fl Fl realm= Ns Ar string
realm
.It Xo
.Fl n Ar string ,
.Fl Fl no-lock
.Xc
.El
.Pp
prints the version of the last record in each of the given log files, or
the configured, or the default log file if none is given.
.It signal
.Bl -tag -width Ds
.It Fl c Ar file , Fl Fl config-file= Ns Ar file
configuration file
.It Fl r Ar string , Fl Fl realm= Ns Ar string
realm
.El
.Pp
Signals the ipropd-master daemon to send updates to slaves.  Normally
kadmin does this every time it writes to the database, so this should
rarely be needed.
.El
.Sh SEE ALSO
.Xr iprop 8