Changes

Jump to navigation Jump to search
531 bytes removed ,  12:53, 8 July 2020
no edit summary
=Standalone=
;Launch The following options are available for the standalone (console) mode:<pre>$ basexBaseX [Standalone[Command-Line Client]]Try "help" to get more information.> _</pre>:
You can list the command-line options available for the standalone mode using {{Code|-h}}:<presyntaxhighlight>
$ basex -h
BaseX [Standalone]
-x Toggle output of query plan
-z Toggle output of query result
</presyntaxhighlight>
The meaning of all options 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, it might be necessary to escape some characters depending on your Operating Systemoperating system.
{| class="wikitable"
|- valign="top"
| {{Code|-c&lt;input&gt;}}
| Executes [[commands]]:* Several commands should be supplied via single <code>-c</code> flags.* If the specified input is a valid 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/>"}}
|- valign="top"
| {{Code|-d}}
=GUI=
;Launch the GUI:
The following options are available for the standalone [[GUI|Graphical User Interface]]: <codesyntaxhighlight>$ basexgui -hBaseX [GUI]Usage: basexgui[-d] [files] [files] Open specified files -d Enable debugging</codesyntaxhighlight> 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 [You can pass one or more files as parameters. If an XML document is specified, a database instance can be created from this file]</pre>. Other files are opened in the editor.
=Server=
;Launch The following options are available for the server<pre>$ basexserverBaseX [[Database Server]Server was started (port]: 1984)</pre>
You can list the available command-line options using {{Code|-h}}:<presyntaxhighlight>
$ basexserver -h
BaseX [Server]
-S Start as service
-z Suppress logging
</presyntaxhighlight>
The meaning of Details on all options is are listed in the following table (equivalent database options are shown in the table as well).For the examples to work, it might be necessary to escape some characters depending on your Operating Systemoperating system.
{| class="wikitable"
|- valign="top"
| {{Code|-c&lt;input&gt;}}
| Executes [[commands]]:* Several commands should be supplied via single <code>-c</code> flags.* If the specified input is a valid URI or file reference, this file will be evaluated as [[Commands#Command_Scripts|Command Script]].
|
|
|- valign="top"
| {{Code|-d}}
| Turns on the Enables debugging modeoutput. Debugging information is output to ''standard error''.
| {{Option|DEBUG}}
| <code>false</code>
=Client=
;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>
You can list the available command-line options using {{Code|-h}}:<presyntaxhighlight>
$ basexclient -h
BaseX [Client]
-x Toggle output of query plan
-z Toggle output of query result
</presyntaxhighlight>
The meaning of all options is listed in See the following table for details (equivalent database options are shown in the table as well).For the examples to work, it might be necessary to escape some characters depending on your Operating Systemoperating system.
{| class="wikitable"
|- valign="top"
| {{Code|-b&lt;args&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].
| {{Option|BINDINGS}}
|
|- valign="top"
| {{Code|-c&lt;input&gt;}}
| Executes [[commands]]:* Several commands should be supplied via single <code>-c</code> flags.* If the specified input is a valid URI or file reference, 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/>"}}
|- valign="top"
| {{Code|-d}}
=HTTP Server=
;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>
You can list the available command-line options using {{Code|-h}}:<presyntaxhighlight>
$ basexhttp -h
BaseX [HTTP]
-c<input> Execute commands from file or string
-d Enable debugging output
-g Enable GZIP support
-h<port> Set port of HTTP server
-l Start in local mode
-U<name> Specify user name
-z Suppress logging
</presyntaxhighlight>
The meaning of all options is listed in the following table (equivalent database options are shown in the table as well).
|- valign="top"
| {{Code|-c&lt;input&gt;}}
| Executes [[commands]]:* Several commands should be supplied via single <code>-c</code> flags.* 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|-de}}| Turns on the Enables debugging modeoutput. Debugging information is output to ''standard error''.
| {{Option|DEBUG}}
|
|
|- valign="top"
| {{Code|-g}}
| Enables GZIP support in Jetty.
| {{Option|GZIP}}
|
|
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu