dbck.8

.\" $Id: dbck.8,v 1.13 1996/06/09 13:49:05 byers Exp $
.\" Copyright (C) 1991, 1992  Lysator Academic Computer Association.
.\"
.\" 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. 
.\"
.\" $Id: dbck.8,v 1.13 1996/06/09 13:49:05 byers Exp $
.\" $Date: 1996/06/09 13:49:05 $
.TH dbck 8 "August 22, 1991"
.SH NAME
dbck - reports and corrects errors in the LysKOM database. This
program is also used remove unreferenced texts from the texts file.
.SH SYNOPSIS
.B /usr/lyskom/bin/dbck 
[
.B options
] [
.I config_file
]
.SH DESCRIPTION
This program should be run after something has happened that has made the
database corrupted.  It can only be used for some other database
maintenance.
.PP
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
The database is only modified if at least one of the options
.B -r ", " -i ,
or any of the options that explicitly manipulate the database
are given.  
Otherwise, it is only checked and any detected errors are reported.
.PP
The option
.B -F
forces the database to be written even if no modifications have been made.
.SH OPTIONS
Both the short and long form of the opions are given below.
.TP
.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.
.TP
.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
Repair simple errors without asking.
.TP
.B \-v \-\-verbose
Verbose mode. Report not only errors but other statuses of the
database.
.TP
.B \-g \-\-compact\-text\-mass
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.
.TP
.B \-s \-\-print\-statistics
Gather statistics about the lengths of texts. A table containing
the frequency of all lenghts that is currently used is printed.
.TP
.B \-t \-\-list\-text\-no
Print
.B Checking text_no
.I T
for each text number
.I T
that exists.  Warning: this generates lots of output!
.TP
.B \-c \-\-set\-change\-name
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.
.TP
.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 "
Select output format. Valid formats are 1 or 0.
.TP
.B \-F  \-\-force\-output
Force output. Always write a new data file even if no modifications
have been made. This is useful for converting between different
database formats.
.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.
.SH NOTES
The messages
.I Conference <confno> has a bad Text-list. Starts with 0
and
.I Person <persno> has created <number> conferences, not <number> 
.RI ( as
.I said in
.IR person-stat ).
are normal. If you get them when you specify
.B -g,
let
.B dbck
fix them and run
.B dbck -g
again.
.SH FILES
.TP 20
.B /usr/lyskom
Default database directory, unless the
.I config_file
specifies something different.
.TP
.IB database-directory /db/ramkomd-data
File with all the elements and pointers.
.TP
.IB database-directory /db/ramkomd-texts
File with the texts.
.TP
.IB database-directory /db/ramkomd-backup
Backup file of
.B ramkomd-data.
.SH BUGS
Does not lock the database.
.PP
Does never check if the database is locked.
.PP
Should have an unlock database option.
.PP
Does not check that 
.B ramkomd-data
and
.B ramkomd-texts
are consistent.
.SH AUTHOR
Per Cederqvist <ceder@lysator.liu.se>