crypto/heimdal/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 maintain the iprop log file
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl Fl version
  45 .Op Fl h | Fl Fl help
  46 .Ar command
  47 .Pp
  48 .Nm iprop-log truncate
  49 .Oo Fl c Ar file \*(Ba Xo
  50 .Fl Fl config-file= Ns Ar file
  51 .Xc
  52 .Oc
  53 .Oo Fl r Ar string \*(Ba Xo
  54 .Fl Fl realm= Ns Ar string
  55 .Xc
  56 .Oc
  57 .Op Fl h | Fl Fl help
  58 .Pp
  59 .Nm iprop-log dump
  60 .Oo Fl c Ar file \*(Ba Xo
  61 .Fl Fl config-file= Ns Ar file
  62 .Xc
  63 .Oc
  64 .Oo Fl r Ar string \*(Ba Xo
  65 .Fl Fl realm= Ns Ar string
  66 .Xc
  67 .Oc
  68 .Op Fl h | Fl Fl help
  69 .Pp
  70 .Nm iprop-log replay
  71 .Op Fl Fl start-version= Ns Ar version-number
  72 .Op Fl Fl end-version= Ns Ar version-number
  73 .Oo Fl c Ar file \*(Ba Xo
  74 .Fl Fl config-file= Ns Ar file
  75 .Xc
  76 .Oc
  77 .Oo Fl r Ar string \*(Ba Xo
  78 .Fl Fl realm= Ns Ar string
  79 .Xc
  80 .Oc
  81 .Op Fl h | Fl Fl help
  82 .Sh DESCRIPTION
  83 Supported options:
  84 .Bl -tag -width Ds
  85 .It Fl Fl version
  86 .It Fl h , Fl Fl help
  87 .El
  88 .Pp
  89 command can be one of the following:
  90 .Bl -tag -width truncate
  91 .It truncate
  92 .Bl -tag -width Ds
  93 .It Fl c Ar file , Fl Fl config-file= Ns Ar file
  94 configuration file
  95 .It Fl r Ar string , Fl Fl realm= Ns Ar string
  96 realm
  97 .El
  98 .Pp
  99 Truncates the log. Sets the new logs version number for the to the
 100 last entry of the old log.  If the log is truncted by emptying the
 101 file, the log will start over at the first version (0).
 102 .It dump
 103 .Bl -tag -width Ds
 104 .It Fl c Ar file , Fl Fl config-file= Ns Ar file
 105 configuration file
 106 .It Xo
 107 .Fl r Ar string ,
 108 .Fl Fl realm= Ns Ar string
 109 .Xc
 110 realm
 111 .El
 112 .Pp
 113 Print out all entries in the log to standard output.
 114 .It replay
 115 .Bl -tag -width Ds
 116 .It Fl Fl start-version= Ns Ar version-number
 117 start replay with this version
 118 .It Xo
 119 .Fl Fl end-version= Ns Ar version-number
 120 .Xc
 121 end replay with this version
 122 .It Fl c Ar file , Fl Fl config-file= Ns Ar file
 123 configuration file
 124 .It Fl r Ar string , Fl Fl realm= Ns Ar string
 125 realm
 126 .El
 127 .Pp
 128 Replay the changes from specified entries (or all if none is
 129 specified) in the transaction log to the database.
 130 .It last-version
 131 .Bl -tag -width Ds
 132 .It Fl c Ar file , Fl Fl config-file= Ns Ar file
 133 configuration file
 134 .It Fl r Ar string , Fl Fl realm= Ns Ar string
 135 realm
 136 .El
 137 .Pp
 138 prints the version of the last log entry.
 139 .El
 140 .Sh SEE ALSO
 141 .Xr iprop 8