From a298d7eb9722257d737d1b0baa51e7e8c6bb8ebb Mon Sep 17 00:00:00 2001 From: Dylan Baker Date: Wed, 28 Feb 2018 09:09:08 -0800 Subject: docs: regenerate generated sources --- docs/source/configuration/accounts_table | 182 ++++++++++++++-------------- docs/source/usage/modes/envelope.rst | 168 +++++++++++++------------- docs/source/usage/modes/global.rst | 144 +++++++++++----------- docs/source/usage/modes/search.rst | 34 +++--- docs/source/usage/modes/thread.rst | 200 +++++++++++++++---------------- 5 files changed, 364 insertions(+), 364 deletions(-) (limited to 'docs') diff --git a/docs/source/configuration/accounts_table b/docs/source/configuration/accounts_table index 33c554a3..0fca90ff 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,59 +63,6 @@ :default: None -.. _sent-tags: - -.. describe:: sent_tags - - list of tags to automatically add to outgoing messages - - :type: string list - :default: sent, - - -.. _signature: - -.. describe:: signature - - path to signature file that gets attached to all outgoing mails from this account, optionally - renamed to :ref:`signature_filename `. - - :type: string - :default: None - - -.. _signature-as-attachment: - -.. describe:: signature_as_attachment - - 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 ` is set to True - - :type: string - :default: None - - -.. _sign-by-default: - -.. describe:: sign_by_default - - Outgoing messages will be GPG signed by default if this is set to True. - - :type: boolean - :default: False - - .. _encrypt-by-default: .. describe:: encrypt_by_default @@ -184,17 +114,87 @@ :default: None -.. _case-sensitive-username: +.. _realname: -.. describe:: case_sensitive_username +.. describe:: realname - Whether the server treats the address as case-senstive or - case-insensitve (True for the former, False for the latter) + used to format the (proposed) From-header in outgoing mails - .. 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: string + +.. _sendmail-command: + +.. describe:: sendmail_command + + sendmail command. This is the shell command used to send out mails via the sendmail protocol + + :type: string + :default: "sendmail -t" + + +.. _sent-box: + +.. 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. + + .. 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. + + :type: mail_container + :default: None + + +.. _sent-tags: + +.. describe:: sent_tags + + list of tags to automatically add to outgoing messages + + :type: string list + :default: sent, + + +.. _sign-by-default: + +.. describe:: sign_by_default + + Outgoing messages will be GPG signed by default if this is set to True. :type: boolean :default: False + +.. _signature: + +.. describe:: signature + + path to signature file that gets attached to all outgoing mails from this account, optionally + renamed to :ref:`signature_filename `. + + :type: string + :default: None + + +.. _signature-as-attachment: + +.. describe:: signature_as_attachment + + 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 ` is set to True + + :type: string + :default: None + diff --git a/docs/source/usage/modes/envelope.rst b/docs/source/usage/modes/envelope.rst index 8644a6c1..263705b9 100644 --- a/docs/source/usage/modes/envelope.rst +++ b/docs/source/usage/modes/envelope.rst @@ -5,38 +5,32 @@ Commands in `envelope` mode --------------------------- The following commands are available in envelope mode -.. _cmd.envelope.unencrypt: - -.. describe:: unencrypt +.. _cmd.envelope.toggleheaders: - remove request to encrypt message before sending +.. describe:: toggleheaders + toggle display of all headers -.. _cmd.envelope.set: -.. describe:: set +.. _cmd.envelope.unattach: - set header value +.. describe:: unattach - positional arguments - 0: header to refine - 1: value + remove attachments from current envelope + argument + which attached file to remove - optional arguments - :---append: keep previous values. -.. _cmd.envelope.encrypt: +.. _cmd.envelope.rmencrypt: -.. describe:: encrypt +.. describe:: rmencrypt - request encryption of message before sendout + do not encrypt to given recipient key argument keyid of the key to encrypt with - optional arguments - :---trusted: only add trusted keys. .. _cmd.envelope.togglesign: @@ -48,22 +42,29 @@ The following commands are available in envelope mode which key id to use -.. _cmd.envelope.toggleheaders: +.. _cmd.envelope.unencrypt: -.. describe:: toggleheaders +.. describe:: unencrypt - toggle display of all headers + remove request to encrypt message before sending -.. _cmd.envelope.edit: +.. _cmd.envelope.send: -.. describe:: edit +.. describe:: send - edit mail + send mail + + +.. _cmd.envelope.tag: + +.. describe:: tag + + add tags to message + + argument + comma separated list of tags - optional arguments - :---spawn: spawn editor in new terminal. - :---refocus: refocus envelope after editing (Defaults to: 'True'). .. _cmd.envelope.retag: @@ -75,31 +76,42 @@ The following commands are available in envelope mode comma separated list of tags -.. _cmd.envelope.tag: +.. _cmd.envelope.encrypt: -.. describe:: tag +.. describe:: encrypt - add tags to message + request encryption of message before sendout argument - comma separated list of tags + keyid of the key to encrypt with + + optional arguments + :---trusted: only add trusted keys. +.. _cmd.envelope.toggleencrypt: -.. _cmd.envelope.send: +.. describe:: toggleencrypt -.. describe:: send + toggle if message should be encrypted before sendout - send mail + argument + keyid of the key to encrypt with + optional arguments + :---trusted: only add trusted keys. -.. _cmd.envelope.sign: +.. _cmd.envelope.unsign: -.. describe:: sign +.. describe:: unsign - mark mail to be signed before sending + mark mail not to be signed before sending - argument - which key id to use + +.. _cmd.envelope.save: + +.. describe:: save + + save draft .. _cmd.envelope.untag: @@ -112,34 +124,44 @@ The following commands are available in envelope mode comma separated list of tags -.. _cmd.envelope.attach: +.. _cmd.envelope.edit: -.. describe:: attach +.. describe:: edit - attach files to the mail + edit mail + + optional arguments + :---spawn: spawn editor in new terminal. + :---refocus: refocus envelope after editing (Defaults to: 'True'). + +.. _cmd.envelope.unset: + +.. describe:: unset + + remove header field argument - file(s) to attach (accepts wildcads) + header to refine -.. _cmd.envelope.unattach: +.. _cmd.envelope.toggletags: -.. describe:: unattach +.. describe:: toggletags - remove attachments from current envelope + flip presence of tags on message argument - which attached file to remove + comma separated list of tags -.. _cmd.envelope.rmencrypt: +.. _cmd.envelope.sign: -.. describe:: rmencrypt +.. describe:: sign - do not encrypt to given recipient key + mark mail to be signed before sending argument - keyid of the key to encrypt with + which key id to use .. _cmd.envelope.refine: @@ -152,49 +174,27 @@ The following commands are available in envelope mode header to refine -.. _cmd.envelope.toggleencrypt: +.. _cmd.envelope.attach: -.. describe:: toggleencrypt +.. describe:: attach - toggle if message should be encrypted before sendout + attach files to the mail argument - keyid of the key to encrypt with - - optional arguments - :---trusted: only add trusted keys. - -.. _cmd.envelope.save: - -.. describe:: save - - save draft - - -.. _cmd.envelope.unsign: - -.. describe:: unsign - - mark mail not to be signed before sending - - -.. _cmd.envelope.toggletags: - -.. describe:: toggletags + file(s) to attach (accepts wildcads) - flip presence of tags on message - - argument - comma separated list of tags +.. _cmd.envelope.set: -.. _cmd.envelope.unset: +.. describe:: set -.. describe:: unset + set header value - remove header field + positional arguments + 0: header to refine + 1: value - argument - header to refine + optional arguments + :---append: keep previous values. diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst index dcbe4040..ee3955fd 100644 --- a/docs/source/usage/modes/global.rst +++ b/docs/source/usage/modes/global.rst @@ -5,23 +5,6 @@ Global Commands --------------- The following commands are available globally -.. _cmd.global.bclose: - -.. describe:: bclose - - close a buffer - - optional arguments - :---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 @@ -35,13 +18,6 @@ The following commands are available globally 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 @@ -52,35 +28,47 @@ The following commands are available globally initial content -.. _cmd.global.help: +.. _cmd.global.bnext: -.. describe:: help +.. describe:: bnext - display help for a command. Use 'bindings' to display all keybings - interpreted in current mode.' + focus next buffer - argument - command or 'bindings' +.. _cmd.global.reload: -.. _cmd.global.buffer: +.. describe:: reload -.. describe:: buffer + Reload all configuration files - focus buffer with given index - argument - buffer index to focus +.. _cmd.global.bufferlist: +.. describe:: bufferlist -.. _cmd.global.move: + open a list of active buffers -.. describe:: move - move focus in current buffer +.. _cmd.global.bclose: - argument - up, down, [half]page up, [half]page down, first, last +.. describe:: bclose + + close a buffer + + optional arguments + :---redraw: redraw current buffer after command has finished. + :---force: never ask for confirmation. + +.. _cmd.global.exit: + +.. describe:: exit + + Shut down cleanly. + + The _prompt variable is for internal use only, it's used to control + prompting to close without sending, and is used by the BufferCloseCommand + if settings change after yielding to the UI. + .. _cmd.global.shellescape: @@ -97,26 +85,35 @@ The following commands are available globally :---thread: run in separate thread. :---refocus: refocus current buffer after command has finished. -.. _cmd.global.refresh: +.. _cmd.global.help: -.. describe:: refresh +.. describe:: help - refresh the current buffer + display help for a command. Use 'bindings' to display all keybings + interpreted in current mode.' + argument + command or 'bindings' -.. _cmd.global.reload: -.. describe:: reload +.. _cmd.global.call: - Reload all configuration files +.. describe:: call + Executes python code -.. _cmd.global.pyshell: + argument + python command string to call -.. describe:: pyshell - open an interactive python shell for introspection +.. _cmd.global.taglist: + +.. describe:: taglist + + opens taglist buffer + optional arguments + :---tags: tags to display. .. _cmd.global.compose: @@ -139,16 +136,21 @@ The following commands are available globally :---omit_signature: do not add signature. :---spawn: spawn editor in new terminal. -.. _cmd.global.exit: +.. _cmd.global.bprevious: -.. describe:: exit +.. describe:: bprevious - Shut down cleanly. + focus previous buffer - The _prompt variable is for internal use only, it's used to control - prompting to close without sending, and is used by the BufferCloseCommand - if settings change after yielding to the UI. - + +.. _cmd.global.buffer: + +.. describe:: buffer + + focus buffer with given index + + argument + buffer index to focus .. _cmd.global.flush: @@ -158,36 +160,34 @@ The following commands are available globally flush write operations or retry until committed -.. _cmd.global.bufferlist: +.. _cmd.global.refresh: -.. describe:: bufferlist +.. describe:: refresh - open a list of active buffers + refresh the current buffer -.. _cmd.global.call: +.. _cmd.global.repeat: -.. describe:: call +.. describe:: repeat - Executes python code + Repeats the command executed last time - argument - python command string to call +.. _cmd.global.pyshell: -.. _cmd.global.bnext: +.. describe:: pyshell -.. describe:: bnext + open an interactive python shell for introspection - focus next buffer +.. _cmd.global.move: -.. _cmd.global.taglist: +.. describe:: move -.. describe:: taglist + move focus in current buffer - opens taglist buffer + argument + up, down, [half]page up, [half]page down, first, last - optional arguments - :---tags: tags to display. diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst index 93a59eff..ed632e83 100644 --- a/docs/source/usage/modes/search.rst +++ b/docs/source/usage/modes/search.rst @@ -15,6 +15,13 @@ The following commands are available in search mode sort order. valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. +.. _cmd.search.retagprompt: + +.. describe:: retagprompt + + prompt to retag selected threads' tags + + .. _cmd.search.untag: .. describe:: untag @@ -38,25 +45,17 @@ The following commands are available in search mode last -.. _cmd.search.retag: +.. _cmd.search.toggletags: -.. describe:: retag +.. describe:: toggletags - set tags of all messages in the thread that match the current query + flip presence of tags on this thread. A tag is considered present if at least one message contained in this thread is tagged with it. In that case this command will remove the tag from every message in the thread. 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.refineprompt: - -.. describe:: refineprompt - - prompt to change this buffers querystring - .. _cmd.search.tag: @@ -83,24 +82,25 @@ The following commands are available in search mode optional arguments :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. -.. _cmd.search.retagprompt: +.. _cmd.search.refineprompt: -.. describe:: retagprompt +.. describe:: refineprompt - prompt to retag selected threads' tags + prompt to change this buffers querystring -.. _cmd.search.toggletags: +.. _cmd.search.retag: -.. describe:: toggletags +.. describe:: retag - flip presence of tags on this thread. A tag is considered present if at least one message contained in this thread is tagged with it. In that case this command will remove the tag from every message in the thread. + set tags of 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.select: diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst index 29a7850a..01c9db9c 100644 --- a/docs/source/usage/modes/thread.rst +++ b/docs/source/usage/modes/thread.rst @@ -5,33 +5,15 @@ Commands in `thread` mode ------------------------- The following commands are available in thread mode -.. _cmd.thread.pipeto: +.. _cmd.thread.toggleheaders: -.. describe:: pipeto +.. describe:: toggleheaders - pipe message(s) to stdin of a shellcommand + display all headers argument - shellcommand to pipe to - - 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: - -.. describe:: editnew - - edit message in as new + query used to filter messages to affect - optional arguments - :---spawn: open editor in new window. .. _cmd.thread.move: @@ -43,50 +25,45 @@ The following commands are available in thread mode 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.indent: +.. _cmd.thread.unfold: -.. describe:: indent +.. describe:: unfold - change message/reply indentation + unfold message(s) argument - None - - -.. _cmd.thread.toggleheaders: + query used to filter messages to affect -.. describe:: toggleheaders - display all headers +.. _cmd.thread.editnew: - argument - query used to filter messages to affect +.. describe:: editnew + edit message in as new -.. _cmd.thread.retag: + optional arguments + :---spawn: open editor in new window. -.. describe:: retag +.. _cmd.thread.reply: - set message(s) tags. +.. describe:: reply - argument - comma separated list of tags + reply to message optional arguments - :---all: tag all messages in thread. - :---no-flush: postpone a writeout to the index (Defaults to: 'True'). + :---all: reply to all. + :---list: reply to list. + :---spawn: open editor in new window. -.. _cmd.thread.print: +.. _cmd.thread.forward: -.. describe:: print +.. describe:: forward - print message(s) + forward message optional arguments - :---all: print all messages. - :---raw: pass raw mail string. - :---separately: call print command once for each message. - :---add_tags: add 'Tags' header to the message. + :---attach: attach original mail. + :---spawn: open editor in new window. .. _cmd.thread.bounce: @@ -95,16 +72,46 @@ The following commands are available in thread mode directly re-send selected message -.. _cmd.thread.togglesource: +.. _cmd.thread.select: -.. describe:: togglesource +.. describe:: select - display message source + 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.save: + +.. describe:: save + + save attachment(s) + + argument + path to save to + + optional arguments + :---all: save all attachments. + +.. _cmd.thread.fold: + +.. describe:: fold + + fold message(s) argument query used to filter messages to affect +.. _cmd.thread.remove: + +.. describe:: remove + + remove message(s) from the index + + optional arguments + :---all: remove whole thread. + .. _cmd.thread.untag: .. describe:: untag @@ -118,21 +125,21 @@ 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.togglesource: -.. describe:: fold +.. describe:: togglesource - fold message(s) + display message source argument query used to filter messages to affect -.. _cmd.thread.tag: +.. _cmd.thread.toggletags: -.. describe:: tag +.. describe:: toggletags - add tags to message(s) + flip presence of tags on message(s) argument comma separated list of tags @@ -141,77 +148,70 @@ 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.tag: -.. describe:: remove +.. describe:: tag - remove message(s) from the index + add tags to message(s) + + argument + comma separated list of tags optional arguments - :---all: remove whole thread. + :---all: tag all messages in thread. + :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -.. _cmd.thread.unfold: +.. _cmd.thread.retag: -.. describe:: unfold +.. describe:: retag - unfold message(s) + set message(s) tags. argument - query used to filter messages to affect - - -.. _cmd.thread.forward: - -.. describe:: forward - - forward message + comma separated list of tags optional arguments - :---attach: attach original mail. - :---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.reply: +.. _cmd.thread.print: -.. describe:: reply +.. describe:: print - reply to message + print message(s) optional arguments - :---all: reply to all. - :---list: reply to list. - :---spawn: open editor in new window. + :---all: print all messages. + :---raw: pass raw mail string. + :---separately: call print command once for each message. + :---add_tags: add 'Tags' header to the message. -.. _cmd.thread.save: +.. _cmd.thread.indent: -.. describe:: save +.. describe:: indent - save attachment(s) + change message/reply indentation argument - path to save to + None - optional arguments - :---all: save all attachments. -.. _cmd.thread.toggletags: +.. _cmd.thread.pipeto: -.. describe:: toggletags +.. describe:: pipeto - flip presence of tags on message(s) + 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'). - -.. _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 - + :---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'). -- cgit v1.2.3