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

(Parameter Types): Document "timeval".

(Parameters): Updated the documentation for "timeval" parameters
	and the parameters relating to penalty points.
parent e390ebf2
\input texinfo
@c $Id: lyskomd.texi,v 1.58 2003/01/10 11:18:06 ceder Exp $
@c $Id: lyskomd.texi,v 1.59 2003/07/13 09:48:23 ceder Exp $
@c %**start of header
@setfilename lyskomd.info
@include version.texi
......@@ -199,13 +199,44 @@ The parameter is a TCP/IP port. It can be a symbolic port name
@item int
The parameter is a number of some sort. It can be a conference number,
text number or perhaps a timeout.
text number or perhaps something else.
@item double
The parameter is a floating point number. Any syntax that the C
function @code{strtod} accepts is OK. Examples of truly portable
values: @samp{1} or @samp{1.3}.
@item timeval
The parameter is a time period. It consists of a floating point
number (in the same format as for parameters of type @code{double}),
optionally followed by optional whitespace and a suffix. If no suffix
is specified, it defaults to the suffix mentioned in the description
of the parameter.
Valid suffixes includes:
@itemize
@item seconds
@item second
@item sec
@item s
@item minutes
@item minute
@item min
@item hours
@item hour
@item h
@item days
@item day
@item d
@item milliseconds
@item millisecond
@item m
@item microseconds
@item microsecond
@item u
@end itemize
@end table
A few parameters have ad-hoc types, that are used for a single
......@@ -420,38 +451,38 @@ saves the database and dies. Default is @file{etc/status}.
If this file exists, the server will not allow any connections at all.
Default is @file{/etc/nologin}.
@item Idle timeout: @var{int}
Number of milliseconds to sleep when there is nothing for lyskomd
to do. Default is @code{120000} (two minutes.)
@item Garb busy postponement: @var{timeval}
The garb only runs while the server is idle. This determines how
often the garb will check if the server is idle. Default is @code{20
milliseconds}.
@item Garb timeout: @var{garb}
Number of milliseconds to sleep when the server is garbage-collecting
texts, but has nothing else important to do. Default is @code{100} (0.1
seconds.)
@item Garb timeout: @var{timeval}
How long to sleep when the server is garbage-collecting texts, but has
nothing else important to do. Default is @code{100 milliseconds}.
@item Sync timeout: @var{sync}
Number of milliseconds to sleep when lyskomd is saving its database.
Defaults to 0.
@item Sync timeout: @var{timeval}
How long to sleep when lyskomd is saving its database.
Defaults to @code{0 milliseconds}.
@item Permissive sync: @var{bool}
Turning this option on lets any session sync the LysKOM database.
Turning it off restricts the operation to LysKOM administrators. Default
is off.
@item Garb interval: @var{int}
Number of minutes between each garb sweep. Defaults to @code{1440}, that
is, a garb sweep will be run once per day.
@item Garb interval: @var{timeval}
How long to wait between each garb sweep. Defaults to @code{1440
minutes}, which means that 24 hours will pass between each garb sweep.
@item Sync interval: @var{int}
Number of minutes between syncs. The current version of lyskomd keeps
@item Sync interval: @var{timeval}
How long to wait between syncs. The current version of lyskomd keeps
changes to the database in memory until they are synced to disk. This
parameter specifies the number of minutes the server waits before
attempting to dump the database. The default is @code{5}.
parameter specifies how long the server waits before attempting to
dump the database. The default is @code{5 minutes}.
@item Sync retry interval: @var{int}
@item Sync retry interval: @var{timeval}
If anything goes wrong while trying to dump the data base (such as if
the disk is full), lyskomd will wait for this many minutes before trying
again. Default is @code{1}.
the disk is full), lyskomd will wait for this long before trying
again. Default is @code{1 minute}.
@item Saved items per call: @var{int}
When the server is saving the database, it does so in the background.
......@@ -460,6 +491,26 @@ file, serves another call, et c. This parameter sets the number of
items (texts, conferences, persons) that are saved after each call.
Default is @code{5}.
@item Penalty per call: @var{int}
Penalty points given to a client once a call is completed. This
affects the scheduling. Default is @code{10}.
@item Penalty per read: @var{int}
Penalty points given to a client each time a @code{read(2)} is
performed on the socket connected to the client. This affects the
scheduling. Default is @code{1}.
@item Max penalty: @var{int}
Once a client receives this many penalty points, the server will stop
reading from the socket connected to the client. (Once the server
becomes idle, all penalty points will be aged, so the server will soon
start reading from it again.) Default is @code{100}.
@item Low penalty: @var{int}
Once the penalty points for a client is reduced below this setting,
the server will start reading from the client again. This should be
lower than @code{Max penalty}.
@item Max client data length: @var{int}
The maxiumum allowed length for client name and version data. The
default is @code{60}.
......
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