diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/api/conf.py | 2 | ||||
| -rw-r--r-- | docs/source/configuration/accounts_table | 214 | ||||
| -rw-r--r-- | docs/source/faq.rst | 6 | ||||
| -rwxr-xr-x | docs/source/generate_commands.py | 4 | ||||
| -rwxr-xr-x | docs/source/generate_configs.py | 8 | ||||
| -rw-r--r-- | docs/source/installation.rst | 4 | ||||
| -rw-r--r-- | docs/source/usage/modes/envelope.rst | 156 | ||||
| -rw-r--r-- | docs/source/usage/modes/global.rst | 170 | ||||
| -rw-r--r-- | docs/source/usage/modes/search.rst | 80 | ||||
| -rw-r--r-- | docs/source/usage/modes/thread.rst | 172 |
10 files changed, 408 insertions, 408 deletions
diff --git a/docs/source/api/conf.py b/docs/source/api/conf.py index 101fce21..54b31e07 100644 --- a/docs/source/api/conf.py +++ b/docs/source/api/conf.py @@ -250,7 +250,7 @@ man_pages = [ autodoc_member_order = 'bysource' autoclass_content = 'both' intersphinx_mapping = { - 'python': ('http://docs.python.org/3.2', None), + 'python': ('http://docs.python.org/3.5', None), 'notmuch': ('http://packages.python.org/notmuch', None), 'urwid': ('http://urwid.readthedocs.org/en/latest', None), } diff --git a/docs/source/configuration/accounts_table b/docs/source/configuration/accounts_table index 2215df51..db727898 100644 --- a/docs/source/configuration/accounts_table +++ b/docs/source/configuration/accounts_table @@ -13,24 +13,6 @@ :type: string -.. _realname: - -.. describe:: realname - - used to format the (proposed) From-header in outgoing mails - - :type: string - -.. _aliases: - -.. describe:: aliases - - used to clear your addresses/ match account when formatting replies - - :type: string list - :default: , - - .. _alias-regexp: .. describe:: alias_regexp @@ -41,28 +23,29 @@ :default: None -.. _sendmail-command: +.. _aliases: -.. describe:: sendmail_command +.. describe:: aliases - sendmail command. This is the shell command used to send out mails via the sendmail protocol + used to clear your addresses/ match account when formatting replies - :type: string - :default: "sendmail -t" + :type: string list + :default: , -.. _sent-box: +.. _case-sensitive-username: -.. describe:: sent_box +.. describe:: case_sensitive_username - where to store outgoing mails, e.g. `maildir:///home/you/mail/Sent`. - You can use mbox, maildir, mh, babyl and mmdf in the protocol part of the URL. + Whether the server treats the address as case-senstive or + case-insensitve (True for the former, False for the latter) - .. note:: If you want to add outgoing mails automatically to the notmuch index - you must use maildir in a path within your notmuch database path. + .. note:: The vast majority (if not all) SMTP servers in modern use + treat usernames as case insenstive, you should only set + this if you know that you need it. - :type: mail_container - :default: None + :type: boolean + :default: False .. _draft-box: @@ -80,34 +63,65 @@ :default: None -.. _sent-tags: +.. _draft-tags: -.. describe:: sent_tags +.. describe:: draft_tags - list of tags to automatically add to outgoing messages + list of tags to automatically add to draft messages :type: string list - :default: sent + :default: draft -.. _draft-tags: +.. _encrypt-by-default: -.. describe:: draft_tags +.. describe:: encrypt_by_default - list of tags to automatically add to draft messages + Alot will try to GPG encrypt outgoing messages by default when this + is set to `all` or `trusted`. If set to `all` the message will be + encrypted for all recipients for who a key is available in the key + ring. If set to `trusted` it will be encrypted to all + recipients if a trusted key is available for all recipients (one + where the user id for the key is signed with a trusted signature). - :type: string list - :default: draft + .. note:: If the message will not be encrypted by default you can + still use the :ref:`toggleencrypt + <cmd.envelope.toggleencrypt>`, :ref:`encrypt + <cmd.envelope.encrypt>` and :ref:`unencrypt + <cmd.envelope.unencrypt>` commands to encrypt it. + .. deprecated:: 0.4 + The values `True` and `False` are interpreted as `all` and + `none` respectively. `0`, `1`, `true`, `True`, `false`, + `False`, `yes`, `Yes`, `no`, `No`, will be removed before + 1.0, please move to `all`, `none`, or `trusted`. + :type: option, one of ['all', 'none', 'trusted', 'True', 'False', 'true', 'false', 'Yes', 'No', 'yes', 'no', '1', '0'] + :default: none -.. _replied-tags: -.. describe:: replied_tags +.. _encrypt-to-self: - list of tags to automatically add to replied messages +.. describe:: encrypt_to_self - :type: string list - :default: replied + If this is true when encrypting a message it will also be encrypted + with the key defined for this account. + + .. warning:: + + Before 0.6 this was controlled via gpg.conf. + + :type: boolean + :default: True + + +.. _gpg-key: + +.. describe:: gpg_key + + The GPG key ID you want to use with this account. + + :type: string + :default: None .. _passed-tags: @@ -120,111 +134,97 @@ :default: passed -.. _signature: +.. _realname: -.. describe:: signature +.. describe:: realname - path to signature file that gets attached to all outgoing mails from this account, optionally - renamed to :ref:`signature_filename <signature-filename>`. + used to format the (proposed) From-header in outgoing mails :type: string - :default: None - -.. _signature-as-attachment: +.. _replied-tags: -.. describe:: signature_as_attachment +.. describe:: replied_tags - attach signature file if set to True, append its content (mimetype text) - to the body text if set to False. + list of tags to automatically add to replied messages - :type: boolean - :default: False + :type: string list + :default: replied -.. _signature-filename: +.. _sendmail-command: -.. describe:: signature_filename +.. describe:: sendmail_command - signature file's name as it appears in outgoing mails if - :ref:`signature_as_attachment <signature-as-attachment>` is set to True + sendmail command. This is the shell command used to send out mails via the sendmail protocol :type: string - :default: None - - -.. _sign-by-default: + :default: "sendmail -t" -.. describe:: sign_by_default - Outgoing messages will be GPG signed by default if this is set to True. +.. _sent-box: - :type: boolean - :default: False +.. describe:: sent_box + where to store outgoing mails, e.g. `maildir:///home/you/mail/Sent`. + You can use mbox, maildir, mh, babyl and mmdf in the protocol part of the URL. -.. _encrypt-by-default: + .. note:: If you want to add outgoing mails automatically to the notmuch index + you must use maildir in a path within your notmuch database path. -.. describe:: encrypt_by_default + :type: mail_container + :default: None - Alot will try to GPG encrypt outgoing messages by default when this - is set to `all` or `trusted`. If set to `all` the message will be - encrypted for all recipients for who a key is available in the key - ring. If set to `trusted` it will be encrypted to all - recipients if a trusted key is available for all recipients (one - where the user id for the key is signed with a trusted signature). - .. note:: If the message will not be encrypted by default you can - still use the :ref:`toggleencrypt - <cmd.envelope.toggleencrypt>`, :ref:`encrypt - <cmd.envelope.encrypt>` and :ref:`unencrypt - <cmd.envelope.unencrypt>` commands to encrypt it. - .. deprecated:: 0.4 - The values `True` and `False` are interpreted as `all` and - `none` respectively. `0`, `1`, `true`, `True`, `false`, - `False`, `yes`, `Yes`, `no`, `No`, will be removed before - 1.0, please move to `all`, `none`, or `trusted`. +.. _sent-tags: - :type: option, one of ['all', 'none', 'trusted', 'True', 'False', 'true', 'false', 'Yes', 'No', 'yes', 'no', '1', '0'] - :default: none +.. describe:: sent_tags + list of tags to automatically add to outgoing messages -.. _encrypt-to-self: + :type: string list + :default: sent -.. describe:: encrypt_to_self - If this is true when encrypting a message it will also be encrypted - with the key defined for this account. +.. _sign-by-default: - .. warning:: +.. describe:: sign_by_default - Before 0.6 this was controlled via gpg.conf. + Outgoing messages will be GPG signed by default if this is set to True. :type: boolean - :default: True + :default: False -.. _gpg-key: +.. _signature: -.. describe:: gpg_key +.. describe:: signature - The GPG key ID you want to use with this account. + path to signature file that gets attached to all outgoing mails from this account, optionally + renamed to :ref:`signature_filename <signature-filename>`. :type: string :default: None -.. _case-sensitive-username: - -.. describe:: case_sensitive_username +.. _signature-as-attachment: - Whether the server treats the address as case-senstive or - case-insensitve (True for the former, False for the latter) +.. describe:: signature_as_attachment - .. note:: The vast majority (if not all) SMTP servers in modern use - treat usernames as case insenstive, you should only set - this if you know that you need it. + attach signature file if set to True, append its content (mimetype text) + to the body text if set to False. :type: boolean :default: False + +.. _signature-filename: + +.. describe:: signature_filename + + signature file's name as it appears in outgoing mails if + :ref:`signature_as_attachment <signature-as-attachment>` is set to True + + :type: string + :default: None + diff --git a/docs/source/faq.rst b/docs/source/faq.rst index 05847347..9ad30a8b 100644 --- a/docs/source/faq.rst +++ b/docs/source/faq.rst @@ -67,7 +67,9 @@ FAQ .. _faq_7: -7. Why doesn't alot run on python3? +7. I thought alot ran on Python 2? - We're on it. Check out the `py3k milestone <https://github.com/pazz/alot/issues?q=is%3Aopen+is%3Aissue+milestone%3A%22full+py3k+compatibility%22>`_ + It used to. When we made the transition to Python 3 we didn't maintain + Python 2 support. If you still need Python 2 support the 0.7 release is your + best bet. diff --git a/docs/source/generate_commands.py b/docs/source/generate_commands.py index c3db693f..4ead8c11 100755 --- a/docs/source/generate_commands.py +++ b/docs/source/generate_commands.py @@ -100,7 +100,7 @@ def get_mode_docs(): if __name__ == "__main__": modes = [] - for mode, modecommands in COMMANDS.items(): + for mode, modecommands in sorted(COMMANDS.items()): modefilename = mode+'.rst' modefile = open(os.path.join(HERE, 'usage', 'modes', modefilename), 'w') @@ -115,7 +115,7 @@ if __name__ == "__main__": header = 'Global Commands' modefile.write('%s\n%s\n' % (header, '-' * len(header))) modefile.write('The following commands are available globally\n\n') - for cmdstring, struct in modecommands.items(): + for cmdstring, struct in sorted(modecommands.items()): cls, parser, forced_args = struct labelline = '.. _cmd.%s.%s:\n\n' % (mode, cmdstring.replace('_', '-')) diff --git a/docs/source/generate_configs.py b/docs/source/generate_configs.py index a5427792..88726060 100755 --- a/docs/source/generate_configs.py +++ b/docs/source/generate_configs.py @@ -22,15 +22,13 @@ NOTE = """ """ -def rewrite_entries(config, path, specpath, sec=None, sort=False): +def rewrite_entries(config, path, specpath, sec=None): file = open(path, 'w') file.write(NOTE % specpath) if sec is None: sec = config - if sort: - sec.scalars.sort() - for entry in sec.scalars: + for entry in sorted(sec.scalars): v = Validator() etype, eargs, ekwargs, default = v._parse_check(sec[entry]) if default is not None: @@ -72,7 +70,7 @@ if __name__ == "__main__": alotrc_table_file = os.path.join(HERE, 'configuration', 'alotrc_table') rewrite_entries(config.configspec, alotrc_table_file, - 'defaults/alot.rc.spec', sort=True) + 'defaults/alot.rc.spec') rewrite_entries(config, os.path.join(HERE, 'configuration', 'accounts_table'), diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 8e30de1a..2d3fe44c 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -4,14 +4,14 @@ Installation .. rubric:: dependencies Alot depends on recent versions of notmuch and urwid. Note that due to restrictions -on argparse and subprocess, you need to run *`3.0` > python ≥ `2.7`* (see :ref:`faq <faq_7>`). +on argparse and subprocess, you need to run *`python ≥ `3.5`* (see :ref:`faq <faq_7>`). A full list of dependencies is below: * `libmagic and python bindings <http://darwinsys.com/file/>`_, ≥ `5.04` * `configobj <http://www.voidspace.org.uk/python/configobj.html>`_, ≥ `4.7.0` * `twisted <http://twistedmatrix.com/trac/>`_, ≥ `10.2.0`: * `libnotmuch <http://notmuchmail.org/>`_ and it's python bindings, ≥ `0.13` -* `urwid <http://excess.org/urwid/>`_ toolkit, ≥ `1.1.0` +* `urwid <http://excess.org/urwid/>`_ toolkit, ≥ `1.3.0` * `urwidtrees <https://github.com/pazz/urwidtrees>`_, ≥ `1.0` * `gpg <http://www.gnupg.org/related_software/gpgme>`_ and it's python bindings, ≥ `1.9.0` diff --git a/docs/source/usage/modes/envelope.rst b/docs/source/usage/modes/envelope.rst index 8644a6c1..ee857cc4 100644 --- a/docs/source/usage/modes/envelope.rst +++ b/docs/source/usage/modes/envelope.rst @@ -5,26 +5,25 @@ Commands in `envelope` mode --------------------------- The following commands are available in envelope mode -.. _cmd.envelope.unencrypt: - -.. describe:: unencrypt +.. _cmd.envelope.attach: - remove request to encrypt message before sending +.. describe:: attach + attach files to the mail -.. _cmd.envelope.set: + argument + file(s) to attach (accepts wildcads) -.. describe:: set - set header value +.. _cmd.envelope.edit: - positional arguments - 0: header to refine - 1: value +.. describe:: edit + edit mail optional arguments - :---append: keep previous values. + :---spawn: spawn editor in new terminal. + :---refocus: refocus envelope after editing (Defaults to: 'True'). .. _cmd.envelope.encrypt: @@ -38,32 +37,15 @@ The following commands are available in envelope mode optional arguments :---trusted: only add trusted keys. -.. _cmd.envelope.togglesign: +.. _cmd.envelope.refine: -.. describe:: togglesign +.. describe:: refine - toggle sign status + prompt to change the value of a header argument - which key id to use - - -.. _cmd.envelope.toggleheaders: - -.. describe:: toggleheaders - - toggle display of all headers - - -.. _cmd.envelope.edit: - -.. describe:: edit - - edit mail + header to refine - optional arguments - :---spawn: spawn editor in new terminal. - :---refocus: refocus envelope after editing (Defaults to: 'True'). .. _cmd.envelope.retag: @@ -75,14 +57,21 @@ The following commands are available in envelope mode comma separated list of tags -.. _cmd.envelope.tag: +.. _cmd.envelope.rmencrypt: -.. describe:: tag +.. describe:: rmencrypt - add tags to message + do not encrypt to given recipient key argument - comma separated list of tags + keyid of the key to encrypt with + + +.. _cmd.envelope.save: + +.. describe:: save + + save draft .. _cmd.envelope.send: @@ -92,6 +81,20 @@ The following commands are available in envelope mode send mail +.. _cmd.envelope.set: + +.. describe:: set + + set header value + + positional arguments + 0: header to refine + 1: value + + + optional arguments + :---append: keep previous values. + .. _cmd.envelope.sign: .. describe:: sign @@ -102,99 +105,96 @@ The following commands are available in envelope mode which key id to use -.. _cmd.envelope.untag: +.. _cmd.envelope.tag: -.. describe:: untag +.. describe:: tag - remove tags from message + add tags to message argument comma separated list of tags -.. _cmd.envelope.attach: +.. _cmd.envelope.toggleencrypt: -.. describe:: attach +.. describe:: toggleencrypt - attach files to the mail + toggle if message should be encrypted before sendout argument - file(s) to attach (accepts wildcads) - + keyid of the key to encrypt with -.. _cmd.envelope.unattach: + optional arguments + :---trusted: only add trusted keys. -.. describe:: unattach +.. _cmd.envelope.toggleheaders: - remove attachments from current envelope +.. describe:: toggleheaders - argument - which attached file to remove + toggle display of all headers -.. _cmd.envelope.rmencrypt: +.. _cmd.envelope.togglesign: -.. describe:: rmencrypt +.. describe:: togglesign - do not encrypt to given recipient key + toggle sign status argument - keyid of the key to encrypt with + which key id to use -.. _cmd.envelope.refine: +.. _cmd.envelope.toggletags: -.. describe:: refine +.. describe:: toggletags - prompt to change the value of a header + flip presence of tags on message argument - header to refine + comma separated list of tags -.. _cmd.envelope.toggleencrypt: +.. _cmd.envelope.unattach: -.. describe:: toggleencrypt +.. describe:: unattach - toggle if message should be encrypted before sendout + remove attachments from current envelope argument - keyid of the key to encrypt with + which attached file to remove - optional arguments - :---trusted: only add trusted keys. -.. _cmd.envelope.save: +.. _cmd.envelope.unencrypt: -.. describe:: save +.. describe:: unencrypt - save draft + remove request to encrypt message before sending -.. _cmd.envelope.unsign: +.. _cmd.envelope.unset: -.. describe:: unsign +.. describe:: unset - mark mail not to be signed before sending + remove header field + argument + header to refine -.. _cmd.envelope.toggletags: -.. describe:: toggletags +.. _cmd.envelope.unsign: - flip presence of tags on message +.. describe:: unsign - argument - comma separated list of tags + mark mail not to be signed before sending -.. _cmd.envelope.unset: +.. _cmd.envelope.untag: -.. describe:: unset +.. describe:: untag - remove header field + remove tags from message argument - header to refine + comma separated list of tags diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst index dcbe4040..6e79c67a 100644 --- a/docs/source/usage/modes/global.rst +++ b/docs/source/usage/modes/global.rst @@ -15,52 +15,18 @@ The following commands are available globally :---redraw: redraw current buffer after command has finished. :---force: never ask for confirmation. -.. _cmd.global.bprevious: - -.. describe:: bprevious - - focus previous buffer - - -.. _cmd.global.search: - -.. describe:: search - - open a new search buffer. Search obeys the notmuch - :ref:`search.exclude_tags <search.exclude_tags>` setting. - - argument - search string - - optional arguments - :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. - -.. _cmd.global.repeat: - -.. describe:: repeat - - Repeats the command executed last time - - -.. _cmd.global.prompt: - -.. describe:: prompt - - prompts for commandline and interprets it upon select +.. _cmd.global.bnext: - argument - initial content +.. describe:: bnext + focus next buffer -.. _cmd.global.help: -.. describe:: help +.. _cmd.global.bprevious: - display help for a command. Use 'bindings' to display all keybings - interpreted in current mode.' +.. describe:: bprevious - argument - command or 'bindings' + focus previous buffer .. _cmd.global.buffer: @@ -73,49 +39,21 @@ The following commands are available globally buffer index to focus -.. _cmd.global.move: - -.. describe:: move +.. _cmd.global.bufferlist: - move focus in current buffer +.. describe:: bufferlist - argument - up, down, [half]page up, [half]page down, first, last + open a list of active buffers -.. _cmd.global.shellescape: +.. _cmd.global.call: -.. describe:: shellescape +.. describe:: call - run external command + Executes python code argument - command line to execute - - optional arguments - :---spawn: run in terminal window. - :---thread: run in separate thread. - :---refocus: refocus current buffer after command has finished. - -.. _cmd.global.refresh: - -.. describe:: refresh - - refresh the current buffer - - -.. _cmd.global.reload: - -.. describe:: reload - - Reload all configuration files - - -.. _cmd.global.pyshell: - -.. describe:: pyshell - - open an interactive python shell for introspection + python command string to call .. _cmd.global.compose: @@ -158,29 +96,91 @@ The following commands are available globally flush write operations or retry until committed -.. _cmd.global.bufferlist: +.. _cmd.global.help: -.. describe:: bufferlist +.. describe:: help - open a list of active buffers + display help for a command. Use 'bindings' to display all keybings + interpreted in current mode.' + + argument + command or 'bindings' -.. _cmd.global.call: +.. _cmd.global.move: -.. describe:: call +.. describe:: move - Executes python code + move focus in current buffer argument - python command string to call + up, down, [half]page up, [half]page down, first, last -.. _cmd.global.bnext: +.. _cmd.global.prompt: -.. describe:: bnext +.. describe:: prompt - focus next buffer + prompts for commandline and interprets it upon select + + argument + initial content + + +.. _cmd.global.pyshell: +.. describe:: pyshell + + open an interactive python shell for introspection + + +.. _cmd.global.refresh: + +.. describe:: refresh + + refresh the current buffer + + +.. _cmd.global.reload: + +.. describe:: reload + + Reload all configuration files + + +.. _cmd.global.repeat: + +.. describe:: repeat + + Repeats the command executed last time + + +.. _cmd.global.search: + +.. describe:: search + + open a new search buffer. Search obeys the notmuch + :ref:`search.exclude_tags <search.exclude_tags>` setting. + + argument + search string + + optional arguments + :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. + +.. _cmd.global.shellescape: + +.. describe:: shellescape + + run external command + + argument + command line to execute + + optional arguments + :---spawn: run in terminal window. + :---thread: run in separate thread. + :---refocus: refocus current buffer after command has finished. .. _cmd.global.taglist: diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst index 93a59eff..c95d1a01 100644 --- a/docs/source/usage/modes/search.rst +++ b/docs/source/usage/modes/search.rst @@ -5,37 +5,33 @@ Commands in `search` mode ------------------------- The following commands are available in search mode -.. _cmd.search.sort: +.. _cmd.search.move: -.. describe:: sort +.. describe:: move - set sort order + move focus in search buffer argument - sort order. valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. + last -.. _cmd.search.untag: +.. _cmd.search.refine: -.. describe:: untag +.. describe:: refine - remove tags from all messages in the thread that match the query + refine query argument - comma separated list of tags + search string optional arguments - :---no-flush: postpone a writeout to the index (Defaults to: 'True'). - :---all: retag all messages in search result. - -.. _cmd.search.move: + :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. -.. describe:: move +.. _cmd.search.refineprompt: - move focus in search buffer +.. describe:: refineprompt - argument - last + prompt to change this buffers querystring .. _cmd.search.retag: @@ -51,44 +47,42 @@ The following commands are available in search mode :---no-flush: postpone a writeout to the index (Defaults to: 'True'). :---all: retag all messages in search result. -.. _cmd.search.refineprompt: - -.. describe:: refineprompt +.. _cmd.search.retagprompt: - prompt to change this buffers querystring +.. describe:: retagprompt + prompt to retag selected threads' tags -.. _cmd.search.tag: -.. describe:: tag +.. _cmd.search.select: - add tags to all messages in the thread that match the current query +.. describe:: select - argument - comma separated list of tags + open thread in a new buffer - optional arguments - :---no-flush: postpone a writeout to the index (Defaults to: 'True'). - :---all: retag all messages in search result. -.. _cmd.search.refine: +.. _cmd.search.sort: -.. describe:: refine +.. describe:: sort - refine query + set sort order argument - search string + sort order. valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. - optional arguments - :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. -.. _cmd.search.retagprompt: +.. _cmd.search.tag: -.. describe:: retagprompt +.. describe:: tag - prompt to retag selected threads' tags + add tags to all messages in the thread that match the current query + + argument + comma separated list of tags + optional arguments + :---no-flush: postpone a writeout to the index (Defaults to: 'True'). + :---all: retag all messages in search result. .. _cmd.search.toggletags: @@ -102,10 +96,16 @@ The following commands are available in search mode optional arguments :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -.. _cmd.search.select: +.. _cmd.search.untag: -.. describe:: select +.. describe:: untag - open thread in a new buffer + remove tags from all messages in the thread that match the query + + argument + comma separated list of tags + optional arguments + :---no-flush: postpone a writeout to the index (Defaults to: 'True'). + :---all: retag all messages in search result. diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst index 29a7850a..447e543a 100644 --- a/docs/source/usage/modes/thread.rst +++ b/docs/source/usage/modes/thread.rst @@ -5,24 +5,12 @@ Commands in `thread` mode ------------------------- The following commands are available in thread mode -.. _cmd.thread.pipeto: - -.. describe:: pipeto +.. _cmd.thread.bounce: - pipe message(s) to stdin of a shellcommand +.. describe:: bounce - argument - shellcommand to pipe to + directly re-send selected message - optional arguments - :---all: pass all messages. - :---format: output format. Valid choices are: \`raw\`,\`decoded\`,\`id\`,\`filepath\` (Defaults to: 'raw'). - :---separately: call command once for each message. - :---background: don't stop the interface. - :---add_tags: add 'Tags' header to the message. - :---shell: let the shell interpret the command. - :---notify_stdout: display cmd's stdout as notification. - :---field_key: mailcap field key for decoding (Defaults to: 'copiousoutput'). .. _cmd.thread.editnew: @@ -33,15 +21,25 @@ The following commands are available in thread mode optional arguments :---spawn: open editor in new window. -.. _cmd.thread.move: +.. _cmd.thread.fold: -.. describe:: move +.. describe:: fold - move focus in current buffer + fold message(s) argument - up, down, [half]page up, [half]page down, first, last, parent, first reply, last reply, next sibling, previous sibling, next, previous, next unfolded, previous unfolded, next NOTMUCH_QUERY, previous NOTMUCH_QUERY + query used to filter messages to affect + +.. _cmd.thread.forward: + +.. describe:: forward + + forward message + + optional arguments + :---attach: attach original mail. + :---spawn: open editor in new window. .. _cmd.thread.indent: @@ -53,28 +51,34 @@ The following commands are available in thread mode None -.. _cmd.thread.toggleheaders: +.. _cmd.thread.move: -.. describe:: toggleheaders +.. describe:: move - display all headers + move focus in current buffer argument - query used to filter messages to affect + up, down, [half]page up, [half]page down, first, last, parent, first reply, last reply, next sibling, previous sibling, next, previous, next unfolded, previous unfolded, next NOTMUCH_QUERY, previous NOTMUCH_QUERY -.. _cmd.thread.retag: +.. _cmd.thread.pipeto: -.. describe:: retag +.. describe:: pipeto - set message(s) tags. + pipe message(s) to stdin of a shellcommand argument - comma separated list of tags + shellcommand to pipe to optional arguments - :---all: tag all messages in thread. - :---no-flush: postpone a writeout to the index (Defaults to: 'True'). + :---all: pass all messages. + :---format: output format. Valid choices are: \`raw\`,\`decoded\`,\`id\`,\`filepath\` (Defaults to: 'raw'). + :---separately: call command once for each message. + :---background: don't stop the interface. + :---add_tags: add 'Tags' header to the message. + :---shell: let the shell interpret the command. + :---notify_stdout: display cmd's stdout as notification. + :---field_key: mailcap field key for decoding (Defaults to: 'copiousoutput'). .. _cmd.thread.print: @@ -88,28 +92,31 @@ The following commands are available in thread mode :---separately: call print command once for each message. :---add_tags: add 'Tags' header to the message. -.. _cmd.thread.bounce: - -.. describe:: bounce +.. _cmd.thread.remove: - directly re-send selected message +.. describe:: remove + remove message(s) from the index -.. _cmd.thread.togglesource: + optional arguments + :---all: remove whole thread. -.. describe:: togglesource +.. _cmd.thread.reply: - display message source +.. describe:: reply - argument - query used to filter messages to affect + reply to message + optional arguments + :---all: reply to all. + :---list: reply to list. + :---spawn: open editor in new window. -.. _cmd.thread.untag: +.. _cmd.thread.retag: -.. describe:: untag +.. describe:: retag - remove tags from message(s) + set message(s) tags. argument comma separated list of tags @@ -118,14 +125,25 @@ The following commands are available in thread mode :---all: tag all messages in thread. :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -.. _cmd.thread.fold: +.. _cmd.thread.save: -.. describe:: fold +.. describe:: save - fold message(s) + save attachment(s) argument - query used to filter messages to affect + path to save to + + optional arguments + :---all: save all attachments. + +.. _cmd.thread.select: + +.. describe:: select + + select focussed element. The fired action depends on the focus: + - if message summary, this toggles visibility of the message, + - if attachment line, this opens the attachment .. _cmd.thread.tag: @@ -141,63 +159,54 @@ The following commands are available in thread mode :---all: tag all messages in thread. :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -.. _cmd.thread.remove: +.. _cmd.thread.toggleheaders: -.. describe:: remove +.. describe:: toggleheaders - remove message(s) from the index + display all headers - optional arguments - :---all: remove whole thread. + argument + query used to filter messages to affect -.. _cmd.thread.unfold: -.. describe:: unfold +.. _cmd.thread.togglesource: - unfold message(s) +.. describe:: togglesource + + display message source argument query used to filter messages to affect -.. _cmd.thread.forward: - -.. describe:: forward - - forward message - - optional arguments - :---attach: attach original mail. - :---spawn: open editor in new window. +.. _cmd.thread.toggletags: -.. _cmd.thread.reply: +.. describe:: toggletags -.. describe:: reply + flip presence of tags on message(s) - reply to message + argument + comma separated list of tags optional arguments - :---all: reply to all. - :---list: reply to list. - :---spawn: open editor in new window. + :---all: tag all messages in thread. + :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -.. _cmd.thread.save: +.. _cmd.thread.unfold: -.. describe:: save +.. describe:: unfold - save attachment(s) + unfold message(s) argument - path to save to + query used to filter messages to affect - optional arguments - :---all: save all attachments. -.. _cmd.thread.toggletags: +.. _cmd.thread.untag: -.. describe:: toggletags +.. describe:: untag - flip presence of tags on message(s) + remove tags from message(s) argument comma separated list of tags @@ -206,12 +215,3 @@ The following commands are available in thread mode :---all: tag all messages in thread. :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -.. _cmd.thread.select: - -.. describe:: select - - select focussed element. The fired action depends on the focus: - - if message summary, this toggles visibility of the message, - - if attachment line, this opens the attachment - - |