Update of /cvsroot/monetdb/MonetDB5/src/tools
In directory sc8-pr-cvs16.sourceforge.net:/tmp/cvs-serv27651
Modified Files:
Makefile.ag monetdb.mx
Added Files:
monetdb.1
Log Message:
Added manpage for monetdb utility.
--- NEW FILE: monetdb.1 ---
.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
.TH MONETDB 1 "SEPTEMBER 2007" Application "MonetDB Applications"
.SH NAME
monetdb \- control a MonetDB Database Server instance
.SH SYNOPSIS
.B monetdb
command [command_options] [command_args]
.SH DESCRIPTION
.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)
running in the background for starting and stopping databases.
.SH COMMANDS
The commands for the
.B monetdb
utility are
.B create, destroy, lock, release, status, start, stop, kill, help, version.
The commands facilitate adding, removing, maintaining, starting and
stopping a database inside the MonetDB Database Server.
.IP "create [\-l] database"
Initialises a new database in the MonetDB Database Server. A database
created with this command makes it available for use by clients under
its database name.
.IP \-l
The
.I \-l
(lock) option, puts the database in maintenance mode directly after
its creation. A database created like this is guaranteed not to be
automatically started by
.BR merovingian (1)
upon a client request during its creation time.
.IP "destroy [\-f] database"
Removes the given database, including all its data and logfiles. Once
destroy has completed, all data is lost. Be careful when using this
command.
.IP \-f
By default, a confirmation question is asked, however the
.I \-f
option, when provided, supresses this question and removal is executed
right away. Note that you cannot destroy a running database, bring it
down first using the
.B stop
command.
.IP "lock database"
Puts the given database in maintenance mode. A database under
maintenance can only be connected to by an administrator account
(by default the
.I monetdb
account). A database which is under maintenance is not started
automatically by
.BR merovingian (1)
, the MonetDB Database Server when clients request for it. Use the
.B release
command to bring the database back for normal usage. To start a
database which in under maintenance for administrator access, the
.B start
command can be used.
.IP "release database"
Brings back a database from maintenance mode. A released database is
available again for normal use by any client, and is started on demand.
Use the
.B lock
command to take a database under maintenance.
.IP "status [\-als] [database ...]"
Shows the state of the given database(s) or, when
.I \-a
is supplied, all known databases. Three modes control the level of
detail in the displayed output. By default the most used properties of
a database are being shown. This includes the state of the database
(running, crashed, stopped), whether it is under maintenance or not, the
crash averages and uptime statistics. The crash average is the number
of times the database has crashed over the last 1, 15 or 30 starts. The
lower the average, the healthier the database is.
.IP \-l
Triggered by the
.I \-l
flag, a long listing is used. This listing spans many rows with on each
row one property and its value separated by a colon (`:'). The long
listing includes every information that is available.
.IP \-s
Contrary to the long listing, the
.I \-s
flag produces a short, one-line output per database. This output
resembles pretty much the output of various
.B XXXstat
functions, and is ideal for quickly gaining an overview of the system
state in combination with the
.I \-a
flag.
.IP "start [\-a] [database ...]"
.IP "stop [\-a] [database ...]"
.IP "kill [\-a] [database ...]"
Starts, stops or kills the given database(s) or, when
.I \-a
is supplied, all known databases, if the MonetDB Database Server
.BR merovingian (1)
is running. The
.B kill
command should only be used as last resort for a database that doesn't
respond any more to a
.B stop
command. Killing a database may result in (partial) data loss.
.IP \-h
.IP "help [command]"
Shows general help, or short help for a given command.
.IP \-v
.IP version
Shows the version of the
.B monetdb
utility.
.SH "RETURN VALUE"
The
.B monetdb
utility returns exit code
.B 0
if it successfully performed the requested command. An error caused by
user input or database state is indicated by exit code
.B 1.
If an internal error in the utility occurs, exit code
.B 2
is returned.
.SH FILES
.I /etc/monetdb5.conf
.RS
The configuration file for MonetDB, located in the system configuration
directory.
.SH "SEE ALSO"
.BR merovingian (1)
.\".BR mserver5 (1)
Index: monetdb.mx
===================================================================
RCS file: /cvsroot/monetdb/MonetDB5/src/tools/monetdb.mx,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -d -r1.24 -r1.25
--- monetdb.mx 2 Sep 2007 19:38:01 -0000 1.24
+++ monetdb.mx 2 Sep 2007 20:56:16 -0000 1.25
@@ -131,7 +131,7 @@
printf(" as last resort to stop a database. A database
being\n");
printf(" killed may end up with data loss.\n");
} else if (strcmp(argv[1], "help") == 0) {
- printf("Yeah , help on help, how desparate can you be? ;)");
+ printf("Yeah , help on help, how desparate can you be? ;)\n");
} else if (strcmp(argv[1], "version") == 0) {
printf("Usage: monetdb version\n");
printf(" prints the version of this monetdb utility\n");
Index: Makefile.ag
===================================================================
RCS file: /cvsroot/monetdb/MonetDB5/src/tools/Makefile.ag,v
retrieving revision 1.49
retrieving revision 1.50
diff -u -d -r1.49 -r1.50
--- Makefile.ag 31 Aug 2007 15:55:45 -0000 1.49
+++ Makefile.ag 2 Sep 2007 20:56:15 -0000 1.50
@@ -18,6 +18,8 @@
MTSAFE
INCLUDES = -I../mal $(CLIENTS_INCS) $(MONETDB_INCS) $(OPENSSL_INCS)
$(PCRE_CFLAGS)
+man_MANS = monetdb.1
+
bin_mserver5 = {
SOURCES = mserver5.mx.in
LIBS = ../mal/libmal @SHARED_LIBS@ $(MONETDB_LIBS) \
@@ -77,4 +79,4 @@
SOURCES = monetdb5-config.bat.in
}
-EXTRA_DIST_DIR = Tests
+EXTRA_DIST_DIR = Tests $(man_MANS)
-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Monetdb-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/monetdb-checkins
