diff options
author | Dylan Baker <dylan@pnwbakers.com> | 2018-02-28 08:45:03 -0800 |
---|---|---|
committer | Dylan Baker <dylan@pnwbakers.com> | 2018-03-01 10:35:20 -0800 |
commit | 92206052f1a5169f3337b1bc14327fcdbd86c878 (patch) | |
tree | 99c8b1d5294216ab61509db6f03661d9465aa675 /docs | |
parent | 2879419806d40d4eb53d4601487781e70a86846c (diff) |
docs: update generated docs
It seems like a bunch of stuff is now rendered in a different order.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/usage/modes/bufferlist.rst | 12 | ||||
-rw-r--r-- | docs/source/usage/modes/envelope.rst | 158 | ||||
-rw-r--r-- | docs/source/usage/modes/global.rst | 180 | ||||
-rw-r--r-- | docs/source/usage/modes/search.rst | 90 | ||||
-rw-r--r-- | docs/source/usage/modes/thread.rst | 196 |
5 files changed, 318 insertions, 318 deletions
diff --git a/docs/source/usage/modes/bufferlist.rst b/docs/source/usage/modes/bufferlist.rst index 7de661e9..c8be65c1 100644 --- a/docs/source/usage/modes/bufferlist.rst +++ b/docs/source/usage/modes/bufferlist.rst @@ -5,17 +5,17 @@ Commands in `bufferlist` mode ----------------------------- The following commands are available in bufferlist mode -.. _cmd.bufferlist.close: +.. _cmd.bufferlist.open: -.. describe:: close +.. describe:: open - close focussed buffer + focus selected buffer -.. _cmd.bufferlist.open: +.. _cmd.bufferlist.close: -.. describe:: open +.. describe:: close - focus selected buffer + close focussed buffer diff --git a/docs/source/usage/modes/envelope.rst b/docs/source/usage/modes/envelope.rst index 8644a6c1..be612216 100644 --- a/docs/source/usage/modes/envelope.rst +++ b/docs/source/usage/modes/envelope.rst @@ -5,65 +5,62 @@ Commands in `envelope` mode --------------------------- The following commands are available in envelope mode -.. _cmd.envelope.unencrypt: - -.. describe:: unencrypt - - remove request to encrypt message before sending +.. _cmd.envelope.edit: +.. describe:: edit -.. _cmd.envelope.set: + edit mail -.. describe:: set + optional arguments + :---spawn: spawn editor in new terminal. + :---refocus: refocus envelope after editing (Defaults to: 'True'). - set header value +.. _cmd.envelope.save: - positional arguments - 0: header to refine - 1: value +.. describe:: save + save draft - 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: +.. _cmd.envelope.tag: -.. describe:: togglesign +.. describe:: tag - toggle sign status + add tags to message argument - which key id to use + comma separated list of tags -.. _cmd.envelope.toggleheaders: +.. _cmd.envelope.refine: -.. describe:: toggleheaders +.. describe:: refine - toggle display of all headers + prompt to change the value of a header + argument + header to refine -.. _cmd.envelope.edit: -.. describe:: edit +.. _cmd.envelope.togglesign: - edit mail +.. describe:: togglesign + + toggle sign status + + argument + which key id to use - optional arguments - :---spawn: spawn editor in new terminal. - :---refocus: refocus envelope after editing (Defaults to: 'True'). .. _cmd.envelope.retag: @@ -75,41 +72,43 @@ The following commands are available in envelope mode comma separated list of tags -.. _cmd.envelope.tag: +.. _cmd.envelope.unattach: -.. describe:: tag +.. describe:: unattach - add tags to message + remove attachments from current envelope argument - comma separated list of tags + which attached file to remove -.. _cmd.envelope.send: +.. _cmd.envelope.toggleheaders: -.. describe:: send +.. describe:: toggleheaders - send mail + toggle display of all headers -.. _cmd.envelope.sign: +.. _cmd.envelope.encrypt: -.. describe:: sign +.. describe:: encrypt - mark mail to be signed before sending + request encryption of message before sendout argument - which key id to use + keyid of the key to encrypt with + optional arguments + :---trusted: only add trusted keys. -.. _cmd.envelope.untag: +.. _cmd.envelope.unset: -.. describe:: untag +.. describe:: unset - remove tags from message + remove header field argument - comma separated list of tags + header to refine .. _cmd.envelope.attach: @@ -122,60 +121,57 @@ The following commands are available in envelope mode file(s) to attach (accepts wildcads) -.. _cmd.envelope.unattach: +.. _cmd.envelope.toggleencrypt: -.. describe:: unattach +.. describe:: toggleencrypt - remove attachments from current envelope + toggle if message should be encrypted before sendout argument - which attached file to remove + keyid of the key to encrypt with + optional arguments + :---trusted: only add trusted keys. -.. _cmd.envelope.rmencrypt: +.. _cmd.envelope.untag: -.. describe:: rmencrypt +.. describe:: untag - do not encrypt to given recipient key + remove tags from message argument - keyid of the key to encrypt with + comma separated list of tags -.. _cmd.envelope.refine: +.. _cmd.envelope.sign: -.. describe:: refine +.. describe:: sign - prompt to change the value of a header + mark mail to be signed before sending argument - header to refine - - -.. _cmd.envelope.toggleencrypt: + which key id to use -.. describe:: toggleencrypt - toggle if message should be encrypted before sendout - - argument - keyid of the key to encrypt with +.. _cmd.envelope.set: - optional arguments - :---trusted: only add trusted keys. +.. describe:: set -.. _cmd.envelope.save: + set header value -.. describe:: save + positional arguments + 0: header to refine + 1: value - save draft + optional arguments + :---append: keep previous values. -.. _cmd.envelope.unsign: +.. _cmd.envelope.unencrypt: -.. describe:: unsign +.. describe:: unencrypt - mark mail not to be signed before sending + remove request to encrypt message before sending .. _cmd.envelope.toggletags: @@ -188,13 +184,17 @@ The following commands are available in envelope mode comma separated list of tags -.. _cmd.envelope.unset: +.. _cmd.envelope.unsign: -.. describe:: unset +.. describe:: unsign - remove header field + mark mail not to be signed before sending - argument - header to refine + +.. _cmd.envelope.send: + +.. describe:: send + + send mail diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst index dcbe4040..672e43d5 100644 --- a/docs/source/usage/modes/global.rst +++ b/docs/source/usage/modes/global.rst @@ -5,21 +5,40 @@ Global Commands --------------- The following commands are available globally -.. _cmd.global.bclose: +.. _cmd.global.call: -.. describe:: bclose +.. describe:: call - close a buffer + Executes python code - optional arguments - :---redraw: redraw current buffer after command has finished. - :---force: never ask for confirmation. + argument + python command string to call -.. _cmd.global.bprevious: -.. describe:: bprevious +.. _cmd.global.refresh: - focus previous buffer +.. describe:: refresh + + refresh the current buffer + + +.. _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.flush: + +.. describe:: flush + + flush write operations or retry until committed .. _cmd.global.search: @@ -35,53 +54,52 @@ 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: +.. _cmd.global.move: -.. describe:: prompt +.. describe:: move - prompts for commandline and interprets it upon select + move focus in current buffer argument - initial content - - -.. _cmd.global.help: + up, down, [half]page up, [half]page down, first, last -.. describe:: help - display help for a command. Use 'bindings' to display all keybings - interpreted in current mode.' +.. _cmd.global.taglist: - argument - command or 'bindings' +.. describe:: taglist + opens taglist buffer -.. _cmd.global.buffer: + optional arguments + :---tags: tags to display. -.. describe:: buffer +.. _cmd.global.bufferlist: - focus buffer with given index +.. describe:: bufferlist - argument - buffer index to focus + open a list of active buffers -.. _cmd.global.move: +.. _cmd.global.compose: -.. describe:: move +.. describe:: compose - move focus in current buffer + compose a new email argument - up, down, [half]page up, [half]page down, first, last + None + optional arguments + :---sender: sender. + :---template: path to a template message file. + :---tags: comma-separated list of tags to apply to message. + :---subject: subject line. + :---to: recipients. + :---cc: copy to. + :---bcc: blind copy to. + :---attach: attach files. + :---omit_signature: do not add signature. + :---spawn: spawn editor in new terminal. .. _cmd.global.shellescape: @@ -97,97 +115,79 @@ The following commands are available globally :---thread: run in separate thread. :---refocus: refocus current buffer after command has finished. -.. _cmd.global.refresh: - -.. describe:: refresh - - refresh the current buffer - +.. _cmd.global.bprevious: -.. _cmd.global.reload: +.. describe:: bprevious -.. describe:: reload + focus previous buffer - Reload all configuration files +.. _cmd.global.prompt: -.. _cmd.global.pyshell: +.. describe:: prompt -.. describe:: pyshell + prompts for commandline and interprets it upon select - open an interactive python shell for introspection + argument + initial content -.. _cmd.global.compose: +.. _cmd.global.help: -.. describe:: compose +.. describe:: help - compose a new email + display help for a command. Use 'bindings' to display all keybings + interpreted in current mode.' argument - None - - optional arguments - :---sender: sender. - :---template: path to a template message file. - :---tags: comma-separated list of tags to apply to message. - :---subject: subject line. - :---to: recipients. - :---cc: copy to. - :---bcc: blind copy to. - :---attach: attach files. - :---omit_signature: do not add signature. - :---spawn: spawn editor in new terminal. + command or 'bindings' -.. _cmd.global.exit: -.. describe:: exit +.. _cmd.global.bclose: - Shut down cleanly. +.. describe:: bclose - 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. - + close a buffer + optional arguments + :---redraw: redraw current buffer after command has finished. + :---force: never ask for confirmation. -.. _cmd.global.flush: +.. _cmd.global.repeat: -.. describe:: flush +.. describe:: repeat - flush write operations or retry until committed + Repeats the command executed last time -.. _cmd.global.bufferlist: +.. _cmd.global.bnext: -.. describe:: bufferlist +.. describe:: bnext - open a list of active buffers + focus next buffer -.. _cmd.global.call: +.. _cmd.global.buffer: -.. describe:: call +.. describe:: buffer - Executes python code + focus buffer with given index argument - python command string to call + buffer index to focus -.. _cmd.global.bnext: +.. _cmd.global.reload: -.. describe:: bnext +.. describe:: reload - focus next buffer + Reload all configuration files -.. _cmd.global.taglist: +.. _cmd.global.pyshell: -.. describe:: taglist +.. describe:: pyshell - opens taglist buffer + open an interactive python shell for introspection - optional arguments - :---tags: tags to display. diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst index 93a59eff..5dbd0abc 100644 --- a/docs/source/usage/modes/search.rst +++ b/docs/source/usage/modes/search.rst @@ -5,6 +5,19 @@ Commands in `search` mode ------------------------- The following commands are available in search mode +.. _cmd.search.retag: + +.. describe:: retag + + 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.sort: .. describe:: sort @@ -15,6 +28,32 @@ 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.select: + +.. describe:: select + + open thread in a new buffer + + +.. _cmd.search.refine: + +.. describe:: refine + + refine query + + argument + search string + + optional arguments + :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. + .. _cmd.search.untag: .. describe:: untag @@ -38,25 +77,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: @@ -71,41 +102,10 @@ 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.refine: - -.. describe:: refine - - refine query - - argument - search string - - optional arguments - :---sort: 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.toggletags: - -.. describe:: toggletags - - 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'). - -.. _cmd.search.select: +.. _cmd.search.refineprompt: -.. describe:: select +.. describe:: refineprompt - open thread in a new buffer + prompt to change this buffers querystring diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst index 29a7850a..7e98e327 100644 --- a/docs/source/usage/modes/thread.rst +++ b/docs/source/usage/modes/thread.rst @@ -5,52 +5,24 @@ Commands in `thread` mode ------------------------- The following commands are available in thread mode -.. _cmd.thread.pipeto: - -.. describe:: pipeto - - pipe message(s) to stdin of a shellcommand - - 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 - - optional arguments - :---spawn: open editor in new window. - -.. _cmd.thread.move: +.. _cmd.thread.indent: -.. describe:: move +.. describe:: indent - move focus in current buffer + change message/reply indentation 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 + None -.. _cmd.thread.indent: +.. _cmd.thread.unfold: -.. describe:: indent +.. describe:: unfold - change message/reply indentation + unfold message(s) argument - None + query used to filter messages to affect .. _cmd.thread.toggleheaders: @@ -63,11 +35,20 @@ The following commands are available in thread mode query used to filter messages to affect -.. _cmd.thread.retag: +.. _cmd.thread.editnew: -.. describe:: retag +.. describe:: editnew - set message(s) tags. + edit message in as new + + optional arguments + :---spawn: open editor in new window. + +.. _cmd.thread.tag: + +.. describe:: tag + + add tags to message(s) argument comma separated list of tags @@ -76,34 +57,34 @@ 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.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. - -.. _cmd.thread.bounce: - -.. describe:: bounce - - directly re-send selected message - + :---attach: attach original mail. + :---spawn: open editor in new window. -.. _cmd.thread.togglesource: +.. _cmd.thread.pipeto: -.. describe:: togglesource +.. describe:: pipeto - display message source + pipe message(s) to stdin of a shellcommand argument - query used to filter messages to affect + 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.untag: @@ -118,6 +99,35 @@ 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: + +.. describe:: remove + + remove message(s) from the index + + optional arguments + :---all: remove whole thread. + +.. _cmd.thread.reply: + +.. describe:: reply + + reply to message + + optional arguments + :---all: reply to all. + :---list: reply to list. + :---spawn: open editor in new window. + +.. _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.fold: .. describe:: fold @@ -128,11 +138,11 @@ The following commands are available in thread mode query used to filter messages to affect -.. _cmd.thread.tag: +.. _cmd.thread.retag: -.. describe:: tag +.. describe:: retag - add tags to message(s) + set message(s) tags. argument comma separated list of tags @@ -141,45 +151,47 @@ 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.bounce: -.. describe:: remove +.. describe:: bounce - remove message(s) from the index + directly re-send selected message - optional arguments - :---all: remove whole thread. -.. _cmd.thread.unfold: +.. _cmd.thread.print: -.. describe:: unfold +.. describe:: print - unfold message(s) + print message(s) - argument - query used to filter messages to affect + 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. +.. _cmd.thread.togglesource: -.. _cmd.thread.forward: +.. describe:: togglesource -.. describe:: forward + display message source - forward message + argument + query used to filter messages to affect - optional arguments - :---attach: attach original mail. - :---spawn: open editor in new window. -.. _cmd.thread.reply: +.. _cmd.thread.toggletags: -.. describe:: reply +.. describe:: toggletags - reply to message + flip presence of tags on message(s) + + 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: @@ -193,25 +205,13 @@ The following commands are available in thread mode optional arguments :---all: save all attachments. -.. _cmd.thread.toggletags: +.. _cmd.thread.move: -.. describe:: toggletags +.. describe:: move - flip presence of tags on message(s) + move focus in current buffer argument - comma separated list of tags - - 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 + 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 |