administrator, editor
162
edits
Changes
Jump to navigation
Jump to search
no edit summary
Each BaseX [[Startup]] mode has can be launched with its own Start Script each of which can in turn be used with its own range of [[Command-Line Options]]. The Start Scripts are included in the BaseX [http://basex.org/download/ Windows and ZIP distributions]readily include all Start Scripts.
* We recommend you to manually add the {{Code|bin}} directory of your BaseX directory to the [http://en.wikipedia.org/wiki/PATH_(variable) PATH variable] of your environment.
If BaseX terminates with an {{Code|Out of Memory}} or {{Code|Java heap space}} error, you can assign more RAM via the {{Code|-Xmx}} flag (see below). The conservative value that was chosen in our distributions ensures that BaseX will also run on 32 bit JVMs.
=Main PackageStandalone=
The following scripts can be used to launch the standalone version of BaseX. Please replace the class name in <code>org.basex.BaseX</code> with either <code>BaseXClient</code>, <code>BaseXServer</code>, or <code>BaseXGUI</code> to run the client, server or GUI version.:
==Windows: {{Code|basex.bat}}==
<pre class="brush:bash">
</pre>
==Linux/Mac: {{Code|basex}}==
<pre class="brush:bash">
java -cp "$CP" $BASEX_JVM org.basex.BaseX "$@"
</pre>
=GUI, Server, Client=
If you would like to launch the GUI, Server or Client version of BaseX, please replace the class name in <code>org.basex.BaseX</code> with either <code>BaseXGUI</code>, <code>BaseXServer</code> or <code>BaseXClient</code>.
=HTTP Server=
The scripts for starting the HTTP server, which gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] services, can be found below.:
==Windows: {{Code|basexhttp.bat}}==
<pre class="brush:bash">
</pre>
==Linux/Mac: {{Code|basexhttp}}==
<pre class="brush:bash">
java -cp "$CP" $BASEX_JVM org.basex.BaseXHTTP "$@"
</pre>
=Included Start Scripts=
The BaseX [http://basex.org/download/ Windows and ZIP distributions] readily include the following Start Scripts:
{| class="wikitable"
|- valign="top"
! Windows
! Linux/Mac
! width="40%" | Description
|- valign="top"
| {{Code|basex.bat}}
| {{Code|basex}}
| Launches the BaseX standalone mode.
|- valign="top"
| {{Code|basexclient.bat}}
| {{Code|basexclient}}
| Starts a BaseX client.
|- valign="top"
| {{Code|basexgui.bat}}
| {{Code|basexgui}}
| Starts the BaseX GUI.
|- valign="top"
| {{Code|basexhttp.bat}}
| {{Code|basexhttp}}
| Starts the BaseX HTTP Server.
|- valign="top"
| {{Code|basexserver.bat}}
| {{Code|basexserver}}
| Starts the BaseX database server.
|}
For the BaseX HTTP and database server, there are also stop scripts available:
{| class="wikitable"
|- valign="top"
! Windows
! Linux/Mac
! width="40%" | Description
|- valign="top"
|- valign="top"
| {{Code|basexhttpstop.bat}}
| {{Code|basexhttpstop}}
| Stops the BaseX HTTP Server.
|- valign="top"
| {{Code|basexserverstop.bat}}
| {{Code|basexserverstop}}
| Stops the BaseX database server.
|}
=Changelog=
