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 following options are available for the console mode:<pre>$ basexBaseX standalone [[StandaloneCommand-Line Client]]Try "help" to get more information.> _</pre>:

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

-b<parsargs> Bind external query variables

-o<filepath> Write output to local file

-s<parsargs> Set serialization parameters

</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.

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

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

| Executes [[commands]]:* 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>}}

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

One The following options are available for the standalone [[GUI|Graphical User Interface]]: <syntaxhighlight>$ basexgui -hBaseX [GUI]Usage: basexgui [-d] [files] [files] Open specified files -d Enable debugging</syntaxhighlight> You can pass one or more XML and XQuery files can be passed on as parameters. If an XML file document is specified, a database instance is can be created from this file, or an existing database is opened. XQuery Other files are opened in the XQuery editor.

;Launch The following options are available for the server<pre>$ basexserverBaseX [[Database Server]Server was started (port]: 1984)</pre>

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

-c<cmdinput> Execute commands from file or string

</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.

| {{Code|-c&lt;cmdinput&gt;}}| Executes [[commands]]:* 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]].

| 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>[[Options#SERVERPORT{{Option|SERVERPORT]]</code>}}

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

;Launch If the console mode communicating with [[Database Server|Database Client]] is executed, the server The user name and password will be requestedon command-line. The default initial user/password combination is '''admin'''/'''admin'''. The following options are available:<pre>$ basexclientUsername: adminPassword: *****BaseX [Client]Try "help" to get more information.&gt; _</pre>

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

-b<parsargs> Bind external query variables

-o<filepath> Write output to local file

-s<parsargs> Set serialization parameters

</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.

| {{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 [[commands]]:* 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>[[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>}}

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

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

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

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

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

</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.

| {{Code|-c&lt;cmdinput&gt;}}| Executes [[commands]]:* 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|-de}}| Turns on the Enables debugging modeoutput. Debugging information is output to ''standard error''.| <code>[[Options#{{Option|DEBUG}}|||- valign="top"|DEBUG]]</code>{{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|-s&lt;numport&gt;}}

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

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

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