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.

=BaseX Standalone= ;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 initial Bind file or databaseto context -L Append newlines I<input> Bind input string to query resultscontext -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 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>}}

|• <code>-b$vbv=example "declare variable $v external; $v"</code><br/>• <code>-b{URL}ln=value<br/>"declare namespace ns='URL'; declare variable $ns:ln external; $ns:ln"</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 a the specified XML file, directory with XML files, or database or XML document specified by the argument. The opened input may can then be further processed by an a command or XQuery expression.

| {{Code|-LI&lt;input&gt;}}| Separates returned query items by newlines (instead Assigns an input string as item of spaces) and appends a newline type {{Code|xs:untypedAtomic}} to the end of a resultquery context.|

| {{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]}}| Runs all [[Unit Module|Unit tests]] in the specified file or directory. {{Mark|Introduced with Version 7.9}}| |

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

| Creates Generates the query plan before or after query compilation. {{Code|-x}} needs to be activated to make the plan visible.| <code>[[Options#COMPPLAN{{Option|COMPPLAN]]</code>}}

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

=BaseX GUI=;Launch the GUI: The <code>basexgui</code> command has only one option. You can pass one or more XML and XQuery files 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. <pre>$ basexgui [file]</pre> =Server= 

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

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

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"

| Stops an existing a local database server instance and quits.

| {{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]].

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

|

=BaseX Client=

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 initial Bind file or databaseto context -L Append newlines I<input> Bind input string to query resultscontext -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 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 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 a the specified XML file, directory with XML files, or database or XML document specified by the argument. The opened input may can then be further processed by an a command or XQuery expression.

| {{Code|-LI&lt;input&gt;}}| Separates returned query items by newlines (instead Assigns an input string as item of spaces) and appends a newline type {{Code|xs:untypedAtomic}} to the end of a resultquery context.

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

| Creates Generates the query plan before or after query compilation. {{Code|-x}} needs to be activated to make the plan visible.| <code>[[Options#COMPPLAN{{Option|COMPPLAN]]</code>}}

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

=BaseX HTTP Server=

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

Usage: basexhttp [-dehlnpPRUWzcdhlnpsSUz] [stop] stop Stop running server -d Activate debugging modec<input> Execute commands from file or string -e<port> Set event portd Enable debugging output -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

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"

| Stops a running local HTTP serverand quits. By default, the The database server will be stopped as well, unless {{Code|-l}} has been is specified.

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

| {{Code|-eh&lt;num&gt;}}| Specifies the port on which the server will send events to clients.| <code>[[Options#EVENTPORT|EVENTPORT]]</code>| {{Code|1985}}| {{Code|-e9998}}|- valign="top"| {{Code|-h&lt;num&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|-Ps&lt;passport&gt;}}| Specifies a user password, which the port that will be used by to stop the HTTP services to open a new sessionserver. If this flag is omitted, and if | {{CodeOption|-USTOPPORT}} was specified, the password will be requested on command line. ''Warning'': when the password is specified with this flag, it may get visible to othersor<br/><code>pom.xml</code>| <code>[[Options#PASSWORD|PASSWORD]]8985</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>}}|

=BaseX GUIChangelog= ;Version 9.0 * Added: BaseXHTTP, command-line option {{Code|-c}}.* Updated: BaseXHTTP, command-line option {{Code|-c}}, additionally accepts valid URLs and file references. ;Launch the GUIVersion 8.2 * Removed:Event ports, {{Code|-e}}.<pre>$ basexgui [file];Version 8.1 </pre>* Added: Bind input strings to the query context with {{Code|-I}}.

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 8.0