mirror of https://gitee.com/bigwinds/arangodb
1187 lines
32 KiB
JSON
1187 lines
32 KiB
JSON
{
|
|
"check-configuration" : {
|
|
"category" : "command",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "check the configuration and exit",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "",
|
|
"type" : "boolean"
|
|
},
|
|
"config" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "the configuration file or 'none'",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "",
|
|
"type" : "string"
|
|
},
|
|
"configuration" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "the configuration file or 'none'",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "",
|
|
"type" : "string"
|
|
},
|
|
"console.audit-file" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "audit log file to save commands and results",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "console",
|
|
"type" : "string"
|
|
},
|
|
"console.auto-complete" : {
|
|
"category" : "option",
|
|
"default" : true,
|
|
"deprecatedIn" : null,
|
|
"description" : "enable auto completion",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "console",
|
|
"type" : "boolean"
|
|
},
|
|
"console.colors" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "enable color support",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "console",
|
|
"type" : "boolean"
|
|
},
|
|
"console.history" : {
|
|
"category" : "option",
|
|
"default" : true,
|
|
"deprecatedIn" : null,
|
|
"description" : "whether or not to load and persist command-line history",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : [
|
|
"v3.4.5",
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "console",
|
|
"type" : "boolean"
|
|
},
|
|
"console.pager" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "enable paging",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "console",
|
|
"type" : "boolean"
|
|
},
|
|
"console.pager-command" : {
|
|
"category" : "option",
|
|
"default" : "less -X -R -F -L",
|
|
"deprecatedIn" : null,
|
|
"description" : "pager command",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "console",
|
|
"type" : "string"
|
|
},
|
|
"console.pretty-print" : {
|
|
"category" : "option",
|
|
"default" : true,
|
|
"deprecatedIn" : null,
|
|
"description" : "enable pretty printing",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "console",
|
|
"type" : "boolean"
|
|
},
|
|
"console.prompt" : {
|
|
"category" : "option",
|
|
"default" : "%E@%d> ",
|
|
"deprecatedIn" : null,
|
|
"description" : "prompt used in REPL. prompt components are: '%t': current time as timestamp, '%p': duration of last command in seconds, '%d': name of current database, '%e': current endpoint, '%E': current endpoint without protocol, '%u': current user",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "console",
|
|
"type" : "string"
|
|
},
|
|
"default-language" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "ISO-639 language code",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "",
|
|
"type" : "string"
|
|
},
|
|
"define" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "define key=value for a @key@ entry in config file",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "",
|
|
"type" : "string..."
|
|
},
|
|
"dump-dependencies" : {
|
|
"category" : "command",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "dump dependency graph",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "",
|
|
"type" : "boolean"
|
|
},
|
|
"dump-options" : {
|
|
"category" : "command",
|
|
"default" : true,
|
|
"deprecatedIn" : null,
|
|
"description" : "dump configuration options in JSON format",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "",
|
|
"type" : "boolean"
|
|
},
|
|
"encryption.key-generator" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "program providing the encryption key on stdout. If set, encryption will be enabled.",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : true,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "encryption",
|
|
"type" : "string"
|
|
},
|
|
"encryption.keyfile" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "file containing the encryption key. If set, encryption will be enabled.",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : true,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "encryption",
|
|
"type" : "string"
|
|
},
|
|
"javascript.allow-external-process-control" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "allow execution and control of external processes from within JavaScript actions",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "javascript",
|
|
"type" : "boolean"
|
|
},
|
|
"javascript.allow-port-testing" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "allow testing of ports from within JavaScript actions",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "javascript",
|
|
"type" : "boolean"
|
|
},
|
|
"javascript.check-syntax" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "syntax check code Javascript code from file",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string..."
|
|
},
|
|
"javascript.client-module" : {
|
|
"category" : "option",
|
|
"default" : "inspector.js",
|
|
"deprecatedIn" : null,
|
|
"description" : "client module to use at startup",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string"
|
|
},
|
|
"javascript.copy-directory" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "target directory to copy files from 'javascript.startup-directory' into (only used when `--javascript.copy-installation` is enabled)",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string"
|
|
},
|
|
"javascript.copy-installation" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "copy contents of 'javascript.startup-directory'",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "javascript",
|
|
"type" : "boolean"
|
|
},
|
|
"javascript.current-module-directory" : {
|
|
"category" : "option",
|
|
"default" : true,
|
|
"deprecatedIn" : null,
|
|
"description" : "add current directory to module path",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "javascript",
|
|
"type" : "boolean"
|
|
},
|
|
"javascript.endpoints-blacklist" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "endpoints that cannot be connected to via @arangodb/request module in JavaScript actions if not whitelisted",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string..."
|
|
},
|
|
"javascript.endpoints-whitelist" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "endpoints that can be connected to via @arangodb/request module in JavaScript actions",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string..."
|
|
},
|
|
"javascript.environment-variables-blacklist" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "environment variables that will be inaccessible in JavaScript if not whitelisted",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string..."
|
|
},
|
|
"javascript.environment-variables-whitelist" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "environment variables that will be accessible in JavaScript",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string..."
|
|
},
|
|
"javascript.execute" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "execute Javascript code from file",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string..."
|
|
},
|
|
"javascript.execute-string" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "execute Javascript code from string",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string..."
|
|
},
|
|
"javascript.files-whitelist" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "filesystem paths that will be accessible from within JavaScript actions",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string..."
|
|
},
|
|
"javascript.gc-interval" : {
|
|
"category" : "option",
|
|
"default" : 50,
|
|
"deprecatedIn" : null,
|
|
"description" : "request-based garbage collection interval (each n.th command)",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "uint64"
|
|
},
|
|
"javascript.harden" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "disables access to JavaScript functions in the internal module: getPid() and logLevel()",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "javascript",
|
|
"type" : "boolean"
|
|
},
|
|
"javascript.module-directory" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "additional paths containing JavaScript modules",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string..."
|
|
},
|
|
"javascript.startup-directory" : {
|
|
"category" : "option",
|
|
"default" : "./js",
|
|
"deprecatedIn" : null,
|
|
"description" : "startup paths containing the Javascript files",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string"
|
|
},
|
|
"javascript.startup-options-blacklist" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "startup options whose names match this regular expression will not be exposed (if not whitelisted) to JavaScript actions",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string..."
|
|
},
|
|
"javascript.startup-options-whitelist" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "startup options whose names match this regular expression will be whitelisted and exposed to JavaScript",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string..."
|
|
},
|
|
"javascript.unit-test-filter" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "filter testcases in suite",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string"
|
|
},
|
|
"javascript.unit-tests" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "do not start as shell, run unit tests instead",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string..."
|
|
},
|
|
"javascript.v8-max-heap" : {
|
|
"category" : "option",
|
|
"default" : 3072,
|
|
"deprecatedIn" : null,
|
|
"description" : "maximal heap size (in MB)",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "uint64"
|
|
},
|
|
"javascript.v8-options" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "options to pass to v8",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "javascript",
|
|
"type" : "string..."
|
|
},
|
|
"jslint" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "do not start as shell, run jslint instead",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "",
|
|
"type" : "string..."
|
|
},
|
|
"log" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
"info"
|
|
],
|
|
"deprecatedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"description" : "the global or topic-specific log level",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "",
|
|
"type" : "string..."
|
|
},
|
|
"log.color" : {
|
|
"category" : "option",
|
|
"default" : true,
|
|
"deprecatedIn" : null,
|
|
"description" : "use colors for TTY logging",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.escape" : {
|
|
"category" : "option",
|
|
"default" : true,
|
|
"deprecatedIn" : null,
|
|
"description" : "escape characters when logging",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.file" : {
|
|
"category" : "option",
|
|
"default" : "-",
|
|
"deprecatedIn" : null,
|
|
"description" : "shortcut for '--log.output file://<filename>'",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "log",
|
|
"type" : "string"
|
|
},
|
|
"log.file-group" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "group to use for new log file, user must be a member of this group",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : [
|
|
"v3.4.5",
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "log",
|
|
"type" : "string"
|
|
},
|
|
"log.file-mode" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "mode to use for new log file, umask will be applied as well",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : [
|
|
"v3.4.5",
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "log",
|
|
"type" : "string"
|
|
},
|
|
"log.force-direct" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "do not start a seperate thread for logging",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.foreground-tty" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "also log to tty if backgrounded",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.ids" : {
|
|
"category" : "option",
|
|
"default" : true,
|
|
"deprecatedIn" : null,
|
|
"description" : "log unique message ids",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.keep-logrotate" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "keep the old log file after receiving a sighup",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.level" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
"info"
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "the global or topic-specific log level",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "log",
|
|
"type" : "string..."
|
|
},
|
|
"log.line-number" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "append line number and file name",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.output" : {
|
|
"category" : "option",
|
|
"default" : [
|
|
],
|
|
"deprecatedIn" : null,
|
|
"description" : "log destination(s)",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "log",
|
|
"type" : "string..."
|
|
},
|
|
"log.performance" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"description" : "shortcut for '--log.level performance=trace'",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.prefix" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "prefix log message with this string",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "log",
|
|
"type" : "string"
|
|
},
|
|
"log.request-parameters" : {
|
|
"category" : "option",
|
|
"default" : true,
|
|
"deprecatedIn" : null,
|
|
"description" : "include full URLs and HTTP request parameters in trace logs",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.role" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "log server role",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.shorten-filenames" : {
|
|
"category" : "option",
|
|
"default" : true,
|
|
"deprecatedIn" : null,
|
|
"description" : "shorten filenames in log output (use with --log.line-number)",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.thread" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "show thread identifier in log message",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.thread-name" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "show thread name in log message",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.time-format" : {
|
|
"category" : "option",
|
|
"default" : "utc-datestring",
|
|
"deprecatedIn" : null,
|
|
"description" : "time format to use in logs",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "log",
|
|
"type" : "string",
|
|
"values" : "Possible values: \"local-datestring\", \"timestamp\", \"timestamp-micros\", \"timestamp-millis\", \"uptime\", \"uptime-micros\", \"uptime-millis\", \"utc-datestring\", \"utc-datestring-millis\""
|
|
},
|
|
"log.use-local-time" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"description" : "use local timezone instead of UTC",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"log.use-microtime" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : [
|
|
"v3.5.0"
|
|
],
|
|
"description" : "use microtime instead",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "log",
|
|
"type" : "boolean"
|
|
},
|
|
"quiet" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "silent startup",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "",
|
|
"type" : "boolean"
|
|
},
|
|
"random.generator" : {
|
|
"category" : "option",
|
|
"default" : 1,
|
|
"deprecatedIn" : null,
|
|
"description" : "random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not for Windows), 5 = WinCrypt (Windows only)",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "random",
|
|
"type" : "uint32",
|
|
"values" : "Possible values: 1, 2, 3, 4"
|
|
},
|
|
"server.ask-jwt-secret" : {
|
|
"category" : "option",
|
|
"default" : true,
|
|
"deprecatedIn" : null,
|
|
"description" : "if this option is specified, the user will be prompted for a JWT secret. This option is not compatible with --server.username or --server.password. If specified, it will be used for all connections - even when a new connection to another server is created",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "server",
|
|
"type" : "boolean"
|
|
},
|
|
"server.authentication" : {
|
|
"category" : "option",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "require authentication credentials when connecting (does not affect the server-side authentication settings)",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "server",
|
|
"type" : "boolean"
|
|
},
|
|
"server.connection-timeout" : {
|
|
"category" : "option",
|
|
"default" : 5,
|
|
"deprecatedIn" : null,
|
|
"description" : "connection timeout in seconds",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "server",
|
|
"type" : "double"
|
|
},
|
|
"server.database" : {
|
|
"category" : "option",
|
|
"default" : "_system",
|
|
"deprecatedIn" : null,
|
|
"description" : "database name to use when connecting",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "server",
|
|
"type" : "string"
|
|
},
|
|
"server.endpoint" : {
|
|
"category" : "option",
|
|
"default" : "http+tcp://127.0.0.1:8529",
|
|
"deprecatedIn" : null,
|
|
"description" : "endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// or vst+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp://, vst+tcp:// or unix://",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "server",
|
|
"type" : "string"
|
|
},
|
|
"server.jwt-secret-keyfile" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "if this option is specified, the jwt secret will be loaded from the given file. This option is not compatible with --server.ask-jwt-secret, --server.username or --server.password. If specified, it will be used for all connections - even when a new connection to another server is created",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "server",
|
|
"type" : "string"
|
|
},
|
|
"server.max-packet-size" : {
|
|
"category" : "option",
|
|
"default" : 1073741824,
|
|
"deprecatedIn" : null,
|
|
"description" : "maximum packet size (in bytes) for client/server communication",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : true,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "server",
|
|
"type" : "uint64"
|
|
},
|
|
"server.password" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "password to use when connecting. If not specified and authentication is required, the user will be prompted for a password",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "server",
|
|
"type" : "string"
|
|
},
|
|
"server.request-timeout" : {
|
|
"category" : "option",
|
|
"default" : 1200,
|
|
"deprecatedIn" : null,
|
|
"description" : "request timeout in seconds",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "server",
|
|
"type" : "double"
|
|
},
|
|
"server.username" : {
|
|
"category" : "option",
|
|
"default" : "root",
|
|
"deprecatedIn" : null,
|
|
"description" : "username to use when connecting",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "server",
|
|
"type" : "string"
|
|
},
|
|
"ssl.protocol" : {
|
|
"category" : "option",
|
|
"default" : 5,
|
|
"deprecatedIn" : null,
|
|
"description" : "ssl protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3)",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "ssl",
|
|
"type" : "uint64",
|
|
"values" : "Possible values: 1, 2, 3, 4, 5, 6"
|
|
},
|
|
"temp.path" : {
|
|
"category" : "option",
|
|
"default" : "",
|
|
"deprecatedIn" : null,
|
|
"description" : "path for temporary files",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : true,
|
|
"section" : "temp",
|
|
"type" : "string"
|
|
},
|
|
"version" : {
|
|
"category" : "command",
|
|
"default" : false,
|
|
"deprecatedIn" : null,
|
|
"description" : "reports the version and exits",
|
|
"dynamic" : false,
|
|
"enterpriseOnly" : false,
|
|
"hidden" : false,
|
|
"introducedIn" : null,
|
|
"obsolete" : false,
|
|
"requiresValue" : false,
|
|
"section" : "",
|
|
"type" : "boolean"
|
|
}
|
|
}
|