Commit 6965df0b authored by Per Cederqvist's avatar Per Cederqvist
Browse files

lyskomd now uses a configuration file.

parent c607d061
<.\" $Id: lyskomd.8,v 1.6 1991/10/29 05:41:58 linus Exp $
.\" Copyright (C) 1991 Lysator Academic Computer Association.
.\" $Id: lyskomd.8,v 1.7 1994/01/12 01:22:23 ceder Exp $
.\" Copyright (C) 1991, 1994 Lysator Academic Computer Association.
.\"
.\" This file is part of the LysKOM server.
.\"
......@@ -21,39 +21,32 @@
.\"
.\" Please mail bug reports to bug-lyskom@lysator.liu.se.
.\"
.\" $Id: lyskomd.8,v 1.6 1991/10/29 05:41:58 linus Exp $
.\" $Date: 1991/10/29 05:41:58 $
.TH lyskomd 8 "August 22, 1991"
.\" $Id: lyskomd.8,v 1.7 1994/01/12 01:22:23 ceder Exp $
.\" $Date: 1994/01/12 01:22:23 $
.TH lyskomd 8 "January 12, 1994" "Lysator"
.SH NAME
lyskomd - LysKOM server
.SH SYNOPSIS
.B /usr/lyskom/bin/lyskomd
[
.B -d
.B -d ...
] [
.B -q
] [
.BI -D database-directory
] [
.BI -p client_port
] [
.BI -P mux_port
] [
.B -a
.B config-file
]
.SH DESCRIPTION
This program runs a LysKOM server.
.PP
It listens for connections on the given ports (defaults are 4894
The server reads a configuration file (see CONFIGURATION below) and
then listensfor connections on the given ports (defaults are 4894
for the
.I client_port
and 4787 for the
and 4895 for the
.IR mux_port ).
.SH OPTIONS
.TP
.B \-d
Adds one to the debug-level i.e. increases the amount of output on the
stderr from the process.
stderr from the process. This option can be given repeatedly.
Using one
.B \-d
......@@ -62,32 +55,111 @@ make the process print a
for every timeout, a message for every person that is connecting or
disconnecting and a message for every successful or unsuccessful
communication to the process.
.SH CONFIGURATION
The configuration file is line oriented.
Each line consists of one
.B parameter name,
a colon, and the
.B parameter value.
Empty lines, and lines whose first non-blank character is #, are
comment lines and ignored.
The configuration file is normally found in
.B /usr/lyskom/etc/config,
but the exact location can be changed at compile time (by modifying
.B DEFAULT_DBASE_DIR
and/or
.B CONFIG_FILE
in
.B src/server/server-config.c)
or at run time (by specifying a config file as an argument).
The following parameters can be set in the config file:
.TP
.B Locale: locale_name
Use
.I locale_name
as the locale to run in.
This parameter is only available on systems which support the
.B setlocale()
call. If this parameter is not set, no call to
.B setlocale()
will be made.
.TP
.B \-q
Never save the database.
.TP
.BI \-D database-directory
Use the database in the
.I database-directory.
.br
Example: If your database is in
.B $HOME/lyskom/db
you should use the option
.B \-D$HOME/lyskom
.TP
.BI \-p client_port
listens for clients on the port number
.I client_port.
.TP
.BI \-P mux_port
listens for mux connections on the port number
.I mux_port.
A mux connection is a connection using a special protocol to allow
several sessions within one connection.
.TP
.B \-a
.B Prefix: prefix
The default value of
.I prefix
is
.B /usr/lyskom
(unless changed in server-config.c).
All files that the server uses are found in sub-directories of this
directory. See FILES below.
.TP
.B Send async: bool
Do not send any non-requested messages. This disables the sending of
messages about events in the server to all connections.
messages about events in the server to all connections.
Use of this parameter is not recommended. This option is on by
default.
.TP
.B Client port: portname
Listen for new clients on
.I portname,
which can be a symbolic port name (traditionally looked up in
.B /etc/services)
or a port number. This defaults to 4894, and all clients currently
expect that number.
.TP
.B Mux port: portname
Listen for mux connections on
.I portname.
Muxes can be used to multiplex several clients on a single file
descriptor. The mux runs as a separate process. This was used
historically when LysKOM ran on a machine were only 20 file
descriptors coule be open at once. The mux code has not been
released. Send a mail to
.B bug-lyskom@lysator.liu.se
if you need it. The default port number is 4895.
.TP
.B Presentation of conferences: conf-no
The number of the conference where presentations should be sent.
Defaults to 1.
.TP
.B Presentation of persons: conf-no
The number of the conference where presentations should be sent.
Defaults to 2.
.TP
.B Motd-conference: conf-no
The number of the conference where "message-of-the-day" messages
should be sent.
Defaults to 3.
.TP
.B News-conference: conf-no
The number of the conference where news of interest to the readers of
this LysKOM server should be written. This is typically a conference
with very low traffic which everyone shoule be a member of. Clients
should offer new users to join it. Defaults to 4.
.TP
.B Message of the day: text-no
Default message-of-the-day of this server.
The text will be showed automatically by conforming LysKOM clients
when a user logs on.
There is a question in protocol A which changes this number, but
(currently) a motd set by the protocol will be forgotten the next time
the server is restarted.
This may change in the future.
.TP
.B Never save: bool
Do not use unless you know what you are doing.
(Note: there is currently no-one in the LysKOM development group which
knows exactly what this option does!)
.TP
.B Log accesses: filename
This parameter can only be set if the server has been compiled with
.B LOGACCESSES
defined. It will save a trace of all activity in the database to a
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.
.SH SIGNALS
There are some signals that have a special meaning to the LysKOM
server.
......@@ -110,28 +182,55 @@ Suns.)
.SH FILES
.TP 20
.B /usr/lyskom
Default database directory.
Default value of
.I prefix.
.TP
.IB database-directory /db/lyskomd-data
File with all the elements and pointers.
.IB prefix /db/lyskomd-data
Half of the database: all status information.
.TP
.IB database-directory /db/lyskomd-texts
File with the texts.
.IB prefix /db/lyskomd-texts
The other half of the database: the actual texts.
.TP
.IB database-directory /etc/pid
.IB prefix /db/lyskomd-backup
A backup copy of
.I lyskomd-data.
Never, ever delete this file unless you know what you are doing, or
you may lose the entire data base. Most of the time this is the only
complete database file!
.TP
.IB prefix /etc/pid
File with the pid of the lyskom-process.
.TP
.IB database-directory /db/lyskomd-backup
Backup file with all data.
.IB database-directory /etc/memory-usage
On normal exit,
.I lyskomd
will append some statistics to this file. It can be used for
detecting memory leaks.
.SH BUGS
Small memory leak.
.PP
lyskomd should re-read the config file when a SIGHUP is received.
.PP
lyskomd should terminate when a SIGINT or SIGTERM is received.
.PP
A very small memory leak still remains.
.PP
There is no practical handling of security.
.PP
The choice of asynchronously issued messages is not very good.
.PP
The so called "data base" is a joke.
.SH AUTHOR
Per Cederqvist <ceder@lysator.liu.se>
.PP
It uses too much memory.
.SH HISTORY
In 1990, Per Cederqvist <ceder@lysator.liu.se> and Peter Eriksson
<pen@lysator.liu.se> and a few other persons started to write the
server. It was operational in the summer of 1990, even though the
members of Lysator discovered a thing called MUD. We started using
RCS on 20 May 1991. The first release was made on 16 Sept 1991.
Around that time we switched from RCS to CVS, and ceder started to
write pcl-cvs (a GNU Emacs front-end to CVS) instead of LysKOM. After
a while, he started writing Bugtrack, to be able to handle all bug
reports he recieved about pcl-cvs. He hopes to be able to devote some
more time to LysKOM in the future.
.SH NOTE
Version 2.0 on its way.
Contact Per Cederqvist if you want commercial support of LysKOM.
<.\" $Id: lyskomd.8,v 1.6 1991/10/29 05:41:58 linus Exp $
.\" Copyright (C) 1991 Lysator Academic Computer Association.
.\" $Id: lyskomd.8,v 1.7 1994/01/12 01:22:23 ceder Exp $
.\" Copyright (C) 1991, 1994 Lysator Academic Computer Association.
.\"
.\" This file is part of the LysKOM server.
.\"
......@@ -21,39 +21,32 @@
.\"
.\" Please mail bug reports to bug-lyskom@lysator.liu.se.
.\"
.\" $Id: lyskomd.8,v 1.6 1991/10/29 05:41:58 linus Exp $
.\" $Date: 1991/10/29 05:41:58 $
.TH lyskomd 8 "August 22, 1991"
.\" $Id: lyskomd.8,v 1.7 1994/01/12 01:22:23 ceder Exp $
.\" $Date: 1994/01/12 01:22:23 $
.TH lyskomd 8 "January 12, 1994" "Lysator"
.SH NAME
lyskomd - LysKOM server
.SH SYNOPSIS
.B /usr/lyskom/bin/lyskomd
[
.B -d
.B -d ...
] [
.B -q
] [
.BI -D database-directory
] [
.BI -p client_port
] [
.BI -P mux_port
] [
.B -a
.B config-file
]
.SH DESCRIPTION
This program runs a LysKOM server.
.PP
It listens for connections on the given ports (defaults are 4894
The server reads a configuration file (see CONFIGURATION below) and
then listensfor connections on the given ports (defaults are 4894
for the
.I client_port
and 4787 for the
and 4895 for the
.IR mux_port ).
.SH OPTIONS
.TP
.B \-d
Adds one to the debug-level i.e. increases the amount of output on the
stderr from the process.
stderr from the process. This option can be given repeatedly.
Using one
.B \-d
......@@ -62,32 +55,111 @@ make the process print a
for every timeout, a message for every person that is connecting or
disconnecting and a message for every successful or unsuccessful
communication to the process.
.SH CONFIGURATION
The configuration file is line oriented.
Each line consists of one
.B parameter name,
a colon, and the
.B parameter value.
Empty lines, and lines whose first non-blank character is #, are
comment lines and ignored.
The configuration file is normally found in
.B /usr/lyskom/etc/config,
but the exact location can be changed at compile time (by modifying
.B DEFAULT_DBASE_DIR
and/or
.B CONFIG_FILE
in
.B src/server/server-config.c)
or at run time (by specifying a config file as an argument).
The following parameters can be set in the config file:
.TP
.B Locale: locale_name
Use
.I locale_name
as the locale to run in.
This parameter is only available on systems which support the
.B setlocale()
call. If this parameter is not set, no call to
.B setlocale()
will be made.
.TP
.B \-q
Never save the database.
.TP
.BI \-D database-directory
Use the database in the
.I database-directory.
.br
Example: If your database is in
.B $HOME/lyskom/db
you should use the option
.B \-D$HOME/lyskom
.TP
.BI \-p client_port
listens for clients on the port number
.I client_port.
.TP
.BI \-P mux_port
listens for mux connections on the port number
.I mux_port.
A mux connection is a connection using a special protocol to allow
several sessions within one connection.
.TP
.B \-a
.B Prefix: prefix
The default value of
.I prefix
is
.B /usr/lyskom
(unless changed in server-config.c).
All files that the server uses are found in sub-directories of this
directory. See FILES below.
.TP
.B Send async: bool
Do not send any non-requested messages. This disables the sending of
messages about events in the server to all connections.
messages about events in the server to all connections.
Use of this parameter is not recommended. This option is on by
default.
.TP
.B Client port: portname
Listen for new clients on
.I portname,
which can be a symbolic port name (traditionally looked up in
.B /etc/services)
or a port number. This defaults to 4894, and all clients currently
expect that number.
.TP
.B Mux port: portname
Listen for mux connections on
.I portname.
Muxes can be used to multiplex several clients on a single file
descriptor. The mux runs as a separate process. This was used
historically when LysKOM ran on a machine were only 20 file
descriptors coule be open at once. The mux code has not been
released. Send a mail to
.B bug-lyskom@lysator.liu.se
if you need it. The default port number is 4895.
.TP
.B Presentation of conferences: conf-no
The number of the conference where presentations should be sent.
Defaults to 1.
.TP
.B Presentation of persons: conf-no
The number of the conference where presentations should be sent.
Defaults to 2.
.TP
.B Motd-conference: conf-no
The number of the conference where "message-of-the-day" messages
should be sent.
Defaults to 3.
.TP
.B News-conference: conf-no
The number of the conference where news of interest to the readers of
this LysKOM server should be written. This is typically a conference
with very low traffic which everyone shoule be a member of. Clients
should offer new users to join it. Defaults to 4.
.TP
.B Message of the day: text-no
Default message-of-the-day of this server.
The text will be showed automatically by conforming LysKOM clients
when a user logs on.
There is a question in protocol A which changes this number, but
(currently) a motd set by the protocol will be forgotten the next time
the server is restarted.
This may change in the future.
.TP
.B Never save: bool
Do not use unless you know what you are doing.
(Note: there is currently no-one in the LysKOM development group which
knows exactly what this option does!)
.TP
.B Log accesses: filename
This parameter can only be set if the server has been compiled with
.B LOGACCESSES
defined. It will save a trace of all activity in the database to a
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.
.SH SIGNALS
There are some signals that have a special meaning to the LysKOM
server.
......@@ -110,28 +182,55 @@ Suns.)
.SH FILES
.TP 20
.B /usr/lyskom
Default database directory.
Default value of
.I prefix.
.TP
.IB database-directory /db/lyskomd-data
File with all the elements and pointers.
.IB prefix /db/lyskomd-data
Half of the database: all status information.
.TP
.IB database-directory /db/lyskomd-texts
File with the texts.
.IB prefix /db/lyskomd-texts
The other half of the database: the actual texts.
.TP
.IB database-directory /etc/pid
.IB prefix /db/lyskomd-backup
A backup copy of
.I lyskomd-data.
Never, ever delete this file unless you know what you are doing, or
you may lose the entire data base. Most of the time this is the only
complete database file!
.TP
.IB prefix /etc/pid
File with the pid of the lyskom-process.
.TP
.IB database-directory /db/lyskomd-backup
Backup file with all data.
.IB database-directory /etc/memory-usage
On normal exit,
.I lyskomd
will append some statistics to this file. It can be used for
detecting memory leaks.
.SH BUGS
Small memory leak.
.PP
lyskomd should re-read the config file when a SIGHUP is received.
.PP
lyskomd should terminate when a SIGINT or SIGTERM is received.
.PP
A very small memory leak still remains.
.PP
There is no practical handling of security.
.PP
The choice of asynchronously issued messages is not very good.
.PP
The so called "data base" is a joke.
.SH AUTHOR
Per Cederqvist <ceder@lysator.liu.se>
.PP
It uses too much memory.
.SH HISTORY
In 1990, Per Cederqvist <ceder@lysator.liu.se> and Peter Eriksson
<pen@lysator.liu.se> and a few other persons started to write the
server. It was operational in the summer of 1990, even though the
members of Lysator discovered a thing called MUD. We started using
RCS on 20 May 1991. The first release was made on 16 Sept 1991.
Around that time we switched from RCS to CVS, and ceder started to
write pcl-cvs (a GNU Emacs front-end to CVS) instead of LysKOM. After
a while, he started writing Bugtrack, to be able to handle all bug
reports he recieved about pcl-cvs. He hopes to be able to devote some
more time to LysKOM in the future.
.SH NOTE
Version 2.0 on its way.
Contact Per Cederqvist if you want commercial support of LysKOM.
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