arangovpack Options

Usage: arangovpack [<options>]

General

--check-configuration

Type: boolean

Check the configuration and exit

This is a command, no value needs to be specified. The process terminates after executing the command.

--config

Type: string

The configuration file or 'none'

Default: "none"

--configuration

Type: string

The configuration file or 'none'

Default: "none"

--define

Type: string…

Define key=value for a @key@ entry in config file

Default: []

--dump-dependencies

Type: boolean

Dump dependency graph

This is a command, no value needs to be specified. The process terminates after executing the command.

--dump-options

Type: boolean

Dump configuration options in JSON format

This is a command, no value needs to be specified. The process terminates after executing the command.

--fail-on-non-json

Introduced in: v3.8.0

Type: boolean

Fail when trying to emit non-JSON types to JSON output

This option can be specified without a value to enable it.

Default: true

--input-file

Type: string

Input filename (leave empty or use "-" for stdin)

Default: ""

--input-type

Introduced in: v3.8.0

Type: string

Type of input

Default: "vpack"

Possible values: “json”, “json-hex”, “vpack”, “vpack-hex”

--log

Deprecated in: v3.5.0

Type: string…

The global or topic-specific log level

Default: ["info"]

--output-file

Type: string

Output filename (leave empty or use "+" for stdout)

Default: ""

--output-type

Introduced in: v3.8.0

Type: string

Type of output

Default: "json-pretty"

Possible values: “json”, “json-pretty”, “vpack”, “vpack-hex”

--version

Type: boolean

Reports the version and exits

This is a command, no value needs to be specified. The process terminates after executing the command.

--version-json

Introduced in: v3.9.0

Type: boolean

Reports the version as JSON and exits

This is a command, no value needs to be specified. The process terminates after executing the command.

Log

--log.color

Type: boolean

Use colors for TTY logging

This option can be specified without a value to enable it.

Default: dynamic (e.g. true)

--log.escape-control-chars

Introduced in: v3.9.0

Type: boolean

Escape control characters when logging

This option can be specified without a value to enable it.

Default: true

--log.escape-unicode-chars

Introduced in: v3.9.0

Type: boolean

Escape unicode characters when logging

This option can be specified without a value to enable it.

Default: false

--log.file

Type: string

Shortcut for '--log.output file://<filename>'

Default: ""

--log.file-group

Introduced in: v3.4.5

Type: string

Group to use for new log file, user must be a member of this group

Default: ""

--log.file-mode

Introduced in: v3.4.5

Type: string

Mode to use for new log file, umask will be applied as well

Default: ""

--log.force-direct

Type: boolean

Do not start a seperate thread for logging

This option can be specified without a value to enable it.

Default: false

--log.foreground-tty

Type: boolean

Also log to tty if backgrounded

This option can be specified without a value to enable it.

Default: dynamic (e.g. false)

--log.hostname

Introduced in: v3.8.0

Type: string

Hostname to use in log message (empty for none, use 'auto' to automatically figure out hostname)

Default: ""

--log.ids

Introduced in: v3.5.0

Type: boolean

Log unique message ids

This option can be specified without a value to enable it.

Default: true

--log.level

Type: string…

The global or topic-specific log level

Default: ["info"]

--log.line-number

Type: boolean

Include the function name, file name and line number of the source code that issues the log message. Format: [func@FileName.cpp:123]

This option can be specified without a value to enable it.

Default: false

--log.max-entry-length

Introduced in: v3.7.9

Type: uint32

Maximum length of a log entry (in bytes)

Default: 134217728

--log.output

Type: string…

Log destination(s), e.g. file:///path/to/file (any '$PID' will be replaced with the process id)

Default: []

--log.performance

Deprecated in: v3.5.0

Type: boolean

Shortcut for '--log.level performance=trace'

This option can be specified without a value to enable it.

Default: false

--log.prefix

Type: string

Prefix log message with this string

Default: ""

--log.process

Introduced in: v3.8.0

Type: boolean

Show process identifier (pid) in log message

This option can be specified without a value to enable it.

Default: true

--log.request-parameters

Type: boolean

Include full URLs and HTTP request parameters in trace logs

This option can be specified without a value to enable it.

Default: true

--log.role

Type: boolean

Log server role

This option can be specified without a value to enable it.

Default: false

--log.shorten-filenames

Type: boolean

Shorten filenames in log output (use with --log.line-number)

This option can be specified without a value to enable it.

Default: true

--log.thread

Type: boolean

Show thread identifier in log message

This option can be specified without a value to enable it.

Default: false

--log.thread-name

Type: boolean

Show thread name in log message

This option can be specified without a value to enable it.

Default: false

--log.time-format

Introduced in: v3.5.0

Type: string

Time format to use in logs

Default: "utc-datestring"

Possible values: “local-datestring”, “timestamp”, “timestamp-micros”, “timestamp-millis”, “uptime”, “uptime-micros”, “uptime-millis”, “utc-datestring”, “utc-datestring-millis”

--log.use-json-format

Introduced in: v3.8.0

Type: boolean

Use json output format

This option can be specified without a value to enable it.

Default: false

--log.use-local-time

Deprecated in: v3.5.0

Type: boolean

Use local timezone instead of UTC

This option can be specified without a value to enable it.

Default: false

--log.use-microtime

Deprecated in: v3.5.0

Type: boolean

Use microtime instead

This option can be specified without a value to enable it.

Default: false

Random

--random.generator

Type: uint32

Random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not for Windows), 5 = WinCrypt (Windows only)

Default: 1

Possible values: 1, 2, 3, 4