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

fixed man page generation

This commit is contained in:
Frank Celler 2016-02-23 15:23:07 +01:00
parent c66a480db9
commit 48e39567fc
23 changed files with 397 additions and 374 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CMakeLists.txt
View File

@ -858,3 +858,4 @@ add_custom_target (love
include(CPack) include(CPack)
add_subdirectory(Documentation)

38
Documentation/CMakeLists.txt Normal file
View File

@ -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})

14
Documentation/Scripts/man.sed
View File

@ -3,14 +3,18 @@
/SYNOPSIS/s/^\(.*\)$/\.SH \1/ /SYNOPSIS/s/^\(.*\)$/\.SH \1/
/DESCRIPTION/s/^\(.*\)$/\.SH \1/ /DESCRIPTION/s/^\(.*\)$/\.SH \1/
/OPTIONS/s/^\(.*\)$/\.SH \1/ /OPTIONS/s/^\(.*\)$/\.SH \1/
/\<EXAMPLES\>/s/^\(.*\)$/\.SH \1/ /EXAMPLES/s/^\(.*\)$/\.SH \1/
/FILES/s/^\(.*\)$/\.SH \1/ /FILES/s/^\(.*\)$/\.SH \1/
/AUTHOR/s/^\(.*\)$/\.SH \1/ /AUTHOR/s/^\(.*\)$/\.SH AUTHOR/
/SEE ALSO/s/^\(.*\)$/\.SH \1/ /SEE ALSO/s/^\(.*\)$/\.SH \1/
s/\<OPTION\>/\.IP/g s/\<OPTION\>/\.IP/g
s/\<ENDOPTION\>//g s/\<ENDOPTION\>//g
s/\<EXAMPLE\>/\.EX\nshell>/g s/\<EXAMPLE\> \(.*\)/\.nf\
s/\<ENDEXAMPLE\>/\n\.EE\n/g shell> \1\
\.fi\
/g
s/\<ENDEXAMPLE\>/\
/g
/SEE ALSO/,/AUTHOR/{ /SEE ALSO/,/AUTHOR/{
/^[a-z]/s/^\(.*\)$/\.BR \1/ /^[a-z]/s/^\(.*\)$/\.BR \1/
s/(\([1-9]\))/ "(\1), "/g s/(\([1-9]\))/ "(\1), "/g
@ -19,5 +23,5 @@ s/\<ENDEXAMPLE\>/\n\.EE\n/g
i\ i\
a\ a\
Copyright triAGENS GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany
} }

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

@ -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 .SH NAME
arangob - the ArangoDB benchmark and test tool arangob - the ArangoDB benchmark and test tool
.SH SYNOPSIS .SH SYNOPSIS
@ -7,68 +7,48 @@ arangob [options]
The arangob binary can be used to issue test requests to the The arangob binary can be used to issue test requests to the
ArangoDB database. It can be used for benchmarks or server function 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.
arangob currently only supports a few common test cases out of the box.
More test cases might be added later.
.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 http://www.arangodb.org/
The most important startup options are: The most important startup options are:
.IP "--configuration <string>" OPTION "--configuration <string>"
read configuration from file <string> read configuration from file <string> ENDOPTION
.IP "--batch-size <int32>" OPTION "--batch-size <int32>"
number of operations to send per batch (use 0 to disable batching) number of operations to send per batch (use 0 to disable batching) ENDOPTION
.IP "--collection <string>" OPTION "--collection <string>"
name of collection to use in test (only relevant for tests that invoke collections) name of collection to use in test (only relevant for tests that invoke collections) ENDOPTION
.IP "--concurrency <int32>" OPTION "--concurrency <int32>"
number of parallel threads that will issue requests (default is 1 thread) number of parallel threads that will issue requests (default is 1 thread) ENDOPTION
.IP "--requests <int32>" OPTION "--requests <int32>"
total number of requests to perform total number of requests to perform ENDOPTION
.IP "--test-case <string>" OPTION "--test-case <string>"
name of test case to perform (possible values: "version" and "document") name of test case to perform (possible values: version, document, collection,
.IP "--complexity <int32>" import-document, hash, skiplist, edge, shapes, shapes-append, random-shapes, crud,
complexity value for test case (meaning depends on test case) crud-append, crud-write-read, aqltrx, counttrx, multitrx, multi-collection, aqlinsert, aqlv8) ENDOPTION
.IP "--server.endpoint <string>" OPTION "--complexity <int32>"
server endpoint to connect to, consisting of protocol, ip address and port complexity value for test case (meaning depends on test case) ENDOPTION
.IP "--server.database <string>" OPTION "--server.endpoint <string>"
database name to use when connection (default: "_system") server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION
.IP "--server.username <string>" OPTION "--server.database <string>"
username to use when connecting (default "root") database name to use when connecting (default: "_system") ENDOPTION
.IP "--server.password <string>" OPTION "--server.username <string>"
password to use when connecting. Don't specify this option to get a password prompt username to use when connecting (default "root") ENDOPTION
.IP "--server.disable-authentication <boolean>" OPTION "--server.password <string>"
disable the password prompt and authentication when connecting to the server password to use when connecting. Don't specify this option to get a password prompt ENDOPTION
.SH EXAMPLES OPTION "--server.disable-authentication <boolean>"
.EX disable the password prompt and authentication when connecting to the server ENDOPTION
shell> arangob EXAMPLES
starts arangob with the default user and server endpoint EXAMPLE arangob
.EE 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
.EX EXAMPLE arangob --test-case document --requests 1000 --concurrency 2
shell> arangob --test-case version --requests 1000 --concurrency 1 runs the 'document' test case with 2000 requests, with concurrency 2 ENDEXAMPLE
runs the 'version' test case with 1000 requests, without concurrency EXAMPLE arangob --test-case document --requests 1000 --concurrency 2 --async true
.EE 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
.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
.SH AUTHOR .SH AUTHOR
Copyright triAGENS GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

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

