third_party/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
  39 .Sh NAME
  40 .Nm iprop-log
  41 .Nd examine and 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 .Oo Fl K Ar integer \*(Ba Xo
  58 .Fl Fl keep-entries= Ns Ar integer
  59 .Xc
  60 .Oc
  61 .Oo Fl B Ar integer \*(Ba Xo
  62 .Fl Fl max-bytes= Ns Ar integer
  63 .Xc
  64 .Oc
  65 .Oo Fl R \*(Ba Xo
  66 .Fl Fl reset
  67 .Xc
  68 .Oc
  69 .Op Fl h | Fl Fl help
  70 .Op Ar log-file
  71 .Pp
  72 .Nm iprop-log dump
  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 .Oo Fl n \*(Ba Xo
  82 .Fl Fl no-lock
  83 .Xc
  84 .Oc
  85 .Oo Fl R \*(Ba Xo
  86 .Fl Fl reverse
  87 .Xc
  88 .Oc
  89 .Op Fl h | Fl Fl help
  90 .Op Ar log-file
  91 .Pp
  92 .Nm iprop-log replay
  93 .Op Fl Fl start-version= Ns Ar version-number
  94 .Op Fl Fl end-version= Ns Ar version-number
  95 .Oo Fl c Ar file \*(Ba Xo
  96 .Fl Fl config-file= Ns Ar file
  97 .Xc
  98 .Oc
  99 .Oo Fl r Ar string \*(Ba Xo
 100 .Fl Fl realm= Ns Ar string
 101 .Xc
 102 .Oc
 103 .Op Fl h | Fl Fl help
 104 .Op Ar log-file
 105 .Pp
 106 .Nm iprop-log last-version
 107 .Oo Fl c Ar file \*(Ba Xo
 108 .Fl Fl config-file= Ns Ar file
 109 .Xc
 110 .Oc
 111 .Oo Fl r Ar string \*(Ba Xo
 112 .Fl Fl realm= Ns Ar string
 113 .Xc
 114 .Oc
 115 .Oo Fl n \*(Ba Xo
 116 .Fl Fl no-lock
 117 .Xc
 118 .Oc
 119 .Op Fl h | Fl Fl help
 120 .Op Ar log-files
 121 .Pp
 122 .Nm iprop-log signal
 123 .Oo Fl c Ar file \*(Ba Xo
 124 .Fl Fl config-file= Ns Ar file
 125 .Xc
 126 .Oc
 127 .Oo Fl r Ar string \*(Ba Xo
 128 .Fl Fl realm= Ns Ar string
 129 .Xc
 130 .Oc
 131 .Op Fl h | Fl Fl help
 132 .Pp
 133 .Sh DESCRIPTION
 134 Supported options:
 135 .Bl -tag -width Ds
 136 .It Fl Fl version
 137 .It Fl h , Fl Fl help
 138 .El
 139 .Pp
 140 command can be one of the following:
 141 .Bl -tag -width truncate
 142 .It truncate
 143 .Bl -tag -width Ds
 144 .It Fl c Ar file , Fl Fl config-file= Ns Ar file
 145 configuration file
 146 .It Fl r Ar string , Fl Fl realm= Ns Ar string
 147 realm
 148 .It Xo
 149 .Fl K Ar integer ,
 150 .Fl Fl keep-entries= Ns Ar integer
 151 .Xc
 152 .It Xo
 153 .Fl B Ar integer ,
 154 .Fl Fl max-bytes= Ns Ar integer
 155 .Xc
 156 .It Xo
 157 .Fl R ,
 158 .Fl Fl reset
 159 .Xc
 160 .El
 161 .Pp
 162 If
 163 .Fl Fl reset
 164 is given, then the given, configured, or default log file will be
 165 truncated and will start at version 1.  This forces full propagations to
 166 all slave KDCs.
 167 .Pp
 168 Otherwise the log will be truncated but some entries will be preserved,
 169 as specified by the
 170 .Fl Fl keep-entries
 171 and/or
 172 .Fl Fl max-bytes
 173 options.  The largest number of
 174 .Fl Fl keep-entries
 175 entries that are available and fit in the given
 176 .Fl Fl max-bytes
 177 option will be used.  The
 178 .Fl Fl keep-entries option defaults to 100, and the
 179 .Fl Fl max-bytes
 180 option defaults to the
 181 .Ar log-max-size
 182 parameter in the configuration.
 183 .Pp
 184 .It dump
 185 .Bl -tag -width Ds
 186 .It Fl c Ar file , Fl Fl config-file= Ns Ar file
 187 configuration file
 188 .It Xo
 189 .Fl r Ar string ,
 190 .Fl Fl realm= Ns Ar string
 191 .Xc
 192 realm
 193 .It Xo
 194 .Fl n Ar string ,
 195 .Fl Fl no-lock
 196 .Xc
 197 .It Xo
 198 .Fl R Ar string ,
 199 .Fl Fl reverse
 200 .Xc
 201 .El
 202 .Pp
 203 Print out all entries in the given, configured, or default log file to
 204 standard output.  If the
 205 .Fl n
 206 option is used then don't lock the iprop log file.  If the
 207 .Fl R
 208 option is used, then print the entries in reverse order
 209 (this can be useful when the log is very large).
 210 .It replay
 211 .Bl -tag -width Ds
 212 .It Fl Fl start-version= Ns Ar version-number
 213 start replay with this version
 214 .It Xo
 215 .Fl Fl end-version= Ns Ar version-number
 216 .Xc
 217 end replay with this version
 218 .It Fl c Ar file , Fl Fl config-file= Ns Ar file
 219 configuration file
 220 .It Fl r Ar string , Fl Fl realm= Ns Ar string
 221 realm
 222 .El
 223 .Pp
 224 Replay the changes from specified entries (or all if none is specified)
 225 in the given, configured, or default transaction log file to the
 226 database.
 227 .It last-version
 228 .Bl -tag -width Ds
 229 .It Fl c Ar file , Fl Fl config-file= Ns Ar file
 230 configuration file
 231 .It Fl r Ar string , Fl Fl realm= Ns Ar string
 232 realm
 233 .It Xo
 234 .Fl n Ar string ,
 235 .Fl Fl no-lock
 236 .Xc
 237 .El
 238 .Pp
 239 prints the version of the last record in each of the given log files, or
 240 the configured, or the default log file if none is given.
 241 .It signal
 242 .Bl -tag -width Ds
 243 .It Fl c Ar file , Fl Fl config-file= Ns Ar file
 244 configuration file
 245 .It Fl r Ar string , Fl Fl realm= Ns Ar string
 246 realm
 247 .El
 248 .Pp
 249 Signals the ipropd-master daemon to send updates to slaves.  Normally
 250 kadmin does this every time it writes to the database, so this should
 251 rarely be needed.
 252 .El
 253 .Sh SEE ALSO
 254 .Xr iprop 8