Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fixed manual pages

This commit is contained in:
Frank Celler 2016-02-24 19:56:47 +01:00
parent da7955e417
commit fb8965d4b7
20 changed files with 160 additions and 657 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/Scripts/man.sed
View File

@ -1,4 +1,5 @@
1s/^\(.*\)$/\.TH \1/ 1s/^\(.*\)$/\.TH \1/
s/^ //
/NAME/s/^\(.*\)$/\.SH \1/ /NAME/s/^\(.*\)$/\.SH \1/
/SYNOPSIS/s/^\(.*\)$/\.SH \1/ /SYNOPSIS/s/^\(.*\)$/\.SH \1/
/DESCRIPTION/s/^\(.*\)$/\.SH \1/ /DESCRIPTION/s/^\(.*\)$/\.SH \1/

43
Documentation/man/man1/arangob.1
View File

@ -1,4 +1,4 @@
.TH arangob 1 "23 Feb 2016" "3.0.0-devel" "ArangoDB" .TH arangob 1 "24 Feb 2016" "3.0.0-devel" "ArangoDB"
.SH NAME .SH NAME
arangob - the ArangoDB benchmark and test tool arangob - the ArangoDB benchmark and test tool
.SH SYNOPSIS .SH SYNOPSIS
@ -9,46 +9,7 @@ ArangoDB database. It can be used for benchmarks or server function
testing. It supports parallel querying and batch requests. testing. It supports parallel querying and batch requests.
.SH OPTIONS .SH OPTIONS
For a complete list of options, please refer to the ArangoDB For a complete list of options, please refer to the ArangoDB
online manual, available at http://www.arangodb.org/ online manual, available at https://www.arangodb.com/
The most important startup options are:
OPTION "--configuration <string>"
read configuration from file <string> ENDOPTION
OPTION "--batch-size <int32>"
number of operations to send per batch (use 0 to disable batching) ENDOPTION
OPTION "--collection <string>"
name of collection to use in test (only relevant for tests that invoke collections) ENDOPTION
OPTION "--concurrency <int32>"
number of parallel threads that will issue requests (default is 1 thread) ENDOPTION
OPTION "--requests <int32>"
total number of requests to perform ENDOPTION
OPTION "--test-case <string>"
name of test case to perform (possible values: version, document, collection,
import-document, hash, skiplist, edge, shapes, shapes-append, random-shapes, crud,
crud-append, crud-write-read, aqltrx, counttrx, multitrx, multi-collection, aqlinsert, aqlv8) ENDOPTION
OPTION "--complexity <int32>"
complexity value for test case (meaning depends on test case) ENDOPTION
OPTION "--server.endpoint <string>"
server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION
OPTION "--server.database <string>"
database name to use when connecting (default: "_system") ENDOPTION
OPTION "--server.username <string>"
username to use when connecting (default "root") ENDOPTION
OPTION "--server.password <string>"
password to use when connecting. Don't specify this option to get a password prompt ENDOPTION
OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server ENDOPTION
EXAMPLES
EXAMPLE arangob
starts arangob with the default user and server endpoint ENDEXAMPLE
EXAMPLE arangob --test-case version --requests 1000 --concurrency 1
runs the 'version' test case with 1000 requests, without concurrency ENDEXAMPLE
EXAMPLE arangob --test-case document --requests 1000 --concurrency 2
runs the 'document' test case with 2000 requests, with concurrency 2 ENDEXAMPLE
EXAMPLE arangob --test-case document --requests 1000 --concurrency 2 --async true
runs the 'document' test case with 2000 requests, with concurrency 2, with async requests ENDEXAMPLE
EXAMPLE arangob --test-case document --requests 1000 --concurrency 2 --batch-size 10
runs the 'document' test case with 2000 requests, with concurrency 2, using batch requests ENDEXAMPLE
.SH AUTHOR .SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

37
Documentation/man/man1/arangodump.1
View File

@ -1,4 +1,4 @@
.TH arangodump 1 "23 Feb 2016" "3.0.0-devel" "ArangoDB" .TH arangodump 1 "24 Feb 2016" "3.0.0-devel" "ArangoDB"
.SH NAME .SH NAME
arangodump - a tool to create logical dumps of an ArangoDB database arangodump - a tool to create logical dumps of an ArangoDB database
.SH SYNOPSIS .SH SYNOPSIS
@ -22,38 +22,9 @@ is specified, arangodump will work on the default database ("_system").
The dumped files can be re-stored in an ArangoDB database using the The dumped files can be re-stored in an ArangoDB database using the
arangorestore tool. arangorestore tool.
.SH OPTIONS .SH OPTIONS
For a complete list of options, please refer to the ArangoDB The arangodump binary has many options that can be used to control its
online manual, available at http://www.arangodb.org/ behavior. For a complete list of options, please refer to the
ArangoDB online manual, available at https://www.arangodb.com/
The most important startup options are:
OPTION "--configuration <string>"
read configuration from file <string> ENDOPTION
OPTION "--collection <string>"
name of collection to dump (can be specified multiple times). This can be
used to restrict the dump to certain collections only. If not specified,
all collections will be dumped ENDOPTION
OPTION "--dump-data <bool>"
when set to "true" will dump the data (documents) of the collection ENDOPTION
OPTION "--include-system-collections <bool>"
when set to "true" will also dump system collections, otherwise they will be excluded ENDOPTION
OPTION "--output-directory <string>"
directory in which all dump files will be created. If the directory already exists,
arangodump will refuse to work unless started with option "--overwrite true" ENDOPTION
OPTION "--overwrite <bool>"
when set to "true", will overwrite any files in an existing output directory ENDOPTION
OPTION "--progress <bool>"
when set to "true", will display progress information ENDOPTION
OPTION "--server.endpoint <string>"
server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION
OPTION "--server.database <string>"
database name to use when connection (default: "_system") ENDOPTION
OPTION "--server.username <string>"
username to use when connecting (default "root") ENDOPTION
OPTION "--server.password <string>"
password to use when connecting. Don't specify this option to get a password prompt ENDOPTION
OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server ENDOPTION
EXAMPLES
.SH AUTHOR .SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

