Command-Line Options

This page gives an overview on all command-line options of the BaseX Startup scripts:

BaseX Server

Launch the server

> basexserver
BaseX [Server]
Server was started.

Available command-line options can be listed with the -h flag:

> 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 options 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 will be addressable.	-p9999
-s	Start the server as service (i.e., in background).
-z	Do not generate log files.

BaseX Client

Launch interactive mode

The user name and password will be requested. The default user/password combination is admin/admin:

> basexclient
Username: admin
Password:
BaseX [Client]
Try "help" to get more information.

> _

Available command-line options can be listed with the -h flag:

> 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         Retain whitespaces from source files
  -z         Skip XQuery serialization

The options 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
-o<file>	Command and query output is written to the specified file.	-p9999
-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.	-q"doc('input')//head"
-U<name>	Specify the user name.	-Uadmin
-v	Process information is written to standard output (STDOUT).
-V	Detailed query information is written to standard output (STDOUT), including compilation and profiling steps.
-w	By default, whitespaces around text nodes are chopped when a database is created. This flag can be specified to suppress chopping.
-z	Skip the serialization of XQuery results. This flag may be useful for analyzing query plans.

BaseX Standalone

Launch the interactive mode

> basex
BaseX [Standalone]
Try "help" to get more information.
>_

Available command-line options can be listed with the -h flag:

> basex -h
Usage: BaseX [-diosuvVwz] [-cq] [file]
  [file]     Execute XQuery file
  -c<cmd>    Execute database command(s)
  -d         Activate debugging mode
  -i<input>  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         Retain whitespaces from source files
  -z         Skip output of results

The options 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, as 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.
-i<input>	Open a database or XML document specified by the argument. The opened input may be further processed by an XQuery expression.	-iitems.xml -q"//item"
-o<file>	Command and query output is written to the specified file.	-p9999
-q<expr>	Execute the specified string as XQuery expression. The flag should be placed last, as all remaining characters are interpreted as XQuery.	-q"doc('input')//head"
-s<pars>	Specify parameters for serializing XQuery results, as specified in the W3C XQuery Serialization document. Key/value pairs are separated by equality signs (=).	-smethod=text
-u	Modify original files after evaluating XQuery Update expressions.
-v	Process information is written to standard output.
-V	Detailed query information is written to standard output, including compilation and profiling steps.
-w	By default, whitespaces around text nodes are chopped when a database is created. This flag can be specified to suppress chopping.
-z	Skip the serialization of XQuery results. This flag may be useful for analyzing query plans.

BaseX REST

Launch the REST Server

> basexrest
Starting REST Server on port 8984...
BaseX [Server]
Server was started.
2011-01-02 03:04:05.600:INFO::Logging to STDERR via org.mortbay.log.StdErrLog
2011-01-02 03:04:05.700:INFO::jetty-6.1.25
2011-01-02 03:04:05.800:INFO::Started SocketConnector@0.0.0.0:8984

Available command-line options can be listed with the -h flag:

> basex -h
Usage: JaxRxServer [-pPrsUz]
  -p<num>   Set database server port
  -P<pass>  Specify user password
  -r<num>   Set REST server port
  -s<pars>  Set serialization parameter(s)
  -U<name>  Specify user name
  -z        Suppress logging

The options have the following meaning:

Flag	Description	Examples
-p<num>	The port on which the BaseX Server will be addressable. The default port is 1984.	-p9998
-r<num>	The port on which the REST Server will be addressable. This port will be specified in the REST URLs. The default port is 8984.	-r9999
-P<pass>	The user password, which will be used by JAX-RX to communicate with the BaseX Server. The default password is admin. Warning: when the password is specified on command-line, it may be visible to others.	-Uadmin -Padmin
-s<pars>	Specify parameters for serializing XQuery results, as specified in the W3C XQuery Serialization document. Key/value pairs are separated by equality signs (=).	-sencoding=US-ASCII -sindent=no
-U<name>	The user name, which will be used by JAX-RX to communicate with the BaseX Server. The default user is admin.	-Uadmin
-z	Do not generate log files.