Changes

The following scripts, which are referenced in the BaseX can be [[Startup|started in different ways]] and . The [[Startup Options]] articles, are also included in the Windows and ZIP [httphttps://basex.org/products/download/ release filesWindows and ZIP distributions]include various start scripts, which are presented in the following, and available in our [https://githubwhich can also be maintained separately.com/BaseXdb/basex/tree/master/etc GitHub repository]:

* We recommend you to manually add the BaseX {{Code|bin}} directory of your BaseX instance to the [https://en.wikipedia.org/wiki/PATH_(variable) PATH variable] of your <code>PATH</code> environment variable.* The If you use the Windows installer , that’s done automatically adds .* You can copy the start scripts to another location in your file system. After that, you should edit the scripts and assign the BaseX directory to the project’s {{Code|binMAIN}} directory to your path environmentvariable.* If you are compiling the source code with [[Maven]], you can launch BaseX via the scripts in the [https://github.com/BaseXdb/basex/tree/master/basex-core/etc basex-core/etc] and [https://github.<brcom/BaseXdb/basex/tree/master/basex-api/><bretc basex-api/>etc] subdirectories of the project.

=If BaseX Main Package=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). A conservative value was chosen in our distributions to ensure that BaseX will also run on older JVMs.

==WindowsUse the following scripts to launch the standalone version of BaseX: basex.bat==

==Windows: {{Code|basex.bat}}== <pre classlang="brush:bashbatch">

REM Path to this scriptcore and library classesset PWDMAIN=%~dp0 REM Core and library classes/..set CP=%PWDMAIN%/../BaseX.jarset LIB=;%PWDMAIN%/../libfor /R "%LIB%" %%a in (*.jar) do set CP=!CP!;%MAIN%a/lib/custom/*

set VMBASEX_JVM=-Xmx512mXmx1200m %BASEX_JVM%

java -cp "%CP%" %VMBASEX_JVM% org.basex.BaseX %*

==Linux/Mac: {{Code|basex}}==

<pre classlang="brush:bash">#!/usr/bin/env bash

BXMAIN="$( cd -P "$(dirname "$FILE")/.." && pwd )"

CP="$BXMAIN/BaseX.jar"CP=":$CPMAIN/lib/*:$(for JAR in "$BX"MAIN/lib/custom/*.jar; do echo -n ":$JAR"; done)"CLASSPATH

# Options for virtual machine(can be extended by global options)VMBASEX_JVM="-Xmx512mXmx2g $BASEX_JVM"

java -cp "$CP" $VM BASEX_JVM org.basex.BaseX "$@"

=BaseX HTTP 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>.

The scripts for starting the =HTTP server, which gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] services, can be found below.Server=

In {{MarkThe scripts for running [[Web Application|Version 7.2}}, the {{Code|BaseXHTTP}} start class has been moved from the {{Code|org.basex.api}} package to {{Code|org.basex}}.Web Applications]] can be found below:

==Windows: {{Code|basexhttp.bat}}==

<pre classlang="brush:bashbatch">

REM Path to this scriptcore and library classesset PWDMAIN=%~dp0 REM Core and library classes/..set CP=%PWDMAIN%/../BaseX.jarset LIB=;%PWDMAIN%/../libfor /R "%LIB%" %%a in (*.jar) do set CP=!CP!;%MAIN%afor /R "%LIB%" %%a in (lib/custom/*.jar) do set CP=!CP!;%%a

set VMBASEX_JVM=-Xmx512mXmx1200m %BASEX_JVM%

java -cp "%CP%;." %VMBASEX_JVM% org.basex.BaseXHTTP %*

==Linux/Mac: {{Code|basexhttp}}==

<pre classlang="brush:bash">#!/usr/bin/env bash

BXMAIN="$( cd -P "$(dirname "$FILE")/.." && pwd )"BXCORE="$( cd -P "$BX/../basex" && pwd )"

CP="$BXMAIN/BaseX.jar$(printf ":%s" "$BXMAIN/lib/BaseX.jar" "*:$BXMAIN/lib/"custom/*.jar :$CLASSPATH # Options for virtual machine (can be extended by global options)BASEX_JVM="-Xmx2g $BXCORE/target/classesBASEX_JVM"  # Run codejava -cp "$BXCORE/lib/CP"*$BASEX_JVM org.basex.jar)BaseXHTTP "$@"</pre>

# Options for virtual machineVM=-Xmx512mIncluded Start Scripts=

general_argsThe BaseX [https://basex.org/download/ Windows and ZIP distributions] include the following start scripts: {| class="wikitable"|- valign=( )"top"vm_args! Windows! Linux/Mac! Description|- valign=( )"top"while (( $# )) ; do| {{Code|basex.bat}} if [[ $1 | {{Code|basex}}| Launches the BaseX standalone mode.|- valign= "top"| {{Code|basexclient.bat}}| {{Code|basexclient}}| Starts a BaseX client.|-Xvalign=" ]] ; thentop"| {{Code|basexgui.bat}}| {{Code|basexgui}}| Starts the BaseX GUI. vm_args+|- valign=( "$2top" ) shift 2| {{Code|basexhttp.bat}}| {{Code|basexhttp}} else| Starts the BaseX HTTP Server. general_args+|- valign=( "$1top" ) shift| {{Code|basexserver.bat}}| {{Code|basexserver}}| Starts the BaseX database server.|} fidoneFor the BaseX HTTP and database server, additional stop scripts are available:

# Run code{| class="wikitable"java |-cp valign="top"! Windows! Linux/Mac! width="$CP40%" $VM | Description|- valign="$top"|- valign="top"| {{Code|basexhttpstop.bat}}| {{vm_args[@]Code|basexhttpstop}}| Stops the BaseX HTTP Server.|- valign="top" org| {{Code|basexserverstop.basexbat}}| {{Code|basexserverstop}}| Stops the BaseX database server.BaseXHTTP "${general_args[@]|}" </pre>

;Version 7.45