dbck.8 5.45 KB
Newer Older
1
.\" $Id: dbck.8,v 1.13 1996/06/09 13:49:05 byers Exp $
Per Cederqvist's avatar
Per Cederqvist committed
2
.\" Copyright (C) 1991, 1992  Lysator Academic Computer Association.
Linus Tolke's avatar
Linus Tolke committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
.\"
.\" This file is part of the LysKOM server.
.\" 
.\" LysKOM is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License as published by 
.\" the Free Software Foundation; either version 1, or (at your option) 
.\" any later version.
.\" 
.\" LysKOM is distributed in the hope that it will be useful, but WITHOUT
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
.\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
.\" for more details.
.\" 
.\" You should have received a copy of the GNU General Public License
.\" along with LysKOM; see the file COPYING.  If not, write to
.\" Lysator, c/o ISY, Linkoping University, S-581 83 Linkoping, SWEDEN,
.\" or the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, 
.\" MA 02139, USA.
.\"
.\" Please mail bug reports to bug-lyskom@lysator.liu.se. 
.\"
24
25
.\" $Id: dbck.8,v 1.13 1996/06/09 13:49:05 byers Exp $
.\" $Date: 1996/06/09 13:49:05 $
Linus Tolke's avatar
Linus Tolke committed
26
27
.TH dbck 8 "August 22, 1991"
.SH NAME
Linus Tolke's avatar
Linus Tolke committed
28
29
dbck - reports and corrects errors in the LysKOM database. This
program is also used remove unreferenced texts from the texts file.
Linus Tolke's avatar
Linus Tolke committed
30
31
32
.SH SYNOPSIS
.B /usr/lyskom/bin/dbck 
[
33
.B options
Linus Tolke's avatar
Linus Tolke committed
34
] [
Per Cederqvist's avatar
Per Cederqvist committed
35
.I config_file
Linus Tolke's avatar
Linus Tolke committed
36
37
]
.SH DESCRIPTION
Linus Tolke's avatar
Linus Tolke committed
38
This program should be run after something has happened that has made the
39
40
database corrupted.  It can only be used for some other database
maintenance.
Linus Tolke's avatar
Linus Tolke committed
41
.PP
Linus Tolke's avatar
Linus Tolke committed
42
43
44
45
46
47
48
49
It fixes the database, checking all references.
.PP
With argument
.B -g
the file with texts are rewritten without all unreferenced texts and
all pointers are adjusted. This does only happen if the database was
correct.
.PP
Per Cederqvist's avatar
Per Cederqvist committed
50
The database is only modified if at least one of the options
51
52
53
.B -r ", " -i ,
or any of the options that explicitly manipulate the database
are given.  
Per Cederqvist's avatar
Per Cederqvist committed
54
Otherwise, it is only checked and any detected errors are reported.
David Byers's avatar
David Byers committed
55
56
57
58
.PP
The option
.B -F
forces the database to be written even if no modifications have been made.
Linus Tolke's avatar
Linus Tolke committed
59
.SH OPTIONS
60
Both the short and long form of the opions are given below.
Linus Tolke's avatar
Linus Tolke committed
61
.TP
62
63
64
65
.B \-h \-\-help
Give a usage message (which includes the version number and the
compiled-in default location of the config file) and exit
immediately.
Linus Tolke's avatar
Linus Tolke committed
66
.TP
67
68
69
70
71
72
.B \-i \-\-interactive
Run interactively.
If any inconsistency is found, a remedial cure will be suggested, and
the user must confirm if he wants the action to be taken or not.
.TP
.B \-r \-\-auto\-repair
Linus Tolke's avatar
Linus Tolke committed
73
74
Repair simple errors without asking.
.TP
75
.B \-v \-\-verbose
Linus Tolke's avatar
Linus Tolke committed
76
77
78
Verbose mode. Report not only errors but other statuses of the
database.
.TP
79
.B \-g \-\-compact\-text\-mass
Linus Tolke's avatar
Linus Tolke committed
80
81
82
Do the garbage collect of the texts part of the database. This is
sometimes called a compression of the text but it only removes
non-referenced texts.
Per Cederqvist's avatar
Per Cederqvist committed
83
.TP
84
.B \-s \-\-print\-statistics
Per Cederqvist's avatar
Per Cederqvist committed
85
86
Gather statistics about the lengths of texts. A table containing
the frequency of all lenghts that is currently used is printed.
Per Cederqvist's avatar
Per Cederqvist committed
87
.TP
88
.B \-t \-\-list\-text\-no
Per Cederqvist's avatar
Per Cederqvist committed
89
90
91
92
93
Print
.B Checking text_no
.I T
for each text number
.I T
94
that exists.  Warning: this generates lots of output!
Per Cederqvist's avatar
Per Cederqvist committed
95
.TP
96
.B \-c \-\-set\-change\-name
Per Cederqvist's avatar
Per Cederqvist committed
97
98
99
100
101
102
Consider it an error if the
.B change_name
capability of a person is not set.  
Due to a bug, that capability was never set for newly created persons
in release 1.6.1 of lyskomd.  This option can be used to repair the
damage.
David Byers's avatar
David Byers committed
103
.TP
104
105
106
107
108
109
110
111
112
.BI \-P " pers_no " \-\-clear-password= pers_no
Clear the password of the specified user.  
This option is silently ignored if the user doesn't exist.
.TP
.BI \-G " pers_no " \-\-grant-all= pers_no
Grant all privileges to the specified user.
This option is silently ignored if the user doesn't exist.
.TP
.BI \-o " format " \-\-output\-version= " format "
David Byers's avatar
David Byers committed
113
114
Select output format. Valid formats are 1 or 0.
.TP
115
.B \-F  \-\-force\-output
David Byers's avatar
David Byers committed
116
117
118
Force output. Always write a new data file even if no modifications
have been made. This is useful for converting between different
database formats.
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
.B \-\-pers-pres-conf= " conf-no "
Set the conference for person presentations. This option overrides the
configuration file and the database file.
.B \-\-conf-pres-conf= " conf-no "
Set the conference for conference presentations. This option overrides
the configuration file and the database file.
.B \-\-motd-conf= " conf-no "
Set the conference for lapps on doors. This option overrides the
configuration file and the database file.
.B \-\-kom-news-conf= " conf-no "
Set the conference for news about LysKOM. This option overries the
configuration file and the database file.
.B \-\-motd-of-kom= " text-no "
Set the login message of LysKOM. This option overrides the
configuration file and the database file.
Linus Tolke's avatar
Linus Tolke committed
134
135
136
137
.SH NOTES
The messages
.I Conference <confno> has a bad Text-list. Starts with 0
and
138
139
140
141
.I Person <persno> has created <number> conferences, not <number> 
.RI ( as
.I said in
.IR person-stat ).
Linus Tolke's avatar
Linus Tolke committed
142
143
144
145
146
147
148
are normal. If you get them when you specify
.B -g,
let
.B dbck
fix them and run
.B dbck -g
again.
Linus Tolke's avatar
Linus Tolke committed
149
150
151
.SH FILES
.TP 20
.B /usr/lyskom
Per Cederqvist's avatar
Per Cederqvist committed
152
153
154
Default database directory, unless the
.I config_file
specifies something different.
Linus Tolke's avatar
Linus Tolke committed
155
.TP
Linus Tolke's avatar
Linus Tolke committed
156
.IB database-directory /db/ramkomd-data
Linus Tolke's avatar
Linus Tolke committed
157
158
File with all the elements and pointers.
.TP
Linus Tolke's avatar
Linus Tolke committed
159
.IB database-directory /db/ramkomd-texts
Linus Tolke's avatar
Linus Tolke committed
160
161
File with the texts.
.TP
Linus Tolke's avatar
Linus Tolke committed
162
.IB database-directory /db/ramkomd-backup
Linus Tolke's avatar
Linus Tolke committed
163
164
Backup file of
.B ramkomd-data.
Linus Tolke's avatar
Linus Tolke committed
165
.SH BUGS
Linus Tolke's avatar
Linus Tolke committed
166
167
168
169
170
Does not lock the database.
.PP
Does never check if the database is locked.
.PP
Should have an unlock database option.
Linus Tolke's avatar
Linus Tolke committed
171
172
173
174
175
176
.PP
Does not check that 
.B ramkomd-data
and
.B ramkomd-texts
are consistent.
Linus Tolke's avatar
Linus Tolke committed
177
178
.SH AUTHOR
Per Cederqvist <ceder@lysator.liu.se>