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

Doc - Startup parameter usage improvements (#5759)

This commit is contained in:
Simran 2018-07-04 13:58:15 +02:00 committed by sleto-it
parent 38839c336e
commit 2ebad67906
2 changed files with 29 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/Books/Manual/Administration/Configuration/README.md
View File

@ -82,22 +82,24 @@ So you see in general `--section.param value` translates to
param=value param=value
``` ```
{% hint 'warning' %} {% hint 'tip' %}
Whitespace around `=` is ignored in the configuration file. Do not put spaces Whitespace around `=` is ignored in the configuration file.
around additional `=` in the parameter value however. The following example This includes whitespace around equals signs in the parameter value:
shows the correct way to specify a log level of `trace` for the topic `startup`:
```js ```js
log.level = startup=trace log.level = startup = trace
``` ```
Note that there is no whitespace between `startup` and `=`, and also not `=` It is the same as without whitespace:
and `trace`.
```js
log.level=startup=trace
```
{% endhint %} {% endhint %}
Where one section may occur multiple times, and the last occurance of `param` Where one section may occur multiple times, and the last occurrence of `param`
will become the final value. In case of parameters being vectors, multiple will become the final value. In case of parameters being vectors, multiple
occurance adds another item to the vector. Vectors can be identified by the occurrence adds another item to the vector. Vectors can be identified by the
`...` in the `--help` output of the binaries. `...` in the `--help` output of the binaries.
Comments can be placed in the configuration file, only if the line begins with Comments can be placed in the configuration file, only if the line begins with

18
Documentation/Books/Manual/Programs/Arangod/Options.md
View File

@ -3,4 +3,22 @@ ArangoDB Server Options
Usage: `arangod [<options>]` Usage: `arangod [<options>]`
The database directory can be specified as positional (unnamed) first parameter:
arangod /path/to/datadir
Or explicitly as named parameter:
arangod --database.directory /path/to/datadir
All other parameters need to be passed as named parameters.
That is two hyphens followed by the option name, an equals sign or a space and
finally the parameter value. The value needs to be wrapped in double quote marks
if the value contains whitespace. Extra whitespace around `=` is allowed:
arangod --database.directory = "/path with spaces/to/datadir"
See [Configuration](../../Administration/Configuration/README.md#configuration-files)
if you want to translate startup parameters to configuration files.
@startDocuBlock program_options_arangod @startDocuBlock program_options_arangod