Command-Line Options

From BaseX Documentation
Jump to navigation Jump to search

BaseX Server

If you want to interact (execute commands, add databases, add users) with the server, start the server with the -i flag.

> basexserver -i

All available command-line flags can be listed by adding -h to the call:

> basexserver -h

Usage: BaseXServer [-s] [-dpz] [-c] [stop]
  stop     Stop existing server
  -c<cmd>  Execute initial database command(s)
  -d       Activate debugging mode
  -i       Enter interactive mode
  -p<num>  Set server port
  -s       Start as service
  -z       Suppress logging

If the server is succesfully started, this is coming up:

BaseX [Server]
Server was started.

BaseX Client

All available command-line flags can be listed by adding -h to the call:

> basexclient -h

Usage: BaseXClient [-npPU] [-dovVwz] [-cq] [file]
  [file]     Execute XQuery file
  -c<cmd>    Execute database command(s)
  -d         Activate debugging mode
  -n<name>   Set server (host) name
  -o<file>   Write output to file
  -p<num>    Set server port
  -P<pass>   Specify user password
  -q<expr>   Execute XQuery expression
  -U<name>   Specify user name
  -v/V       Show (all) process info
  -w         Keep whitespaces from source files
  -z         Skip output of results

BaseX Standalone

All available command-line flags can be listed by adding -h to the call:

> basex -h

Usage: BaseX [-diosuvVwz] [-cq] [file]
  [file]     Execute XQuery file
  -c<cmd>    Execute database command(s)
  -d         Activate debugging mode
  -i<file>   Open initial file or database
  -o<file>   Write output to file
  -q<expr>   Execute XQuery expression
  -s<pars>   Set serialization parameter(s)
  -u         Modifiy original files after updates
  -v/V       Show (all) process info
  -w         wrap query result to xml
  -z         Skip output of results