Difference between revisions of "Command-Line Options"
Jump to navigation
Jump to search
| Line 66: | Line 66: | ||
==BaseX Client== | ==BaseX Client== | ||
| − | ; | + | ;Launch interactive mode |
:<code> | :<code> | ||
> basexclient | > basexclient | ||
</code> | </code> | ||
| − | + | The user name and password is requested. The default user '''admin''' has '''admin''' as password, unless it has been changed: | |
<pre>Username: admin | <pre>Username: admin | ||
| Line 77: | Line 77: | ||
> _</pre> | > _</pre> | ||
| − | + | Available command-line flags can be listed by adding <code>-h</code> to the call: | |
:<code> | :<code> | ||
> basexclient -h | > basexclient -h | ||
| Line 96: | Line 96: | ||
-z Skip output of results | -z Skip output of results | ||
</pre> | </pre> | ||
| + | |||
| + | The command-line flags have the following meaning: | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- valign="top" | ||
| + | ! width='60' | Flag | ||
| + | ! Description | ||
| + | ! width='165' | Examples | ||
| + | |- valign="top" | ||
| + | | <code>[file]</code> | ||
| + | | Execute the specified XQuery file. | ||
| + | | | ||
| + | |- valign="top" | ||
| + | | <code>-c<cmd></code> | ||
| + | | Launch database commands and skip interactive mode. The flag should be placed last, all remaining characters are interpreted as commands. Several commands can be separated by semicolons. | ||
| + | | <code>-c"list;info"</code> | ||
| + | |- valign="top" | ||
| + | | <code>-d</code> | ||
| + | | Turn on debugging. Debugging information is output to standard error (<code>STDERR</code>). | ||
| + | | | ||
| + | |- valign="top" | ||
| + | | <code>-n<name></code> | ||
| + | | Specify the server name on which the server is running. | ||
| + | | <code>-nserver.basex.org</code> | ||
| + | |- valign="top" | ||
| + | | <code>-p<num></code> | ||
| + | | Specify the port on which the server is running. | ||
| + | | <code>-p9999</code> | ||
| + | |- valign="top" | ||
| + | | <code>-P<pass></code> | ||
| + | | Specify the user password. ''Warning'': when the password is specified on command-line, it may be visible to others. | ||
| + | | <code>-Uadmin -Padmin</code> | ||
| + | |- valign="top" | ||
| + | | <code>-q<expr></code> | ||
| + | | Execute the specified string as XQuery expression. The flag should be placed last, as all remaining characters are interpreted as XQuery. | ||
| + | | <code>-Uadmin -Padmin</code> | ||
| + | |- valign="top" | ||
| + | | <code>-U<name></code> | ||
| + | | Specify the user name. | ||
| + | | <code>-Uadmin</code> | ||
| + | |} | ||
==BaseX Standalone== | ==BaseX Standalone== | ||
Revision as of 21:46, 23 January 2011
This page gives an overview on all command-line options of the BaseX Startup scripts:
BaseX Server
- Console command
> basexserver
If the server has been succesfully started, this is coming up:
BaseX [Server] Server was started.
Additional command-line flags can be listed by adding -h to the call:
> basexserver -h
Usage: BaseXServer [-dpsz] [-c] [stop] stop Stop existing server -c<cmd> Execute initial database command(s) -d Activate debugging mode -i Enter interactive mode -p<num> Set server port -s Start as service -z Suppress logging
The command-line flags have the following meaning:
| Flag | Description | Examples |
|---|---|---|
stop
|
Stop an existing server instance; remaining input is ignored. | |
-c<cmd>
|
Launch database commands before the server itself is started; all remaining text is interpreted as command input. Several commands can be separated by semicolons. | -c"open database;info"
|
-d
|
Turn on debugging. Debugging information is output to standard error (STDERR).
|
|
-i
|
Interactively enter commands on the console, similar to standalone and client mode. | |
-p<num>
|
Specify the port on which the server can be addressed. | -p9999
|
-s
|
Start the server as service (i.e., in background). | |
-z
|
Do not generate log files. |
BaseX Client
- Launch interactive mode
> basexclient
The user name and password is requested. The default user admin has admin as password, unless it has been changed:
Username: admin Password: > _
Available command-line flags can be listed by adding -h to the call:
> basexclient -h
Usage: BaseXClient [-npPU] [-dovVwz] [-cq] [file] [file] Execute XQuery file -c<cmd> Execute database command(s) -d Activate debugging mode -n<name> Set server (host) name -o<file> Write output to file -p<num> Set server port -P<pass> Specify user password -q<expr> Execute XQuery expression -U<name> Specify user name -v/V Show (all) process info -w Keep whitespaces from source files -z Skip output of results
The command-line flags have the following meaning:
| Flag | Description | Examples |
|---|---|---|
[file]
|
Execute the specified XQuery file. | |
-c<cmd>
|
Launch database commands and skip interactive mode. The flag should be placed last, all remaining characters are interpreted as commands. Several commands can be separated by semicolons. | -c"list;info"
|
-d
|
Turn on debugging. Debugging information is output to standard error (STDERR).
|
|
-n<name>
|
Specify the server name on which the server is running. | -nserver.basex.org
|
-p<num>
|
Specify the port on which the server is running. | -p9999
|
-P<pass>
|
Specify the user password. Warning: when the password is specified on command-line, it may be visible to others. | -Uadmin -Padmin
|
-q<expr>
|
Execute the specified string as XQuery expression. The flag should be placed last, as all remaining characters are interpreted as XQuery. | -Uadmin -Padmin
|
-U<name>
|
Specify the user name. | -Uadmin
|
BaseX Standalone
- Console command
> basex
All available command-line flags can be listed by adding -h to the call:
> basex -h
Usage: BaseX [-diosuvVwz] [-cq] [file] [file] Execute XQuery file -c<cmd> Execute database command(s) -d Activate debugging mode -i<file> Open initial file or database -o<file> Write output to file -q<expr> Execute XQuery expression -s<pars> Set serialization parameter(s) -u Modifiy original files after updates -v/V Show (all) process info -w wrap query result to xml -z Skip output of results
