Constant SERVER_HELP

Source
pub const SERVER_HELP: &str = r#"links server

USAGE:
    server [FLAGS] [OPTIONS] [CONFIGURATION]

EXAMPLE:
    server -c ./config.toml --log-level warn

FLAGS:
 -h --help                   Print this and exit
    --example-redirect       Set an example redirect on server start ("example" -> "9dDbKpJP" -> "https://example.com/")

OPTIONS:
 -c --config PATH            Configuration file path. Supported formats: toml (*.toml), yaml/json (*.yaml, *.yml, *.json)
    --watcher-timeout MS     File watcher timeout in milliseconds, default 10000
    --watcher-debounce MS    File watcher debounce time in milliseconds, default 1000

CONFIGURATION:
    --[OPTION] VALUE         Configuration option (in "kebab-case"), see documentation for possible options and values

The FLAGS and OPTIONS above are separate from configuration options, because they influence server behaviour on startup only, and can only be specified on the command-line.
Configuration options are parsed first from environment variables ("LINKS_[CONFIG_OPTION]"), then from the configuration file, then from command-line arguments ("--[config-option]"), later ones overwriting earlier ones.
This means that command-line options overwrite everything, config file options overwrite default values and environment variables, environment variable overwrite only defaults, and the default value is used only when an option is not specified anywhere.
"#;
Expand description

Help string for server CLI