@ -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 .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
@ -27,34 +27,33 @@ online manual, available at http://www.arangodb.org/
The most important startup options are: The most important startup options are:
.IP "--configuration <string>" OPTION "--configuration <string>"
read configuration from file <string> read configuration from file <string> ENDOPTION
.IP "--collection <string>" OPTION "--collection <string>"
name of collection to dump (can be specified multiple times). This can be 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, used to restrict the dump to certain collections only. If not specified,
all collections will be dumped all collections will be dumped ENDOPTION
.IP "--dump-data <bool>" OPTION "--dump-data <bool>"
when set to "true" will dump the data (documents) of the collection when set to "true" will dump the data (documents) of the collection ENDOPTION
.IP "--include-system-collections <bool>" OPTION "--include-system-collections <bool>"
when set to "true" will also dump system collections, otherwise they will be excluded when set to "true" will also dump system collections, otherwise they will be excluded ENDOPTION
.IP "--output-directory <string>" OPTION "--output-directory <string>"
directory in which all dump files will be created. If the directory already exists, 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" arangodump will refuse to work unless started with option "--overwrite true" ENDOPTION
.IP "--overwrite <bool>" OPTION "--overwrite <bool>"
when set to "true", will overwrite any files in an existing output directory when set to "true", will overwrite any files in an existing output directory ENDOPTION
.IP "--progress <bool>" OPTION "--progress <bool>"
when set to "true", will display progress information when set to "true", will display progress information ENDOPTION
.IP "--server.endpoint <string>" OPTION "--server.endpoint <string>"
server endpoint to connect to, consisting of protocol, ip address and port server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION
.IP "--server.database <string>" OPTION "--server.database <string>"
database name to use when connection (default: "_system") database name to use when connection (default: "_system") ENDOPTION
.IP "--server.username <string>" OPTION "--server.username <string>"
username to use when connecting (default "root") username to use when connecting (default "root") ENDOPTION
.IP "--server.password <string>" OPTION "--server.password <string>"
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 ENDOPTION
.IP "--server.disable-authentication <boolean>" OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server disable the password prompt and authentication when connecting to the server ENDOPTION
.SH EXAMPLES EXAMPLES
.SH AUTHOR .SH AUTHOR
Copyright triAGENS GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

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

