usage: designate [-h] [--config-dir DIR] [--config-file PATH] [--debug] [--log-config-append PATH]
[--log-date-format DATE_FORMAT] [--log-dir LOG_DIR] [--log-file PATH] [--nodebug]
[--nouse-journal] [--nouse-json] [--nouse-syslog] [--nowatch-log-file]
[--shell_completion SHELL_COMPLETION] [--syslog-log-facility SYSLOG_LOG_FACILITY]
[--use-journal] [--use-json] [--use-syslog] [--watch-log-file]
options:
-h, --help show this help message and exit
--config-dir DIR Path to a config directory to pull `*.conf` files from. This file set is
sorted, so as to provide a predictable parse order if individual options
are over-ridden. The set is parsed after the file(s) specified via
previous --config-file, arguments hence over-ridden options in the
directory take precedence. This option must be set from the command-line.
--config-file PATH Path to a config file to use. Multiple config files can be specified, with
values in later files taking precedence. Defaults to None. This option
must be set from the command-line.
--debug, -d If set to true, the logging level will be set to DEBUG instead of the
default INFO level.
--log-config-append PATH, --log-config PATH, --log_config PATH
The name of a logging configuration file. This file is appended to any
existing logging configuration files. For details about logging
configuration files, see the Python logging module documentation. Note
that when logging configuration files are used then all logging
configuration is set in the configuration file and other logging
configuration options are ignored (for example, log-date-format).
--log-date-format DATE_FORMAT
Defines the format string for %(asctime)s in log records. Default: None .
This option is ignored if log_config_append is set.
--log-dir LOG_DIR, --logdir LOG_DIR
(Optional) The base directory used for relative log_file paths. This
option is ignored if log_config_append is set.
--log-file PATH, --logfile PATH
(Optional) Name of log file to send logging output to. If no default is
set, logging will go to stderr as defined by use_stderr. This option is
ignored if log_config_append is set.
--nodebug The inverse of --debug
--nouse-journal The inverse of --use-journal
--nouse-json The inverse of --use-json
--nouse-syslog The inverse of --use-syslog
--nowatch-log-file The inverse of --watch-log-file
--shell_completion SHELL_COMPLETION
Display a shell completion script Allowed values: bash, zsh
--syslog-log-facility SYSLOG_LOG_FACILITY
Syslog facility to receive log lines. This option is ignored if
log_config_append is set.
--use-journal Enable journald for logging. If running in a systemd environment you may
wish to enable journal support. Doing so will use the journal native
protocol which includes structured metadata in addition to log
messages.This option is ignored if log_config_append is set.
--use-json Use JSON formatting for logging. This option is ignored if
log_config_append is set.
--use-syslog Use syslog for logging. Existing syslog format is DEPRECATED and will be
changed later to honor RFC5424. This option is ignored if
log_config_append is set.
--watch-log-file Uses logging handler designed to watch file system. When log file is moved
or removed this handler will open a new log file with specified path
instantaneously. It makes sense only if log_file option is specified and
Linux platform is used. This option is ignored if log_config_append is
set.
Options (16)
| Option | Description | Source |
|---|
-h, --help | show this help message and exit | help |
--config-dir DIR | Path to a config directory to pull `*.conf` files from. | help |
--config-file PATH | Path to a config file to use. | help |
--debug, -d | If set to true, the logging level will be set to DEBUG instead of the default INFO level. | help |
--log-date-format DATE_FORMAT | Defines the format string for %(asctime)s in log records. | help |
--nodebug | The inverse of --debug | help |
--nouse-journal | The inverse of --use-journal | help |
--nouse-json | The inverse of --use-json | help |
--nouse-syslog | The inverse of --use-syslog | help |
--nowatch-log-file | The inverse of --watch-log-file | help |
--shell_completion SHELL_COMPLETION | Display a shell completion script Allowed values: bash, zsh | help |
--syslog-log-facility SYSLOG_LOG_FACILITY | Syslog facility to receive log lines. | help |
--use-journal | Enable journald for logging. | help |
--use-json | Use JSON formatting for logging. | help |
--use-syslog | Use syslog for logging. | help |
--watch-log-file | Uses logging handler designed to watch file system. | help |
Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.