Changes

It gives more details on the command-line options of all Each BaseX [[Startup]] modesmode has one or more command-line options which are described in this article.

Options Command-line options can be specified multiple times. All Please note that all options are will be evaluated in the given order (in earlier versions, the sequential evaluation was limited to the specified inputs, query files, queries and commands, while all other options were initially set). The standard input can be parsed by specifying a single dash ({{Code|-}}) as argument.

Available commandThe following options are available for the standalone [[Command-line flags can be listed with {{Code|-h}}Line Client]]: <presyntaxhighlight>

Usage: basex [-bcdiLoqrRsuvVwxXzbcdiIoqrRstuvVwxz] [input] [input] Execute input XQuery or command file , or expressionquery string -b<parsargs> Bind external query variables -c<input> Execute commands from file or string -d Activate Toggle debugging modeoutput -i<input> Open XML Bind file or databaseto context -I<input> Assign Bind input string to context -o<outputpath> Write output to local file -q<expr> Execute XQuery expression -r<num> Set number of Run query executionsmultiple times -R Turn Toggle query execution on/off -s<parsargs> Set serialization parameter(s)parameters -t[path] Run tests in file or directory -u Write Toggle updates back to in original files -v/V Show (all) process Toggle output of progress info -w Preserve whitespaces from input filesV Toggle detailed query output -x Show query execution planw Toggle whitespace chopping -X Show x Toggle output of query plan before/after compilation -z Skip Toggle output of resultsquery result</presyntaxhighlight>