44
Documentation/man/man1/arangoimp.1
View File

@ -1,4 +1,4 @@
.TH arangoimp 1 "23 Feb 2016" "3.0.0-devel" "ArangoDB" .TH arangoimp 1 "24 Feb 2016" "3.0.0-devel" "ArangoDB"
.SH NAME .SH NAME
arangoimp - a bulk importer for the ArangoDB database arangoimp - a bulk importer for the ArangoDB database
.SH SYNOPSIS .SH SYNOPSIS
@ -10,45 +10,9 @@ format with column headlines, or in JSON format. If JSON format is used,
each line in the input file must contain exactly one JSON document with each line in the input file must contain exactly one JSON document with
the attribute name/value pairs to import. the attribute name/value pairs to import.
.SH OPTIONS .SH OPTIONS
For a complete list of options, please refer to the ArangoDB The arangoimp binary has many options that can be used to control its
online manual, available at http://www.arangodb.org/ behavior. For a complete list of options, please refer to the
ArangoDB online manual, available at https://www.arangodb.com/
The most important startup options are:
OPTION "--batch-size <uint64>"
maximum size of data batches that are sent to the server ENDOPTION
OPTION "--configuration <string>"
read configuration from file <string> ENDOPTION
OPTION "--collection <string>"
name of collection to import into ENDOPTION
OPTION "--create-collection <bool>"
set to "true" if collection should be created by the import ENDOPTION
OPTION "--file <string>"
input file with the data to import ENDOPTION
OPTION "--overwrite <bool>"
set to "true" to remove all data from the collection prior to the import ENDOPTION
OPTION "--quote <string>"
optional quote character to be used ENDOPTION
OPTION "--separator <string>"
separator character or string to be used. the default value is "," ENDOPTION
OPTION "--type <string>"
set to "json", "tsv" or "csv", depending on the input file format ENDOPTION
OPTION "--server.endpoint <string>"
server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION
OPTION "--server.database <string>"
database name to use when connection (default: "_system") ENDOPTION
OPTION "--server.username <string>"
username to use when connecting (default "root") ENDOPTION
OPTION "--server.password <string>"
password to use when connecting. Don't specify this option to get a password prompt ENDOPTION
OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server ENDOPTION
EXAMPLES
EXAMPLE arangoimp --file heroes.json --type json --collection superheroes --create-collection true
imports JSON data from file heroes.json into collection superhoeres. creates the collection if it does not exist ENDEXAMPLE
EXAMPLE arangoimp --file export.csv --type csv --collection mydata
imports CSV data from export.csv into existing collection mydata ENDEXAMPLE
EXAMPLE arangoimp --file values.json --collection mydata --server.endpoint tcp://127.0.0.1:8529 --server.database mydb
imports JSON data from file values.json into collection mydata, using a different server endpoint and database ENDEXAMPLE
.SH AUTHOR .SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

48
Documentation/man/man1/arangorestore.1
View File

@ -1,51 +1,17 @@
.TH arangorestore 1 "23 Feb 2016" "3.0.0-devel" "ArangoDB" .TH arangorestore 1 "24 Feb 2016" "3.0.0-devel" "ArangoDB"
arangorestore SECTION "DATE" "" "ArangoDB"
.SH NAME .SH NAME
arangorestore - a data restore tool for the ArangoDB database arangorestore - a data restore tool for the ArangoDB database
.SH SYNOPSIS .SH SYNOPSIS
arangorestore [options] arangorestore [options]
.SH DESCRIPTION .SH DESCRIPTION
The arangorestore binary can be used to restore data from logical dumps created The arangorestore binary can be used to restore data from logical dumps
with the arangodump tool. created with the arangodump tool. Input data be present in the input
ArangoDB database. Input data be present in the input file in either CSV file in either CSV format with column headlines, or in JSON format. If
format with column headlines, or in JSON format. If JSON format is used, JSON format is used, each line in the input file must contain exactly
each line in the input file must contain exactly one JSON document with one JSON document with the attribute name/value pairs to import.
the attribute name/value pairs to import.
.SH OPTIONS .SH OPTIONS
For a complete list of options, please refer to the ArangoDB For a complete list of options, please refer to the ArangoDB
online manual, available at http://www.arangodb.org/ online manual, available at https://www.arangodb.com/
The most important startup options are:
OPTION "--configuration <string>"
read configuration from file <string> ENDOPTION
OPTION "--collection <string>"
name of collection to restore (can be specified multiple times). This can be
used to restrict the restore operation to certain collections only. If not
specified, all collections from the "--input-directory" will be restored ENDOPTION
OPTION "--create-collection <bool>"
set to "true" if collections should be created ENDOPTION
OPTION "--import-data <bool>"
when set to "true" will restore the data (documents) of the collection ENDOPTION
OPTION "--include-system-collections <bool>"
when set to "true" will also restore system collections, otherwise they will be
excluded ENDOPTION
OPTION "--input-directory <string>"
input directory in which to look for dump files. ENDOPTION
OPTION "--overwrite <bool>"
when set to "true", will drop an existing collection before re-creating it ENDOPTION
OPTION "--progress <bool>"
when set to "true", will display progress information ENDOPTION
OPTION "--server.endpoint <string>"
server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION
OPTION "--server.database <string>"
database name to use when connection (default: "_system") ENDOPTION
OPTION "--server.username <string>"
username to use when connecting (default "root") ENDOPTION
OPTION "--server.password <string>"
password to use when connecting. Don't specify this option to get a password prompt ENDOPTION
OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server ENDOPTION
EXAMPLES
.SH AUTHOR .SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

68
Documentation/man/man1/arangosh.1
View File

@ -1,4 +1,4 @@
.TH arangosh 1 "23 Feb 2016" "3.0.0-devel" "ArangoDB" .TH arangosh 1 "24 Feb 2016" "3.0.0-devel" "ArangoDB"
.SH NAME .SH NAME
arangosh - the ArangoDB shell arangosh - the ArangoDB shell
.SH SYNOPSIS .SH SYNOPSIS
@ -9,71 +9,7 @@ client connection to the ArangoDB database. When the connection
is established, it can be used to execute actions on the server. is established, it can be used to execute actions on the server.
.SH OPTIONS .SH OPTIONS
For a complete list of options, please refer to the ArangoDB For a complete list of options, please refer to the ArangoDB
online manual, available at http://www.arangodb.org/ online manual, available at https://www.arangodb.com/
The most important startup options are:
.IP "--audit-log <string>"
log input and output to audit log file <string>
.IP "--configuration <string>"
read configuration from file <string>
.IP "--log.level <string>"
set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace")
.IP "--server.endpoint <string>"
server endpoint to connect to, consisting of protocol, ip address and port
.IP "--server.database <string>"
database name to use when connection (default: "_system")
.IP "--server.username <string>"
username to use when connecting (default "root")
.IP "--server.password <string>"
password to use when connecting. Don't specify this option to get a password prompt
.IP "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server
.SH EXAMPLES
.nf
shell> arangosh
.fi
starts arangosh with the default user and server endpoint
.nf
shell> arangosh --server.username fuchsia
.fi
starts arangosh with a specific user. Password prompt will follow if --server.disable-authentication is true.
.nf
shell> arangosh --server.username fuchsia --server.password "abcd@34"
.fi
starts arangosh with a specific user and password given on command line
.nf
shell> arangosh --server.endpoint tcp://192.168.173.13:8529
.fi
starts arangosh connecting to a specific server
.nf
shell> arangosh --server.endpoint ssl://192.168.173.13:8530
.fi
starts arangosh connecting to a specific server using an SSL connection
.SH AUTHOR .SH AUTHOR
Copyright ArangoDB GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

27
Documentation/man/man8/arango-dfdb.8
View File

@ -1,20 +1,17 @@
.TH COMMAND SECTION "DATE" "" "ArangoDB" .TH arango-dfdb 8 "24 Feb 2016" "3.0.0-devel" "ArangoDB"
.SH NAME .SH NAME
COMMAND - a datafile debugger for ArangoDB arango-dfdb - a datafile debugger for ArangoDB
.SH SYNOPSIS .SH SYNOPSIS
COMMAND options arango-dfdb options
.SH DESCRIPTION .SH DESCRIPTION
The COMMAND binary can be used to verify the datafiles of an The arango-dfdb binary can be used to verify the datafiles of an
ArangoDB database server. The script must be run with exclusive ArangoDB database server. The script must be run with exclusive access
access to the server's data directory, meaning the ArangoDB to the server's data directory, meaning the ArangoDB server must not
server must not be running and accessing the datafiles in the be running and accessing the datafiles in the specified data
specified data directory. directory.
More specific instructions are displayed when the program is invoked.
.SH OPTIONS .SH OPTIONS
OPTION "--database.directory <string>" For a complete list of options, please refer to the ArangoDB
path to the database directory ENDOPTION online manual, available at https://www.arangodb.com/
EXAMPLES
EXAMPLE COMMAND --database.directory /data/arangodb
starts the debugger with database directory /data/arangodb ENDEXAMPLE
.SH AUTHOR .SH AUTHOR
Copyright triAGENS GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

61
Documentation/man/man8/arangod.8
View File

