diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2012-03-04 22:45:41 +0000 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-03-04 22:45:41 +0000 |
| commit | 2ec31fa5df30df4df5c280d6c681992c825e9ec9 (patch) | |
| tree | c920532c8964292c4169acbb3a48f4759162c0a8 /docs/source/configuration/index.rst | |
| parent | f6f73dce60e571c7993093d92b6c3e7ff0a5bcfe (diff) | |
docs: intro on config values
Diffstat (limited to 'docs/source/configuration/index.rst')
| -rw-r--r-- | docs/source/configuration/index.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/source/configuration/index.rst b/docs/source/configuration/index.rst index 5226454a..3a8229d9 100644 --- a/docs/source/configuration/index.rst +++ b/docs/source/configuration/index.rst @@ -12,6 +12,17 @@ The default location for the config file is :file:`~/.config/alot/config`. Config options ============== +The following lists all available config options with their type and default values. +The type of an option is used to validate a given value. For instance, +if the type says "boolean" you may only provide "True" or "False" as values in your config file, +otherwise alot will complain on startup. Strings *may* be quoted but do not need to be. + +.. warning:: + + values for options with type `string_list` *must* be comma-separated lists of strings + and must end in a comma if they only provide a single element: + "From," is a valid `string_list`, "From" is not. + .. include:: alotrc_table.rst .. _account: |