Commit be594d28 authored by Per Cederqvist's avatar Per Cederqvist
Browse files

lyskomd now uses a configuration file. Document it.

parent e5697ad3
.\" $Id: lyskomd.8,v 1.7 1994/01/12 01:22:23 ceder Exp $
.\" $Id: lyskomd.8,v 1.8 1994/02/19 04:57:37 ceder Exp $
.\" Copyright (C) 1991, 1994 Lysator Academic Computer Association.
.\"
.\" This file is part of the LysKOM server.
......@@ -21,8 +21,8 @@
.\"
.\" Please mail bug reports to bug-lyskom@lysator.liu.se.
.\"
.\" $Id: lyskomd.8,v 1.7 1994/01/12 01:22:23 ceder Exp $
.\" $Date: 1994/01/12 01:22:23 $
.\" $Id: lyskomd.8,v 1.8 1994/02/19 04:57:37 ceder Exp $
.\" $Date: 1994/02/19 04:57:37 $
.TH lyskomd 8 "January 12, 1994" "Lysator"
.SH NAME
lyskomd - LysKOM server
......@@ -160,6 +160,172 @@ file, for later use in simulations et c.
Compiling with
.B LOGECCESSES
slows the server down quite a lot, so it is normally not defined.
.TP
.B Data file: data_file
Part of the data base will be held in
.I prefix/data_file.
.TP
.B Backup file: backup_file
The file
.I prefix/backup_file
will always contain a complete data base, but it might be a little
outdated.
.TP
.B Text file: text_file
The file
.I prefix/text_file
holds all actual text which is written.
.TP
.B Text backup file: backup_text
When dbck is run with the
.I -g
option (see dbck(8)) it will store the previous contents of
.I prefix/text_file
in
.I prefix/backup_text.
This file is never used by lyskomd itself.
.TP
.B Log statistics: stat_file
Whenever lyskomd receives a SIGHUP it will append a timestamp and
a count of how many different atomic calls have been made in
.I prefix/stat_file.
.TP
.B Pid file: pid_file
When lyskomd is up-and-running it will write its pid in the file
.I prefix/pid_file.
This file is not currently used as a log file. It is present here
only so that the updateLysKOM script can easily find out what pid the
LysKOM server has.
.TP
.B Memory usage file: mem_file
When lyskomd exits normally it appends some info on its usage of
memory to
.I prefix/mem_file.
Almost any memory leak bugs should be detectable by looking in this
file.
.TP
.B Idle timeout: idle
Number of milliseconds to sleep when there is nothing for lyskomd
to do.
.TP
.B Garb timeout: garb
Number of milliseconds to sleep when the server is garbaging texts,
but has nothing else important to do.
.TP
.B Sync timeout: sync
Number of milliseconds to sleep when lyskomd is saving its database.
Defaults to 0.
.TP
.B Garb interval: garb_interval
Number of minutes between each garb sweep. Defaults to 1440, that is,
a garb sweep will be run once per day.
.TP
.B Sync interval: sync_interval
Number of minutes between syncs. Currently, lyskomd holds part of the
data base in main memory. It is dumped to
.I prefix/data_file
periodically. This parameter determines the period.
.TP
.B Sync retry interval: retry_interval
If anything goes wrong while trying to dump the data base to
.I prefix/data_file
(such as if the disk is full),
lyskomd will wait for this many minutes before trying again.
.TP
.B Max conference name length: int
.TP
.B Max password length: int
Only the first eight characters of the password are currently
significant, even if this number is much larger.
.TP
.B Max what am I doing length: int
.TP
.B Max username length: int
.TP
.B Max text length: int
.TP
.B Max broadcaset length: int
.TP
.B Max regexp length: int
.TP
.B Max marks per person: int
.TP
.B Max marks per text: int
.TP
.B Max recipients per text: int
.TP
.B Max comments per text: int
.TP
.B Max footnotes per text: int
.TP
.B Max links per text: int
.TP
.B Max mark_as_read chunks: int
.TP
.B Max super_conf loop: int
.TP
.B Default garb nice: int
Each conference has a lifetime for texts written in it.
The lifetime is counted in days, and can be set for each conference by
the administrator of the conference.
This is the default value assigned to new conferences.
.TP
.B Max client transmit queue: int
Mux number of pending data blocks in the reply queue to a client. If
there is ever more than this many data blocks in the queue the client
will be disconnected. Each atomic question typically generates two
data blocks.
.TP
.B Max simultaneous client replies: int
This is a performance tuning parameter of little real interest.
.TP
.B Anyone can create new persons: bool
If this is set, anyone can create a new person, even if he lacks
special bits for doing so.
.TP
.B Anyone can create new conferences: bool
If this is set, anyone can create a new conferences, even if he lacks
special bits for doing so.
.TP
.B Allow creation of persons before login: bool
If this is set, persons can connect the the server and create a new
person without logging in. This is how new users register in open
environments.
.TP
.B Default change name capability: bool
If this is set, new users are created with the ability to change their
own name.
.TP
.B Cache conference limit: int
How many conference statuses the server cache should hold in main
memory.
.TP
.B Cache person limit: assign_int
How many person statuses the server cache should hold in main
memory.
.TP
.B Cache text_stat limit: assign_int
How many text statuses the server cache should hold in main
memory.
.TP
.B Echo: text_string
Write
.I text_string
in the log.
.TP
.B Jubel: pers_no text_no
State that
.I pers_no
is not allowed to create text number
.I text_no
.TP
.B Jubel: pers_no divident remainder
Say that
.I pers_no
is not allowed to create any text number
.I T
which meets the condition
.I T \% divident == remainder
.SH SIGNALS
There are some signals that have a special meaning to the LysKOM
server.
......
.\" $Id: lyskomd.8,v 1.7 1994/01/12 01:22:23 ceder Exp $
.\" $Id: lyskomd.8,v 1.8 1994/02/19 04:57:37 ceder Exp $
.\" Copyright (C) 1991, 1994 Lysator Academic Computer Association.
.\"
.\" This file is part of the LysKOM server.
......@@ -21,8 +21,8 @@
.\"
.\" Please mail bug reports to bug-lyskom@lysator.liu.se.
.\"
.\" $Id: lyskomd.8,v 1.7 1994/01/12 01:22:23 ceder Exp $
.\" $Date: 1994/01/12 01:22:23 $
.\" $Id: lyskomd.8,v 1.8 1994/02/19 04:57:37 ceder Exp $
.\" $Date: 1994/02/19 04:57:37 $
.TH lyskomd 8 "January 12, 1994" "Lysator"
.SH NAME
lyskomd - LysKOM server
......@@ -160,6 +160,172 @@ file, for later use in simulations et c.
Compiling with
.B LOGECCESSES
slows the server down quite a lot, so it is normally not defined.
.TP
.B Data file: data_file
Part of the data base will be held in
.I prefix/data_file.
.TP
.B Backup file: backup_file
The file
.I prefix/backup_file
will always contain a complete data base, but it might be a little
outdated.
.TP
.B Text file: text_file
The file
.I prefix/text_file
holds all actual text which is written.
.TP
.B Text backup file: backup_text
When dbck is run with the
.I -g
option (see dbck(8)) it will store the previous contents of
.I prefix/text_file
in
.I prefix/backup_text.
This file is never used by lyskomd itself.
.TP
.B Log statistics: stat_file
Whenever lyskomd receives a SIGHUP it will append a timestamp and
a count of how many different atomic calls have been made in
.I prefix/stat_file.
.TP
.B Pid file: pid_file
When lyskomd is up-and-running it will write its pid in the file
.I prefix/pid_file.
This file is not currently used as a log file. It is present here
only so that the updateLysKOM script can easily find out what pid the
LysKOM server has.
.TP
.B Memory usage file: mem_file
When lyskomd exits normally it appends some info on its usage of
memory to
.I prefix/mem_file.
Almost any memory leak bugs should be detectable by looking in this
file.
.TP
.B Idle timeout: idle
Number of milliseconds to sleep when there is nothing for lyskomd
to do.
.TP
.B Garb timeout: garb
Number of milliseconds to sleep when the server is garbaging texts,
but has nothing else important to do.
.TP
.B Sync timeout: sync
Number of milliseconds to sleep when lyskomd is saving its database.
Defaults to 0.
.TP
.B Garb interval: garb_interval
Number of minutes between each garb sweep. Defaults to 1440, that is,
a garb sweep will be run once per day.
.TP
.B Sync interval: sync_interval
Number of minutes between syncs. Currently, lyskomd holds part of the
data base in main memory. It is dumped to
.I prefix/data_file
periodically. This parameter determines the period.
.TP
.B Sync retry interval: retry_interval
If anything goes wrong while trying to dump the data base to
.I prefix/data_file
(such as if the disk is full),
lyskomd will wait for this many minutes before trying again.
.TP
.B Max conference name length: int
.TP
.B Max password length: int
Only the first eight characters of the password are currently
significant, even if this number is much larger.
.TP
.B Max what am I doing length: int
.TP
.B Max username length: int
.TP
.B Max text length: int
.TP
.B Max broadcaset length: int
.TP
.B Max regexp length: int
.TP
.B Max marks per person: int
.TP
.B Max marks per text: int
.TP
.B Max recipients per text: int
.TP
.B Max comments per text: int
.TP
.B Max footnotes per text: int
.TP
.B Max links per text: int
.TP
.B Max mark_as_read chunks: int
.TP
.B Max super_conf loop: int
.TP
.B Default garb nice: int
Each conference has a lifetime for texts written in it.
The lifetime is counted in days, and can be set for each conference by
the administrator of the conference.
This is the default value assigned to new conferences.
.TP
.B Max client transmit queue: int
Mux number of pending data blocks in the reply queue to a client. If
there is ever more than this many data blocks in the queue the client
will be disconnected. Each atomic question typically generates two
data blocks.
.TP
.B Max simultaneous client replies: int
This is a performance tuning parameter of little real interest.
.TP
.B Anyone can create new persons: bool
If this is set, anyone can create a new person, even if he lacks
special bits for doing so.
.TP
.B Anyone can create new conferences: bool
If this is set, anyone can create a new conferences, even if he lacks
special bits for doing so.
.TP
.B Allow creation of persons before login: bool
If this is set, persons can connect the the server and create a new
person without logging in. This is how new users register in open
environments.
.TP
.B Default change name capability: bool
If this is set, new users are created with the ability to change their
own name.
.TP
.B Cache conference limit: int
How many conference statuses the server cache should hold in main
memory.
.TP
.B Cache person limit: assign_int
How many person statuses the server cache should hold in main
memory.
.TP
.B Cache text_stat limit: assign_int
How many text statuses the server cache should hold in main
memory.
.TP
.B Echo: text_string
Write
.I text_string
in the log.
.TP
.B Jubel: pers_no text_no
State that
.I pers_no
is not allowed to create text number
.I text_no
.TP
.B Jubel: pers_no divident remainder
Say that
.I pers_no
is not allowed to create any text number
.I T
which meets the condition
.I T \% divident == remainder
.SH SIGNALS
There are some signals that have a special meaning to the LysKOM
server.
......
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