From 72fe673a82b5b973951e3d5612a16089903f0b47 Mon Sep 17 00:00:00 2001 From: Dylan Baker Date: Wed, 28 Feb 2018 09:21:30 -0800 Subject: docs: regenerate again, hopefully for the last time --- docs/source/usage/modes/envelope.rst | 176 +++++++++++++++---------------- docs/source/usage/modes/global.rst | 174 +++++++++++++++---------------- docs/source/usage/modes/search.rst | 86 +++++++-------- docs/source/usage/modes/thread.rst | 196 +++++++++++++++++------------------ 4 files changed, 316 insertions(+), 316 deletions(-) (limited to 'docs') diff --git a/docs/source/usage/modes/envelope.rst b/docs/source/usage/modes/envelope.rst index 263705b9..ee857cc4 100644 --- a/docs/source/usage/modes/envelope.rst +++ b/docs/source/usage/modes/envelope.rst @@ -5,143 +5,143 @@ Commands in `envelope` mode --------------------------- The following commands are available in envelope mode -.. _cmd.envelope.toggleheaders: +.. _cmd.envelope.attach: -.. describe:: toggleheaders +.. describe:: attach - toggle display of all headers + attach files to the mail + argument + file(s) to attach (accepts wildcads) -.. _cmd.envelope.unattach: -.. describe:: unattach +.. _cmd.envelope.edit: - remove attachments from current envelope +.. describe:: edit - argument - which attached file to remove + edit mail + optional arguments + :---spawn: spawn editor in new terminal. + :---refocus: refocus envelope after editing (Defaults to: 'True'). -.. _cmd.envelope.rmencrypt: +.. _cmd.envelope.encrypt: -.. describe:: rmencrypt +.. describe:: encrypt - do not encrypt to given recipient key + request encryption of message before sendout argument keyid of the key to encrypt with + 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 + header to refine -.. _cmd.envelope.unencrypt: +.. _cmd.envelope.retag: -.. describe:: unencrypt +.. describe:: retag - remove request to encrypt message before sending + set message tags. + argument + comma separated list of tags -.. _cmd.envelope.send: -.. describe:: send +.. _cmd.envelope.rmencrypt: - send mail +.. describe:: rmencrypt + do not encrypt to given recipient key -.. _cmd.envelope.tag: + argument + keyid of the key to encrypt with -.. describe:: tag - add tags to message +.. _cmd.envelope.save: - argument - comma separated list of tags +.. describe:: save + save draft -.. _cmd.envelope.retag: -.. describe:: retag +.. _cmd.envelope.send: - set message tags. +.. describe:: send - argument - comma separated list of tags + send mail -.. _cmd.envelope.encrypt: +.. _cmd.envelope.set: -.. describe:: encrypt +.. describe:: set - request encryption of message before sendout + set header value + + positional arguments + 0: header to refine + 1: value - argument - keyid of the key to encrypt with optional arguments - :---trusted: only add trusted keys. + :---append: keep previous values. -.. _cmd.envelope.toggleencrypt: +.. _cmd.envelope.sign: -.. describe:: toggleencrypt +.. describe:: sign - toggle if message should be encrypted before sendout + mark mail to be signed before sending argument - keyid of the key to encrypt with - - optional arguments - :---trusted: only add trusted keys. - -.. _cmd.envelope.unsign: - -.. describe:: unsign + which key id to use - mark mail not to be signed before sending +.. _cmd.envelope.tag: -.. _cmd.envelope.save: +.. describe:: tag -.. describe:: save + add tags to message - save draft + argument + comma separated list of tags -.. _cmd.envelope.untag: +.. _cmd.envelope.toggleencrypt: -.. describe:: untag +.. describe:: toggleencrypt - remove tags from message + toggle if message should be encrypted before sendout argument - comma separated list of tags + keyid of the key to encrypt with + optional arguments + :---trusted: only add trusted keys. -.. _cmd.envelope.edit: +.. _cmd.envelope.toggleheaders: -.. describe:: edit +.. describe:: toggleheaders - edit mail + toggle display of all headers - optional arguments - :---spawn: spawn editor in new terminal. - :---refocus: refocus envelope after editing (Defaults to: 'True'). -.. _cmd.envelope.unset: +.. _cmd.envelope.togglesign: -.. describe:: unset +.. describe:: togglesign - remove header field + toggle sign status argument - header to refine + which key id to use .. _cmd.envelope.toggletags: @@ -154,47 +154,47 @@ The following commands are available in envelope mode comma separated list of tags -.. _cmd.envelope.sign: +.. _cmd.envelope.unattach: -.. describe:: sign +.. describe:: unattach - mark mail to be signed before sending + remove attachments from current envelope argument - which key id to use + which attached file to remove -.. _cmd.envelope.refine: - -.. describe:: refine +.. _cmd.envelope.unencrypt: - prompt to change the value of a header +.. describe:: unencrypt - argument - header to refine + remove request to encrypt message before sending -.. _cmd.envelope.attach: +.. _cmd.envelope.unset: -.. describe:: attach +.. describe:: unset - attach files to the mail + remove header field argument - file(s) to attach (accepts wildcads) + header to refine -.. _cmd.envelope.set: +.. _cmd.envelope.unsign: -.. describe:: set +.. describe:: unsign - set header value + mark mail not to be signed before sending - positional arguments - 0: header to refine - 1: value +.. _cmd.envelope.untag: + +.. describe:: untag + + remove tags from message + + argument + comma separated list of tags - optional arguments - :---append: keep previous values. diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst index ee3955fd..6e79c67a 100644 --- a/docs/source/usage/modes/global.rst +++ b/docs/source/usage/modes/global.rst @@ -5,41 +5,38 @@ Global Commands --------------- The following commands are available globally -.. _cmd.global.search: - -.. describe:: search +.. _cmd.global.bclose: - open a new search buffer. Search obeys the notmuch - :ref:`search.exclude_tags ` setting. +.. describe:: bclose - argument - search string + close a buffer optional arguments - :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. + :---redraw: redraw current buffer after command has finished. + :---force: never ask for confirmation. -.. _cmd.global.prompt: +.. _cmd.global.bnext: -.. describe:: prompt +.. describe:: bnext - prompts for commandline and interprets it upon select + focus next buffer - argument - initial content +.. _cmd.global.bprevious: -.. _cmd.global.bnext: +.. describe:: bprevious -.. describe:: bnext + focus previous buffer - focus next buffer +.. _cmd.global.buffer: -.. _cmd.global.reload: +.. describe:: buffer -.. describe:: reload + focus buffer with given index - Reload all configuration files + argument + buffer index to focus .. _cmd.global.bufferlist: @@ -49,15 +46,36 @@ The following commands are available globally open a list of active buffers -.. _cmd.global.bclose: +.. _cmd.global.call: -.. describe:: bclose +.. describe:: call - close a buffer + Executes python code + + argument + python command string to call + + +.. _cmd.global.compose: + +.. describe:: compose + + compose a new email + + argument + None optional arguments - :---redraw: redraw current buffer after command has finished. - :---force: never ask for confirmation. + :---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.exit: @@ -71,19 +89,12 @@ The following commands are available globally -.. _cmd.global.shellescape: +.. _cmd.global.flush: -.. describe:: shellescape +.. describe:: flush - run external command + flush write operations or retry until committed - 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.help: @@ -96,98 +107,87 @@ The following commands are available globally 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 - - -.. _cmd.global.taglist: - -.. describe:: taglist - - opens taglist buffer + up, down, [half]page up, [half]page down, first, last - optional arguments - :---tags: tags to display. -.. _cmd.global.compose: +.. _cmd.global.prompt: -.. describe:: compose +.. describe:: prompt - compose a new email + prompts for commandline and interprets it upon select argument - None + initial content - 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.bprevious: +.. _cmd.global.pyshell: -.. describe:: bprevious +.. describe:: pyshell - focus previous buffer + open an interactive python shell for introspection -.. _cmd.global.buffer: +.. _cmd.global.refresh: -.. describe:: buffer +.. describe:: refresh - focus buffer with given index + refresh the current buffer - argument - buffer index to focus +.. _cmd.global.reload: -.. _cmd.global.flush: +.. describe:: reload -.. describe:: flush + Reload all configuration files - flush write operations or retry until committed +.. _cmd.global.repeat: -.. _cmd.global.refresh: +.. describe:: repeat -.. describe:: refresh + Repeats the command executed last time - refresh the current buffer +.. _cmd.global.search: -.. _cmd.global.repeat: +.. describe:: search -.. describe:: repeat + open a new search buffer. Search obeys the notmuch + :ref:`search.exclude_tags ` setting. - Repeats the command executed last time + argument + search string + optional arguments + :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. -.. _cmd.global.pyshell: +.. _cmd.global.shellescape: -.. describe:: pyshell +.. describe:: shellescape - open an interactive python shell for introspection + run external command + argument + command line to execute -.. _cmd.global.move: + optional arguments + :---spawn: run in terminal window. + :---thread: run in separate thread. + :---refocus: refocus current buffer after command has finished. -.. describe:: move +.. _cmd.global.taglist: - move focus in current buffer +.. describe:: taglist - argument - up, down, [half]page up, [half]page down, first, last + opens taglist buffer + optional arguments + :---tags: tags to display. diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst index ed632e83..c95d1a01 100644 --- a/docs/source/usage/modes/search.rst +++ b/docs/source/usage/modes/search.rst @@ -5,28 +5,40 @@ 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.retagprompt: +.. _cmd.search.refine: -.. describe:: retagprompt +.. describe:: refine - prompt to retag selected threads' tags + refine query + argument + search string -.. _cmd.search.untag: + optional arguments + :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. -.. describe:: untag +.. _cmd.search.refineprompt: - remove tags from all messages in the thread that match the query +.. describe:: refineprompt + + prompt to change this buffers querystring + + +.. _cmd.search.retag: + +.. describe:: retag + + set tags of all messages in the thread that match the current query argument comma separated list of tags @@ -35,27 +47,29 @@ 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.move: +.. _cmd.search.retagprompt: -.. describe:: move +.. describe:: retagprompt - move focus in search buffer + prompt to retag selected threads' tags - argument - last +.. _cmd.search.select: -.. _cmd.search.toggletags: +.. describe:: select -.. describe:: toggletags + open thread in a new buffer - 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. + +.. _cmd.search.sort: + +.. describe:: sort + + set sort order argument - comma separated list of tags + sort order. valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. - optional arguments - :---no-flush: postpone a writeout to the index (Defaults to: 'True'). .. _cmd.search.tag: @@ -70,30 +84,23 @@ 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: +.. _cmd.search.toggletags: -.. describe:: refine +.. describe:: toggletags - refine 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 - search string + comma separated list of tags optional arguments - :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. - -.. _cmd.search.refineprompt: - -.. describe:: refineprompt - - prompt to change this buffers querystring - + :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -.. _cmd.search.retag: +.. _cmd.search.untag: -.. describe:: retag +.. describe:: untag - set tags of all messages in the thread that match the current query + remove tags from all messages in the thread that match the query argument comma separated list of tags @@ -102,10 +109,3 @@ 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.select: - -.. describe:: select - - open thread in a new buffer - - diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst index 01c9db9c..447e543a 100644 --- a/docs/source/usage/modes/thread.rst +++ b/docs/source/usage/modes/thread.rst @@ -5,34 +5,11 @@ Commands in `thread` mode ------------------------- The following commands are available in thread mode -.. _cmd.thread.toggleheaders: - -.. describe:: toggleheaders - - display all headers - - argument - query used to filter messages to affect - - -.. _cmd.thread.move: - -.. describe:: move - - move focus in current buffer - - 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 - - -.. _cmd.thread.unfold: - -.. describe:: unfold +.. _cmd.thread.bounce: - unfold message(s) +.. describe:: bounce - argument - query used to filter messages to affect + directly re-send selected message .. _cmd.thread.editnew: @@ -44,16 +21,15 @@ The following commands are available in thread mode optional arguments :---spawn: open editor in new window. -.. _cmd.thread.reply: +.. _cmd.thread.fold: -.. describe:: reply +.. describe:: fold - reply to message + fold message(s) + + argument + query used to filter messages to affect - optional arguments - :---all: reply to all. - :---list: reply to list. - :---spawn: open editor in new window. .. _cmd.thread.forward: @@ -65,43 +41,56 @@ The following commands are available in thread mode :---attach: attach original mail. :---spawn: open editor in new window. -.. _cmd.thread.bounce: +.. _cmd.thread.indent: -.. describe:: bounce +.. describe:: indent - directly re-send selected message + change message/reply indentation + + argument + None -.. _cmd.thread.select: +.. _cmd.thread.move: -.. describe:: select +.. describe:: move - 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 + move focus in current buffer + 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 -.. _cmd.thread.save: -.. describe:: save +.. _cmd.thread.pipeto: - save attachment(s) +.. describe:: pipeto + + pipe message(s) to stdin of a shellcommand argument - path to save to + shellcommand to pipe to optional arguments - :---all: save all attachments. - -.. _cmd.thread.fold: + :---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'). -.. describe:: fold +.. _cmd.thread.print: - fold message(s) +.. describe:: print - argument - query used to filter messages to affect + print message(s) + 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.remove: @@ -112,11 +101,22 @@ The following commands are available in thread mode optional arguments :---all: remove whole thread. -.. _cmd.thread.untag: +.. _cmd.thread.reply: -.. describe:: untag +.. describe:: reply - remove tags from message(s) + reply to message + + optional arguments + :---all: reply to all. + :---list: reply to list. + :---spawn: open editor in new window. + +.. _cmd.thread.retag: + +.. describe:: retag + + set message(s) tags. argument comma separated list of tags @@ -125,28 +125,26 @@ 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.togglesource: +.. _cmd.thread.save: -.. describe:: togglesource +.. describe:: save - display message source + save attachment(s) argument - query used to filter messages to affect - + path to save to -.. _cmd.thread.toggletags: + optional arguments + :---all: save all attachments. -.. describe:: toggletags +.. _cmd.thread.select: - flip presence of tags on message(s) +.. describe:: select - argument - comma separated list of tags + 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 - optional arguments - :---all: tag all messages in thread. - :---no-flush: postpone a writeout to the index (Defaults to: 'True'). .. _cmd.thread.tag: @@ -161,57 +159,59 @@ 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.retag: +.. _cmd.thread.toggleheaders: -.. describe:: retag +.. describe:: toggleheaders - set message(s) tags. + display all headers argument - comma separated list of tags + query used to filter messages to affect - optional arguments - :---all: tag all messages in thread. - :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -.. _cmd.thread.print: +.. _cmd.thread.togglesource: -.. describe:: print +.. describe:: togglesource - print message(s) + display message source + + argument + query used to filter messages to affect + + +.. _cmd.thread.toggletags: + +.. describe:: toggletags + + flip presence of tags on message(s) + + argument + comma separated list of tags 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. + :---all: tag all messages in thread. + :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -.. _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.pipeto: +.. _cmd.thread.untag: -.. describe:: pipeto +.. describe:: untag - pipe message(s) to stdin of a shellcommand + remove tags from message(s) argument - shellcommand to pipe to + comma separated list of tags 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'). + :---all: tag all messages in thread. + :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -- cgit v1.2.3