@ -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 .SH NAME
arangoimp - a bulk importer for the ArangoDB database arangoimp - a bulk importer for the ArangoDB database
.SH SYNOPSIS .SH SYNOPSIS
@ -15,50 +15,40 @@ online manual, available at http://www.arangodb.org/
The most important startup options are: The most important startup options are:
.IP "--batch-size <uint64>" OPTION "--batch-size <uint64>"
maximum size of data batches that are sent to the server maximum size of data batches that are sent to the server ENDOPTION
.IP "--configuration <string>" OPTION "--configuration <string>"
read configuration from file <string> read configuration from file <string> ENDOPTION
.IP "--collection <string>" OPTION "--collection <string>"
name of collection to import into name of collection to import into ENDOPTION
.IP "--create-collection <bool>" OPTION "--create-collection <bool>"
set to "true" if collection should be created by the import set to "true" if collection should be created by the import ENDOPTION
.IP "--file <string>" OPTION "--file <string>"
input file with the data to import input file with the data to import ENDOPTION
.IP "--overwrite <bool>" OPTION "--overwrite <bool>"
set to "true" to remove all data from the collection prior to the import set to "true" to remove all data from the collection prior to the import ENDOPTION
.IP "--quote <string>" OPTION "--quote <string>"
optional quote character to be used optional quote character to be used ENDOPTION
.IP "--separator <string>" OPTION "--separator <string>"
separator character or string to be used. the default value is "," separator character or string to be used. the default value is "," ENDOPTION
.IP "--type <string>" OPTION "--type <string>"
set to "json", "tsv" or "csv", depending on the input file format set to "json", "tsv" or "csv", depending on the input file format ENDOPTION
.IP "--server.endpoint <string>" OPTION "--server.endpoint <string>"
server endpoint to connect to, consisting of protocol, ip address and port server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION
.IP "--server.database <string>" OPTION "--server.database <string>"
database name to use when connection (default: "_system") database name to use when connection (default: "_system") ENDOPTION
.IP "--server.username <string>" OPTION "--server.username <string>"
username to use when connecting (default "root") username to use when connecting (default "root") ENDOPTION
.IP "--server.password <string>" OPTION "--server.password <string>"
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 ENDOPTION
.IP "--server.disable-authentication <boolean>" OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server disable the password prompt and authentication when connecting to the server ENDOPTION
.SH EXAMPLES EXAMPLES
.EX EXAMPLE arangoimp --file heroes.json --type json --collection superheroes --create-collection true
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 ENDEXAMPLE
imports JSON data from file heroes.json into collection superhoeres. creates the collection if it does not exist EXAMPLE arangoimp --file export.csv --type csv --collection mydata
.EE 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
.EX imports JSON data from file values.json into collection mydata, using a different server endpoint and database ENDEXAMPLE
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
.SH AUTHOR .SH AUTHOR
Copyright triAGENS GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

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

@ -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 .SH NAME
arangorestore - a data restore tool for the ArangoDB database arangorestore - a data restore tool for the ArangoDB database
.SH SYNOPSIS .SH SYNOPSIS
@ -16,36 +17,35 @@ online manual, available at http://www.arangodb.org/
The most important startup options are: The most important startup options are:
.IP "--configuration <string>" OPTION "--configuration <string>"
read configuration from file <string> read configuration from file <string> ENDOPTION
.IP "--collection <string>" OPTION "--collection <string>"
name of collection to restore (can be specified multiple times). This can be 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 used to restrict the restore operation to certain collections only. If not
specified, all collections from the "--input-directory" will be restored specified, all collections from the "--input-directory" will be restored ENDOPTION
.IP "--create-collection <bool>" OPTION "--create-collection <bool>"
set to "true" if collections should be created set to "true" if collections should be created ENDOPTION
.IP "--import-data <bool>" OPTION "--import-data <bool>"
when set to "true" will restore the data (documents) of the collection when set to "true" will restore the data (documents) of the collection ENDOPTION
.IP "--include-system-collections <bool>" OPTION "--include-system-collections <bool>"
when set to "true" will also restore system collections, otherwise they will be when set to "true" will also restore system collections, otherwise they will be
excluded excluded ENDOPTION
.IP "--input-directory <string>" OPTION "--input-directory <string>"
input directory in which to look for dump files. input directory in which to look for dump files. ENDOPTION
.IP "--overwrite <bool>" OPTION "--overwrite <bool>"
when set to "true", will drop an existing collection before re-creating it when set to "true", will drop an existing collection before re-creating it ENDOPTION
.IP "--progress <bool>" OPTION "--progress <bool>"
when set to "true", will display progress information when set to "true", will display progress information ENDOPTION
.IP "--server.endpoint <string>" OPTION "--server.endpoint <string>"
server endpoint to connect to, consisting of protocol, ip address and port server endpoint to connect to, consisting of protocol, ip address and port ENDOPTION
.IP "--server.database <string>" OPTION "--server.database <string>"
database name to use when connection (default: "_system") database name to use when connection (default: "_system") ENDOPTION
.IP "--server.username <string>" OPTION "--server.username <string>"
username to use when connecting (default "root") username to use when connecting (default "root") ENDOPTION
.IP "--server.password <string>" OPTION "--server.password <string>"
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 ENDOPTION
.IP "--server.disable-authentication <boolean>" OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server disable the password prompt and authentication when connecting to the server ENDOPTION
.SH EXAMPLES EXAMPLES
.SH AUTHOR .SH AUTHOR
Copyright triAGENS GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

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

