Commit 4681dade authored by Per Cederqvist's avatar Per Cederqvist
Browse files

Documentation removed. Refer to lyskomdb.info.

parent 3e7fa8c1
.\" $Id: lyskom.5,v 1.6 1996/06/09 13:49:08 byers Exp $
.\" $Id: lyskom.5,v 1.7 1999/04/03 21:58:39 ceder Exp $
.\" Copyright (C) 1991 Lysator Academic Computer Association.
.\"
.\" This file is part of the LysKOM server.
......@@ -21,300 +21,16 @@
.\"
.\" Please mail bug reports to bug-lyskom@lysator.liu.se.
.\"
.\" $Id: lyskom.5,v 1.6 1996/06/09 13:49:08 byers Exp $
.\" $Date: 1996/06/09 13:49:08 $
.TH lyskom 5 "August 24, 1991"
.\" $Id: lyskom.5,v 1.7 1999/04/03 21:58:39 ceder Exp $
.\" $Date: 1999/04/03 21:58:39 $
.TH lyskom 5 "April 3, 1999"
.SH NAME
lyskom - LysKOM
.I database
format
.SH SYNOPSIS
.B /usr/lyskom/db/lyskomd-*
.br
and
.br
.B /usr/lyskom/etc/pid
.PP
.B #include <lyskom/kom-types.h>
.SH WARNING
This file and the data format it describes are obsolete starting with
version 1.9 of lyskomd.
.SH DISCLAIMER
The
.I database
is not really a database but a sequential file where all data is saved
from the memory.
.SH DESCRIPTION
There are 2 files: One file with all the data
.RB ( lyskomd-data ).
And one with all texts
.RB ( lyskomd-texts ).
The texts file does not contain any information about where any text
starts of ends, all this is in the data file together with other infos
on the text.
.PP
If the first five chars of the data file is CLEAN then the
.I database
is considered clean. If its anything else the
.BR lyskomd (8)
proglys will try to find the backupfile instead.
.PP
Then there is a number telling the number of the next free conference
.RI ( next_free_num ).
.PP
Now follows a list of all conferences. One conference on each line. If
the conference is deleted the line consists of a
.B @
otherwise it starts with a
.BR + .
.PP
Now follows a list of all person statuses. Here is also every person
on its own line and the deleted persons or the numbers that are not
persons but conferences are lines containing just a
.BR @ .
.PP
Both the conference status part and the person status part are exactly
.IR next_free_num -1
lines long.
.PP
Now follows the number of the next text that is not used and a list of
text statuses.
Every text status has its own line just like the other statuses and
non-existent texts are represented by the
.BI @ .
.PP
The different statuses types are
.B conference
.BR statuses ,
.B person statuses
and
.B text
.BR statuses .
These are in a struct in the include file but in this file they are
not saved as structs but every element is saved as a ascii string.
Strings are saved as holerith strings. The field of the struct is not
even saved in the same order as in the struct.
Their order in the database is followed below.
.PP
An array of things is represented in the database by a number telling
how many elements there are in the array and the either a
.B *
in the case no elements or a
.B {
followed by all the elements and a finishing
.BR } .
.SS Conference status
.LP
This contains all information for a conference. A conference is a
object that recieves texts.
.TP 15
.I Name
Name of the conference saved as a holerith string.
.TP
.I Member list
An array of the members in that conference.
.TP
.I First local number
This is the local number of the first text in the conference. Its
saved here in order to save space in this file by not mentioning all
deleted texts in the beginning of the conference.
.TP
.I Texts
This is an array of recieved texts. The local number of the text is
determined by the position in this list and the value of the
.I first local
.IR number .
.TP
.I Type
This is the type of the conf, it contains the infomation that says if
the conference is read protected, original flagged conference, secret,
or if its a letter box.
.TP
.I Creation time
The time the conference was created.
.TP
.I Last written
The time the last text was sent to the conference.
.TP
.I Creator
The number of the person that has created the conference. This is 0
for conferences that are created initially.
.TP
.I Presentation
This is the number of the text containing a presentation of the
conference. If there is no presentation this number is 0.
.TP
.I Supervisor
This is the number of the conference whose members are supervisors of
the conference. Initially this is set to be the number of the letter
box of the creator.
.TP
.I Permitted submitters
This is the number of the conference whose members are allowed to
submit texts to this conference. If this is 0 (the default) all
persons i
.B LysKOM
are allowed to submit.
.TP
.I Super conference
This is a number of a conference that comments to articles should be
sent to if this conference is original flagged.
.TP
.I Message of the day
This is the textnumber of the text containing a notice message about
the conference. Mostly used for letter boxes. If 0 then there is no
such message.
.TP
.I Garb nice
This is the number of days a text stays in the conference before it is
removed by the expiration routines. Its really the expiration rate.
.SS Person statuses
.LP
Person statuses contains all info about persons.
.TP 15
.I Password
The password is stored as a string. The length of the string is 64 but
the length of the password itself is stored as the first char in the
string. Passwords longer that 63 chars are truncated.
.TP
.I Username
This is the username and machine from the last time the person logged in.
.TP
.I Privileges
The persons privileges are stored here. This is a bit array, length is
16 bits. It is not really welldetemined what bit does what.
.TP
.I Personal flags
The persons flags are stored here.
.TP
.I First local number
This is the local number of the first created text that still exists
in the database. Its local to this list.
.TP
.I Created text list
This is an array of all created texts beginning at the first local
number.
.TP
.I Marked texts
This is an array of all marked texts and their mark type. Every
element in the array is a text number and a mark number.
.TP
.I Membership
Here is the information about which conferences the person is member
in. Its an array where every element is of the type
.B Membership
(See below).
.TP
.I Last login
Time of the last login.
.TP
.I User area
Number of the text being the persons user area. If there is no user
area this is 0.
.TP
.I Total time present
Time in
.B LysKOM
in seconds.
.TP
.I Sessions
Number of logins made for that person.
.TP
.I Created lines
.TP
.I Created bytes
.TP
.I Read texts
Count of read marked texts.
.TP
.I No of fetches
This is the information about how many texts this person has fetched.
Using caching clients this number could increase well beyond
.I Read
.IR texts .
.TP
.I Created persons
Count of created persons.
.TP
.I Created conferences
Count of created conferences.
.SS Text statuses
This contains info about the texts.
.TP 15
.I Created time
Time this text was created.
.TP
.I Author
Person that wrote this text.
.TP
.I Start
Start pointer for the text in the
.I lyskomd-texts
file.
.TP
.I Number of lines
Length of the text in lines.
.TP
.I Number of chars
Length of the text in chars.
.TP
.I Number of marks
Count of existing marks on this text.
.TP
.I Header list
An array containing info about
.IR recipients ,
.I comments
.IR to -pointers
etc. Every element is a
.IR Misc_info .
.SS Membership
The membership type tells us about conferences we are member of and
how much we have already read of it. It is saved in this way:
.TP
.I Last time read
Updated when we mark a text as read in this conference.
.TP
.I Conference number
The number telling what conf.
.TP
.I Priority
Used by the client to determine reading order.
.TP
.I Last text read
Local number of the last text we have read. This is used to keep track
of which texts we have not yet read and calculate how many unread we
have in this conference.
.TP
.I Read texts
An array containing the texts that we have read after the
.I Last text
.IR read .
This is necessary because its possible to read in any order.
.SH FILES
.TP 20
.IB database-directory /db/lyskomd-data
File with all the elements and pointers.
.TP
.IB database-directory /db/lyskomd-texts
File with the texts.
.TP
.IB database-directory /etc/pid
File with the pid of the lyskom-process.
.TP
.IB database-directory /db/lyskomd-backup
Backup file with all data.
.SH "SEE ALSO"
.BR lyskomd (8),
.BR dbck (8)
.SH BUGS
This is really a joke. Its not a database, not optimal in any way. But
it works.
.PP
The
.I message of the day
text number is not saved anywhere. This makes the
server forget what text that is when restarting.
.SH NOTES
This will soon disapear and be replaced by something more bazaarly
inexplicable.
The LysKOM database is stored in a couple of files.
.SH SEE ALSO
Full documentation can be found in the Texinfo manual "lyskomd
Database Format Specification" (found in info format as
.BR lyskomdb.info ).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment