Difference between revisions of "Command-Line Options"

From BaseX Documentation
Jump to navigation Jump to search
Line 12: Line 12:
 
Server was started.</pre>
 
Server was started.</pre>
  
−
All available command-line flags can be listed by adding <code>-h</code> to the call:
+
Additional command-line flags can be listed by adding <code>-h</code> to the call:
 
:<code>
 
:<code>
 
> basexserver -h
 
> basexserver -h
 
</code>
 
</code>
 
<pre>
 
<pre>
−
Usage: BaseXServer [-s] [-dpz] [-c] [stop]
+
Usage: BaseXServer [-dpsz] [-c] [stop]
 
   stop    Stop existing server
 
   stop    Stop existing server
 
   -c<cmd>  Execute initial database command(s)
 
   -c<cmd>  Execute initial database command(s)
Line 27: Line 27:
 
</pre>
 
</pre>
  
−
If you want to interact (execute commands, add databases, add users)  
+
The command-line flags have the following meaning:
−
with the server, start the server with the <code>-i</code> flag.
+
 
−
:<code>
+
{| class="wikitable"
−
> basexserver -i
+
|- valign="top"
−
</code>
+
! width='60' | Flag
 +
! Description
 +
! width='165' | Examples
 +
|- valign="top"
 +
| <code>stop</code>
 +
| Stop an existing server instance; remaining input is ignored.
 +
|
 +
|- valign="top"
 +
| <code>-c&lt;cmd&gt;</code>
 +
| Launch database commands before the server itself is started; all remaining text is interpreted as command input. Several commands can be separated by semicolons.
 +
| <code>-c"open database;info"</code>
 +
|- valign="top"
 +
| <code>-d</code>
 +
| Turns on debugging. Debugging information is output to standard error (<code>STDERR</code>).
 +
|
 +
|- valign="top"
 +
| <code>-i</code>
 +
| Interactively enter commands on the console, similar to standalone and client mode.
 +
|
 +
|- valign="top"
 +
| <code>-p&lt;num&gt;</code>
 +
| Specify the port on which the server can be addressed.
 +
| <code>-p9999</code>
 +
|- valign="top"
 +
| <code>-s</code>
 +
| Start the server as service (i.e., in background).
 +
|
 +
|- valign="top"
 +
| <code>-z</code>
 +
| Do not generate log files.
 +
|
 +
|}
  
 
==BaseX Client==
 
==BaseX Client==

Revision as of 21:27, 23 January 2011

This page gives an overview on all command-line options of the BaseX Startup scripts:

BaseX Server

Console command

> basexserver

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

BaseX [Server]
Server was started.

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

> basexserver -h 

Usage: BaseXServer [-dpsz] [-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

The command-line flags have the following meaning:

Flag Description Examples
stop Stop an existing server instance; remaining input is ignored.
-c<cmd> Launch database commands before the server itself is started; all remaining text is interpreted as command input. Several commands can be separated by semicolons. -c"open database;info"
-d Turns on debugging. Debugging information is output to standard error (STDERR).
-i Interactively enter commands on the console, similar to standalone and client mode.
-p<num> Specify the port on which the server can be addressed. -p9999
-s Start the server as service (i.e., in background).
-z Do not generate log files.

BaseX Client

Console command

> basexclient

Next, the user name and password has to be entered. By default, the user admin has admin as password: 

Username: admin
Password:
> _

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

Console command

> basex

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
Retrieved from "http://docs.basex.org/index.php?title=Command-Line_Options&oldid=2185"