xref: /freebsd/crypto/heimdal/lib/kadm5/iprop-log.8 (revision 6a068746777241722b2b32c5d0bc443a2a64d80b)

.\" $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 Heimdal
.Sh NAME
.Nm iprop-log
.Nd 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
.Op Fl h | Fl Fl help
.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
.Op Fl h | Fl Fl help
.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
.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
.El
.Pp
Truncates the log. Sets the new logs version number for the to the
last entry of the old log.  If the log is truncted by emptying the
file, the log will start over at the first version (0).
.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
.El
.Pp
Print out all entries in the log to standard output.
.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 transaction log 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
.El
.Pp
prints the version of the last log entry.
.El
.Sh SEE ALSO
.Xr iprop 8