@ -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 .SH NAME
arangosh - the ArangoDB shell arangosh - the ArangoDB shell
.SH SYNOPSIS .SH SYNOPSIS
@ -14,51 +14,66 @@ online manual, available at http://www.arangodb.org/
The most important startup options are: The most important startup options are:
.IP "--audit-log <string>" .IP "--audit-log <string>"
log input and output to audit log file <string> log input and output to audit log file <string>
.IP "--configuration <string>" .IP "--configuration <string>"
read configuration from file <string> read configuration from file <string>
.IP "--log.level <string>" .IP "--log.level <string>"
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 <string>" .IP "--server.endpoint <string>"
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 <string>" .IP "--server.database <string>"
database name to use when connection (default: "_system") database name to use when connection (default: "_system")
.IP "--server.username <string>" .IP "--server.username <string>"
username to use when connecting (default "root") username to use when connecting (default "root")
.IP "--server.password <string>" .IP "--server.password <string>"
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 <boolean>" .IP "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server disable the password prompt and authentication when connecting to the server
.SH EXAMPLES .SH EXAMPLES
.EX .nf
shell> arangosh shell> arangosh
starts arangosh with the default user and server endpoint .fi
.EE
starts arangosh with the default user and server endpoint
.EX .nf
shell> arangosh --server.username fuchsia shell> arangosh --server.username fuchsia
starts arangosh with a specific user. Password prompt will follow if --server.disable-authentication is true. .fi
.EE
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" shell> arangosh --server.username fuchsia --server.password "abcd@34"
starts arangosh with a specific user and password given on command line .fi
.EE
starts arangosh with a specific user and password given on command line
.EX .nf
shell> arangosh --server.endpoint tcp://192.168.173.13:8529 shell> arangosh --server.endpoint tcp://192.168.173.13:8529
starts arangosh connecting to a specific server .fi
.EE
starts arangosh connecting to a specific server
.EX .nf
shell> arangosh --server.endpoint ssl://192.168.173.13:8530 shell> arangosh --server.endpoint ssl://192.168.173.13:8530
starts arangosh connecting to a specific server using an SSL connection .fi
.EE
starts arangosh connecting to a specific server using an SSL connection
.SH AUTHOR .SH AUTHOR
Copyright triAGENS GmbH, Cologne, Germany Copyright ArangoDB GmbH, Cologne, Germany

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

@ -1,24 +1,20 @@
.TH arango-dfdb 8 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB" .TH COMMAND SECTION "DATE" "" "ArangoDB"
.SH NAME .SH NAME
arango-dfdb - a datafile debugger for ArangoDB COMMAND - a datafile debugger for ArangoDB
.SH SYNOPSIS .SH SYNOPSIS
arango-dfdb options COMMAND options
.SH DESCRIPTION .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 ArangoDB database server. The script must be run with exclusive
access to the server's data directory, meaning the ArangoDB access to the server's data directory, meaning the ArangoDB
server must not be running and accessing the datafiles in the server must not be running and accessing the datafiles in the
specified data directory. specified data directory.
More specific instructions are displayed when the program is invoked. More specific instructions are displayed when the program is invoked.
.SH OPTIONS .SH OPTIONS
.IP "--database.directory <string>" OPTION "--database.directory <string>"
path to the database directory path to the database directory ENDOPTION
.SH EXAMPLES EXAMPLES
.EX EXAMPLE COMMAND --database.directory /data/arangodb
shell> arango-dfdb --database.directory /data/arangodb starts the debugger with database directory /data/arangodb ENDEXAMPLE
starts the debugger with database directory /data/arangodb
.EE
.SH AUTHOR .SH AUTHOR
Copyright triAGENS GmbH, Cologne, Germany Copyright triAGENS GmbH, Cologne, Germany

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

