From fb8965d4b7367bac08f8fd38bb65fbdeeefdc3c7 Mon Sep 17 00:00:00 2001 From: Frank Celler Date: Wed, 24 Feb 2016 19:56:47 +0100 Subject: [PATCH] fixed manual pages --- Documentation/Scripts/man.sed | 1 + Documentation/man/man1/arangob.1 | 43 +--------------- Documentation/man/man1/arangodump.1 | 37 ++------------ Documentation/man/man1/arangoimp.1 | 44 ++--------------- Documentation/man/man1/arangorestore.1 | 48 +++--------------- Documentation/man/man1/arangosh.1 | 68 +------------------------- Documentation/man/man8/arango-dfdb.8 | 27 +++++----- Documentation/man/man8/arangod.8 | 61 ++++++----------------- Documentation/man/man8/foxx-manager.8 | 35 +++---------- Documentation/man/man8/rcarangod.8 | 19 ++++--- Documentation/man1/arangob.1 | 54 +++----------------- Documentation/man1/arangodump.1 | 68 +++++++------------------- Documentation/man1/arangoimp.1 | 57 ++++----------------- Documentation/man1/arangorestore.1 | 53 ++++---------------- Documentation/man1/arangosh.1 | 59 +++------------------- Documentation/man8/arango-dfdb.8 | 24 ++++----- Documentation/man8/arangod.8 | 58 +++++----------------- Documentation/man8/foxx-manager.8 | 36 +++----------- Documentation/man8/rcarangod.8 | 18 +++---- utils/manPages.sh | 7 ++- 20 files changed, 160 insertions(+), 657 deletions(-) diff --git a/Documentation/Scripts/man.sed b/Documentation/Scripts/man.sed index 1d49b82fdf..b2da6a8e3c 100644 --- a/Documentation/Scripts/man.sed +++ b/Documentation/Scripts/man.sed @@ -1,4 +1,5 @@ 1s/^\(.*\)$/\.TH \1/ +s/^ // /NAME/s/^\(.*\)$/\.SH \1/ /SYNOPSIS/s/^\(.*\)$/\.SH \1/ /DESCRIPTION/s/^\(.*\)$/\.SH \1/ diff --git a/Documentation/man/man1/arangob.1 b/Documentation/man/man1/arangob.1 index 85ed2c0b95..b2031c0fde 100644 --- a/Documentation/man/man1/arangob.1 +++ b/Documentation/man/man1/arangob.1 @@ -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 arangob - the ArangoDB benchmark and test tool .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. .SH OPTIONS 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 " -read configuration from file ENDOPTION -OPTION "--batch-size " -number of operations to send per batch (use 0 to disable batching) ENDOPTION -OPTION "--collection " -name of collection to use in test (only relevant for tests that invoke collections) ENDOPTION -OPTION "--concurrency " -number of parallel threads that will issue requests (default is 1 thread) ENDOPTION -OPTION "--requests " -total number of requests to perform ENDOPTION -OPTION "--test-case " -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 " -complexity value for test case (meaning depends on test case) ENDOPTION -OPTION "--server.endpoint " -server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION -OPTION "--server.database " -database name to use when connecting (default: "_system") ENDOPTION -OPTION "--server.username " -username to use when connecting (default "root") ENDOPTION -OPTION "--server.password " -password to use when connecting. Don't specify this option to get a password prompt ENDOPTION -OPTION "--server.disable-authentication " -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 Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man/man1/arangodump.1 b/Documentation/man/man1/arangodump.1 index 9275038a22..6c74c9ec64 100644 --- a/Documentation/man/man1/arangodump.1 +++ b/Documentation/man/man1/arangodump.1 @@ -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 arangodump - a tool to create logical dumps of an ArangoDB database .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 arangorestore tool. .SH OPTIONS -For a complete list of options, please refer to the ArangoDB -online manual, available at http://www.arangodb.org/ +The arangodump binary has many options that can be used to control its +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 " -read configuration from file ENDOPTION -OPTION "--collection " -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 " -when set to "true" will dump the data (documents) of the collection ENDOPTION -OPTION "--include-system-collections " -when set to "true" will also dump system collections, otherwise they will be excluded ENDOPTION -OPTION "--output-directory " -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 " -when set to "true", will overwrite any files in an existing output directory ENDOPTION -OPTION "--progress " -when set to "true", will display progress information ENDOPTION -OPTION "--server.endpoint " -server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION -OPTION "--server.database " -database name to use when connection (default: "_system") ENDOPTION -OPTION "--server.username " -username to use when connecting (default "root") ENDOPTION -OPTION "--server.password " -password to use when connecting. Don't specify this option to get a password prompt ENDOPTION -OPTION "--server.disable-authentication " -disable the password prompt and authentication when connecting to the server ENDOPTION -EXAMPLES .SH AUTHOR Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man/man1/arangoimp.1 b/Documentation/man/man1/arangoimp.1 index 8fc86148a4..fee782787c 100644 --- a/Documentation/man/man1/arangoimp.1 +++ b/Documentation/man/man1/arangoimp.1 @@ -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 arangoimp - a bulk importer for the ArangoDB database .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 the attribute name/value pairs to import. .SH OPTIONS -For a complete list of options, please refer to the ArangoDB -online manual, available at http://www.arangodb.org/ +The arangoimp binary has many options that can be used to control its +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 " -maximum size of data batches that are sent to the server ENDOPTION -OPTION "--configuration " -read configuration from file ENDOPTION -OPTION "--collection " -name of collection to import into ENDOPTION -OPTION "--create-collection " -set to "true" if collection should be created by the import ENDOPTION -OPTION "--file " -input file with the data to import ENDOPTION -OPTION "--overwrite " -set to "true" to remove all data from the collection prior to the import ENDOPTION -OPTION "--quote " -optional quote character to be used ENDOPTION -OPTION "--separator " -separator character or string to be used. the default value is "," ENDOPTION -OPTION "--type " -set to "json", "tsv" or "csv", depending on the input file format ENDOPTION -OPTION "--server.endpoint " -server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION -OPTION "--server.database " -database name to use when connection (default: "_system") ENDOPTION -OPTION "--server.username " -username to use when connecting (default "root") ENDOPTION -OPTION "--server.password " -password to use when connecting. Don't specify this option to get a password prompt ENDOPTION -OPTION "--server.disable-authentication " -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 Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man/man1/arangorestore.1 b/Documentation/man/man1/arangorestore.1 index ac40abc23c..22eb17c736 100644 --- a/Documentation/man/man1/arangorestore.1 +++ b/Documentation/man/man1/arangorestore.1 @@ -1,51 +1,17 @@ -.TH arangorestore 1 "23 Feb 2016" "3.0.0-devel" "ArangoDB" -arangorestore SECTION "DATE" "" "ArangoDB" +.TH arangorestore 1 "24 Feb 2016" "3.0.0-devel" "ArangoDB" .SH NAME arangorestore - a data restore tool for the ArangoDB database .SH SYNOPSIS arangorestore [options] .SH DESCRIPTION -The arangorestore binary can be used to restore data from logical dumps created -with the arangodump tool. -ArangoDB database. Input data be present in the input file in either CSV -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 -the attribute name/value pairs to import. +The arangorestore binary can be used to restore data from logical dumps +created with the arangodump tool. Input data be present in the input +file in either CSV 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 the attribute name/value pairs to import. .SH OPTIONS 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 " -read configuration from file ENDOPTION -OPTION "--collection " -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 " -set to "true" if collections should be created ENDOPTION -OPTION "--import-data " -when set to "true" will restore the data (documents) of the collection ENDOPTION -OPTION "--include-system-collections " -when set to "true" will also restore system collections, otherwise they will be -excluded ENDOPTION -OPTION "--input-directory " -input directory in which to look for dump files. ENDOPTION -OPTION "--overwrite " -when set to "true", will drop an existing collection before re-creating it ENDOPTION -OPTION "--progress " -when set to "true", will display progress information ENDOPTION -OPTION "--server.endpoint " -server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION -OPTION "--server.database " -database name to use when connection (default: "_system") ENDOPTION -OPTION "--server.username " -username to use when connecting (default "root") ENDOPTION -OPTION "--server.password " -password to use when connecting. Don't specify this option to get a password prompt ENDOPTION -OPTION "--server.disable-authentication " -disable the password prompt and authentication when connecting to the server ENDOPTION -EXAMPLES .SH AUTHOR Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man/man1/arangosh.1 b/Documentation/man/man1/arangosh.1 index 0c89f7940f..5f4ea9a32f 100644 --- a/Documentation/man/man1/arangosh.1 +++ b/Documentation/man/man1/arangosh.1 @@ -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 arangosh - the ArangoDB shell .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. .SH OPTIONS For a complete list of options, please refer to the ArangoDB -online manual, available at http://www.arangodb.org/ - -The most important startup options are: - -.IP "--audit-log " -log input and output to audit log file - -.IP "--configuration " -read configuration from file - -.IP "--log.level " -set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace") - -.IP "--server.endpoint " -server endpoint to connect to, consisting of protocol, ip address and port - -.IP "--server.database " -database name to use when connection (default: "_system") - -.IP "--server.username " -username to use when connecting (default "root") - -.IP "--server.password " -password to use when connecting. Don't specify this option to get a password prompt - -.IP "--server.disable-authentication " -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 - - +online manual, available at https://www.arangodb.com/ .SH AUTHOR Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man/man8/arango-dfdb.8 b/Documentation/man/man8/arango-dfdb.8 index 9a9d65e546..57f1b11a36 100644 --- a/Documentation/man/man8/arango-dfdb.8 +++ b/Documentation/man/man8/arango-dfdb.8 @@ -1,20 +1,17 @@ -.TH COMMAND SECTION "DATE" "" "ArangoDB" +.TH arango-dfdb 8 "24 Feb 2016" "3.0.0-devel" "ArangoDB" .SH NAME -COMMAND - a datafile debugger for ArangoDB +arango-dfdb - a datafile debugger for ArangoDB .SH SYNOPSIS -COMMAND options +arango-dfdb options .SH DESCRIPTION -The COMMAND binary can be used to verify the datafiles of an -ArangoDB database server. The script must be run with exclusive -access to the server's data directory, meaning the ArangoDB -server must not be running and accessing the datafiles in the -specified data directory. -More specific instructions are displayed when the program is invoked. +The arango-dfdb binary can be used to verify the datafiles of an +ArangoDB database server. The script must be run with exclusive access +to the server's data directory, meaning the ArangoDB server must not +be running and accessing the datafiles in the specified data +directory. .SH OPTIONS -OPTION "--database.directory " -path to the database directory ENDOPTION -EXAMPLES -EXAMPLE COMMAND --database.directory /data/arangodb -starts the debugger with database directory /data/arangodb ENDEXAMPLE +For a complete list of options, please refer to the ArangoDB +online manual, available at https://www.arangodb.com/ + .SH AUTHOR -Copyright triAGENS GmbH, Cologne, Germany +Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man/man8/arangod.8 b/Documentation/man/man8/arangod.8 index 0041688a97..1379017d2c 100644 --- a/Documentation/man/man8/arangod.8 +++ b/Documentation/man/man8/arangod.8 @@ -1,52 +1,21 @@ -.TH COMMAND SECTION "DATE" "" "ArangoDB" +.TH arangod 8 "24 Feb 2016" "3.0.0-devel" "ArangoDB" .SH NAME -COMMAND - the ArangoDB database server +arangod - the ArangoDB database server .SH SYNOPSIS -COMMAND [options] database-directory +arangod [options] database-directory .SH DESCRIPTION -The COMMAND binary can be used to start the ArangoDB database -server. By default, the server will run in a mode that allows -clients to connect to it via the network. The server also has -an emergency console mode that can be used for any sort of -maintenance operations. In the emergency console mode, the -server does not allow any clients to connect. -The server can be stopped gracefully at any time by pressing -CTRL-C or by sending the SIGINT signal to the process. +The arangod binary can be used to start the ArangoDB database +server. By default, the server will run in a mode that allows clients +to connect to it via the network. The server also has an emergency +console mode that can be used for any sort of maintenance +operations. In the emergency console mode, the server does not allow +any clients to connect. The server can be stopped gracefully at any +time by pressing CTRL-C or by sending the SIGINT signal to the +process. .SH OPTIONS -The COMMAND binary has many options that can be used to control -its behavior. -For a complete list of options, please refer to the ArangoDB -online manual, available at http://www.arangodb.org/ +The arangod binary has many options that can be used to control its +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 " -read configuration from file ENDOPTION -OPTION "--console" -do not start as server, start an emergency console instead ENDOPTION -OPTION "--log.file " -log to file ENDOPTION -OPTION "--log.level " -set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace") ENDOPTION -OPTION "--server.endpoint " -listen endpoint for client requests, consisting of protocol, ip address and port ENDOPTION -OPTION "--server.disable-authentication " -disable authentication for all clients ENDOPTION -OPTION "--database.directory " -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 -Copyright triAGENS GmbH, Cologne, Germany +Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man/man8/foxx-manager.8 b/Documentation/man/man8/foxx-manager.8 index e3a0e9ea9a..e187ca2421 100644 --- a/Documentation/man/man8/foxx-manager.8 +++ b/Documentation/man/man8/foxx-manager.8 @@ -1,34 +1,15 @@ -.TH COMMAND SECTION "DATE" "" "ArangoDB" +.TH foxx-manager 8 "24 Feb 2016" "3.0.0-devel" "ArangoDB" .SH NAME -COMMAND - a Foxx application manager for ArangoDB +foxx-manager - a Foxx application manager for ArangoDB .SH SYNOPSIS -COMMAND options +foxx-manager options .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 uninstalled. -More specific instructions are displayed when the program is invoked. .SH OPTIONS -OPTION "--server.database " -database name to use when connecting (default: "_system") ENDOPTION -OPTION "--server.username " -username to use when connecting (default "root") ENDOPTION -OPTION "--server.password " -password to use when connecting. Don't specify this option to get a password prompt ENDOPTION -OPTION "--server.disable-authentication " -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 +For a complete list of options, please refer to the ArangoDB +online manual, available at https://www.arangodb.com/ + .SH AUTHOR -Copyright triAGENS GmbH, Cologne, Germany +Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man/man8/rcarangod.8 b/Documentation/man/man8/rcarangod.8 index cfb12374d3..90c1dfc164 100644 --- a/Documentation/man/man8/rcarangod.8 +++ b/Documentation/man/man8/rcarangod.8 @@ -1,16 +1,15 @@ -.TH COMMAND SECTION "DATE" "" "ArangoDB" +.TH rcarangod 8 "24 Feb 2016" "3.0.0-devel" "ArangoDB" .SH NAME -COMMAND - control script for the ArangoDB database server +rcarangod - control script for the ArangoDB database server .SH SYNOPSIS -COMMAND start|stop +rcarangod start|stop .SH DESCRIPTION -The COMMAND script controls the operation of the ArangoDB -database server daemon running on the system. The COMMAND script -is normally run at system boot time with the "start" argument, and -at system shutdown time with the "stop" argument. -It can also be invoked manually at any time to start or stop the -ArangoDB database server. +The rcarangod script controls the operation of the ArangoDB database +server daemon running on the system. The rcarangod script is normally +run at system boot time with the "start" argument, and at system +shutdown time with the "stop" argument. It can also be invoked +manually at any time to start or stop the ArangoDB database server. .SH SEE ALSO .BR arangod "(8), " .SH AUTHOR -Copyright triAGENS GmbH, Cologne, Germany +Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man1/arangob.1 b/Documentation/man1/arangob.1 index 059690c140..8084f690b8 100644 --- a/Documentation/man1/arangob.1 +++ b/Documentation/man1/arangob.1 @@ -1,53 +1,13 @@ -
"" "" "ArangoDB" NAME - - the ArangoDB benchmark and test tool + - the ArangoDB benchmark and test tool SYNOPSIS - [options] + [options] DESCRIPTION -The arangob binary can be used to issue test requests to the -ArangoDB database. It can be used for benchmarks or server function -testing. It supports parallel querying and batch requests. + The arangob binary can be used to issue test requests to the + ArangoDB database. It can be used for benchmarks or server function + testing. It supports parallel querying and batch requests. OPTIONS -For a complete list of options, please refer to the ArangoDB -online manual, available at http://www.arangodb.org/ + 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 " -read configuration from file ENDOPTION -OPTION "--batch-size " -number of operations to send per batch (use 0 to disable batching) ENDOPTION -OPTION "--collection " -name of collection to use in test (only relevant for tests that invoke collections) ENDOPTION -OPTION "--concurrency " -number of parallel threads that will issue requests (default is 1 thread) ENDOPTION -OPTION "--requests " -total number of requests to perform ENDOPTION -OPTION "--test-case " -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 " -complexity value for test case (meaning depends on test case) ENDOPTION -OPTION "--server.endpoint " -server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION -OPTION "--server.database " -database name to use when connecting (default: "_system") ENDOPTION -OPTION "--server.username " -username to use when connecting (default "root") ENDOPTION -OPTION "--server.password " -password to use when connecting. Don't specify this option to get a password prompt ENDOPTION -OPTION "--server.disable-authentication " -disable the password prompt and authentication when connecting to the server ENDOPTION -EXAMPLES -EXAMPLE -starts with the default user and server endpoint ENDEXAMPLE -EXAMPLE --test-case version --requests 1000 --concurrency 1 -runs the 'version' test case with 1000 requests, without concurrency ENDEXAMPLE -EXAMPLE --test-case document --requests 1000 --concurrency 2 -runs the 'document' test case with 2000 requests, with concurrency 2 ENDEXAMPLE -EXAMPLE --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 --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 diff --git a/Documentation/man1/arangodump.1 b/Documentation/man1/arangodump.1 index 3fe9b73cba..c3bf234db9 100644 --- a/Documentation/man1/arangodump.1 +++ b/Documentation/man1/arangodump.1 @@ -1,58 +1,28 @@ -
"" "" "ArangoDB" NAME - - a tool to create logical dumps of an ArangoDB database + - a tool to create logical dumps of an ArangoDB database SYNOPSIS - [options] + [options] DESCRIPTION -The binary can be used to create logical dumps of collection -meta information and collection data (documents) of an ArangoDB database. -By default, all non-system collections of the specified ArangoDB database -will be dumped with structural information and data. + The binary can be used to create logical dumps of collection + meta information and collection data (documents) of an ArangoDB database. + By default, all non-system collections of the specified ArangoDB database + will be dumped with structural information and data. -For each collection, a file named ".structure.json" will be -created with information about the collection. When data is also dumped, -an additional file ".data.json" will also be created. -All dump files will be placed in a directory, which will be created by - when run. If the directory already exists, will refuse to -work unless started with the option "--overwrite true". + For each collection, a file named ".structure.json" will be + created with information about the collection. When data is also dumped, + an additional file ".data.json" will also be created. + All dump files will be placed in a directory, which will be created by + when run. If the directory already exists, will refuse to + work unless started with the option "--overwrite true". - will work on the specified database only. If no database name -is specified, will work on the default database ("_system"). + will work on the specified database only. If no database name + is specified, will work on the default database ("_system"). -The dumped files can be re-stored in an ArangoDB database using the -arangorestore tool. + The dumped files can be re-stored in an ArangoDB database using the + arangorestore tool. OPTIONS -For a complete list of options, please refer to the ArangoDB -online manual, available at http://www.arangodb.org/ + The binary has many options that can be used to control its + 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 " -read configuration from file ENDOPTION -OPTION "--collection " -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 " -when set to "true" will dump the data (documents) of the collection ENDOPTION -OPTION "--include-system-collections " -when set to "true" will also dump system collections, otherwise they will be excluded ENDOPTION -OPTION "--output-directory " -directory in which all dump files will be created. If the directory already exists, - will refuse to work unless started with option "--overwrite true" ENDOPTION -OPTION "--overwrite " -when set to "true", will overwrite any files in an existing output directory ENDOPTION -OPTION "--progress " -when set to "true", will display progress information ENDOPTION -OPTION "--server.endpoint " -server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION -OPTION "--server.database " -database name to use when connection (default: "_system") ENDOPTION -OPTION "--server.username " -username to use when connecting (default "root") ENDOPTION -OPTION "--server.password " -password to use when connecting. Don't specify this option to get a password prompt ENDOPTION -OPTION "--server.disable-authentication " -disable the password prompt and authentication when connecting to the server ENDOPTION -EXAMPLES AUTHOR diff --git a/Documentation/man1/arangoimp.1 b/Documentation/man1/arangoimp.1 index 3950ab63df..289140ae34 100644 --- a/Documentation/man1/arangoimp.1 +++ b/Documentation/man1/arangoimp.1 @@ -1,53 +1,16 @@ -
"" "" "ArangoDB" NAME - - a bulk importer for the ArangoDB database + - a bulk importer for the ArangoDB database SYNOPSIS - [options] + [options] DESCRIPTION -The binary can be used to bulk import data from a file into the -ArangoDB database. Input data be present in the input file in either CSV -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 -the attribute name/value pairs to import. + The binary can be used to bulk import data from a file into the + ArangoDB database. Input data be present in the input file in either CSV + 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 + the attribute name/value pairs to import. OPTIONS -For a complete list of options, please refer to the ArangoDB -online manual, available at http://www.arangodb.org/ + The binary has many options that can be used to control its + 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 " -maximum size of data batches that are sent to the server ENDOPTION -OPTION "--configuration " -read configuration from file ENDOPTION -OPTION "--collection " -name of collection to import into ENDOPTION -OPTION "--create-collection " -set to "true" if collection should be created by the import ENDOPTION -OPTION "--file " -input file with the data to import ENDOPTION -OPTION "--overwrite " -set to "true" to remove all data from the collection prior to the import ENDOPTION -OPTION "--quote " -optional quote character to be used ENDOPTION -OPTION "--separator " -separator character or string to be used. the default value is "," ENDOPTION -OPTION "--type " -set to "json", "tsv" or "csv", depending on the input file format ENDOPTION -OPTION "--server.endpoint " -server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION -OPTION "--server.database " -database name to use when connection (default: "_system") ENDOPTION -OPTION "--server.username " -username to use when connecting (default "root") ENDOPTION -OPTION "--server.password " -password to use when connecting. Don't specify this option to get a password prompt ENDOPTION -OPTION "--server.disable-authentication " -disable the password prompt and authentication when connecting to the server ENDOPTION -EXAMPLES -EXAMPLE --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 --file export.csv --type csv --collection mydata -imports CSV data from export.csv into existing collection mydata ENDEXAMPLE -EXAMPLE --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 diff --git a/Documentation/man1/arangorestore.1 b/Documentation/man1/arangorestore.1 index 4a2ce9b8d4..ba12f86d95 100644 --- a/Documentation/man1/arangorestore.1 +++ b/Documentation/man1/arangorestore.1 @@ -1,50 +1,15 @@ -
"" "" "ArangoDB" - SECTION "DATE" "" "ArangoDB" NAME - - a data restore tool for the ArangoDB database + - a data restore tool for the ArangoDB database SYNOPSIS - [options] + [options] DESCRIPTION -The binary can be used to restore data from logical dumps created -with the arangodump tool. -ArangoDB database. Input data be present in the input file in either CSV -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 -the attribute name/value pairs to import. + The binary can be used to restore data from logical dumps + created with the arangodump tool. Input data be present in the input + file in either CSV 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 the attribute name/value pairs to import. OPTIONS -For a complete list of options, please refer to the ArangoDB -online manual, available at http://www.arangodb.org/ + 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 " -read configuration from file ENDOPTION -OPTION "--collection " -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 " -set to "true" if collections should be created ENDOPTION -OPTION "--import-data " -when set to "true" will restore the data (documents) of the collection ENDOPTION -OPTION "--include-system-collections " -when set to "true" will also restore system collections, otherwise they will be -excluded ENDOPTION -OPTION "--input-directory " -input directory in which to look for dump files. ENDOPTION -OPTION "--overwrite " -when set to "true", will drop an existing collection before re-creating it ENDOPTION -OPTION "--progress " -when set to "true", will display progress information ENDOPTION -OPTION "--server.endpoint " -server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION -OPTION "--server.database " -database name to use when connection (default: "_system") ENDOPTION -OPTION "--server.username " -username to use when connecting (default "root") ENDOPTION -OPTION "--server.password " -password to use when connecting. Don't specify this option to get a password prompt ENDOPTION -OPTION "--server.disable-authentication " -disable the password prompt and authentication when connecting to the server ENDOPTION -EXAMPLES AUTHOR diff --git a/Documentation/man1/arangosh.1 b/Documentation/man1/arangosh.1 index ad16c6e0a6..cd1d50e058 100644 --- a/Documentation/man1/arangosh.1 +++ b/Documentation/man1/arangosh.1 @@ -1,58 +1,13 @@ -
"" "" "ArangoDB" NAME - - the ArangoDB shell + - the ArangoDB shell SYNOPSIS - [options] + [options] DESCRIPTION -The arangosh binary can be used to establish an interactive -client connection to the ArangoDB database. When the connection -is established, it can be used to execute actions on the server. + The binary can be used to establish an interactive + client connection to the ArangoDB database. When the connection + is established, it can be used to execute actions on the server. OPTIONS -For a complete list of options, please refer to the ArangoDB -online manual, available at http://www.arangodb.org/ - -The most important startup options are: - -