From 8a8cfd8f072c332d95bcc1f3be57daeb7c44f57d Mon Sep 17 00:00:00 2001 From: ulif <uli@gnufix.de> Date: Thu, 3 Dec 2015 02:45:31 +0100 Subject: [PATCH] More config file options. --- docs/config.rst | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/config.rst b/docs/config.rst index f363363..582246f 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -8,13 +8,31 @@ defaults and make your custom settings the default. like this:: [diceware] - num = 7 + num = 3 caps = off specials = 2 delimiter = MYDELIMITER randomsource = system wordlist = en_8k +These settings would mean that by default phrases with seven words +(instead six) would be created. Commandline options, however, override +config file settings. So, with the settings above:: + + $ diceware + Duma7YDELIMITER56MYDE^IMITERJock + +we will get three-word phrases while with:: + + $ diceware --delimiter=FOO + AmuseFOO]us(FOO18th + +we will override the config file setting for ``delimiter``. Other +settings from config file are still valid. + +Option Names +------------ + The options names have to match long argument names, as output with ``--help``. The values set must meet the requirements valid for commandline usage. @@ -27,8 +45,8 @@ Please note, that all options must be set within a section ``[diceware]``. -Name and Path -------------- +Config File Name and Path +------------------------- Currently, we look for configuration files only in the calling users' home directory. The file must be called:: -- GitLab