The meaning of all flags is Further details are listed in the following table. If an equivalent database option exists (which can be specified via the <code>[[Commands#SET|SET]]</code> command), it is listed as well. For the examples to work escaping some characters , it might be necessary, to escape some characters depending on your Operating Systemoperating system.

{| class="wikitable"

* The input string may point to an existing file. If the file suffix is {{Code|.bxs}}, the file content contents will be evaluated as [[Commands#Basics|Command Script]]; otherwise, it any other file content will be evaluated as XQuery expression.

| {{Code|-b&lt;parsargs&gt;}}

| <code>[[Options#BINDINGS{{Option|BINDINGS]]</code>}}

| Executes [[Commandscommands]]:* Several commands in the input can be separated by semicolons ({{Code|;}}).* If the specified input is a valid URI or file reference or URL, its content this file will be executed instead. Empty lines and lines starting with the number sign {{Codeevaluated as [[Commands#Command_Scripts|#}} will be ignoredCommand Script]].

|• {{Code|-c"list;info"}}<br/>• {{Code|-ccommands.txt}}<br/>• {{Code|-c"<info/>"}}

| <code>[[Options#DEBUG{{Option|DEBUG]]</code>}}

| Opens an the specified XML file , directory with XML files, or database specified by the argument. The opened input can then be processed by a command or XQuery expression.

| {{Code|-o&lt;filepath&gt;}}

| <code>[[Options#RUNS{{Option|RUNS]]</code>}}

| <code>[[Options#RUNQUERY{{Option|RUNQUERY]]</code>}}

| {{Code|-s&lt;parsargs&gt;}}

| <code>[[Options#SERIALIZER{{Option|SERIALIZER]]</code>}}

| {{Code|-t[path]}}

| |

| <code>[[Options#WRITEBACK{{Option|WRITEBACK]]</code>}}

| Prints Toggles the output of process and timing information to the ''standard output''.

| <code>[[Options#QUERYINFO{{Option|QUERYINFO]]</code>}}

| Specifies if whitespaces in Toggles whitespace chopping of XML text nodes should . By default, whitespaces will be chopped (which is the default) or preserved.| <code>[[Options#CHOP{{Option|CHOP]]</code>}}

| This flags turn on Toggles the output of the query execution plan, formatted in [[Options#XMLPLANas {{Option|XML]]}}.| <code>[[Options#XMLPLAN{{Option|XMLPLAN]]</code>}}

| <code>[[Options#COMPPLAN{{Option|COMPPLAN]]</code>}}

| <code>[[Options#SERIALIZE{{Option|SERIALIZE]]</code>}}

Available command-line flags can be listed with {{Code|-h}}The following options are available for the [[Database Server]]: <presyntaxhighlight>

Usage: basexserver [-cdinpSzcdnpSz] [stop] stop Stop running server -c<cmdsinput> Execute initial database commandsfrom file or string -d Activate Enable debugging modeoutput -n<name> Set host the server is bound to -p<port> Set server port -S Start as service -z Suppress logging</presyntaxhighlight>

The flags have Details on all options are listed in the following meaning table (equivalent database options are shown in the table as well).For the examples to work escaping some characters , it might be necessary, to escape some characters depending on your Operating Systemoperating system.

{| class="wikitable"

| {{Code|-c&lt;cmdinput&gt;}}| Launches database Executes [[commands before ]]. If the server itself specified input is started. Several commands can a valid URI or file reference, this file will be separated by semicolons ({{Codeevaluated as [[Commands#Command_Scripts|;}})Command Script]].

| Turns on the Enables debugging modeoutput. Debugging information is output to ''standard error''.| <code>[[Options#DEBUG{{Option|DEBUG]]</code>}}

| <code>[[Options#SERVERHOST{{Option|SERVERHOST]]</code>}}

| {{Code|-p&lt;numport&gt;}}

| <code>[[Options#SERVERPORT{{Option|SERVERPORT]]</code>}}

| Starts the server as service (i.e., in the background).Use [[YAJSW]], or start BaseX as an ordinary background process to get more options.|

| Does not generate any Prevents the generation of [[Logging|log files]].| <code>[[Options#LOG{{Option|LOG]]</code>}}

|

;Launch If the console mode communicating with [[Database Server|Database Client]] is executed, the serveruser name and password will be requested on command-line. The initial user/password combination is '''admin'''/'''admin'''. The following options are available:

The user name and password will be requested. The default user/password combination is '''admin'''/'''admin''':<pre>$ basexclientUsername: adminPassword: *****BaseX [Client]Try "help" to get more information.&gt; _</pre> Available command-line flags can be listed with {{Code|-h}}:<presyntaxhighlight>

Usage: basexclient [-bcdiLnopPqrRsUvVwxXzbcdiInopPqrRsUvVwxz] [input] [input] Execute input XQuery or command file , or expressionquery string -b<parsargs> Bind external query variables -c<input> Execute commands from file or string -d Activate Toggle debugging modeoutput -i<input> Open XML Bind file or databaseto context -I<input> Assign Bind input string to context -n<name> Set server (host) name -o<outputpath> Write output to local file -p<port> Set server port -P<pass> Specify user password -q<expr> Execute XQuery expression -r<num> Set number of Run query executionsmultiple times -R Turn Toggle query execution on/off -s<parsargs> Set serialization parameter(s)parameters -U<name> Specify user name -v/V Show (all) process Toggle output of progress info -w Preserve whitespaces from input filesV Toggle detailed query output -x Show query execution planw Toggle whitespace chopping -X Show x Toggle output of query plan before/after compilation -z Skip Toggle output of resultsquery result</presyntaxhighlight>

The flags have See the following meaning table for details (equivalent database options are shown in the table as well).For the examples to work escaping some characters , it might be necessary, to escape some characters depending on your Operating Systemoperating system.

{| class="wikitable"

* The input string may point to an existing file. If the file suffix is {{Code|.bxs}}, the file content contents will be evaluated as [[Commands#Basics|Command Script]]; otherwise, it any other file content will be evaluated as XQuery expression.

| {{Code|-b&lt;parsargs&gt;}}| Binds external variables to XQuery expressions. This flag may be specified multiple times. Variables names and their values are delimited by equality signs (<code>=</code>). The names may be optionally prefixed with dollar signs. If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [httphttps://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].| <code>[[Options#BINDINGS{{Option|BINDINGS]]</code>}}

| Executes [[Commandscommands]]:* Several commands in the input can be separated by semicolons ({{Code|;}}).* If the specified input is a valid URI or file reference or URL, its content will be executed instead. Empty lines and lines starting with the number sign {{Code|#}} will be ignored.

|• {{Code|-c"list;info"}}<br/>• {{Code|-ccommands.txt}}<br/>• {{Code|-c"<info/>"}}

| <code>[[Options#DEBUG{{Option|DEBUG]]</code>}}

| Opens an the specified XML file , directory with XML files, or database specified by the argument. The opened input can then be processed by a command or XQuery expression.

| <code>[[Options#HOST{{Option|HOST]]</code>}}

| {{Code|-o&lt;filepath&gt;}}

| {{Code|-p&lt;numport&gt;}}

| <code>[[Options#PORT{{Option|PORT]]</code>}}

| <code>[[Options#PASSWORD{{Option|PASSWORD]]</code>}}

| {{Code|-q"doc('input')//head1+2"}}

| <code>[[Options#RUNS{{Option|RUNS]]</code>}}

| <code>[[Options#RUNQUERY{{Option|RUNQUERY]]</code>}}

| {{Code|-s&lt;parsargs&gt;}}

| <code>[[Options#SERIALIZER{{Option|SERIALIZER]]</code>}}

| Specifies the user name. If this flag is omitted, the user name will be requested on command line. | <code>[[Options#USER{{Option|USER]]</code>}}

| <code>[[Options#QUERYINFO{{Option|QUERYINFO]]</code>}}

| Specifies if whitespaces in Toggles whitespace chopping of XML text nodes should . By default, whitespaces will be chopped (which is the default) or preserved.| <code>[[Options#CHOP{{Option|CHOP]]</code>}}

| This flags turn on Toggles the output of the query execution plan, formatted in [[Options#XMLPLANas {{Option|XML]]}}.| <code>[[Options#XMLPLAN{{Option|XMLPLAN]]</code>}}

| <code>[[Options#COMPPLAN{{Option|COMPPLAN]]</code>}}

| <code>[[Options#SERIALIZE{{Option|SERIALIZE]]</code>}}

;Launch The following options are available for the [[Web Application|HTTP server:<pre>$ basexhttpBaseX [Server]Server was started (port: 1984)HTTP Server was started (port]: 8984)</pre>

Available command-line flags can be listed with {{Code|-h}}:<presyntaxhighlight>

Usage: basexhttp [-dhlnpPRUWzcdhlnpsSUz] [stop] stop Stop running server -c<input> Execute commands from file or string -d Activate Enable debugging modeoutput -g Enable GZIP support -h<port> Set port of HTTP server -l Start in local mode -n<name> Set host name of database server -p<port> Set port of database server -P<pass> Specify user password -s<port> Specify port to stop HTTP server -S Start as service -U<name> Specify user name -z Suppress logging</presyntaxhighlight>

The flags have meaning of all options is listed in the following meaning table (equivalent database options are shown in the table as well).For the examples to work escaping some characters , it might be necessary, to escape some characters depending on your Operating System.

{| class="wikitable"

| {{Code|-dc&lt;input&gt;}}| Turns on Executes [[commands]]. If the specified input is a valid URI or file reference, this file will be evaluated as [[Commands#Command_Scripts|Command Script]].||| {{Code|-c"open database"}}|- valign="top"| {{Code|-e}}| Enables debugging modeoutput. Debugging information is output to ''standard error''.| <code>[[Options#{{Option|DEBUG}}||DEBUG]]</code>|- valign="top"| {{Code|-g}}| Enables GZIP support in Jetty.| {{Option|GZIP}}

| {{Code|-h&lt;numport&gt;}}

| <code>[[Options#HTTPLOCAL{{Option|HTTPLOCAL]]</code>}}

| <code>[[Options#HOST{{Option|HOST]]</code>}}

| {{Code|-p&lt;numport&gt;}}

| <code>[[Options#SERVERPORT{{Option|SERVERPORT]]</code>}}

| {{Code|-P&lt;pass&gt;}}| Specifies a user password, which will be used by the HTTP services to open a new session. If this flag is omitted, and if {{Code|-U}} was specified, the password will be requested on command line. ''Warning'': when the password is specified with this flag, it may get visible to others.| <code>[[Options#PASSWORD|PASSWORD]]</code>|| {{Code|-Uadmin -Padmin}}|- valign="top"| {{Code|-s&lt;numport&gt;}}

| <code>[[Options#STOPPORT{{Option|STOPPORT]]</code> }} or<br/><code>pom.xml</code>

|

| Starts the server as service (i.e., in the background).Use [[YAJSW]], or start BaseX as an ordinary background process to get more options.|

| <code>[[Options#USER{{Option|USER]]</code>}}

| Does not generate any Prevents the generation of [[Logging|log files]].| <code>[[Options#LOG{{Option|LOG]]</code>}}|

=GUIChangelog=;Launch the GUI:<pre>$ basexgui [file]</pre>

One or more XML and XQuery files can be passed on as parameters. If an XML file is specified, a database instance is created from this file, or an existing database is opened. XQuery files are opened in the XQuery editor;Version 9.0