diff --git a/doc/man/dbck.8 b/doc/man/dbck.8 index 8b7d4257355eb88be9e478ee9e2325d657b4b74b..ecb1fb13167ad98d60fb157cb4b64da0efa94b85 100644 --- a/doc/man/dbck.8 +++ b/doc/man/dbck.8 @@ -1,26 +1,50 @@ -.\" $Id: dbck.8,v 1.1 1991/08/22 19:55:33 linus Exp $ -.\" $Date: 1991/08/22 19:55:33 $ +.\" $Id: dbck.8,v 1.2 1991/08/22 21:15:38 linus Exp $ +.\" $Date: 1991/08/22 21:15:38 $ .TH dbck 8 "August 22, 1991" .SH NAME -dbck - checks and fixes the database up, removes unreferenced texts -from the texts file. +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 -Dirvg +.B -D +.I database-directory +] [ +.B -irvg ] .SH DESCRIPTION -This program is run after something has happened that has made the +This program should be run after something has happened that has made the database corrupted. .PP -It fixes the database, checking all references, rewriting the file -with all the text. +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 +If none of the options +.B -r +or +.B -g +are given the database is not changed. .SH OPTIONS .TP -.BI \-D " database directory" +.BI \-D " database-directory" Use the database in the -.I database directory +.I database-directory as the target of the checkup. +.br +Example: If your database is in +.ft B +$HOME/lyskom/db +.ft R +you should use the command +.ft B +.br +/usr/lyskom/bin/dbck -D $HOME/lyskom +.ft R .TP .B \-i Run interactively asking the user questions. @@ -36,7 +60,24 @@ database. 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. +.SH FILES +.TP 20 +.B /usr/lyskom +Default database directory. +.TP +.RB database-directory /db/ramkomd-data +File with all the elements and pointers. +.TP +.RB database-directory /db/ramkomd-texts +File with the texts. +.TP +.RB database-directory /db/ramkomd-backup +Backup file with all data. .SH BUGS +Does not lock the database. +.PP +Does never check if the database is locked. +.PP +Should have an unlock database option. .SH AUTHOR Per Cederqvist <ceder@lysator.liu.se> - diff --git a/doc/man/man8/dbck.8 b/doc/man/man8/dbck.8 index 8b7d4257355eb88be9e478ee9e2325d657b4b74b..ecb1fb13167ad98d60fb157cb4b64da0efa94b85 100644 --- a/doc/man/man8/dbck.8 +++ b/doc/man/man8/dbck.8 @@ -1,26 +1,50 @@ -.\" $Id: dbck.8,v 1.1 1991/08/22 19:55:33 linus Exp $ -.\" $Date: 1991/08/22 19:55:33 $ +.\" $Id: dbck.8,v 1.2 1991/08/22 21:15:38 linus Exp $ +.\" $Date: 1991/08/22 21:15:38 $ .TH dbck 8 "August 22, 1991" .SH NAME -dbck - checks and fixes the database up, removes unreferenced texts -from the texts file. +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 -Dirvg +.B -D +.I database-directory +] [ +.B -irvg ] .SH DESCRIPTION -This program is run after something has happened that has made the +This program should be run after something has happened that has made the database corrupted. .PP -It fixes the database, checking all references, rewriting the file -with all the text. +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 +If none of the options +.B -r +or +.B -g +are given the database is not changed. .SH OPTIONS .TP -.BI \-D " database directory" +.BI \-D " database-directory" Use the database in the -.I database directory +.I database-directory as the target of the checkup. +.br +Example: If your database is in +.ft B +$HOME/lyskom/db +.ft R +you should use the command +.ft B +.br +/usr/lyskom/bin/dbck -D $HOME/lyskom +.ft R .TP .B \-i Run interactively asking the user questions. @@ -36,7 +60,24 @@ database. 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. +.SH FILES +.TP 20 +.B /usr/lyskom +Default database directory. +.TP +.RB database-directory /db/ramkomd-data +File with all the elements and pointers. +.TP +.RB database-directory /db/ramkomd-texts +File with the texts. +.TP +.RB database-directory /db/ramkomd-backup +Backup file with all data. .SH BUGS +Does not lock the database. +.PP +Does never check if the database is locked. +.PP +Should have an unlock database option. .SH AUTHOR Per Cederqvist <ceder@lysator.liu.se> -