Changes

The following scripts, which are mentioned on the Each BaseX [[Startup]] and mode can be launched with its own Start Script which can in turn be used with its own range of [[Startup Command-Line Options]] pages, are also included in our official '''Windows''' and '''ZIP''' release files, and available in our . The BaseX [https://githubbasex.comorg/BaseXdbdownload/basex-dist/tree/master/bin GitHub repositoryWindows and ZIP distributions]:readily include all Start Scripts.

* We recommend you to manually add the {{Code|bin}} directory of your BaseX directory to the [https://en.wikipedia.org/wiki/PATH_(variable) PATH variable] of your environment.* 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 {{Code|MAIN}} variable.* The Windows installer automatically adds the project’s <code>{{Code|bin</code> }} directory to your path environment.* With the ZIP distributionIf you work with [[Maven]], you need to manually modify can directly run the path to scripts in the <code>PATH<[https://github.com/BaseXdb/basex/tree/master/basex-core/etc basex-core/etc] and [https://code> environment variablegithub.<brcom/BaseXdb/basex/tree/master/basex-api/><bretc basex-api/>etc] sub-directories 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). The conservative value that was chosen in our distributions ensures that BaseX will also run on 32 bit JVMs.

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

==Windows: {{Code|basex.bat}}== <pre classsyntaxhighlight lang="brush:bashbatch">@setlocal

REM Path to this scriptcore and library classesset PWDMAIN=%~dp0 REM Paths to distributed JAR archives or class files/..set BASEXCP=basex%MAIN%/BaseX.jar;%MAIN%/lib/*;%MAIN%/lib/custom/*

set VMBASEX_JVM=-Xmx512mXmx1200m %BASEX_JVM%

REM Classpathset LIB=%PWD%/../libset CP=%BASEX%;%LIB%/lucene-analyzers-3.0.2.jar;%LIB%/tagsoup-1.2.jar;%LIB%/snowball.jar REM Run BaseXcodejava -cp "%CP%" %VMBASEX_JVM% org.basex.BaseX %*</presyntaxhighlight>

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

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

PWDFILE=`"${BASH_SOURCE[0]}"while [ -h "$FILE" ] ; do SRC="$(readlink "$FILE")" FILE="$( cd -P "$(dirname "$FILE")" && \ cd -P "$(dirname "$SRC")" && pwd )/$(basename "$SRC")"doneMAIN="$( cd -P "$(dirname "$0`FILE")/.." && pwd )"

# Paths to distributed JAR archives or class filesCore and library classesBASEXCP=basex$MAIN/BaseX.jar:$MAIN/lib/*:$MAIN/lib/custom/*:$CLASSPATH

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

# ClasspathRun codeLIB=java -cp "$PWD/../libCP=$BASEX:$LIB/lucene-analyzers-3.0.2.jar:" $LIB/tagsoup-1BASEX_JVM org.2basex.jar:BaseX "$LIB@"</snowball.jarsyntaxhighlight>

=If you would like to launch the GUI, Server or Client version of BaseX HTTP Server=, 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=

Note: In {{Mark|Version 7.2}}The scripts for starting the HTTP server, which gives access to the {{Mono|BaseXHTTP}} start class will [[REST]], [[RESTXQ]] and [[WebDAV]] services, can be moved from the {{Mono|org.basex.api}} package to {{Mono|org.basex}}.found below:

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

<pre classsyntaxhighlight lang="brush:bashbatch">

setlocal REM Path to this scriptset PWD=%~dp0 REM Paths to distributed JAR archives or class filesset BASEX=%PWD%/basex.jar set BASEXAPI=%PWD%/basex-api.jarsetLocal EnableDelayedExpansion

REM ClasspathPath to core and library classesset LIBMAIN=%PWD%~dp0/../libset CP=%BASEX%;%BASEXAPI%;%LIBMAIN%/commons-beanutils-1.8.2BaseX.jar;%LIBMAIN%/commons-codec-1.4.jar;%LIB%lib/commons-fileupload-1.2.2.jar*;%LIBMAIN%/commons-io-1.4.jar;%LIB%/commons-logging-1.1.1.jar;%LIB%/jdom-1.1.jar;%LIB%/jetty-6.1.26.jar;%LIB%/jetty-util-6.1.26.jar;%LIB%lib/log4j-1.2.14.jar;%LIB%custom/lucene-analyzers-3.0.2.jar;%LIB%/milton-api-1.6.4.jar;%LIB%/mime-util-2.1.3.jar;%LIB%/resolver.jar;%LIB%/servlet-api-2.5-20081211.jar;%LIB%/slf4j-api-1.5.8.jar;%LIB%/slf4j-log4j12-1.5.6.jar;%LIB%/snowball.jar;%LIB%/tagsoup-1.2.jar;%LIB%/xmldb-api-1.0.jar;%LIB%/xqj-api-1.0.jar*

set VMBASEX_JVM=-Xmx512mXmx1200m %BASEX_JVM%

java -cp "%CP%;." %VMBASEX_JVM% org.basex.api.BaseXHTTP %*</presyntaxhighlight>

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

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

PWDFILE=`"${BASH_SOURCE[0]}"while [ -h "$FILE" ] ; do SRC="$(readlink "$FILE")" FILE="$( cd -P "$(dirname "$FILE")" && \ cd -P "$(dirname "$SRC")" && pwd )/$(basename "$SRC")"doneMAIN="$( cd -P "$(dirname "$0`FILE")/.." && pwd )"

# Paths to distributed JAR archives or class filesAPI, core, and library classesBASEXCP=$PWDMAIN/basexBaseX.jarBASEXAPI=:$MAIN/lib/*:$PWDMAIN/lib/basex-api.jarcustom/*:$CLASSPATH

# ClasspathOptions for virtual machine (can be extended by global options)LIBBASEX_JVM=$PWD/../libCP=$BASEX:$BASEXAPI:$LIB/commons-fileupload-1.2.2.jar:$LIB/commons-beanutils-1.8.2.jar:$LIB/commons-codec-1.4.jar:$LIB/commons-fileupload-1.2.2.jar:$LIB/commons-io-1.4.jar:$LIB/commons-logging"-1.1.1.jar:Xmx2g $LIB/jdom-1.1.jar:$LIB/jetty-6.1.26.jar:$LIB/jetty-util-6.1.26.jar:$LIB/log4j-1.2.14.jar:$LIB/lucene-analyzers-3.0.2.jar:$LIB/milton-api-1.6.4.jar:$LIB/mime-util-2.1.3.jar:$LIB/resolver.jar:$LIB/servlet-api-2.5-20081211.jar:$LIB/slf4j-api-1.5.8.jar:$LIB/slf4j-log4j12-1.5.6.jar:$LIB/snowball.jar:$LIB/tagsoup-1.2.jar:$LIB/xmldb-api-1.0.jar:$LIB/xqj-api-1.0.jarBASEX_JVM"

# Options for virtual machineRun codeVM=java -Xmx512mcp "$CP" $BASEX_JVM org.basex.BaseXHTTP "$@"</syntaxhighlight>

# Run code=Included Start Scripts=java The BaseX [https://basex.org/download/ Windows and ZIP distributions] readily include the following Start Scripts: {| class="wikitable"|-cp valign="$CPtop" $VM org! Windows! Linux/Mac! 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.apibat}}| {{Code|basexgui}}| Starts the BaseX GUI.BaseXHTTP |- 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/pre>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.|}

==;Version 7.5 * Updated: Static dependencies removed from Windows batch scripts. ;Version 7.2==

* Updated: The {{MonoCode|BaseXHTTP}} start class will be moved from {{MonoCode|org.basex.api}} to {{MonoCode|org.basex}}.

==;Version 7.0==

* Updated: The {{MonoCode|basexjaxrx}} scripts have been replaced with the {{MonoCode|basexhttp}} scripts.