@ -1,52 +1,21 @@
.TH COMMAND SECTION "DATE" "" "ArangoDB" .TH arangod 8 "24 Feb 2016" "3.0.0-devel" "ArangoDB"
.SH NAME .SH NAME
COMMAND - the ArangoDB database server arangod - the ArangoDB database server
.SH SYNOPSIS .SH SYNOPSIS
COMMAND [options] database-directory arangod [options] database-directory
.SH DESCRIPTION .SH DESCRIPTION
The COMMAND binary can be used to start the ArangoDB database The arangod binary can be used to start the ArangoDB database
server. By default, the server will run in a mode that allows server. By default, the server will run in a mode that allows clients
clients to connect to it via the network. The server also has to connect to it via the network. The server also has an emergency
an emergency console mode that can be used for any sort of console mode that can be used for any sort of maintenance
maintenance operations. In the emergency console mode, the operations. In the emergency console mode, the server does not allow
server does not allow any clients to connect. any clients to connect. The server can be stopped gracefully at any
The server can be stopped gracefully at any time by pressing time by pressing CTRL-C or by sending the SIGINT signal to the
CTRL-C or by sending the SIGINT signal to the process. process.
.SH OPTIONS .SH OPTIONS
The COMMAND binary has many options that can be used to control The arangod binary has many options that can be used to control its
its behavior. behavior. For a complete list of options, please refer to the
For a complete list of options, please refer to the ArangoDB ArangoDB online manual, available at https://www.arangodb.com/
online manual, available at http://www.arangodb.org/
The most important startup options are:
OPTION "--configuration <string>"
read configuration from file <string> ENDOPTION
OPTION "--console"
do not start as server, start an emergency console instead ENDOPTION
OPTION "--log.file <string>"
log to file <string> ENDOPTION
OPTION "--log.level <string>"
set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace") ENDOPTION
OPTION "--server.endpoint <string>"
listen endpoint for client requests, consisting of protocol, ip address and port ENDOPTION
OPTION "--server.disable-authentication <boolean>"
disable authentication for all clients ENDOPTION
OPTION "--database.directory <string>"
path to the database directory ENDOPTION
EXAMPLES
EXAMPLE COMMAND /data/arangodb
starts the server with database directory /data/arangodb ENDEXAMPLE
EXAMPLE COMMAND --database.directory /data/arangodb
same, but uses --database.directory option instead ENDEXAMPLE
EXAMPLE COMMAND --log.level debug /data/arangodb
starts server with log level "debug" ENDEXAMPLE
EXAMPLE COMMAND --server.endpoint tcp://127.0.0.1:8529 /data/arangodb
starts server listening on port 8529 of IP 127.0.0.1 ENDEXAMPLE
EXAMPLE COMMAND --server.endpoint tcp://192.168.173.13:8529
--server.endpoint ssl://192.168.173.13:8530 /data/arangodb
starts server with two endpoints: port 8529 for unencrypted requests and 8530 for ssl-encrypted requests ENDEXAMPLE
EXAMPLE COMMAND --console /data/arangodb
starts the emergency console ENDEXAMPLE
.SH AUTHOR .SH AUTHOR
Copyright triAGENS GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

35
Documentation/man/man8/foxx-manager.8
View File

@ -1,34 +1,15 @@
.TH COMMAND SECTION "DATE" "" "ArangoDB" .TH foxx-manager 8 "24 Feb 2016" "3.0.0-devel" "ArangoDB"
.SH NAME .SH NAME
COMMAND - a Foxx application manager for ArangoDB foxx-manager - a Foxx application manager for ArangoDB
.SH SYNOPSIS .SH SYNOPSIS
COMMAND options foxx-manager options
.SH DESCRIPTION .SH DESCRIPTION
The COMMAND binary can be used to manage Foxx applications in the The foxx-manager binary can be used to manage Foxx applications in the
ArangoDB database server. Foxx applications can be installed and ArangoDB database server. Foxx applications can be installed and
uninstalled. uninstalled.
More specific instructions are displayed when the program is invoked.
.SH OPTIONS .SH OPTIONS
OPTION "--server.database <string>" For a complete list of options, please refer to the ArangoDB
database name to use when connecting (default: "_system") ENDOPTION online manual, available at https://www.arangodb.com/
OPTION "--server.username <string>"
username to use when connecting (default "root") ENDOPTION
OPTION "--server.password <string>"
password to use when connecting. Don't specify this option to get a password prompt ENDOPTION
OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server ENDOPTION
EXAMPLES
EXAMPLE COMMAND search "foobar"
searches the central repository for an application "foobar"ENDEXAMPLE
EXAMPLE COMMAND update
updates the local repository with applications from the central repositoryENDEXAMPLE
EXAMPLE COMMAND list
list all installed Foxx applicationsENDEXAMPLE
EXAMPLE COMMAND install "hello-foxx" "/hello"
installs the "hello-foxx" application under the mount point "/hello"ENDEXAMPLE
EXAMPLE COMMAND uninstall "/hello"
uninstalls the application that is mounted under "/hello"ENDEXAMPLE
EXAMPLE COMMAND help
shows the help pageENDEXAMPLE
.SH AUTHOR .SH AUTHOR
Copyright triAGENS GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

19
Documentation/man/man8/rcarangod.8
View File

@ -1,16 +1,15 @@
.TH COMMAND SECTION "DATE" "" "ArangoDB" .TH rcarangod 8 "24 Feb 2016" "3.0.0-devel" "ArangoDB"
.SH NAME .SH NAME
COMMAND - control script for the ArangoDB database server rcarangod - control script for the ArangoDB database server
.SH SYNOPSIS .SH SYNOPSIS
COMMAND start|stop rcarangod start|stop
.SH DESCRIPTION .SH DESCRIPTION
The COMMAND script controls the operation of the ArangoDB The rcarangod script controls the operation of the ArangoDB database
database server daemon running on the system. The COMMAND script server daemon running on the system. The rcarangod script is normally
is normally run at system boot time with the "start" argument, and run at system boot time with the "start" argument, and at system
at system shutdown time with the "stop" argument. shutdown time with the "stop" argument. It can also be invoked
It can also be invoked manually at any time to start or stop the manually at any time to start or stop the ArangoDB database server.
ArangoDB database server.
.SH SEE ALSO .SH SEE ALSO
.BR arangod "(8), " .BR arangod "(8), "
.SH AUTHOR .SH AUTHOR
Copyright triAGENS GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

