diff options
| -rw-r--r-- | alot/defaults/config.stub | 5 | ||||
| -rw-r--r-- | alot/settings/__init__.py | 1 | ||||
| -rw-r--r-- | docs/source/configuration/index.rst | 5 |
3 files changed, 9 insertions, 2 deletions
diff --git a/alot/defaults/config.stub b/alot/defaults/config.stub index c6619897..17889780 100644 --- a/alot/defaults/config.stub +++ b/alot/defaults/config.stub @@ -1,9 +1,12 @@ +# For a complete list and description of options, please refer to: +# http://alot.readthedocs.org/en/latest/configuration/index.html#config-options +# or the file: defaults/alot.rc.spec in your alot installation. + # editor command # if unset, alot will first try the EDITOR env variable, then file /usr/bin/editor #editor_cmd = nano - #[accounts] # your main email address # address = me@example.com diff --git a/alot/settings/__init__.py b/alot/settings/__init__.py index 38847951..210fb5f4 100644 --- a/alot/settings/__init__.py +++ b/alot/settings/__init__.py @@ -87,6 +87,7 @@ class SettingsManager(object): self._accountmap = self._account_table(self._accounts) def write_default_config(self, path): + """write out defaults/config.stub to path""" (dir, file) = os.path.split(path) try: os.makedirs(dir) diff --git a/docs/source/configuration/index.rst b/docs/source/configuration/index.rst index ef8d1686..89595bd2 100644 --- a/docs/source/configuration/index.rst +++ b/docs/source/configuration/index.rst @@ -7,7 +7,10 @@ Configuration Alot reads a config file in "INI" syntax: It consists of key-value pairs that use "=" as separator and '#' is comment-prefixes. Sections and subsections are defined using square brackets. -The default location for the config file is :file:`~/.config/alot/config`. + +The default location for the config file is :file:`~/.config/alot/config`. If +upon startup this file is not found, a small default configuration (containing +mostly standard key bindings) will be copied in its place. Config options ============== |