Changes

Jump to navigation Jump to search
1,377 bytes added ,  12:56, 2 July 2020
m
Text replacement - "[http://en.wikipedia.org/" to "[https://en.wikipedia.org/"
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.
* The installers automatically We recommend you to manually add the project’s {{MonoCode|bin}} directory of your BaseX directory to the [https://en.wikipedia.org/wiki/PATH_(variable) PATH variable] of your path environment.* OtherwiseYou can copy the start scripts to another location in your file system. After that, you can manually add should edit the scripts and assign the BaseX directory to the {{Code|MAIN}} variable.* The Windows installer automatically adds the project’s {{MonoCode|bin}} directory to your <code>PATH<path environment.* If you work with [[Maven]], you can directly run the scripts in the [https://github.com/BaseXdb/basex/tree/master/basex-core/etc basex-core/etc] and [https://code> environment variablegithub.<brcom/><brBaseXdb/>basex/tree/master/basex-api/etc 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.
The following scripts 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.=Standalone=
==WindowsThe following scripts launch the standalone version of BaseX: basex.bat==
==Windows: {{Code|basex.bat}}== <pre classsyntaxhighlight lang="brush:bashbatch">@setlocal
@echo off
setLocal EnableDelayedExpansion
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/*
REM Options for virtual machine
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
# Path to this script
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>
# Run BaseXjava -cp "$CP" $VM org.basex.XXX "$@"</pre>=GUI, Server, Client=
=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">
@echo off
setlocalsetLocal EnableDelayedExpansion
REM Path to this scriptcore and library classesset PWDMAIN=%~dp0 REM Paths to distributed JAR archives or class filesset BASEX=%PWD%/basex.jar set BASEXAPI=%PWD%/basex-api.jar REM Classpathset LIB=%PWD%/../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%lib/jetty-6.1.26.jar;%LIB%/jetty-util-6.1.26.jar;%LIB%custom/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.jar*
REM Options for virtual machine
set VMBASEX_JVM=-Xmx512mXmx1200m %BASEX_JVM%
REM Run code
java -cp "%CP%;." %VMBASEX_JVM% org.basex.api.BaseXHTTP %*</presyntaxhighlight>
==Linux/Mac: {{Code|basexhttp}}== <syntaxhighlight lang="bash">#!/usr/bin/env bash
# Path to this script
cd -P "$(dirname "$SRC")" && pwd )/$(basename "$SRC")"
done
BXMAIN="$( cd -P "$(dirname "$FILE")/.." && pwd )"
# API, core, and library classes
CP="$BXMAIN/BaseX.jar:$MAIN/lib/*:$MAIN/lib/custom/*:$CLASSPATH # Options for virtual machine (printf can be extended by global options)BASEX_JVM="-Xmx2g $BASEX_JVM":%s # Run codejava -cp " $CP"$BX/BaseXBASEX_JVM org.basex.jarBaseXHTTP " $@"$BX</lib/"*.jar)"syntaxhighlight>
# Options for virtual machineVM=-Xmx512mIncluded Start Scripts=
general_argsThe BaseX [https://basex.org/download/ Windows and ZIP distributions] readily 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, there are also stop scripts available:
# Run code{| class="wikitable"|- valign="top"! Windows! Linux/Mac! width="40%" | Descriptionjava |-cp valign="$CPtop"|- valign=" $VM top"$| {{Code|basexhttpstop.bat}}| {{vm_args[@]Code|basexhttpstop}}| Stops the BaseX HTTP Server.|- valign=" orgtop"| {{Code|basexserverstop.basexbat}}| {{Code|basexserverstop}}| Stops the BaseX database server.BaseXHTTP "${general_args[@]|}"
=Changelog=
==;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.
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu