Update of /cvsroot/monetdb/clients/src/mapiclient
In directory sc8-pr-cvs16.sourceforge.net:/tmp/cvs-serv31361/src/mapiclient
Modified Files:
Makefile.ag
Added Files:
mclient.1
Log Message:
Added an initial man page for mclient.
Index: Makefile.ag
===================================================================
RCS file: /cvsroot/monetdb/clients/src/mapiclient/Makefile.ag,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- Makefile.ag 31 Aug 2007 05:02:17 -0000 1.7
+++ Makefile.ag 13 Sep 2007 15:32:46 -0000 1.8
@@ -39,6 +39,8 @@
$(ICONV_LIBS)
}
-EXTRA_DIST = msqldump.h mprompt.h
+man_MANS = mclient.1
+
+EXTRA_DIST = msqldump.h mprompt.h $(man_MANS)
EXTRA_DIST_DIR = Tests
--- NEW FILE: mclient.1 ---
.TH MCLIENT 1 MonetDB
.SH NAME
mclient \- the MonetDB command-line tool
.SH SYNOPSIS
.B mclient
.BI \-\-language= language
[
.I options
] [
.I file
\&... ]
.br
.B mclient
.B \-\-help
.SH DESCRIPTION
MonetDB is a database management system that is developed from a
main-memory perspective with use of a fully decomposed storage model,
automatic index management, extensibility of data types and search
accelerators, SQL- and XML- frontends.
.PP
.I Mclient
is the command-line interface to the MonetDB server.
.PP
If the
.BI \-\-statement= query
.RB ( \-s
.IR query)
option is given, the query is executed.
If any files are listed after the options, queries are read from the
files and executed.
In either case,
.I mclient
exits after executing the query or queries, unless the
.B \-\-interactive
.RB ( \-i )
option is given, in which case it continues reading queries from
standard input.
If
.I mclient
is started without any non-option arguments and without the
.B \-\-statement
.RB ( \-s )
option, it reads queries from standard input.
.SH
OPTIONS
.SS
General Options
.TP
\fB\-\-language=\fP\fIlanguage\fP (\fB\-l\fP \fIlanguage\fP)
Specify the query language. The following languages are recognized:
.BR mil ,
.BR mal ,
.BR sql ,
and
.BR xquery .
A unique prefix suffices.
The
.B \-\-language
option is required unless the
.B \-\-help
option is given.
.TP
\fB\-\-help\fP (\fB\-?\fP)
Print usage information and exit. If preceded by the
.B \-\-language
option, give language-specific help and continue.
.TP
\fB\-\-database=\fP\fIdatabase\fP (\fB\-d\fP \fIdatabase\fP)
Specify the name of the database to connect to.
.TP
\fB\-\-host=\fP\fIhostname\fP (\fB\-h\fP \fIhostname\fP)
Specify the name of the host on which the server runs (default:
localhost).
.TP
\fB\-\-port=\fP\fIportnr\fP (\fB\-p\fP \fIportnr\fP)
Specify the portnumber of the server (default: 50000).
.TP
\fB\-\-interactive\fP (\fB\-i\fP)
After executing the queries from the
.B \-\-statement
option and any file specified on the command
line, read queries from standard input.
.TP
\fB\-\-user\fP[\fB=\fP\fIuser\fP] (\fB\-u\fP[\fIuser\fP])
Specify the user to connect as. If
.I user
is missing, ask for a user name. Note that
.I user
must follow immediately after the option.
.TP
\fB\-\-passwd\fP[\fB=\fP\fIpassword\fP] (\fB\-P\fP[\fIpassword\fP])
Specify the password to use. If
.I password
is missing, ask for a password. Note that
.I password
must follow immediately after the option.
.TP
\fB\-\-format=\fP\fIformat\fP (\fB\-f\fP \fIformat\fP)
Specify the output format. For XQuery, the possible values include
.BR dm ,
.BR xml ,
and a number of variations.
For the other (table-oriented) languages, the possible values are
.BR sql ,
.BR csv ,
.BR tab ,
.BR raw ,
and
.BR xml .
.TP
\fB\-\-echo\fP (\fB\-e\fP)
Echo the query.
.TP
\fB\-\-history\fP (\fB\-H\fP)
Load and save the command line history (default off).
.TP
\fB\-\-log=\fP\fIlogfile\fP (\fB\-L\fP \fIlogfile\fP)
Save client/server interaction in the specified file.
.TP
\fB\-\-statement=\fP\fIstmt\fP (\fB\-s\fP \fIstmt\fP)
Execute the specified query. The query is run before any queries from
files specified on the command line are run, and before the
interactive session is started (if the \fB\-\-interactive\fP option is
given).
.TP
\fB\-\-time\fP (\fB\-t\fP)
Print timing information.
.TP
\fB\-\-Xdebug\fP (\fB\-X\fP)
Trace network interaction between
.I mclient
and the server.
.TP
\fB\-\-pager=\fP\fIcmd\fP (\fB\-|\fP \fIcmd\fP)
Send query output through the specified
.IR cmd .
One
.I cmd
is started for each query.
Note that the
.B |
will have to be quoted or else the shell will interpret it.
.SS
SQL Options
.TP
\fB\-\-rows=\fP\fInr\fP (\fB\-r\fP \fInr\fP)
If specified, query results will be paged by an internal pager at the
specified number of lines.
.TP
\fB\-\-width=\fP\fInr\fP (\fB\-w\fP \fInr\fP)
Specify the width of the screen. The default is the (initial) width
of the terminal.
.TP
\fB\-\-dump\fP (\fB\-D\fP)
Create an SQL dump.
.SS
XQuery Options
.TP
\fB\-\-collection=\fP\fIcolname\fP (\fB\-C\fP \fIcolname\fP)
Specify the collection name for the XML document shredded with the
.B \-\-input
option.
.TP
\fB\-\-input=\fP\fIdocname\fP (\fB\-I\fP \fIdocname\fP)
The standard input is an XML document which is shredded (added to the
database). The name of the document is specified using this option.
The collection name for the document defaults to the name of the
document but can be specified explicitly with the
.B \-\-collection
option.
Shredding is done before any queries specified with the
.B \-\-statement
option or in files specified on the command line are executed.
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Monetdb-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/monetdb-checkins
