Commit 8455bf12 authored by Per Cederqvist's avatar Per Cederqvist
Browse files

Updated the default paths to the new world order.

parent 46e3316e
\input texinfo
@c $Id: lyskomd.texi,v 1.70 2003/08/14 23:06:43 ceder Exp $
@c $Id: lyskomd.texi,v 1.71 2003/08/16 10:39:46 ceder Exp $
@c %**start of header
@setfilename lyskomd.info
@include version.texi
......@@ -272,8 +272,9 @@ is off.
@item Prefix: @var{path}
Specify the installation prefix. All relative filenames that the
server uses are interpreted relative to this directory. The default
value of this parameter is set at compile time. The default at
compile time is @file{/usr/lyskom}.
value of this parameter is set at compile time. The default is
@file{/usr/lyskom}, but it can be changed by the @samp{--prefix}
argument of @samp{configure} at compile time.
@item Send async: @var{bool}
Do not send any non-requested messages. This disables the sending of
......@@ -343,35 +344,36 @@ not defined.
The path relative to the installation prefix@footnote{The installation
prefix can be specified at compile time, and overridden by the
@code{Prefix:} parameter.} where part of the database is kept. The
default is @file{db/lyskomd-data}.
default is @file{var/lyskomd/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 @file{db/lyskomd-backup}.
database is kept. This file will always contain a complete database,
but it may be a little out-of-date. Default is
@file{var/lyskomd/db/lyskomd-backup}.
@item Backup file 2: @var{path}
The path relative to the installation prefix where a previous generation
of the backup of the database is kept. This file may be needed if an
error in the backup file is detected during the creation of the data
file. Default is @file{db/lyskomd-backup-prev}.
file. Default is @file{var/lyskomd/db/lyskomd-backup-prev}.
@item Lock file: @var{path}
Name of the lock file that ensures that @code{dbck} and @code{lyskomd}
never attempt to modify the database at the same time. It should always
reside in the same directory as the @samp{Data file}. Default is
@file{db/lyskomd-lock}.
@file{var/lyskomd/db/lyskomd-lock}.
@item Text file: @var{path}
The path relative to the installation prefix where the actual texts in
the database are kept. Default is @file{db/lyskomd-texts}.
the database are kept. Default is @file{var/lyskomd/db/lyskomd-texts}.
@item Text backup file: @var{path}
When @code{dbck} is run with the @samp{-g} option (@ref{Invoking
dbck}, it will store the previous contents of the text file in the
file specified by this option. The path is relative to the
installation prefix. This file is never used by @code{lyskomd}
itself. Default is @file{db/lyskomd-texts-backup}.
itself. Default is @file{var/lyskomd/db/lyskomd-texts-backup}.
@item Backup export directory: @var{path}
When @code{splitkomdb} is run, it will create a copy of the database
......@@ -379,7 +381,7 @@ in this directory. The copy will be split in a way that helps to keep
incremental backups of that directory small. @xref{splitkomdb}. The
path is relative to the directory specified by @code{Prefix:}. This
directory is never used by @code{lyskomd} itself. Default is
@file{exportdb}.
@file{var/lyskomd/exportdb}.
@item Number file: @var{path}
@itemx Number temp file: @var{path}
......@@ -389,25 +391,25 @@ time a new conference or text is created, to ensure that numbers are
never reused even if the server later crashes before it has time to
save the database. The information is first written to @code{Number
temp file:}, and then renamed to @code{Number file:}. The path is
relative to the installation prefix. Default is @file{db/number.txt}
and @file{db/number.tmp}, respectively. Both files must reside on the
same partition.
relative to the installation prefix. Default is
@file{var/lyskomd/db/number.txt} and @file{var/lyskomd/db/number.tmp},
respectively. Both files must reside on the same partition.
@item Log file: @var{path}
The path relative to the installation prefix where log messages from
lyskomd are written. Default is @file{etc/server-log}.
lyskomd are written. Default is @file{var/lyskomd.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
@file{etc/lyskomd-log}.
@file{var/lyskomd.stats}.
@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 @file{etc/pid}.
server has. Default is @file{var/run/lyskomd.pid}.
This file should be removed when the computer reboots, before
@code{komrunning} or @code{updateLysKOM} is run.
......@@ -416,7 +418,7 @@ This file should be removed when the computer reboots, before
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 file.
Default is @file{etc/memory-usage}.
Default is @file{var/lyskomd.memory}.
@item Aux-item definition file: @var{path}
This file defines which aux-items the server should support and how it
......@@ -428,7 +430,7 @@ This file is re-read if a @samp{SIGWINCH} singal is sent to the server.
@item Core directory: @var{path}
The Directory where core dumps are written. This path is relative to the
installation prefix. Default is @file{cores}.
installation prefix. Default is @file{var/lyskomd.cores}.
@item Connection status file: @var{path}
@itemx Connection status temp file: @var{path}
......@@ -437,15 +439,15 @@ connections. The status is written to the temp file and atomically
renamed to the status file.
The path is relative to the installation prefix. Defaults are
@file{etc/connections.txt} and @file{etc/connections.tmp}. Both files
must reside on the same file system. @xref{Files}, for information
about the file format.
@file{var/lyskomd.clients} and @file{var/lyskomd.clnt.tmp}. Both
files must reside on the same file system. @xref{Files}, for
information about the file format.
@item Status file: @var{path}
This file is created by @code{komrunning} to indicate that lyskomd
should currently not be running. When this file exists
@code{updateLysKOM} will send it a @samp{SIGTERM} signal, so that it
saves the database and dies. Default is @file{etc/status}.
saves the database and dies. Default is @file{var/lyskomd/db/status}.
@item Nologin file: @var{path}
If this file exists, the server will not allow any connections at all.
......@@ -756,14 +758,16 @@ off.
@item lyskomd path: @var{path}
Path to the @code{lyskomd} binary. This is used by @code{updateLysKOM}
to find the right program to run. Defaults to @file{bin/lyskomd}.
to find the right program to run. Defaults to @file{sbin/lyskomd}.
@item savecore path: @var{path}
Path to the @code{savecore} program. If a file named @file{core} exists
in the directory specified with @code{Core directory} when
@code{updateLysKOM} is about to start @code{lyskomd}, this program will
be called first. It could, for instance, move the core file so that it
is available for later debugging.
Path to the @code{savecore-lyskom} program. If a file named
@file{core} exists in the directory specified with @code{Core
directory} when @code{updateLysKOM} is about to start @code{lyskomd},
this program will be called first. It could, for instance, move the
core file so that it is available for later debugging. The script
supplied by the distribution does nothing.
Defaults to @file{sbin/savecore-lyskom}.
@item Normal shutdown time: @var{int}
In a normal setup, @code{updateLysKOM} will be run from @code{cron} once
......@@ -1068,26 +1072,26 @@ Default value of the @code{Prefix} parameter. The default of this value
is set at compile time, but it can be changed in the server
configuration file. @xref{Parameters}.
@item @var{prefix}/db/lyskomd-data
@item @var{prefix}/var/lyskomd/db/lyskomd-data
Half of the database: all status information.
@item @var{prefix}/db/lyskomd-texts
@item @var{prefix}/var/lyskomd/db/lyskomd-texts
The other half of the database: the actual texts.
@item @var{prefix}/db/lyskomd-backup
@item @var{prefix}/var/lyskomd/db/lyskomd-backup
A backup copy of @file{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!
@item @var{prefix}/db/number.txt
@item @var{prefix}/var/lyskomd/db/number.txt
Information about the highest used text- and conference numbers. In
case of a crash, some objects may be lost. This file ensures that
even if that happens, their numbers will not be reused.
@item @var{prefix}/etc/pid
@item @var{prefix}/var/run/lyskomd.pid
File with the pid of the lyskom-process.
@item @var{prefix}/etc/memory-usage
@item @var{prefix}/var/lyskomd.memory
On normal exit, @code{lyskomd} will append some statistics to this file.
It can be used for detecting memory leaks.
......@@ -1095,7 +1099,7 @@ It can be used for detecting memory leaks.
This file contains definitions of the aux-items that the server should
support. It is read by @code{lyskomd} at startup.
@item @var{prefix}/etc/connections.txt
@item @var{prefix}/var/lyskomd.clients
A list of all currently connected clients, maintained by the server.
The data about each client is collected on a single line:
......@@ -1204,24 +1208,24 @@ 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 (@samp{SIGUSR1}) to it,
which causes the server to write some statistics to a file named
@file{etc/lyskomd-log} in the lyskom directory.
@file{var/lyskomd.stats} 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 @samp{SIGTERM} 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
connections. It will also create a file named @file{var/lyskomd.memory} 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 (configurable) 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 @code{updateLysKOM} will exit with
a non-zero exit status. cron is expected to deliver the error message to
an operator.
named @file{/usr/lyskom/var/lyskomd/db/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 (configurable) 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
@code{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.
......@@ -1231,10 +1235,10 @@ LysKOM server. With no arguments, it will report the status.
@end example
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.
@file{/usr/lyskom/var/lyskomd/db/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 start
......@@ -1242,7 +1246,7 @@ run.
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 @file{/usr/lyskom/etc/status} file.
removes the @file{/usr/lyskom/var/lyskomd/db/status} file.
@node Bugs
......@@ -1480,13 +1484,13 @@ Default value of @code{Prefix:}. The default of this value is set at compile
time, but it can be changed in the server configuration file.
@xref{(lyskomd)Parameters}.
@item @var{prefix}/db/lyskomd-data
@item @var{prefix}/var/lyskomd/db/lyskomd-data
Half of the database: all status information.
@item @var{prefix}/db/lyskomd-texts
@item @var{prefix}/var/lyskomd/db/lyskomd-texts
The other half of the database: the actual texts.
@item @var{prefix}/db/lyskomd-backup
@item @var{prefix}/var/lyskomd/db/lyskomd-backup
A backup copy of @file{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!
......@@ -1540,7 +1544,7 @@ save some of the files created by @code{splitkomdb}.
@code{splitkomdb} can be run while @code{lyskomd} is running. It will
use the last completely saved snapshot, and make a copy of it in the
directory specified by the @code{Backup export directory:} parameter
(default: @file{/usr/lyskom/exportdb/}).
(default: @file{/usr/lyskom/var/lyskomd/exportdb/}).
There are two recommended ways to make backups of a @code{lyskomd}
database:
......@@ -1548,7 +1552,7 @@ database:
@itemize @bullet
@item Run @code{splitkomdb} before each backup, and instruct the backup
program to backup @file{/usr/lyskom/exportdb}, but ignore
program to backup @file{/usr/lyskom/var/lyskomd/exportdb}, but ignore
@file{/usr/lyskom/db}. Run @samp{splitkomdb -f} before each full
backup.
......@@ -1557,7 +1561,7 @@ backup.
@end itemize
The first alternative needs more disk for the copy in
@file{/usr/lyskom/exportdb} and is slightly more complex to set up;
@file{/usr/lyskom/var/lyskomd/exportdb} and is slightly more complex to set up;
the second alternative saves the entire database each time you make a
backup.
......@@ -1611,10 +1615,10 @@ Full backups are run on the 26th of each month. On those days, at
The splitted format of the database is currently very simple:
@table @file
@item exportdb/lyskomd-texts-base.backup
@item var/lyskomd/exportdb/lyskomd-texts-base.backup
This file contains the first part of @code{Text file:} (default:
@file{db/lyskomd-texts}). This file is created when the @samp{-f}
option is given to @code{splitkomdb}.
@file{var/lyskomd/db/lyskomd-texts}). This file is created when the
@samp{-f} option is given to @code{splitkomdb}.
@item lyskomd-texts-tail.backup
This file contains the rest of @code{Text file:}. It is always
......@@ -1622,9 +1626,9 @@ recreated when @code{splitkomdb} is run.
@item lyskomd-data.backup
This file contains a copy of @code{Data file:} (default:
@file{db/lyskomd-data}). If @code{Data file:} file wasn't clean
when @code{splitkomdb} was run, @code{Backup file:} (default:
@file{db/lyskomd-backup}) will be copied instead.
@file{var/lyskomd/db/lyskomd-data}). If @code{Data file:} file wasn't
clean when @code{splitkomdb} was run, @code{Backup file:} (default:
@file{var/lyskomd/db/lyskomd-backup}) will be copied instead.
@end table
......@@ -1633,7 +1637,7 @@ database. If you use the default paths, all you have to do is run
these commands:
@example
$ cd /usr/lyskom/exportdb
$ cd /usr/lyskom/var/lyskomd/exportdb
$ cat lyskomd-texts-base.backup \
> lyskomd-texts-tail.backup \
> > ../db/lyskomd-texts
......@@ -2713,7 +2717,7 @@ effective, you should turn off optimization as well.
@item --with-traced-allocations
There is some builtin support for detecting memory leaks in lyskomd.
Whenever the server exits normally it reports how much memory it still
uses to @file{etc/memory-usage}. The count should always be 0.
uses to @file{var/lyskomd.memory}. The count should always be 0.
If there is a leak you can use this option to trace it down. See
@file{src/server/ram-smalloc.c} for more information. You need gdb and
......
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