lib/kadm5/iprop-log.8

   1 .\" $Id$
   2 .\"
   3 .\" Copyright (c) 2005 - 2007 Kungliga Tekniska Högskolan
   4 .\" (Royal Institute of Technology, Stockholm, Sweden).
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" 3. Neither the name of the Institute nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     $Id$
  35 .\"
  36 .Dd February 18, 2007
  37 .Dt IPROP-LOG 8
  38 .Os Heimdal
  39 .Sh NAME
  40 .Nm iprop-log
  41 .Nd
  42 maintain the iprop log file
  43 .Sh SYNOPSIS
  44 .Nm
  45 .Op Fl -version
  46 .Op Fl h | Fl -help
  47 .Ar command
  48 .Pp
  49 .Nm iprop-log truncate
  50 .Oo Fl c Ar file \*(Ba Xo
  51 .Fl -config-file= Ns Ar file
  52 .Xc
  53 .Oc
  54 .Oo Fl r Ar string \*(Ba Xo
  55 .Fl -realm= Ns Ar string
  56 .Xc
  57 .Oc
  58 .Op Fl h | Fl -help
  59 .Pp
  60 .Nm iprop-log dump
  61 .Oo Fl c Ar file \*(Ba Xo
  62 .Fl -config-file= Ns Ar file
  63 .Xc
  64 .Oc
  65 .Oo Fl r Ar string \*(Ba Xo
  66 .Fl -realm= Ns Ar string
  67 .Xc
  68 .Oc
  69 .Op Fl h | Fl -help
  70 .Pp
  71 .Nm iprop-log replay
  72 .Op Fl -start-version= Ns Ar version-number
  73 .Op Fl -end-version= Ns Ar version-number
  74 .Oo Fl c Ar file \*(Ba Xo
  75 .Fl -config-file= Ns Ar file
  76 .Xc
  77 .Oc
  78 .Oo Fl r Ar string \*(Ba Xo
  79 .Fl -realm= Ns Ar string
  80 .Xc
  81 .Oc
  82 .Op Fl h | Fl -help
  83 .Sh DESCRIPTION
  84 Supported options:
  85 .Bl -tag -width Ds
  86 .It Fl -version
  87 .It Fl h , Fl -help
  88 .El
  89 .Pp
  90 command can be one of the following:
  91 .Bl -tag -width truncate
  92 .It truncate
  93 .Bl -tag -width Ds
  94 .It Fl c Ar file , Fl -config-file= Ns Ar file
  95 configuration file
  96 .It Fl r Ar string , Fl -realm= Ns Ar string
  97 realm
  98 .El
  99 .Pp
 100 Truncates the log. Sets the new logs version number for the to the
 101 last entry of the old log.  If the log is truncted by emptying the
 102 file, the log will start over at the first version (0).
 103 .It dump
 104 .Bl -tag -width Ds
 105 .It Fl c Ar file , Fl -config-file= Ns Ar file
 106 configuration file
 107 .It Xo
 108 .Fl r Ar string ,
 109 .Fl -realm= Ns Ar string
 110 .Xc
 111 realm
 112 .El
 113 .Pp
 114 Print out all entries in the log to standard output.
 115 .It replay
 116 .Bl -tag -width Ds
 117 .It Fl -start-version= Ns Ar version-number
 118 start replay with this version
 119 .It Xo
 120 .Fl -end-version= Ns Ar version-number
 121 .Xc
 122 end replay with this version
 123 .It Fl c Ar file , Fl -config-file= Ns Ar file
 124 configuration file
 125 .It Fl r Ar string , Fl -realm= Ns Ar string
 126 realm
 127 .El
 128 .Pp
 129 Replay the changes from specified entries (or all if none is
 130 specified) in the transaction log to the database.
 131 .It last-version
 132 .Bl -tag -width Ds
 133 .It Fl c Ar file , Fl -config-file= Ns Ar file
 134 configuration file
 135 .It Fl r Ar string , Fl -realm= Ns Ar string
 136 realm
 137 .El
 138 .Pp
 139 prints the version of the last log entry.
 140 .El
 141 .Sh SEE ALSO
 142 .Xr iprop 8