42
Documentation/man1/arangob.1
View File

@ -1,4 +1,3 @@
<COMMAND> <SECTION> "<DATE>" "<VERSION>" "ArangoDB"
NAME NAME
<COMMAND> - the ArangoDB benchmark and test tool <COMMAND> - the ArangoDB benchmark and test tool
SYNOPSIS SYNOPSIS
@ -9,45 +8,6 @@ ArangoDB database. It can be used for benchmarks or server function
testing. It supports parallel querying and batch requests. testing. It supports parallel querying and batch requests.
OPTIONS OPTIONS
For a complete list of options, please refer to the ArangoDB For a complete list of options, please refer to the ArangoDB
online manual, available at http://www.arangodb.org/ online manual, available at https://www.arangodb.com/
The most important startup options are:
OPTION "--configuration <string>"
read configuration from file <string> ENDOPTION
OPTION "--batch-size <int32>"
number of operations to send per batch (use 0 to disable batching) ENDOPTION
OPTION "--collection <string>"
name of collection to use in test (only relevant for tests that invoke collections) ENDOPTION
OPTION "--concurrency <int32>"
number of parallel threads that will issue requests (default is 1 thread) ENDOPTION
OPTION "--requests <int32>"
total number of requests to perform ENDOPTION
OPTION "--test-case <string>"
name of test case to perform (possible values: version, document, collection,
import-document, hash, skiplist, edge, shapes, shapes-append, random-shapes, crud,
crud-append, crud-write-read, aqltrx, counttrx, multitrx, multi-collection, aqlinsert, aqlv8) ENDOPTION
OPTION "--complexity <int32>"
complexity value for test case (meaning depends on test case) ENDOPTION
OPTION "--server.endpoint <string>"
server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION
OPTION "--server.database <string>"
database name to use when connecting (default: "_system") ENDOPTION
OPTION "--server.username <string>"
username to use when connecting (default "root") ENDOPTION
OPTION "--server.password <string>"
password to use when connecting. Don't specify this option to get a password prompt ENDOPTION
OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server ENDOPTION
EXAMPLES
EXAMPLE <COMMAND>
starts <COMMAND> with the default user and server endpoint ENDEXAMPLE
EXAMPLE <COMMAND> --test-case version --requests 1000 --concurrency 1
runs the 'version' test case with 1000 requests, without concurrency ENDEXAMPLE
EXAMPLE <COMMAND> --test-case document --requests 1000 --concurrency 2
runs the 'document' test case with 2000 requests, with concurrency 2 ENDEXAMPLE
EXAMPLE <COMMAND> --test-case document --requests 1000 --concurrency 2 --async true
runs the 'document' test case with 2000 requests, with concurrency 2, with async requests ENDEXAMPLE
EXAMPLE <COMMAND> --test-case document --requests 1000 --concurrency 2 --batch-size 10
runs the 'document' test case with 2000 requests, with concurrency 2, using batch requests ENDEXAMPLE
AUTHOR AUTHOR

36
Documentation/man1/arangodump.1
View File

@ -1,4 +1,3 @@
<COMMAND> <SECTION> "<DATE>" "<VERSION>" "ArangoDB"
NAME NAME
<COMMAND> - a tool to create logical dumps of an ArangoDB database <COMMAND> - a tool to create logical dumps of an ArangoDB database
SYNOPSIS SYNOPSIS
@ -22,37 +21,8 @@ is specified, <COMMAND> will work on the default database ("_system").
The dumped files can be re-stored in an ArangoDB database using the The dumped files can be re-stored in an ArangoDB database using the
arangorestore tool. arangorestore tool.
OPTIONS OPTIONS
For a complete list of options, please refer to the ArangoDB The <COMMAND> binary has many options that can be used to control its
online manual, available at http://www.arangodb.org/ behavior. For a complete list of options, please refer to the
ArangoDB online manual, available at https://www.arangodb.com/
The most important startup options are:
OPTION "--configuration <string>"
read configuration from file <string> ENDOPTION
OPTION "--collection <string>"
name of collection to dump (can be specified multiple times). This can be
used to restrict the dump to certain collections only. If not specified,
all collections will be dumped ENDOPTION
OPTION "--dump-data <bool>"
when set to "true" will dump the data (documents) of the collection ENDOPTION
OPTION "--include-system-collections <bool>"
when set to "true" will also dump system collections, otherwise they will be excluded ENDOPTION
OPTION "--output-directory <string>"
directory in which all dump files will be created. If the directory already exists,
<COMMAND> will refuse to work unless started with option "--overwrite true" ENDOPTION
OPTION "--overwrite <bool>"
when set to "true", will overwrite any files in an existing output directory ENDOPTION
OPTION "--progress <bool>"
when set to "true", will display progress information ENDOPTION
OPTION "--server.endpoint <string>"
server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION
OPTION "--server.database <string>"
database name to use when connection (default: "_system") ENDOPTION
OPTION "--server.username <string>"
username to use when connecting (default "root") ENDOPTION
OPTION "--server.password <string>"
password to use when connecting. Don't specify this option to get a password prompt ENDOPTION
OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server ENDOPTION
EXAMPLES
AUTHOR AUTHOR

43
Documentation/man1/arangoimp.1
View File

