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

(Server Configuration File): Markup fixes.

(Parameter Types): Markup fixes.
(Parameters): Markup fixes.
(Aux-Item Definition File): Markup fixes.
(Administration): Update the discussion about updateLysKOM, dbck and
	komrunning.  Markup fixes.
parent 2a9ff212
\input texinfo
@c $Id: lyskomd.texi,v 1.7 1999/04/03 15:47:31 ceder Exp $
@c $Id: lyskomd.texi,v 1.8 1999/04/03 21:55:58 ceder Exp $
@c %**start of header
@setfilename lyskomd.info
@include version.texi
......@@ -146,7 +146,7 @@ Aux-Item List,The Aux-Item List}.
@section Server Configuration File
The server reads its configuration from a configuration file. The
default configuration file is @code{/usr/lyskom/etc/config}. The
default configuration file is @file{/usr/lyskom/etc/config}. The
location of the configuration file can be changed at run-time by
supplying an argument to lyskomd.
......@@ -185,7 +185,7 @@ the @samp{Prefix} parameter in the configuration file.
@item portname
The parameter is a TCP/IP port. It can be a symbolic port name
(traditionally looked up in @code{/etc/services}) or a port number.
(traditionally looked up in @file{/etc/services}) or a port number.
@item int
The parameter is a number of some sort. It can be a conference number,
......@@ -215,7 +215,7 @@ is off.
@item Prefix: @var{path}
All files that the server uses are found in sub-directories of this
directory. The default value of this parameter is set at compile time.
The default at compile time is @code{/usr/lyskom}.
The default at compile time is @file{/usr/lyskom}.
@item Send async: @var{bool}
Do not send any non-requested messages. This disables the sending of
......@@ -287,12 +287,12 @@ not defined.
@item Data file: @var{path}
The path relative to the installation prefix where part of the database
is kept. The default is @code{db/lyskomd-data}.
is kept. The default is @file{db/lyskomd-data}.
@item Backup file: @var{path}
The path relative to the installation prefix where a backup of the
database is kept. This file will always contain a complete database, but
it may be a little out-of-date. Default is @code{db/lyskomd-backup}.
it may be a little out-of-date. Default is @file{db/lyskomd-backup}.
@item Backup file 2: @var{path}
The path relative to the installation prefix where a previous generation
......@@ -302,7 +302,7 @@ file. Default is @file{db/lyskomd-backup-prev}.
@item Text file: @var{path}
The path relative to the installation prefix where the actual texts in
the database are kept. Default is @code{db/lyskomd-texts}.
the database are kept. Default is @file{db/lyskomd-texts}.
@item Text backup file: @var{path}
When dbck is run with the @code{-g} option (@ref{(dbck)Invoking
......@@ -313,35 +313,35 @@ is @file{db/lyskomd-texts-backup}.
@item Log file: @var{path}
The path relative to the installation prefix where log messages from
lyskomd are written. Default is @code{etc/server-log}.
lyskomd are written. Default is @file{etc/server-log}.
@item Log statistics: @var{path}
Whenever lyskomd receives a SIGUSR1 it will append a timestamp and
a count of how many different atomic calls have been made in this file.
The path is relative to the installation prefix. Default is
@code{etc/lyskomd-log}.
@file{etc/lyskomd-log}.
@item Pid file: @var{path}
When lyskomd is up and running it will write its pid in this file. The
path is relative to the installation prefix. This file is used so the
@code{updateLysKOM} script can easily find out what pid the LysKOM
server has. Default is @code{etc/pid}.
server has. Default is @file{etc/pid}.
@item Memory usage file: @var{path}
When lyskomd exits normally it appends some info on its usage of memory
to this file. The path is relative to the installation prefix. Almost
any memory leak bugs should be detectable by looking in this Default is
@code{etc/memory-usage}. file.
any memory leak bugs should be detectable by looking in this file.
Default is @file{etc/memory-usage}.
@item Aux-item definition file: @var{path}
This file defines which aux-items the server should support and how it
should handle them. @xref{Aux-Item Definition File} for more details.
The path is relative to the installation prefix. Default is
@code{etc/aux-items.conf}.
@file{etc/aux-items.conf}.
@item Core directory: @var{path}
The Directory where core dumps are written. This path is relative to the
installation prefix. Default is @code{cores}.
installation prefix. Default is @file{cores}.
@item Idle timeout: @var{int}
Number of milliseconds to sleep when there is nothing for lyskomd
......@@ -568,7 +568,7 @@ arise at installations used for client or server development.
The location of the aux-item definition file is specified by the
@code{Aux-item definition file} option in the server configuration
file. The default location is @code{/usr/lyskom/etc/aux-items.conf}.
file. The default location is @file{/usr/lyskom/etc/aux-items.conf}.
@subsection Syntax of the Aux-Item Definition File
......@@ -829,55 +829,57 @@ old texts are never removed. The information file contains information
about conferences, users and where in the text file the texts are. This
file is properly garbage collected, but not the text file.
There is a program called dbck (Data Base Check) which is used to check
the consistency of the LysKOM database. This program can also be used to
shrink the text file. To do this, just type `dbck -g' in the database
directory, or give additional switches to dbck to use the correct
directory. See further the manual page for dbck. When dbck is to be run
on the database, the LysKOM server *must* be stopped, or unrepairable
damage may result. See below for a description on how to stop the
server.
There is a program called updateLysKOM which is used to ensure
continuous operation. This program is run with certain intervals and if
the LysKOM server has died for some reason, updateLysKOM restarts it. If
the server is still running properly, updateLysKOM sends a signal
(SIGUSR1) to it, which causes the server to write some statistics to a
file named etc/lyskomd-log in the lyskom directory.
There is a program called @code{dbck} (Data Base Check) which is used to
check the consistency of the LysKOM database. This program can also be
used to shrink the text file. To do this, just type @samp{dbck
-g}. @xref{(dbck)}. When @code{dbck} is to be run on the database, the
LysKOM server @emph{must} be stopped, or unrepairable damage may
result. See below for a description on how to stop the server.
There is a program called @code{updateLysKOM} which is used to ensure
continuous operation. This program should be run with certain intervals,
for instance from @code{cron}. If the LysKOM server has died for some
reason, @code{updateLysKOM} restarts it. If the server is still running
properly, @code{updateLysKOM} sends a signal (@code{SIGUSR1}) to it,
which causes the server to write some statistics to a file named
@file{etc/lyskomd-log} in the lyskom directory.
Taking the server down cleanly can be done in two ways: through the use
of the LysKOM protocol on a socket, preferably through the use of a
suitable client, or by sending the signal SIGHUP to it. This will cause
the server to save the database and close all client connections. It
will also create a file named etc/memory-usage in which the memory usage
of the server is reported.
To prevent updateLysKOM from restarting a server, create a file named
/usr/lyskom/etc/status. The file should contain a valid mail address on
the first line. UpdateLysKOM will not restart the server as long as that
file exists. In addition, if the file is between 1 and 2 hours old an
email will be sent to the mail address found in the file. If the file is
older than that, an error message will be printed on stderr and
updateLysKOM will exit with a non-zero exit status. cron is expected to
deliver the error message to an operator.
The shell script komrunning can be used to start and stop the LysKOM
server. With no arguments, it will report the status.
suitable client, or by sending the signal @code{SIGHUP} to it. This will
cause the server to save the database and close all client
connections. It will also create a file named @file{etc/memory-usage} in
which the memory usage of the server is reported.
To prevent @code{updateLysKOM} from restarting a server, create a file
named @file{/usr/lyskom/etc/status}. The file should contain a valid
mail address on the first line. @code{updateLysKOM} will not restart the
server as long as that file exists. In addition, if the file is between
1 and 2 hours old an email will be sent to the mail address found in the
file. If the file is older than that, an error message will be printed
on stderr and updateLysKOM will exit with a non-zero exit status. cron
is expected to deliver the error message to an operator.
The shell script @code{komrunning} can be used to start and stop the
LysKOM server. With no arguments, it will report the status.
@example
komrunning off
@end example
will shut down the server, creating the file /usr/lyskom/etc/status,
while
will (attempt to) shut down the server, creating the file
@file{/usr/lyskom/etc/status}. If the user running @code{komrunning}
doesn't have permission to send signals to @code{lyskomd} the actual
shutdown will be delayed until the next time that @code{updateLysKOM} is
run.
@example
komrunning on
@end example
will restart it. The actual stopping and starting of the server will
be done by updateLysKOM the next time it is run. komrunning only
creates the lock file.
will restart the server. The actual starting of the server will be done
by @code{updateLysKOM} the next time it is run. @code{komrunning} only
removes the lock file.
@node Bugs, , Administration, Top
......
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