@ -1,10 +1,10 @@
.TH arangod 8 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB" .TH COMMAND SECTION "DATE" "" "ArangoDB"
.SH NAME .SH NAME
arangod - the ArangoDB database server COMMAND - the ArangoDB database server
.SH SYNOPSIS .SH SYNOPSIS
arangod [options] database-directory COMMAND [options] database-directory
.SH DESCRIPTION .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 server. By default, the server will run in a mode that allows
clients to connect to it via the network. The server also has clients to connect to it via the network. The server also has
an emergency console mode that can be used for any sort of 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 The server can be stopped gracefully at any time by pressing
CTRL-C or by sending the SIGINT signal to the process. CTRL-C or by sending the SIGINT signal to the process.
.SH OPTIONS .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. its behavior.
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 http://www.arangodb.org/
The most important startup options are: The most important startup options are:
.IP "--configuration <string>" OPTION "--configuration <string>"
read configuration from file <string> read configuration from file <string> ENDOPTION
.IP "--console" OPTION "--console"
do not start as server, start an emergency console instead do not start as server, start an emergency console instead ENDOPTION
.IP "--log.file <string>" OPTION "--log.file <string>"
log to file <string> log to file <string> ENDOPTION
.IP "--log.level <string>" OPTION "--log.level <string>"
set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace") set the log level (possible values: "fatal", "error", "warning", "info", "debug", "trace") ENDOPTION
.IP "--server.endpoint <string>" OPTION "--server.endpoint <string>"
listen endpoint for client requests, consisting of protocol, ip address and port listen endpoint for client requests, consisting of protocol, ip address and port ENDOPTION
.IP "--server.disable-authentication <boolean>" OPTION "--server.disable-authentication <boolean>"
disable authentication for all clients disable authentication for all clients ENDOPTION
.IP "--database.directory <string>" OPTION "--database.directory <string>"
path to the database directory path to the database directory ENDOPTION
.SH EXAMPLES EXAMPLES
.EX EXAMPLE COMMAND /data/arangodb
shell> arangod /data/arangodb starts the server with database directory /data/arangodb ENDEXAMPLE
starts the server with database directory /data/arangodb EXAMPLE COMMAND --database.directory /data/arangodb
.EE same, but uses --database.directory option instead ENDEXAMPLE
EXAMPLE COMMAND --log.level debug /data/arangodb
.EX starts server with log level "debug" ENDEXAMPLE
shell> arangod --database.directory /data/arangodb EXAMPLE COMMAND --server.endpoint tcp://127.0.0.1:8529 /data/arangodb
same, but uses --database.directory option instead starts server listening on port 8529 of IP 127.0.0.1 ENDEXAMPLE
.EE EXAMPLE COMMAND --server.endpoint tcp://192.168.173.13:8529
.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
--server.endpoint ssl://192.168.173.13:8530 /data/arangodb --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 starts server with two endpoints: port 8529 for unencrypted requests and 8530 for ssl-encrypted requests ENDEXAMPLE
.EE EXAMPLE COMMAND --console /data/arangodb
starts the emergency console ENDEXAMPLE
.EX
shell> arangod --console /data/arangodb
starts the emergency console
.EE
.SH AUTHOR .SH AUTHOR
Copyright triAGENS GmbH, Cologne, Germany Copyright triAGENS GmbH, Cologne, Germany

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

