Changeset: 3eedde03f6cf for MonetDB URL: http://dev.monetdb.org/hg/MonetDB?cmd=changeset;node=3eedde03f6cf Modified Files: tools/merovingian/client/monetdb.1.in tools/merovingian/daemon/monetdbd.1.in Branch: default Log Message:
merovingian: update manpages diffs (truncated from 597 to 300 lines): diff --git a/tools/merovingian/client/monetdb.1.in b/tools/merovingian/client/monetdb.1.in --- a/tools/merovingian/client/monetdb.1.in +++ b/tools/merovingian/client/monetdb.1.in @@ -11,7 +11,7 @@ .B monetdb allows an administrator of the MonetDB Database Server to perform various operations on the databases in the server. It relies on -.BR merovingian (1) +.BR monetdbd (1) running in the background for all operations. .SH OPTIONS .I monetdb_options @@ -27,14 +27,14 @@ allows .B monetdb to connect to a remote -.BR merovingian (1). +.BR monetdbd (1). The use of this option requires \-P (see below). .IP "\-p port" Connects to the given portnumber instead of the default (50001). Requires \-h to be given as option too. .IP "\-P passphrase" Specifies the passphrase necessary to login to a remote -.BR merovingian (1). +.BR monetdbd (1). This option requires \-h to be given as well. A bad passphrase causes .B monetdb to fail to login, and hence fail to perform any remote action. @@ -163,7 +163,7 @@ .BR monetdb (1) indicates failure if one of the databases had a failure, even though the operation on other databases was successful. -.IP "get <all | property[,property]> [database ...]" +.IP "get <all | property[,property[,..]]> [database ...]" Prints the requested properties, or all known properties, for the given database. For each property its source and value are printed. Source indicates where the current value comes from, e.g. the configuration @@ -177,13 +177,13 @@ in .BR monetdb5.conf (5). .IP " forward=<redirect|proxy>" -When set to redirect, merovingian tells each connecting client to make a +When set to redirect, monetdbd tells each connecting client to make a new connection directly to the database the client looks for. This requires that the separate mserver5 processes are reachable by the ports they use. Since this may not be the case due to a firewall, when set to -proxy, merovingian tunnels the client to the right database. +proxy, monetdbd tunnels the client to the right database. .IP " share=<yes|no|tag>" -Defines if and how the database is being announced to other merovingians +Defines if and how the database is being announced to other monetdbds or not. If not set to .I "yes" or @@ -224,7 +224,7 @@ Like set, but unsets the database-local value, and reverts to inherit from the default again. .IP "discover [expression]" -Returns a list of remote merovingians and database URIs +Returns a list of remote monetdbds and database URIs that were discovered by .BR monetdbd (1). All databases listed can be connected to via the local MonetDB Database @@ -235,15 +235,15 @@ URI matches the expression. The expression syntax is described in the section .IR EXPRESSIONS . -Next to database URIs the hostnames and ports for merovingians that +Next to database URIs the hostnames and ports for monetdbds that allow to be controlled remotely can be found in the discover list masked with an asterisk. These entries can easily be filtered out using an expression (e.g. "mapi:monetdb:*") if desired. The control entries come -in handy when one wants to get an overview of available merovingians in -e.g. a local cluster. Note that for merovingian to announce its control +in handy when one wants to get an overview of available monetdbds in +e.g. a local cluster. Note that for monetdbd to announce its control port, the .I mero_controlport -setting for that merovingian must be enabled in the configuration file. +setting for that monetdbd must be enabled in the configuration file. .IP \-h .IP "help [command]" Shows general help, or short help for a given command. @@ -281,4 +281,4 @@ in the enviroment. .SH "SEE ALSO" .BR monetdbd (1) -.\".BR mserver5 (1) +.BR mserver5 (1) 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 @@ -6,51 +6,61 @@ monetdbd \- the MonetDB Database Server daemon .SH SYNOPSIS .B monetdbd +[command [command_args] [dbfarm]] .SH DESCRIPTION .B monetdbd is the MonetDB Database Server daemon. The program is mainly meant to be used as deamon, but it also allows to setup and change the configuration of a dbfarm. -The typical use of +The use of .B monetdbd -is to be started from a startup script, such as from +is either as user-oriented way to configure, start and stop a database +farm, or to be started from a startup script, such as from .I /etc/init.d/ on Linux systems or .BR smf (5) on Solaris systems, as part of a system startup. .P .B monetdbd -was formerly known as +is the system formerly known as .BR merovingian . -Internally, +It was renamed to .B monetdbd -keeps on using the name -.BR merovingian , -but it was renamed to better match the expectations of the product to -regular end-users. +since the name +.B merovingian +proved to be confusing to most regular end-users. Internally, +.B monetdbd +uses the name +.B merovingian +at many places for historical reasons. .P A .B monetdbd -instance manages one local cluster based on the dbfarm specified in the -.I @MONETDB5_CONFFILE@ -config file. Within this local cluster +instance manages one local cluster based, which is a directory in the +system, referred to as the +.IR dbfarm . +Nowadays, it is preferred to always give the dbfarm location as argument +to +.BR monetdbd . +For system-wide installs, the default dbfarm location is set to +@Elocalstatedir@/monetdb5/dbfarm. +.P +Within its local cluster .B monetdbd takes care of starting up databases when necessary, and stopping them either upon request via .BR monetdb (1) -or when being shut down. Client connections initially are made against +or when being shut down. Client database connections are made against .B monetdbd -which redirects or proxies the client to the appropriate database -process, started on the fly when necessary. +initially which redirects or proxies the client to the appropriate +database process, started on the fly when necessary. .P When started, .B monetdbd runs in the background, sending log messages to -.IR @MERO_LOG@ , -until being sent a stop, terminate or interrupt signal. Any arguments -given when starting -.B monetdbd -cause the version to be printed followed by a shutdown of +.IR merovingian.log , +until being sent a stop, terminate or interrupt signal, possibly using +the stop command of .BR monetdbd . .P .B monetdbd @@ -61,147 +71,167 @@ databases never override local databases, and their availability is controlled by the remote .B monetdbd -process. +process. See also the sharing capabilities of +.BR monetdb (1) +and the +.I REMOTE DATABASES +section below. +.SH COMMANDS +The commands for +.B monetdbd +are +.BR create ", " start ", " stop ", " get ", " set ", " version ", and " +help . +The commands facilitate initialising a dbfarm, starting and stopping the +MonetDB Database Server, and retrieving or setting options. +.IP "create dbfarm" +Initialises 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. +.IP "start [dbfarm]" +Starts +.BR monetdbd , +the MonetDB Database Server, on the given dbfarm, or its default, the +system-wide location @Elocalstatedir@/monetdb5/dbfarm. +.IP "stop [dbfarm]" +Sends a stop signal to the +.B monetdbd +process responsible for the given dbfarm, or the default system-wide +location @Elocalstatedir@/monetdb5/dbfarm. +.IP "get <all | property[,property[,..]]> [dbfarm]" +Prints the requested properties, or all known properties, for the given +database. For each property and its value are printed. Some properties +are virtual, and given for information purposes only, they cannot be +modified using the +.I set +command. +.IP "set property=value [dbfarm]" +Sets property to value for the given database. For a list of +properties, run +.BR "monetdbd get all" . +Most properties require a restart of the MonetDB Database Server. The +.I set +command, will however always write the property, and tell the running +.B monetdbd +to reload the properties file (if running). For an explanation of the +properties, see the +.I CONFIGURATION +section below. .SH CONFIGURATION .B monetdbd -defaults to use the configuration file -.I @MONETDB5_CONFFILE@ -that was placed in the file -system during installation to control its behaviour. If the environment -variable -.I MONETDB5CONF -is set, +reads its properties from the +.I .merovingian_properties +file inside the dbfarm. This file is created by the +.I create +command. This file is not meant to be editted manually, instead it +should be updated using the +.I set +command. The following properties can be set: +.IP 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. +.IP pidfile .B monetdbd -uses the value of this variable as configuration file to load instead. -In the configuration file the following options can be specified. Most -are typically to be found under the -.I Merovingian -section in the default configuration file. -.IP gdk_dbfarm -The value of this setting determines which local cluster +stores the process ID of the background server in the file pointed to by +this property. The same rules apply as for the +.I logfile +property. +.IP sockdir +For faster access, .B monetdbd -will monitor. -.IP mero_msglog -.IP mero_errlog -When both options are set to an empty string, +uses UNIX domain sockets for its control mechanism and regular database +connections. The sockets are placed as files in the filesystem +hierarchy. The +.I sockdir +property controls in which directory they are placed. In general this +setting should not be changed. +.IP port +This property specifies which TCP port .B monetdbd -logs messages and errors to the stdout and stderr channels on the -caller's console. By setting one or both of the -.B mero_msglog -and -.B mero_errlog -variables, one can specify messages and/or errors to be logged to a file -instead. It is legitimate to have both -.B mero_msglog -and -.B mero_errlog -pointing to the same file, which is the default -.RI ( @MERO_LOG@ ). -.IP mero_pidfile -Location pointing to the pidfile used by +should listen to for regular database connection requests. Defaults to +50000. +.IP controlport +For remote management of +.BR monetdbd, +the +.I controlport +property specifies the TCP port that is opened up for listening. Note _______________________________________________ Checkin-list mailing list [email protected] http://mail.monetdb.org/mailman/listinfo/checkin-list
