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. Please note that all options will be evaluated in the given order. The standard input can be parsed by specifying a single dash ({{Code|-}}) as argument.

;Launch the standalone (console ) mode:

Available You can list the command-line flags can be listed with options available for the standalone mode using {{Code|-h}}:

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

The meaning of all flags options is 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 System.

{| class="wikitable"

* The input string may point to an existing file. If the file suffix is {{Code|.bxs}}, the file 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 URL URI or file reference, this file will be evaluated as [[Commands#Command_Scripts|Command 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>}}

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

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

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

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

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

Available You can list the available command-line flags can be listed with options using {{Code|-h}}:

Usage: basexserver [-cdinpSzcdnpSz] [stop]

-d Activate Enable debugging modeoutput

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|-c&lt;cmdinput&gt;}}| Executes [[Commandscommands]]:* Several commands in the input can be separated by semicolons ({{Code|;}}).* If the specified input is a valid URL URI or file reference, this file will be evaluated as [[Commands#Command_Scripts|Command Script]].

| <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>}}

|

Available You can list the available command-line flags can be listed with options using {{Code|-h}}:

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

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"

* The input string may point to an existing file. If the file suffix is {{Code|.bxs}}, the file 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 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>}}

Available You can list the available command-line flags can be listed with options using {{Code|-h}}:

Usage: basexhttp [-dhlnpPRUWzcdhlnpsSUz] [stop]

-d Activate Enable debugging modeoutput

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|-c&lt;cmdinput&gt;}}| Executes [[Commandscommands]]:* Several commands in the input can be separated by semicolons ({{Code|;}}).* If the specified input is a valid URL URI or file reference, this file will be evaluated as [[Commands#Command_Scripts|Command Script]].

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

| {{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|-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>}}|