@ -1,47 +1,34 @@
.TH foxx-manager 8 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB" .TH COMMAND SECTION "DATE" "" "ArangoDB"
.SH NAME .SH NAME
foxx-manager - a Foxx application manager for ArangoDB COMMAND - a Foxx application manager for ArangoDB
.SH SYNOPSIS .SH SYNOPSIS
foxx-manager options COMMAND options
.SH DESCRIPTION .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 ArangoDB database server. Foxx applications can be installed and
uninstalled. uninstalled.
More specific instructions are displayed when the program is invoked. More specific instructions are displayed when the program is invoked.
.SH OPTIONS .SH OPTIONS
.IP "--server.database <string>" OPTION "--server.database <string>"
database name to use when connection (default: "_system") database name to use when connecting (default: "_system") ENDOPTION
.IP "--server.username <string>" OPTION "--server.username <string>"
username to use when connecting (default "root") username to use when connecting (default "root") ENDOPTION
.IP "--server.password <string>" OPTION "--server.password <string>"
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 ENDOPTION
.IP "--server.disable-authentication <boolean>" OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server disable the password prompt and authentication when connecting to the server ENDOPTION
.SH EXAMPLES EXAMPLES
.EX EXAMPLE COMMAND search "foobar"
shell> foxx-manager search "foobar" searches the central repository for an application "foobar"ENDEXAMPLE
searches the central repository for an application "foobar" EXAMPLE COMMAND update
.EE
.EX
shell> foxx-manager update
updates the local repository with applications from the central repositoryENDEXAMPLE updates the local repository with applications from the central repositoryENDEXAMPLE
.EX EXAMPLE COMMAND list
shell> foxx-manager list
list all installed Foxx applicationsENDEXAMPLE list all installed Foxx applicationsENDEXAMPLE
.EX EXAMPLE COMMAND install "hello-foxx" "/hello"
shell> foxx-manager install "hello-foxx" "/hello" installs the "hello-foxx" application under the mount point "/hello"ENDEXAMPLE
installs the "hello-foxx" application under the mount point "/hello" EXAMPLE COMMAND uninstall "/hello"
.EE uninstalls the application that is mounted under "/hello"ENDEXAMPLE
EXAMPLE COMMAND help
.EX
shell> foxx-manager uninstall "/hello"
uninstalls the application that is mounted under "/hello"
.EE
.EX
shell> foxx-manager help
shows the help pageENDEXAMPLE shows the help pageENDEXAMPLE
.SH AUTHOR .SH AUTHOR
Copyright triAGENS GmbH, Cologne, Germany Copyright triAGENS GmbH, Cologne, Germany

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

@ -1,17 +1,16 @@
.TH rcarangod 8 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB" .TH COMMAND SECTION "DATE" "" "ArangoDB"
.SH NAME .SH NAME
rcarangod - control script for the ArangoDB database server COMMAND - control script for the ArangoDB database server
.SH SYNOPSIS .SH SYNOPSIS
rcarangod start|stop COMMAND start|stop
.SH DESCRIPTION .SH DESCRIPTION
The rcarangod script controls the operation of the ArangoDB The COMMAND script controls the operation of the ArangoDB
database server daemon running on the system. The rcarangod script database server daemon running on the system. The COMMAND script
is normally run at system boot time with the "start" argument, and is normally run at system boot time with the "start" argument, and
at system shutdown time with the "stop" argument. at system shutdown time with the "stop" argument.
It can also be invoked manually at any time to start or stop the It can also be invoked 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 triAGENS GmbH, Cologne, Germany

18
Documentation/man1/arangob → Documentation/man1/arangob.1
View File

@ -1,8 +1,8 @@
COMMAND SECTION "DATE" "" "ArangoDB" <COMMAND> <SECTION> "<DATE>" "<VERSION>" "ArangoDB"
NAME NAME
COMMAND - the ArangoDB benchmark and test tool <COMMAND> - the ArangoDB benchmark and test tool
SYNOPSIS SYNOPSIS
COMMAND [options] <COMMAND> [options]
DESCRIPTION DESCRIPTION
The arangob binary can be used to issue test requests to the The arangob binary can be used to issue test requests to the
ArangoDB database. It can be used for benchmarks or server function 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 <boolean>" OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server ENDOPTION disable the password prompt and authentication when connecting to the server ENDOPTION
EXAMPLES EXAMPLES
EXAMPLE COMMAND EXAMPLE <COMMAND>
starts COMMAND with the default user and server endpoint ENDEXAMPLE starts <COMMAND> with the default user and server endpoint ENDEXAMPLE
EXAMPLE COMMAND --test-case version --requests 1000 --concurrency 1 EXAMPLE <COMMAND> --test-case version --requests 1000 --concurrency 1
runs the 'version' test case with 1000 requests, without concurrency ENDEXAMPLE runs the 'version' test case with 1000 requests, without concurrency ENDEXAMPLE
EXAMPLE COMMAND --test-case document --requests 1000 --concurrency 2 EXAMPLE <COMMAND> --test-case document --requests 1000 --concurrency 2
runs the 'document' test case with 2000 requests, with concurrency 2 ENDEXAMPLE runs the 'document' test case with 2000 requests, with concurrency 2 ENDEXAMPLE
EXAMPLE COMMAND --test-case document --requests 1000 --concurrency 2 --async true 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 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 <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 runs the 'document' test case with 2000 requests, with concurrency 2, using batch requests ENDEXAMPLE
AUTHOR AUTHOR

