xref: /freebsd/crypto/heimdal/lib/kadm5/iprop-log.8 (revision 9a14aa017b21c292740c00ee098195cd46642730)
1.\" $Id: iprop-log.8 21713 2007-07-27 14:38:49Z lha $
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: iprop-log.8 21713 2007-07-27 14:38:49Z lha $
35.\"
36.Dd February 18, 2007
37.Dt IPROP-LOG 8
38.Os Heimdal
39.Sh NAME
40.Nm iprop-log
41.Nd
42maintain 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
84Supported options:
85.Bl -tag -width Ds
86.It Xo
87.Fl -version
88.Xc
89.It Xo
90.Fl h ,
91.Fl -help
92.Xc
93.El
94.Pp
95command can be one of the following:
96.Bl -tag -width truncate
97.It truncate
98.Bl -tag -width Ds
99.It Xo
100.Fl c Ar file ,
101.Fl -config-file= Ns Ar file
102.Xc
103configuration file
104.It Xo
105.Fl r Ar string ,
106.Fl -realm= Ns Ar string
107.Xc
108realm
109.El
110.Pp
111Truncates the log. Sets the new logs version number for the to the
112last entry of the old log.  If the log is truncted by emptying the
113file, the log will start over at the first version (0).
114.It dump
115.Bl -tag -width Ds
116.It Xo
117.Fl c Ar file ,
118.Fl -config-file= Ns Ar file
119.Xc
120configuration file
121.It Xo
122.Fl r Ar string ,
123.Fl -realm= Ns Ar string
124.Xc
125realm
126.El
127.Pp
128Print out all entires in the log to standard output.
129.It replay
130.Bl -tag -width Ds
131.It Xo
132.Fl -start-version= Ns Ar version-number
133.Xc
134start replay with this version
135.It Xo
136.Fl -end-version= Ns Ar version-number
137.Xc
138end replay with this version
139.It Xo
140.Fl c Ar file ,
141.Fl -config-file= Ns Ar file
142.Xc
143configuration file
144.It Xo
145.Fl r Ar string ,
146.Fl -realm= Ns Ar string
147.Xc
148realm
149.El
150.Pp
151Replay the changes from specified entries (or all if none is
152specified) in the transaction log to the database.
153.It last-version
154.Bl -tag -width Ds
155.It Xo
156.Fl c Ar file ,
157.Fl -config-file= Ns Ar file
158.Xc
159configuration file
160.It Xo
161.Fl r Ar string ,
162.Fl -realm= Ns Ar string
163.Xc
164realm
165.El
166.Pp
167prints the version of the last log entry.
168.El
169.Sh SEE ALSO
170.Xr iprop 8
171