@ -1,4 +1,3 @@
<COMMAND> <SECTION> "<DATE>" "<VERSION>" "ArangoDB"
NAME NAME
<COMMAND> - a bulk importer for the ArangoDB database <COMMAND> - a bulk importer for the ArangoDB database
SYNOPSIS SYNOPSIS
@ -10,44 +9,8 @@ format with column headlines, or in JSON format. If JSON format is used,
each line in the input file must contain exactly one JSON document with each line in the input file must contain exactly one JSON document with
the attribute name/value pairs to import. the attribute name/value pairs to import.
OPTIONS OPTIONS
For a complete list of options, please refer to the ArangoDB The <COMMAND> binary has many options that can be used to control its
online manual, available at http://www.arangodb.org/ behavior. For a complete list of options, please refer to the
ArangoDB online manual, available at https://www.arangodb.com/
The most important startup options are:
OPTION "--batch-size <uint64>"
maximum size of data batches that are sent to the server ENDOPTION
OPTION "--configuration <string>"
read configuration from file <string> ENDOPTION
OPTION "--collection <string>"
name of collection to import into ENDOPTION
OPTION "--create-collection <bool>"
set to "true" if collection should be created by the import ENDOPTION
OPTION "--file <string>"
input file with the data to import ENDOPTION
OPTION "--overwrite <bool>"
set to "true" to remove all data from the collection prior to the import ENDOPTION
OPTION "--quote <string>"
optional quote character to be used ENDOPTION
OPTION "--separator <string>"
separator character or string to be used. the default value is "," ENDOPTION
OPTION "--type <string>"
set to "json", "tsv" or "csv", depending on the input file format ENDOPTION
OPTION "--server.endpoint <string>"
server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION
OPTION "--server.database <string>"
database name to use when connection (default: "_system") ENDOPTION
OPTION "--server.username <string>"
username to use when connecting (default "root") ENDOPTION
OPTION "--server.password <string>"
password to use when connecting. Don't specify this option to get a password prompt ENDOPTION
OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server ENDOPTION
EXAMPLES
EXAMPLE <COMMAND> --file heroes.json --type json --collection superheroes --create-collection true
imports JSON data from file heroes.json into collection superhoeres. creates the collection if it does not exist ENDEXAMPLE
EXAMPLE <COMMAND> --file export.csv --type csv --collection mydata
imports CSV data from export.csv into existing collection mydata ENDEXAMPLE
EXAMPLE <COMMAND> --file values.json --collection mydata --server.endpoint tcp://127.0.0.1:8529 --server.database mydb
imports JSON data from file values.json into collection mydata, using a different server endpoint and database ENDEXAMPLE
AUTHOR AUTHOR

47
Documentation/man1/arangorestore.1
View File

@ -1,50 +1,15 @@
<COMMAND> <SECTION> "<DATE>" "<VERSION>" "ArangoDB"
<COMMAND> SECTION "DATE" "" "ArangoDB"
NAME NAME
<COMMAND> - a data restore tool for the ArangoDB database <COMMAND> - a data restore tool for the ArangoDB database
SYNOPSIS SYNOPSIS
<COMMAND> [options] <COMMAND> [options]
DESCRIPTION DESCRIPTION
The <COMMAND> binary can be used to restore data from logical dumps created The <COMMAND> binary can be used to restore data from logical dumps
with the arangodump tool. created with the arangodump tool. Input data be present in the input
ArangoDB database. Input data be present in the input file in either CSV file in either CSV format with column headlines, or in JSON format. If
format with column headlines, or in JSON format. If JSON format is used, JSON format is used, each line in the input file must contain exactly
each line in the input file must contain exactly one JSON document with one JSON document with the attribute name/value pairs to import.
the attribute name/value pairs to import.
OPTIONS OPTIONS
For a complete list of options, please refer to the ArangoDB For a complete list of options, please refer to the ArangoDB
online manual, available at http://www.arangodb.org/ online manual, available at https://www.arangodb.com/
The most important startup options are:
OPTION "--configuration <string>"
read configuration from file <string> ENDOPTION
OPTION "--collection <string>"
name of collection to restore (can be specified multiple times). This can be
used to restrict the restore operation to certain collections only. If not
specified, all collections from the "--input-directory" will be restored ENDOPTION
OPTION "--create-collection <bool>"
set to "true" if collections should be created ENDOPTION
OPTION "--import-data <bool>"
when set to "true" will restore the data (documents) of the collection ENDOPTION
OPTION "--include-system-collections <bool>"
when set to "true" will also restore system collections, otherwise they will be
excluded ENDOPTION
OPTION "--input-directory <string>"
input directory in which to look for dump files. ENDOPTION
OPTION "--overwrite <bool>"
when set to "true", will drop an existing collection before re-creating it ENDOPTION
OPTION "--progress <bool>"
when set to "true", will display progress information ENDOPTION
OPTION "--server.endpoint <string>"
server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION
OPTION "--server.database <string>"
database name to use when connection (default: "_system") ENDOPTION
OPTION "--server.username <string>"
username to use when connecting (default "root") ENDOPTION
OPTION "--server.password <string>"
password to use when connecting. Don't specify this option to get a password prompt ENDOPTION
OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server ENDOPTION
EXAMPLES
AUTHOR AUTHOR

49
Documentation/man1/arangosh.1
View File

@ -1,58 +1,13 @@
<COMMAND> <SECTION> "<DATE>" "<VERSION>" "ArangoDB"
NAME NAME
<COMMAND> - the ArangoDB shell <COMMAND> - the ArangoDB shell
SYNOPSIS SYNOPSIS
<COMMAND> [options] <COMMAND> [options]
DESCRIPTION DESCRIPTION
The arangosh binary can be used to establish an interactive The <COMMAND> binary can be used to establish an interactive
client connection to the ArangoDB database. When the connection client connection to the ArangoDB database. When the connection
is established, it can be used to execute actions on the server. is established, it can be used to execute actions on the server.
OPTIONS OPTIONS
For a complete list of options, please refer to the ArangoDB For a complete list of options, please refer to the ArangoDB
online manual, available at http://www.arangodb.org/ online manual, available at https://www.arangodb.com/
The most important startup options are:
<OPTION> "--audit-log <string>"
log input and output to audit log file <string>
<ENDOPTION>
<OPTION> "--configuration <string>"
read configuration from file <string>
<ENDOPTION>
<OPTION> "--log.level <string>"
set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace")
<ENDOPTION>
<OPTION> "--server.endpoint <string>"
server endpoint to connect to, consisting of protocol, ip address and port
<ENDOPTION>
<OPTION> "--server.database <string>"
database name to use when connection (default: "_system")
<ENDOPTION>
<OPTION> "--server.username <string>"
username to use when connecting (default "root")
<ENDOPTION>
<OPTION> "--server.password <string>"
password to use when connecting. Don't specify this option to get a password prompt
<ENDOPTION>
<OPTION> "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server
<ENDOPTION>
EXAMPLES
<EXAMPLE> <COMMAND>
starts <COMMAND> with the default user and server endpoint
<ENDEXAMPLE>
<EXAMPLE> <COMMAND> --server.username fuchsia
starts <COMMAND> with a specific user. Password prompt will follow if --server.disable-authentication is true.
<ENDEXAMPLE>
<EXAMPLE> <COMMAND> --server.username fuchsia --server.password "abcd@34"
starts <COMMAND> with a specific user and password given on command line
<ENDEXAMPLE>
<EXAMPLE> <COMMAND> --server.endpoint tcp://192.168.173.13:8529
starts <COMMAND> connecting to a specific server
<ENDEXAMPLE>
<EXAMPLE> <COMMAND> --server.endpoint ssl://192.168.173.13:8530
starts <COMMAND> connecting to a specific server using an SSL connection
<ENDEXAMPLE>
AUTHOR AUTHOR

24
Documentation/man8/arango-dfdb.8
View File

@ -1,19 +1,15 @@
COMMAND SECTION "DATE" "" "ArangoDB"
NAME NAME
COMMAND - a datafile debugger for ArangoDB <COMMAND> - a datafile debugger for ArangoDB
SYNOPSIS SYNOPSIS
COMMAND options <COMMAND> options
DESCRIPTION DESCRIPTION
The COMMAND binary can be used to verify the datafiles of an The <COMMAND> binary can be used to verify the datafiles of an
ArangoDB database server. The script must be run with exclusive ArangoDB database server. The script must be run with exclusive access
access to the server's data directory, meaning the ArangoDB to the server's data directory, meaning the ArangoDB server must not
server must not be running and accessing the datafiles in the be running and accessing the datafiles in the specified data
specified data directory. directory.
More specific instructions are displayed when the program is invoked.
OPTIONS OPTIONS
OPTION "--database.directory <string>" For a complete list of options, please refer to the ArangoDB
path to the database directory ENDOPTION online manual, available at https://www.arangodb.com/
EXAMPLES
EXAMPLE COMMAND --database.directory /data/arangodb
starts the debugger with database directory /data/arangodb ENDEXAMPLE
AUTHOR AUTHOR

58
Documentation/man8/arangod.8
View File

@ -1,51 +1,19 @@
COMMAND SECTION "DATE" "" "ArangoDB"
NAME NAME
COMMAND - the ArangoDB database server <COMMAND> - the ArangoDB database server
SYNOPSIS SYNOPSIS
COMMAND [options] database-directory <COMMAND> [options] database-directory
DESCRIPTION DESCRIPTION
The COMMAND binary can be used to start the ArangoDB database The <COMMAND> binary can be used to start the ArangoDB database
server. By default, the server will run in a mode that allows server. By default, the server will run in a mode that allows clients
clients to connect to it via the network. The server also has to connect to it via the network. The server also has an emergency
an emergency console mode that can be used for any sort of console mode that can be used for any sort of maintenance
maintenance operations. In the emergency console mode, the operations. In the emergency console mode, the server does not allow
server does not allow any clients to connect. any clients to connect. The server can be stopped gracefully at any
The server can be stopped gracefully at any time by pressing time by pressing CTRL-C or by sending the SIGINT signal to the
CTRL-C or by sending the SIGINT signal to the process. process.
OPTIONS OPTIONS
The COMMAND binary has many options that can be used to control The <COMMAND> binary has many options that can be used to control its
its behavior. behavior. For a complete list of options, please refer to the
For a complete list of options, please refer to the ArangoDB ArangoDB online manual, available at https://www.arangodb.com/
online manual, available at http://www.arangodb.org/
The most important startup options are:
OPTION "--configuration <string>"
read configuration from file <string> ENDOPTION
OPTION "--console"
do not start as server, start an emergency console instead ENDOPTION
OPTION "--log.file <string>"
log to file <string> ENDOPTION
OPTION "--log.level <string>"
set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace") ENDOPTION
OPTION "--server.endpoint <string>"
listen endpoint for client requests, consisting of protocol, ip address and port ENDOPTION
OPTION "--server.disable-authentication <boolean>"
disable authentication for all clients ENDOPTION
OPTION "--database.directory <string>"
path to the database directory ENDOPTION
EXAMPLES
EXAMPLE COMMAND /data/arangodb
starts the server with database directory /data/arangodb ENDEXAMPLE
EXAMPLE COMMAND --database.directory /data/arangodb
same, but uses --database.directory option instead ENDEXAMPLE
EXAMPLE COMMAND --log.level debug /data/arangodb
starts server with log level "debug" ENDEXAMPLE
EXAMPLE COMMAND --server.endpoint tcp://127.0.0.1:8529 /data/arangodb
starts server listening on port 8529 of IP 127.0.0.1 ENDEXAMPLE
EXAMPLE COMMAND --server.endpoint tcp://192.168.173.13:8529
--server.endpoint ssl://192.168.173.13:8530 /data/arangodb
starts server with two endpoints: port 8529 for unencrypted requests and 8530 for ssl-encrypted requests ENDEXAMPLE
EXAMPLE COMMAND --console /data/arangodb
starts the emergency console ENDEXAMPLE
AUTHOR AUTHOR

