diff --git a/CMakeLists.txt b/CMakeLists.txt index 87effcf67e..26a8da96d4 100755 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -858,3 +858,4 @@ add_custom_target (love include(CPack) +add_subdirectory(Documentation) diff --git a/Documentation/CMakeLists.txt b/Documentation/CMakeLists.txt new file mode 100644 index 0000000000..f61983bf83 --- /dev/null +++ b/Documentation/CMakeLists.txt @@ -0,0 +1,38 @@ +# -*- mode: CMAKE; -*- + +set(MAN_NAMES + man1/arangob.1 + man1/arangodump.1 + man1/arangoimp.1 + man1/arangorestore.1 + man1/arangosh.1 + man8/rcarangod.8 + man8/arangod.8 + man8/arango-dfdb.8 + man8/foxx-manager.8 +) + +set(MAN_FILES) + +foreach (m IN LISTS MAN_NAMES) + set(msrc ${CMAKE_SOURCE_DIR}/Documentation/${m}) + set(mdst ${CMAKE_SOURCE_DIR}/Documentation/man/${m}) + + add_custom_command( + OUTPUT + ${mdst} + COMMAND + ${CMAKE_SOURCE_DIR}/utils/manPages.sh ${msrc} ${mdst} ${ARANGODB_VERSION} + DEPENDS + ${msrc} + WORKING_DIRECTORY + ${CMAKE_BINARY_DIR} + COMMENT + "Building manpage ${mdst}" + VERBATIM + ) + + list(APPEND MAN_FILES ${mdst}) +endforeach () + +add_custom_target(man ALL DEPENDS ${MAN_FILES}) diff --git a/Documentation/Scripts/man.sed b/Documentation/Scripts/man.sed index 6f87a13b3a..1d49b82fdf 100644 --- a/Documentation/Scripts/man.sed +++ b/Documentation/Scripts/man.sed @@ -3,14 +3,18 @@ /SYNOPSIS/s/^\(.*\)$/\.SH \1/ /DESCRIPTION/s/^\(.*\)$/\.SH \1/ /OPTIONS/s/^\(.*\)$/\.SH \1/ -/\/s/^\(.*\)$/\.SH \1/ +/EXAMPLES/s/^\(.*\)$/\.SH \1/ /FILES/s/^\(.*\)$/\.SH \1/ -/AUTHOR/s/^\(.*\)$/\.SH \1/ +/AUTHOR/s/^\(.*\)$/\.SH AUTHOR/ /SEE ALSO/s/^\(.*\)$/\.SH \1/ s/\/\.IP/g s/\//g -s/\/\.EX\nshell>/g -s/\/\n\.EE\n/g +s/\ \(.*\)/\.nf\ +shell> \1\ +\.fi\ +/g +s/\/\ +/g /SEE ALSO/,/AUTHOR/{ /^[a-z]/s/^\(.*\)$/\.BR \1/ s/(\([1-9]\))/ "(\1), "/g @@ -19,5 +23,5 @@ s/\/\n\.EE\n/g i\ a\ - Copyright triAGENS GmbH, Cologne, Germany + Copyright ArangoDB GmbH, Cologne, Germany } diff --git a/Documentation/man/man1/arangob.1 b/Documentation/man/man1/arangob.1 index 81560eaffd..85ed2c0b95 100644 --- a/Documentation/man/man1/arangob.1 +++ b/Documentation/man/man1/arangob.1 @@ -1,4 +1,4 @@ -.TH arangob 1 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB" +.TH arangob 1 "23 Feb 2016" "3.0.0-devel" "ArangoDB" .SH NAME arangob - the ArangoDB benchmark and test tool .SH SYNOPSIS @@ -7,68 +7,48 @@ arangob [options] 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. -arangob currently only supports a few common test cases out of the box. -More test cases might be added later. .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 "--configuration " -read configuration from file -.IP "--batch-size " -number of operations to send per batch (use 0 to disable batching) -.IP "--collection " -name of collection to use in test (only relevant for tests that invoke collections) -.IP "--concurrency " -number of parallel threads that will issue requests (default is 1 thread) -.IP "--requests " -total number of requests to perform -.IP "--test-case " -name of test case to perform (possible values: "version" and "document") -.IP "--complexity " -complexity value for test case (meaning depends on test case) -.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 -.EX -shell> arangob -starts arangob with the default user and server endpoint -.EE - - -.EX -shell> arangob --test-case version --requests 1000 --concurrency 1 -runs the 'version' test case with 1000 requests, without concurrency -.EE - - -.EX -shell> arangob --test-case document --requests 1000 --concurrency 2 -runs the 'document' test case with 2000 requests, with concurrency 2 -.EE - - -.EX -shell> arangob --test-case document --requests 1000 --concurrency 2 --async true -runs the 'document' test case with 2000 requests, with concurrency 2, with async requests -.EE - - -.EX -shell> 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 -.EE - - +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 triAGENS GmbH, Cologne, Germany +Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man/man1/arangodump.1 b/Documentation/man/man1/arangodump.1 index b7efa4d5a3..9275038a22 100644 --- a/Documentation/man/man1/arangodump.1 +++ b/Documentation/man/man1/arangodump.1 @@ -1,4 +1,4 @@ -.TH arangodump 1 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB" +.TH arangodump 1 "23 Feb 2016" "3.0.0-devel" "ArangoDB" .SH NAME arangodump - a tool to create logical dumps of an ArangoDB database .SH SYNOPSIS @@ -27,34 +27,33 @@ online manual, available at http://www.arangodb.org/ The most important startup options are: -.IP "--configuration " -read configuration from file -.IP "--collection " +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 -.IP "--dump-data " -when set to "true" will dump the data (documents) of the collection -.IP "--include-system-collections " -when set to "true" will also dump system collections, otherwise they will be excluded -.IP "--output-directory " +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" -.IP "--overwrite " -when set to "true", will overwrite any files in an existing output directory -.IP "--progress " -when set to "true", will display progress information -.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 - +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 triAGENS GmbH, Cologne, Germany +Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man/man1/arangoimp.1 b/Documentation/man/man1/arangoimp.1 index cb30b6b3b9..8fc86148a4 100644 --- a/Documentation/man/man1/arangoimp.1 +++ b/Documentation/man/man1/arangoimp.1 @@ -1,4 +1,4 @@ -.TH arangoimp 1 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB" +.TH arangoimp 1 "23 Feb 2016" "3.0.0-devel" "ArangoDB" .SH NAME arangoimp - a bulk importer for the ArangoDB database .SH SYNOPSIS @@ -15,50 +15,40 @@ online manual, available at http://www.arangodb.org/ The most important startup options are: -.IP "--batch-size " -maximum size of data batches that are sent to the server -.IP "--configuration " -read configuration from file -.IP "--collection " -name of collection to import into -.IP "--create-collection " -set to "true" if collection should be created by the import -.IP "--file " -input file with the data to import -.IP "--overwrite " -set to "true" to remove all data from the collection prior to the import -.IP "--quote " -optional quote character to be used -.IP "--separator " -separator character or string to be used. the default value is "," -.IP "--type " -set to "json", "tsv" or "csv", depending on the input file format -.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 -.EX -shell> 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 -.EE - -.EX -shell> arangoimp --file export.csv --type csv --collection mydata -imports CSV data from export.csv into existing collection mydata -.EE - -.EX -shell> 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 -.EE - - +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 triAGENS GmbH, Cologne, Germany +Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man/man1/arangorestore.1 b/Documentation/man/man1/arangorestore.1 index a215c06af9..ac40abc23c 100644 --- a/Documentation/man/man1/arangorestore.1 +++ b/Documentation/man/man1/arangorestore.1 @@ -1,4 +1,5 @@ -.TH arangorestore 1 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB" +.TH arangorestore 1 "23 Feb 2016" "3.0.0-devel" "ArangoDB" +arangorestore SECTION "DATE" "" "ArangoDB" .SH NAME arangorestore - a data restore tool for the ArangoDB database .SH SYNOPSIS @@ -16,36 +17,35 @@ online manual, available at http://www.arangodb.org/ The most important startup options are: -.IP "--configuration " -read configuration from file -.IP "--collection " +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 -.IP "--create-collection " -set to "true" if collections should be created -.IP "--import-data " -when set to "true" will restore the data (documents) of the collection -.IP "--include-system-collections " +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 -.IP "--input-directory " -input directory in which to look for dump files. -.IP "--overwrite " -when set to "true", will drop an existing collection before re-creating it -.IP "--progress " -when set to "true", will display progress information -.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 - +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 triAGENS GmbH, Cologne, Germany +Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man/man1/arangosh.1 b/Documentation/man/man1/arangosh.1 index fea8cee45a..0c89f7940f 100644 --- a/Documentation/man/man1/arangosh.1 +++ b/Documentation/man/man1/arangosh.1 @@ -1,4 +1,4 @@ -.TH arangosh 1 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB" +.TH arangosh 1 "23 Feb 2016" "3.0.0-devel" "ArangoDB" .SH NAME arangosh - the ArangoDB shell .SH SYNOPSIS @@ -14,51 +14,66 @@ 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 +log input and output to audit log file + .IP "--configuration " -read configuration from file +read configuration from file + .IP "--log.level " -set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace") +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 +server endpoint to connect to, consisting of protocol, ip address and port + .IP "--server.database " -database name to use when connection (default: "_system") +database name to use when connection (default: "_system") + .IP "--server.username " -username to use when connecting (default "root") +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 +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 +disable the password prompt and authentication when connecting to the server + + .SH EXAMPLES -.EX +.nf shell> arangosh -starts arangosh with the default user and server endpoint -.EE +.fi + +starts arangosh with the default user and server endpoint -.EX +.nf shell> arangosh --server.username fuchsia -starts arangosh with a specific user. Password prompt will follow if --server.disable-authentication is true. -.EE +.fi + +starts arangosh with a specific user. Password prompt will follow if --server.disable-authentication is true. -.EX +.nf shell> arangosh --server.username fuchsia --server.password "abcd@34" -starts arangosh with a specific user and password given on command line -.EE +.fi + +starts arangosh with a specific user and password given on command line -.EX +.nf shell> arangosh --server.endpoint tcp://192.168.173.13:8529 -starts arangosh connecting to a specific server -.EE +.fi + +starts arangosh connecting to a specific server -.EX +.nf shell> arangosh --server.endpoint ssl://192.168.173.13:8530 -starts arangosh connecting to a specific server using an SSL connection -.EE +.fi + +starts arangosh connecting to a specific server using an SSL connection + .SH AUTHOR - Copyright triAGENS GmbH, Cologne, Germany +Copyright ArangoDB GmbH, Cologne, Germany diff --git a/Documentation/man/man8/arango-dfdb.8 b/Documentation/man/man8/arango-dfdb.8 index 7bdd8b7426..9a9d65e546 100644 --- a/Documentation/man/man8/arango-dfdb.8 +++ b/Documentation/man/man8/arango-dfdb.8 @@ -1,24 +1,20 @@ -.TH arango-dfdb 8 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB" +.TH COMMAND SECTION "DATE" "" "ArangoDB" .SH NAME -arango-dfdb - a datafile debugger for ArangoDB +COMMAND - a datafile debugger for ArangoDB .SH SYNOPSIS -arango-dfdb options +COMMAND options .SH DESCRIPTION -The arango-dfdb 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 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. .SH OPTIONS -.IP "--database.directory " -path to the database directory -.SH EXAMPLES -.EX -shell> arango-dfdb --database.directory /data/arangodb -starts the debugger with database directory /data/arangodb -.EE - - +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 .SH AUTHOR - Copyright triAGENS GmbH, Cologne, Germany +Copyright triAGENS GmbH, Cologne, Germany diff --git a/Documentation/man/man8/arangod.8 b/Documentation/man/man8/arangod.8 index 28f1192ad5..0041688a97 100644 --- a/Documentation/man/man8/arangod.8 +++ b/Documentation/man/man8/arangod.8 @@ -1,10 +1,10 @@ -.TH arangod 8 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB" +.TH COMMAND SECTION "DATE" "" "ArangoDB" .SH NAME -arangod - the ArangoDB database server +COMMAND - the ArangoDB database server .SH SYNOPSIS -arangod [options] database-directory +COMMAND [options] database-directory .SH DESCRIPTION -The arangod 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 clients to connect to it via the network. The server also has an emergency console mode that can be used for any sort of @@ -13,59 +13,40 @@ 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 arangod binary has many options that can be used to control +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 most important startup options are: -.IP "--configuration " -read configuration from file -.IP "--console" -do not start as server, start an emergency console instead -.IP "--log.file " -log to file -.IP "--log.level " -set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace") -.IP "--server.endpoint " -listen endpoint for client requests, consisting of protocol, ip address and port -.IP "--server.disable-authentication " -disable authentication for all clients -.IP "--database.directory " -path to the database directory -.SH EXAMPLES -.EX -shell> arangod /data/arangodb -starts the server with database directory /data/arangodb -.EE - -.EX -shell> arangod --database.directory /data/arangodb -same, but uses --database.directory option instead -.EE - -.EX -shell> arangod --log.level debug /data/arangodb -starts server with log level "debug" -.EE - -.EX -shell> arangod --server.endpoint tcp://127.0.0.1:8529 /data/arangodb -starts server listening on port 8529 of IP 127.0.0.1 -.EE - -.EX -shell> arangod --server.endpoint tcp://192.168.173.13:8529 +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 -.EE - -.EX -shell> arangod --console /data/arangodb -starts the emergency console -.EE - - +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 triAGENS GmbH, Cologne, Germany diff --git a/Documentation/man/man8/foxx-manager.8 b/Documentation/man/man8/foxx-manager.8 index a9514c9d46..e3a0e9ea9a 100644 --- a/Documentation/man/man8/foxx-manager.8 +++ b/Documentation/man/man8/foxx-manager.8 @@ -1,47 +1,34 @@ -.TH foxx-manager 8 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB" +.TH COMMAND SECTION "DATE" "" "ArangoDB" .SH NAME -foxx-manager - a Foxx application manager for ArangoDB +COMMAND - a Foxx application manager for ArangoDB .SH SYNOPSIS -foxx-manager options +COMMAND options .SH DESCRIPTION -The foxx-manager 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 uninstalled. More specific instructions are displayed when the program is invoked. .SH OPTIONS -.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 -.EX -shell> foxx-manager search "foobar" -searches the central repository for an application "foobar" -.EE - -.EX -shell> foxx-manager update +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 -.EX -shell> foxx-manager list +EXAMPLE COMMAND list list all installed Foxx applicationsENDEXAMPLE -.EX -shell> foxx-manager install "hello-foxx" "/hello" -installs the "hello-foxx" application under the mount point "/hello" -.EE - -.EX -shell> foxx-manager uninstall "/hello" -uninstalls the application that is mounted under "/hello" -.EE - -.EX -shell> foxx-manager help +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 - Copyright triAGENS GmbH, Cologne, Germany +Copyright triAGENS GmbH, Cologne, Germany diff --git a/Documentation/man/man8/rcarangod.8 b/Documentation/man/man8/rcarangod.8 index f885f0058c..cfb12374d3 100644 --- a/Documentation/man/man8/rcarangod.8 +++ b/Documentation/man/man8/rcarangod.8 @@ -1,17 +1,16 @@ -.TH rcarangod 8 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB" +.TH COMMAND SECTION "DATE" "" "ArangoDB" .SH NAME -rcarangod - control script for the ArangoDB database server +COMMAND - control script for the ArangoDB database server .SH SYNOPSIS -rcarangod start|stop +COMMAND start|stop .SH DESCRIPTION -The rcarangod script controls the operation of the ArangoDB -database server daemon running on the system. The rcarangod script +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. .SH SEE ALSO .BR arangod "(8), " - .SH AUTHOR - Copyright triAGENS GmbH, Cologne, Germany +Copyright triAGENS GmbH, Cologne, Germany diff --git a/Documentation/man1/arangob b/Documentation/man1/arangob.1 similarity index 81% rename from Documentation/man1/arangob rename to Documentation/man1/arangob.1 index f2bd0e3051..059690c140 100644 --- a/Documentation/man1/arangob +++ b/Documentation/man1/arangob.1 @@ -1,8 +1,8 @@ -COMMAND SECTION "DATE" "" "ArangoDB" +
"" "" "ArangoDB" NAME -COMMAND - the ArangoDB benchmark and test tool + - the ArangoDB benchmark and test tool SYNOPSIS -COMMAND [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 @@ -40,14 +40,14 @@ password to use when connecting. Don't specify this option to get a password pro OPTION "--server.disable-authentication " 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 +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 COMMAND --test-case document --requests 1000 --concurrency 2 +EXAMPLE --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 +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 COMMAND --test-case document --requests 1000 --concurrency 2 --batch-size 10 +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 b/Documentation/man1/arangodump.1 similarity index 81% rename from Documentation/man1/arangodump rename to Documentation/man1/arangodump.1 index 21c78ad99a..3fe9b73cba 100644 --- a/Documentation/man1/arangodump +++ b/Documentation/man1/arangodump.1 @@ -1,10 +1,10 @@ -COMMAND SECTION "DATE" "" "ArangoDB" +
"" "" "ArangoDB" NAME -COMMAND - a tool to create logical dumps of an ArangoDB database + - a tool to create logical dumps of an ArangoDB database SYNOPSIS -COMMAND [options] + [options] DESCRIPTION -The COMMAND binary can be used to create logical dumps of collection +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. @@ -13,11 +13,11 @@ 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 -COMMAND when run. If the directory already exists, COMMAND will refuse to + when run. If the directory already exists, will refuse to work unless started with the option "--overwrite true". -COMMAND will work on the specified database only. If no database name -is specified, COMMAND 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. @@ -39,7 +39,7 @@ 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, -COMMAND will refuse to work unless started with option "--overwrite true" ENDOPTION + 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 " diff --git a/Documentation/man1/arangoimp b/Documentation/man1/arangoimp.1 similarity index 81% rename from Documentation/man1/arangoimp rename to Documentation/man1/arangoimp.1 index 5a89261a0e..3950ab63df 100644 --- a/Documentation/man1/arangoimp +++ b/Documentation/man1/arangoimp.1 @@ -1,10 +1,10 @@ -COMMAND SECTION "DATE" "" "ArangoDB" +
"" "" "ArangoDB" NAME -COMMAND - a bulk importer for the ArangoDB database + - a bulk importer for the ArangoDB database SYNOPSIS -COMMAND [options] + [options] DESCRIPTION -The COMMAND binary can be used to bulk import data from a file into the +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 @@ -44,10 +44,10 @@ password to use when connecting. Don't specify this option to get a password pro OPTION "--server.disable-authentication " 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 +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 COMMAND --file export.csv --type csv --collection mydata +EXAMPLE --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 +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 b/Documentation/man1/arangorestore.1 similarity index 89% rename from Documentation/man1/arangorestore rename to Documentation/man1/arangorestore.1 index cae89c2a53..4a2ce9b8d4 100644 --- a/Documentation/man1/arangorestore +++ b/Documentation/man1/arangorestore.1 @@ -1,10 +1,11 @@ -COMMAND SECTION "DATE" "" "ArangoDB" +
"" "" "ArangoDB" + SECTION "DATE" "" "ArangoDB" NAME -COMMAND - a data restore tool for the ArangoDB database + - a data restore tool for the ArangoDB database SYNOPSIS -COMMAND [options] + [options] DESCRIPTION -The COMMAND binary can be used to restore data from logical dumps created +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, diff --git a/Documentation/man1/arangosh b/Documentation/man1/arangosh deleted file mode 100644 index 7b766253a1..0000000000 --- a/Documentation/man1/arangosh +++ /dev/null @@ -1,43 +0,0 @@ -COMMAND SECTION "DATE" "" "ArangoDB" -NAME -COMMAND - the ArangoDB shell -SYNOPSIS -COMMAND [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. -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: - -OPTION "--audit-log " -log input and output to audit log file ENDOPTION -OPTION "--configuration " -read configuration from file ENDOPTION -OPTION "--log.level " -set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace") 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 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 diff --git a/Documentation/man1/arangosh.1 b/Documentation/man1/arangosh.1 new file mode 100644 index 0000000000..ad16c6e0a6 --- /dev/null +++ b/Documentation/man1/arangosh.1 @@ -0,0 +1,58 @@ +
"" "" "ArangoDB" +NAME + - the ArangoDB shell +SYNOPSIS + [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. +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: + +