Changeset: 4981b1609053 for MonetDB
URL: https://dev.monetdb.org/hg/MonetDB/rev/4981b1609053
Modified Files:
tools/merovingian/daemon/monetdbd.1.in
Branch: default
Log Message:
Slight amendment to exittimeout info.
Also reformat: man page formatting works even better when all
sentences start on a new line (i.e. nothing after the sentence ending
period).
diffs (truncated from 621 to 300 lines):
diff --git a/tools/merovingian/daemon/monetdbd.1.in
b/tools/merovingian/daemon/monetdbd.1.in
--- a/tools/merovingian/daemon/monetdbd.1.in
+++ b/tools/merovingian/daemon/monetdbd.1.in
@@ -1,7 +1,7 @@
.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
-.TH MONETDBD 1 "FEBRUARY 2012" MonetDB "MonetDB Applications"
+.TH MONETDBD 1 "2021-04-12" MonetDB "MonetDB Applications"
.SH NAME
monetdbd \- the MonetDB Database Server daemon
.SH SYNOPSIS
@@ -13,9 +13,9 @@ monetdbd \- the MonetDB Database Server
.I dbfarm
.SH DESCRIPTION
.I Monetdbd
-is the MonetDB Database Server daemon. The program is mainly meant to
-be used as daemon, but it also allows to setup and change the
-configuration of a dbfarm.
+is the MonetDB Database Server daemon.
+The program is mainly meant to be used as daemon, but it also allows
+to setup and change the configuration of a dbfarm.
The use of
.I monetdbd
is either as user-oriented way to configure, start and stop a database
@@ -30,7 +30,8 @@ It was renamed to
.I monetdbd
since the name
.I merovingian
-proved to be confusing to most regular end-users. Internally,
+proved to be confusing to most regular end-users.
+Internally,
.I monetdbd
uses the name
.I merovingian
@@ -49,7 +50,8 @@ Within its local cluster
takes care of starting up databases when necessary, and stopping them
either upon request via
.IR monetdb (1)
-or when being shut down. Client database connections are made against
+or when being shut down.
+Client database connections are made against
.I monetdbd
initially which redirects or proxies the client to the appropriate
database process, started on the fly when necessary.
@@ -65,12 +67,14 @@ the stop command of
.I monetdbd
uses a neighbor discovery scheme to detect other
.I monetdbd
-processes running in the local network. Databases from those remote
-instances are made available to a locally connecting client. Remote
-databases never override local databases, and their availability is
-controlled by the remote
+processes running in the local network.
+Databases from those remote instances are made available to a locally
+connecting client.
+Remote databases never override local databases, and their
+availability is controlled by the remote
.I monetdbd
-process. See also the sharing capabilities of
+process.
+See also the sharing capabilities of
.IR monetdb (1)
and the
.I REMOTE DATABASES
@@ -87,21 +91,22 @@ are
.BR version ,
and
.BR help .
-The commands facilitate initializing a dbfarm, starting and stopping the
-MonetDB Database Server, and retrieving or setting options.
+The commands facilitate initializing a dbfarm, starting and stopping
+the MonetDB Database Server, and retrieving or setting options.
.TP
\fBcreate\fP \fIdbfarm\fP
-Initializes a new database farm, such that a MonetDB Database Server can
-be started on that location. All necessary directories are attempted to
-be created, and an initial properties file is created in the directory
-itself.
+Initializes a new database farm, such that a MonetDB Database Server
+can be started on that location.
+All necessary directories are attempted to be created, and an initial
+properties file is created in the directory itself.
.I dbfarm
must be a location addressable in the local filesystem hierarchy.
.TP
\fBstart\fP [\fB\-n\fP] \fIdbfarm\fP
Starts
.IR monetdbd ,
-the MonetDB Database Server, on the given dbfarm. When the
+the MonetDB Database Server, on the given dbfarm.
+When the
.B \-n
flag is given,
.I monetdbd
@@ -115,71 +120,80 @@ process responsible for the given dbfarm
If the
.B exittimeout
value is non-zero (see below), all mserver processes will be sent a
-termination signal. The current process will wait for the manager
-process to terminate, but sends a SIGKILL signal if waiting takes
-longer than 5 seconds more than the value of exittimeout. If
-exittimeout is negative, both monetdbd processes involved will wait
+termination signal.
+The current process will wait for the manager process to terminate,
+but sends a SIGKILL signal if waiting takes longer than 5 seconds more
+than the value of exittimeout.
+If exittimeout is negative, both monetdbd processes involved will wait
until the servers have all terminated and no extra signals are sent.
.TP
\fBget\fP <\fBall\fP | \fIproperty\fP[,\fIproperty\fP[,..]]> \fIdbfarm\fP
-Prints the requested properties, or all known properties, for the given
-dbfarm. For each property, its value is printed. Some properties
-are virtual, and given for information purposes only, they cannot be
-modified using the
+Prints the requested properties, or all known properties, for the
+given dbfarm.
+For each property, its value is printed.
+Some properties are virtual, and given for information purposes only,
+they cannot be modified using the
.B set
command.
.TP
\fBset\fP \fIproperty\fP\fB=\fP\fIvalue\fP \fIdbfarm\fP
-Sets property to value for the given database. For a list of
-properties, run
+Sets property to value for the given database.
+For a list of properties, run
.BR "monetdbd get all" .
Some properties require a restart of the MonetDB Database Server in
-order to take effect. The
+order to take effect.
+The
.B set
command, will however always write the property, and tell the running
.I monetdbd
-to reload the properties file (if running). For an explanation of the
-properties, see the
+to reload the properties file (if running).
+For an explanation of the properties, see the
.I CONFIGURATION
section below.
.SH CONFIGURATION
.I Monetdbd
reads its properties from the
.I .merovingian_properties
-file inside the dbfarm. This file is created by the
+file inside the dbfarm.
+This file is created by the
.B create
-command. This file is not meant to be edited manually, instead it
-should be updated using the
+command.
+This file is not meant to be edited manually, instead it should be
+updated using the
.B set
-command. The following properties can be set:
+command.
+The following properties can be set:
.TP
.B logfile
This property points to the file where all log messages are written to.
-It is relative to the dbfarm directory, but can be absolute to point to
-e.g. another medium. Changing this property takes effect immediately at
-runtime.
+It is relative to the dbfarm directory, but can be absolute to point
+to e.g. another medium.
+Changing this property takes effect immediately at runtime.
.TP
.B pidfile
.I Monetdbd
-stores the process ID of the background server in the file pointed to by
-this property. The same rules apply as for the
+stores the process ID of the background server in the file pointed to
+by this property.
+The same rules apply as for the
.B logfile
property.
.TP
.B sockdir
For faster access,
.I monetdbd
-uses UNIX domain sockets for its control mechanism and regular database
-connections. The sockets are placed as files in the filesystem
-hierarchy. The
+uses UNIX domain sockets for its control mechanism and regular
+database connections.
+The sockets are placed as files in the filesystem hierarchy.
+The
.B sockdir
-property controls in which directory they are placed. In general this
-setting should not be changed.
+property controls in which directory they are placed.
+In general this setting should not be changed.
.TP
.B port
This property specifies which TCP port
.I monetdbd
-should listen to for connection requests. Defaults to 50000.
+should listen to for connection requests.
+Defaults to 50000.
.TP
.B listenaddr
This property specifies an address that is allowed to connect to the
@@ -189,7 +203,8 @@ The following possibilities exist:
.TP
.B localhost
The server only listens on the IPv4 and IPv6 loopback interface (if
-available). This is the default.
+available).
+This is the default.
.TP
.B 127.0.0.1
The server only listens on the IPv4 loopback interface.
@@ -217,27 +232,29 @@ For remote management of
.IR monetdbd ,
the
.B control
-property specifies whether or not to enable remote management. Note
-that for remote management, a passphrase is required, see below. It
-defaults to false for security reasons. Changing this property takes
-effect immediately at runtime.
+property specifies whether or not to enable remote management.
+Note that for remote management, a passphrase is required, see below.
+It defaults to false for security reasons.
+Changing this property takes effect immediately at runtime.
.TP
.B passphrase
To control
.I monetdbd
from a remote machine, a passphrase is necessary, to be given to
.IR monetdb (1).
-The passphrase can be either given as hashed value prefixed by the hash
-type in curly braces (e.g. {SHA512}xxx...) or as plain text value which
-will be hashed automatically. Note that the only hash accepted is the
-one specified at configure time, which is @PASSWORD_BACKEND@.
+The passphrase can be either given as hashed value prefixed by the
+hash type in curly braces (e.g. {SHA512}xxx...) or as plain text value
+which will be hashed automatically.
+Note that the only hash accepted is the one specified at configure
+time, which is @PASSWORD_BACKEND@.
Changing this property takes effect immediately at runtime.
.TP
.B snapshotdir
This property specifies where the
.I monetdb snapshot create
-command stores its snapshots. There is no default value. If unset, no
-snapshots can be created.
+command stores its snapshots.
+There is no default value.
+If unset, no snapshots can be created.
.TP
.B snapshotcompression
This property specifies whether database snapshots created by
@@ -247,7 +264,8 @@ The default value is
.I .tar.lz4
if LZ4 compression is available, or
.I .tar
-otherwise. Other supported values are, if available,
+otherwise.
+Other supported values are, if available,
.IR .tar.gz ,
.IR .tar.xz ,
and
@@ -258,46 +276,56 @@ would take enormous amounts of time.
.TP
.B discovery
Specifies whether neighbor discovery is to be enabled using UDP
-broadcasts or not. The broadcasts are done on the same portnumber as
-the port setting.
+broadcasts or not.
+The broadcasts are done on the same portnumber as the port setting.
.TP
.B discoveryttl
.I Monetdbd
-publishes locally available databases to others periodically. The
-interval used here, defined in seconds, depends on the time-to-live of
-the databases before they need to get refreshed. The default is 600
-seconds (10 minutes), which should keep traffic in your network fairly
-low. Additions and removals are processed immediately regardless of
-this timeout. If you are in a network environment where physical
-network links disappear often, you may want to decrease this value to
-more quickly remove no longer reachable databases.
+publishes locally available databases to others periodically.
+The interval used here, defined in seconds, depends on the
+time-to-live of the databases before they need to get refreshed.
+The default is 600 seconds (10 minutes), which should keep traffic in
+your network fairly low.
+Additions and removals are processed immediately regardless of this
+timeout.
+If you are in a network environment where physical network links
+disappear often, you may want to decrease this value to more quickly
+remove no longer reachable databases.
.TP
.B exittimeout
-if
+If
.I monetdbd
stops a running mserver, for example in response to a
.I monetdb stop
_______________________________________________
checkin-list mailing list
[email protected]
https://www.monetdb.org/mailman/listinfo/checkin-list