32
Documentation/man8/foxx-manager.8
View File

@ -1,33 +1,13 @@
COMMAND SECTION "DATE" "" "ArangoDB"
NAME NAME
COMMAND - a Foxx application manager for ArangoDB <COMMAND> - a Foxx application manager for ArangoDB
SYNOPSIS SYNOPSIS
COMMAND options <COMMAND> options
DESCRIPTION DESCRIPTION
The COMMAND binary can be used to manage Foxx applications in the The <COMMAND> binary can be used to manage Foxx applications in the
ArangoDB database server. Foxx applications can be installed and ArangoDB database server. Foxx applications can be installed and
uninstalled. uninstalled.
More specific instructions are displayed when the program is invoked.
OPTIONS OPTIONS
OPTION "--server.database <string>" For a complete list of options, please refer to the ArangoDB
database name to use when connecting (default: "_system") ENDOPTION online manual, available at https://www.arangodb.com/
OPTION "--server.username <string>"
username to use when connecting (default "root") ENDOPTION
OPTION "--server.password <string>"
password to use when connecting. Don't specify this option to get a password prompt ENDOPTION
OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server ENDOPTION
EXAMPLES
EXAMPLE COMMAND search "foobar"
searches the central repository for an application "foobar"ENDEXAMPLE
EXAMPLE COMMAND update
updates the local repository with applications from the central repositoryENDEXAMPLE
EXAMPLE COMMAND list
list all installed Foxx applicationsENDEXAMPLE
EXAMPLE COMMAND install "hello-foxx" "/hello"
installs the "hello-foxx" application under the mount point "/hello"ENDEXAMPLE
EXAMPLE COMMAND uninstall "/hello"
uninstalls the application that is mounted under "/hello"ENDEXAMPLE
EXAMPLE COMMAND help
shows the help pageENDEXAMPLE
AUTHOR AUTHOR

16
Documentation/man8/rcarangod.8
View File

@ -1,15 +1,13 @@
COMMAND SECTION "DATE" "" "ArangoDB"
NAME NAME
COMMAND - control script for the ArangoDB database server <COMMAND> - control script for the ArangoDB database server
SYNOPSIS SYNOPSIS
COMMAND start|stop <COMMAND> start|stop
DESCRIPTION DESCRIPTION
The COMMAND script controls the operation of the ArangoDB The <COMMAND> script controls the operation of the ArangoDB database
database server daemon running on the system. The COMMAND script server daemon running on the system. The <COMMAND> script is normally
is normally run at system boot time with the "start" argument, and run at system boot time with the "start" argument, and at system
at system shutdown time with the "stop" argument. shutdown time with the "stop" argument. It can also be invoked
It can also be invoked manually at any time to start or stop the manually at any time to start or stop the ArangoDB database server.
ArangoDB database server.
SEE ALSO SEE ALSO
arangod(8) arangod(8)
AUTHOR AUTHOR

7
utils/manPages.sh
View File

@ -7,11 +7,14 @@ VERSION="$3"
section=`echo $IN | sed -e 's:.*\([0-9]\):\1:'` section=`echo $IN | sed -e 's:.*\([0-9]\):\1:'`
command=`echo $IN | sed -e 's:.*/\([^\.]*\).[0-9]:\1:'` command=`echo $IN | sed -e 's:.*/\([^\.]*\).[0-9]:\1:'`
sed \ (
echo '<COMMAND> <SECTION> "<DATE>" "<VERSION>" "ArangoDB"'
cat $IN
) | sed \
-f `dirname $0`/../Documentation/Scripts/man.sed \ -f `dirname $0`/../Documentation/Scripts/man.sed \
-e "s/<SECTION>/$section/g" \ -e "s/<SECTION>/$section/g" \
-e "s/<COMMAND>/$command/g" \ -e "s/<COMMAND>/$command/g" \
-e "s/<DATE>/`date "+%d %b %Y"`/g" \ -e "s/<DATE>/`date "+%d %b %Y"`/g" \
-e "s/<VERSION>/$VERSION/g" \ -e "s/<VERSION>/$VERSION/g" \
< $IN > $OUT > $OUT