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

Removed all up, next and prev pointers.

(Invoking updateLysKOM): New node.
(Invoking komrunning): New node.
parent 58e53268
\input texinfo
@c $Id: lyskomd.texi,v 1.14 1999/05/12 13:24:15 byers Exp $
@c $Id: lyskomd.texi,v 1.15 1999/05/16 19:10:27 ceder Exp $
@c %**start of header
@setfilename lyskomd.info
@include version.texi
......@@ -50,8 +50,7 @@ another language under the same conditions as for modified versions.
@end titlepage
@ifinfo
@node Top, Copying, (dir), (dir)
@comment node-name, next, previous, up
@node Top
@top lyskomd
lyskomd is a server for the LysKOM conferencing system. This info file
......@@ -63,14 +62,15 @@ documents version @value{VERSION} of lyskomd.
* Installation:: How to install lyskomd.
* Configuration:: How to configure lyskomd.
* Running lyskomd:: How to run lyskomd.
* Invoking updateLysKOM:: How to run updateLysKOM.
* Invoking komrunning:: How to run komrunning.
* Administration:: Administering a LysKOM server.
* Bugs:: Known bugs.
@end menu
@end ifinfo
@node Copying, Overview, Top, Top
@comment node-name, next, previous, up
@node Copying
@chapter Copying
lyskomd is free software. It is distributed under the Gnu General Public
......@@ -78,8 +78,7 @@ License version 2. The file COPYING in the top level of the distribution
contains the text of the license.
@node Overview, Installation, Copying, Top
@comment node-name, next, previous, up
@node Overview
@chapter Overview
LysKOM is a conferencing system@footnote{Or in modern terms, enabling
......@@ -118,8 +117,7 @@ future.
@node Installation, Configuration, Overview, Top
@comment node-name, next, previous, up
@node Installation
@chapter Installation
Instructions for compiling and installing lyskomd are in the file
......@@ -127,8 +125,7 @@ INSTALL, located in the top level of the lyskomd distribution.
Installation should be straightforward on most platforms.
@node Configuration, Running lyskomd, Installation, Top
@comment node-name, next, previous, up
@node Configuration
@chapter Configuration
There are two configuration files for lyskomd. One defines the server
......@@ -141,8 +138,7 @@ Aux-Item List,The Aux-Item List}.
@end menu
@node Server Configuration File, Aux-Item Definition File, Configuration, Configuration
@comment node-name, next, previous, up
@node Server Configuration File
@section Server Configuration File
The server reads its configuration from a configuration file. The
......@@ -160,8 +156,7 @@ ignored.
* Parameters:: Valid configuration parameters.
@end menu
@node Parameter Types, Parameters, Server Configuration File, Server Configuration File
@comment node-name, next, previous, up
@node Parameter Types
@subsection Parameter Types
Every parameter has a type. The legal types are:
......@@ -194,8 +189,7 @@ text number or perhaps a timeout.
@end table
@node Parameters, , Parameter Types, Server Configuration File
@comment node-name, next, previous, up
@node Parameters
@subsection Parameters
@table @code
......@@ -334,6 +328,9 @@ 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}.
This file should be removed when the computer reboots, before
@code{komrunning} or @code{updateLysKOM} is run.
@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
......@@ -604,8 +601,7 @@ status file. Actually, it is the age of the status file (named with
@end table
@node Aux-Item Definition File, , Server Configuration File, Configuration
@comment node-name, next, previous, up
@node Aux-Item Definition File
@section Aux-Item Definition File
The default aux-item definition file should not be changed unless it is
......@@ -798,8 +794,7 @@ validation function.
@node Running lyskomd, Administration, Configuration, Top
@comment node-name, next, previous, up
@node Running lyskomd
@chapter Running lyskomd
This section explains how to run lyskomd, the files it uses and how it
......@@ -812,8 +807,7 @@ can be controlled while running.
@end menu
@node Invoking lyskomd, Signals, Running lyskomd, Running lyskomd
@comment node-name, next, previous, up
@node Invoking lyskomd
@section Invoking lyskomd
@example
......@@ -834,8 +828,7 @@ The optional @var{config-file} argument can be used to specify the server
configuration file. @xref{Server Configuration File}.
@node Signals, Files, Invoking lyskomd, Running lyskomd
@comment node-name, next, previous, up
@node Signals
@section Signals
It is possible to control some aspects of lyskomd using Unix signals.
......@@ -859,8 +852,7 @@ until the child is done and then continues.
@end table
@node Files, , Signals, Running lyskomd
@comment node-name, next, previous, up
@node Files
@section Files Used by lyskomd
All file names can be changed in the server configuration file.
......@@ -902,15 +894,60 @@ the server configuration file.
@end table
@node Invoking updateLysKOM
@chapter Invoking updateLysKOM
@example
updateLysKOM [-c @var{config-file}] [ -v ] [ -V ]
@end example
@code{updateLysKOM} determines if @code{lyskomd} should be running. It
can start or stop @code{lyskomd} if needed. It uses the same
configuration file as @code{lyskomd} (@pxref{Server Configuration
File}). You can use @samp{-c @var{config-file}} to override the
compiled-in default. Note, however, that this option is not passed
along to @code{lyskomd} if @code{updateLysKOM} starts it, so the option
should be used with extreme caution.
@samp{-v} and @samp{-V} causes @code{updateLysKOM} to report its version
number and exit.
@code{updateLysKOM} is normally run from @code{cron};
@pxref{Administration}.
@node Invoking komrunning
@chapter Invoking komrunning
@example
komrunning [-c config-file] [start | stop]
komrunning -v | -V
@end example
@node Administration, Bugs, Running lyskomd, Top
@comment node-name, next, previous, up
@code{komrunning}, when invoked with no arguments, reports whether
@code{lyskomd} is currently running or not, and whether it should be
running or not. @code{komrunning start} attempts to start
@code{lyskomd}. @code{komrunning stop} attempts to stop @code{lyskomd},
and it will not return until the server has saved its database and
exited.
@code{komrunning} uses the same configuration file as @code{lyskomd}
(@pxref{Server Configuration File}). You can use @samp{-c
@var{config-file}} to override the compiled-in default. Note, however,
that this option is not passed along to @code{updateLysKOM} if
@code{komrunning} invokes it, so the option should be used with extreme
caution.
The @code{komrunning} can be installed in @file{/etc/init.d/}. Be
careful, however, to ensure that the pid file is removed earlier during
the boot sequence.
@node Administration
@chapter Administration
The first thing you will have to do is to follow the instructions in the
file @file{INSTALL}. This will set up the LysKOM system with a database
containing a few necessary conferences and one person - the
administrator.
files @file{INSTALL} and @file{README}. This will set up the LysKOM
system with a database containing a few necessary conferences and one
person - the administrator.
Once the LysKOM system is running, there is not much you will have to do
to keep it that way. One thing to remember is that the current release
......@@ -947,10 +984,11 @@ 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.
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.
......@@ -974,8 +1012,7 @@ by @code{updateLysKOM} the next time it is run. @code{komrunning} only
removes the lock file.
@node Bugs, , Administration, Top
@comment node-name, next, previous, up
@node Bugs
@chapter Known Bugs
@itemize @bullet
......
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