fix: Rewrite the config usage comment

This commit is contained in:
teor 2020-07-21 16:28:02 +10:00 committed by Deirdre Connolly
parent 1cb1f1c52e
commit a0dbe85acd
1 changed files with 16 additions and 18 deletions

View File

@ -19,30 +19,28 @@ impl Runnable for GenerateCmd {
network: Default::default(), network: Default::default(),
metrics: Default::default(), metrics: Default::default(),
}; };
let mut output = r"# Default configuration values for zebrad. let mut output = r"# Default configuration for zebrad.
# #
# This file is intended as a skeleton for custom configs. # This file can be used as a skeleton for custom configs.
# #
# Because this contains default values, and the default # This file is generated using zebrad's current defaults. If you want zebrad
# values may change, you should delete all entries except # to automatically use any newer defaults, set the config options you want to
# for the ones you wish to change. # keep, and delete the rest.
# #
# Documentation on the meanings of each config field # The config format is documented here:
# can be found in Rustdoc here:
# https://doc.zebra.zfnd.org/zebrad/config/struct.ZebradConfig.html # https://doc.zebra.zfnd.org/zebrad/config/struct.ZebradConfig.html
# Usage: # Usage:
# One option is to locate this file in the same directory the zebrad binary is # zebrad generate -o myzebrad.toml
# called from, if the default name zebrad.toml is used the app will load the new # zebrad -c myzebrad.toml start
# configuration automatically. For example if you generate with: #
# zebrad generate -o zebrad.toml # zebrad generate -o zebrad.toml
# Edit the file as needed then execute the following to connect using # zebrad start
# the new configuration, default values will be overwritten: #
# zebrad connect # If there is no -c flag on the command line, zebrad looks for zebrad.toml in
# If you generated with a different name or location then -c flag is required # the current directory. If that file does not exist, zebrad uses the default
# to load the new configuration: # config.
# zebrad generate -o myzebrad.toml
# zebrad -c myzebrad.toml connect
" "
.to_owned(); .to_owned();