diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/api/overview.rst | 26 | ||||
-rw-r--r-- | docs/source/api/settings.rst | 2 | ||||
-rw-r--r-- | docs/source/configuration/index.rst | 2 |
3 files changed, 17 insertions, 13 deletions
diff --git a/docs/source/api/overview.rst b/docs/source/api/overview.rst index 051eacaa..a5ef1e7d 100644 --- a/docs/source/api/overview.rst +++ b/docs/source/api/overview.rst @@ -1,19 +1,23 @@ Overview ======== -The main component is :class:`alot.ui.UI`, which provides methods for user input and notifications, -sets up an :mod:`urwid` :class:`mainloop <urwid.main_loop.TwistedEventLoop>` and widget tree and -maintains the list of active buffers. Moreover, it integrates different "managers" responsible for -core functionalities: +The main component is :class:`alot.ui.UI`, which provides methods for user input and notifications, sets up the widget +tree and maintains the list of active buffers. +When you start up alot, :file:`init.py` initializes logging, parses settings and commandline args +and instanciates the :class:`UI <alot.ui.UI>` instance of that gets passes around later. +From its constructor this instance starts the :mod:`urwid` :class:`mainloop <urwid.main_loop.TwistedEventLoop>` +that takes over. -* a :class:`~db.DBManager` to access the email database -* an :class:`~account.AccountManager` to deal with user accounts -* a :class:`~settings.AlotConfigParser` (subclasses :class:`configparser.ConfigParser`) for user settings +Apart from the central :class:`UI <alot.ui.UI>`, there are two other "managers" responsible for +core functionalities, also set up in :file:`init.py`: + +* :attr:`ui.dbman <alot.ui.UI.dbman>`: a :class:`DBManager <alot.db.DBManager>` to access the email database and +* :attr:`alot.settings.settings`: a :class:`SettingsManager <alot.settings.SettingsManager>` fo access user settings Every user action, triggered either by keybindings or as input to the commandprompt, is -given as commandline string that gets :func:`translated <commands.commandfactory>` -to a :class:`~commands.Command` which is then :meth:`applied <ui.UI.apply_command>`. -Different actions are defined as a subclasses of :class:`~commands.Command`, which live -in `alot/commands/MODE.py`, where MODE is the name of the mode (:class:`Buffer` type) they +given as commandline string that gets :func:`translated <alot.commands.commandfactory>` +to a :class:`Command <alot.commands.Command>` object which is then :meth:`applied <alot.ui.UI.apply_command>`. +Different actions are defined as a subclasses of :class:`Command <alot.commands.Command>`, which live +in :file:`alot/commands/MODE.py`, where MODE is the name of the mode (:class:`Buffer <alot.buffers.Buffer>` type) they are used in. diff --git a/docs/source/api/settings.rst b/docs/source/api/settings.rst index 69f91097..d4febd57 100644 --- a/docs/source/api/settings.rst +++ b/docs/source/api/settings.rst @@ -8,7 +8,7 @@ files, the hooks-file for user provided python code and the mailcap, defining shellcomands as handlers for files of certain mime types. Alot sets up :class:`SettingsManager` objects to access these user settings uniformly. -MIME handlers can be looked up via :meth:`SettingsManager.settings.get_mime_handler`, +MIME handlers can be looked up via :meth:`SettingsManager.get_mime_handler`, config values of alot and notmuch's config are accessible using :meth:`SettingsManager.get` and :meth:`SettingsManager.get_notmuch_setting`. These methods return either None or the requested value typed as indicated in diff --git a/docs/source/configuration/index.rst b/docs/source/configuration/index.rst index 4b951ed2..465cd6e7 100644 --- a/docs/source/configuration/index.rst +++ b/docs/source/configuration/index.rst @@ -278,6 +278,6 @@ do the following:: [[notmuch::.*]] fg = '#fff' bg = '#88d' - translation = 'notmuch::(\*)','nm:\1' + translation = 'notmuch::(.*)','nm:\1' .. _nmbug: http://notmuchmail.org/nmbug/ |