diff options
Diffstat (limited to 'docs/source/usage/modes/envelope.rst')
| -rw-r--r-- | docs/source/usage/modes/envelope.rst | 156 |
1 files changed, 78 insertions, 78 deletions
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 |