16
Documentation/man1/arangodump → Documentation/man1/arangodump.1
View File

@ -1,10 +1,10 @@
COMMAND SECTION "DATE" "" "ArangoDB" <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
COMMAND [options] <COMMAND> [options]
DESCRIPTION DESCRIPTION
The COMMAND binary can be used to create logical dumps of collection The <COMMAND> binary can be used to create logical dumps of collection
meta information and collection data (documents) of an ArangoDB database. meta information and collection data (documents) of an ArangoDB database.
By default, all non-system collections of the specified ArangoDB database By default, all non-system collections of the specified ArangoDB database
will be dumped with structural information and data. will be dumped with structural information and data.
@ -13,11 +13,11 @@ For each collection, a file named "<collection>.structure.json" will be
created with information about the collection. When data is also dumped, created with information about the collection. When data is also dumped,
an additional file "<collection>.data.json" will also be created. an additional file "<collection>.data.json" will also be created.
All dump files will be placed in a directory, which will be created by 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 <COMMAND> when run. If the directory already exists, <COMMAND> will refuse to
work unless started with the option "--overwrite true". work unless started with the option "--overwrite true".
COMMAND will work on the specified database only. If no database name <COMMAND> will work on the specified database only. If no database name
is specified, COMMAND will work on the default database ("_system"). 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.
@ -39,7 +39,7 @@ OPTION "--include-system-collections <bool>"
when set to "true" will also dump system collections, otherwise they will be excluded ENDOPTION when set to "true" will also dump system collections, otherwise they will be excluded ENDOPTION
OPTION "--output-directory <string>" OPTION "--output-directory <string>"
directory in which all dump files will be created. If the directory already exists, 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 <COMMAND> will refuse to work unless started with option "--overwrite true" ENDOPTION
OPTION "--overwrite <bool>" OPTION "--overwrite <bool>"
when set to "true", will overwrite any files in an existing output directory ENDOPTION when set to "true", will overwrite any files in an existing output directory ENDOPTION
OPTION "--progress <bool>" OPTION "--progress <bool>"

14
Documentation/man1/arangoimp → Documentation/man1/arangoimp.1
View File

@ -1,10 +1,10 @@
COMMAND SECTION "DATE" "" "ArangoDB" <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
COMMAND [options] <COMMAND> [options]
DESCRIPTION DESCRIPTION
The COMMAND binary can be used to bulk import data from a file into the The <COMMAND> 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 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, 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
@ -44,10 +44,10 @@ password to use when connecting. Don't specify this option to get a password pro
OPTION "--server.disable-authentication <boolean>" OPTION "--server.disable-authentication <boolean>"
disable the password prompt and authentication when connecting to the server ENDOPTION disable the password prompt and authentication when connecting to the server ENDOPTION
EXAMPLES EXAMPLES
EXAMPLE COMMAND --file heroes.json --type json --collection superheroes --create-collection true 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 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 <COMMAND> --file export.csv --type csv --collection mydata
imports CSV data from export.csv into existing collection mydata ENDEXAMPLE 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 <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 imports JSON data from file values.json into collection mydata, using a different server endpoint and database ENDEXAMPLE
AUTHOR AUTHOR

9
Documentation/man1/arangorestore → Documentation/man1/arangorestore.1
View File

@ -1,10 +1,11 @@
COMMAND SECTION "DATE" "" "ArangoDB" <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 created
with the arangodump tool. with the arangodump tool.
ArangoDB database. Input data be present in the input file in either CSV 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, format with column headlines, or in JSON format. If JSON format is used,

43
Documentation/man1/arangosh
View File

@ -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 <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

58
Documentation/man1/arangosh.1 Normal file
View File

@ -0,0 +1,58 @@
<COMMAND> <SECTION> "<DATE>" "<VERSION>" "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 <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

0
Documentation/man8/arango-dfdb → Documentation/man8/arango-dfdb.8
View File

0
Documentation/man8/arangod → Documentation/man8/arangod.8
View File

0
Documentation/man8/foxx-manager → Documentation/man8/foxx-manager.8
View File

0
Documentation/man8/rcarangod → Documentation/man8/rcarangod.8
View File

17
utils/manPages.sh Executable file
View File

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