aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRobin Jarry <robin@jarry.cc>2023-07-05 23:10:39 +0200
committerRobin Jarry <robin@jarry.cc>2023-07-17 10:24:17 +0200
commit4c514ce4d15fd14cad528cf426bc3f853efe7f64 (patch)
treefa52247b470a6af233a6e242962ed20e4831a555 /doc
parent11e5390fa0acbcc609ca177777548dd2d725afbc (diff)
downloadaerc-4c514ce4d15fd14cad528cf426bc3f853efe7f64.tar.gz
compose: allow changing edit-headers on the fly
Add -e|-E flags to all compose commands to allow switching between edit-headers = true/false without restarting aerc. Signed-off-by: Robin Jarry <robin@jarry.cc> Tested-by: Bence Ferdinandy <bence@ferdinandy.com> Tested-by: Koni Marti <koni.marti@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/aerc.1.scd54
1 files changed, 45 insertions, 9 deletions
diff --git a/doc/aerc.1.scd b/doc/aerc.1.scd
index 5a7c9fc4..ab1333f8 100644
--- a/doc/aerc.1.scd
+++ b/doc/aerc.1.scd
@@ -159,19 +159,31 @@ message list, the message in the message viewer, etc).
_month_: Messages are stored in folders per year and subfolders per month
-*:accept*
+*:accept* [*-e*|*-E*]
Accepts an iCalendar meeting invitation.
-*:accept-tentative*
+ *-e*: Forces *[compose].edit-headers* = _true_ for this message only.
+
+ *-E*: Forces *[compose].edit-headers* = _false_ for this message only.
+
+*:accept-tentative* [*-e*|*-E*]
Accepts an iCalendar meeting invitation tentatively.
+ *-e*: Forces *[compose].edit-headers* = _true_ for this message only.
+
+ *-E*: Forces *[compose].edit-headers* = _false_ for this message only.
+
*:copy* _<target>_++
*:cp* _<target>_
Copies the selected message to the target folder.
-*:decline*
+*:decline* [*-e*|*-E*]
Declines an iCalendar meeting invitation.
+ *-e*: Forces *[compose].edit-headers* = _true_ for this message only.
+
+ *-E*: Forces *[compose].edit-headers* = _false_ for this message only.
+
*:delete*++
*:delete-message*
Deletes the selected message.
@@ -185,7 +197,7 @@ message list, the message in the message viewer, etc).
User-defined format specifier requiring two _%s_ for the key and
value strings. Default format: _%-20.20s: %s_
-*:recall* [*-f*]
+*:recall* [*-f*] [*-e*|*-E*]
Opens the selected message for re-editing. Messages can only be
recalled from the postpone directory. The original message is deleted.
@@ -193,7 +205,11 @@ message list, the message in the message viewer, etc).
directory. The original message will be deleted only if it is in the
postpone directory.
-*:forward* [*-A*|*-F*] [*-T* _<template-file>_] [_<address>_...]
+ *-e*: Forces *[compose].edit-headers* = _true_ for this message only.
+
+ *-E*: Forces *[compose].edit-headers* = _false_ for this message only.
+
+*:forward* [*-A*|*-F*] [*-T* _<template-file>_] [*-e*|*-E*] [_<address>_...]
Opens the composer to forward the selected message to another recipient.
*-A*: Forward the message and all attachments.
@@ -206,6 +222,10 @@ message list, the message in the message viewer, etc).
is set as *forwards* in the *[templates]* section of
_aerc.conf_.
+ *-e*: Forces *[compose].edit-headers* = _true_ for this message only.
+
+ *-E*: Forces *[compose].edit-headers* = _false_ for this message only.
+
*:move* _<target>_++
*:mv* _<target>_
Moves the selected message to the target folder.
@@ -233,7 +253,7 @@ message list, the message in the message viewer, etc).
_[PATCH X/Y]_), all marked messages will be sorted by subject to ensure
that the patches are applied in order.
-*:reply* [*-acq*] [*-T* _<template-file>_]
+*:reply* [*-acq*] [*-T* _<template-file>_] [*-e*|*-E*]
Opens the composer to reply to the selected message.
*-a*: Reply all
@@ -248,6 +268,10 @@ message list, the message in the message viewer, etc).
message body. If *-q* is specified, defaults to what is set as
*quoted-reply* in the *[templates]* section of _aerc.conf_.
+ *-e*: Forces *[compose].edit-headers* = _true_ for this message only.
+
+ *-E*: Forces *[compose].edit-headers* = _false_ for this message only.
+
*:read* [*-t*]
Marks the marked or selected messages as read.
@@ -288,12 +312,16 @@ message list, the message in the message viewer, etc).
*:modify-labels* _+inbox_ _-spam_ _unread_
-*:unsubscribe*
+*:unsubscribe* [*-e*|*-E*]
Attempt to automatically unsubscribe the user from the mailing list through
use of the List-Unsubscribe header. If supported, aerc may open a compose
window pre-filled with the unsubscribe information or open the unsubscribe
URL in a web browser.
+ *-e*: Forces *[compose].edit-headers* = _true_ for this message only.
+
+ *-E*: Forces *[compose].edit-headers* = _false_ for this message only.
+
## MESSAGE LIST COMMANDS
*:clear* [*-s*]
@@ -312,7 +340,7 @@ message list, the message in the message viewer, etc).
check-mail-cmd to be set in order for aerc to initiate a check for new mail.
Issuing a manual *:check-mail* command will reset the timer for automatic checking.
-*:compose* [*-H* _"<header>: <value>"_] [*-T* _<template-file>_] [_<body>_]
+*:compose* [*-H* _"<header>: <value>"_] [*-T* _<template-file>_] [*-e*|*-E*] [_<body>_]
Open the compose window to send a new email. The new email will be sent with
the current account's outgoing transport configuration. For details on
configuring outgoing mail delivery consult *aerc-accounts*(5).
@@ -326,6 +354,10 @@ message list, the message in the message viewer, etc).
Use the specified template file for creating the initial
message body.
+ *-e*: Forces *[compose].edit-headers* = _true_ for this message only.
+
+ *-E*: Forces *[compose].edit-headers* = _false_ for this message only.
+
_<body>_: The initial message body.
*:filter* [_<options>_] _<terms>_...
@@ -558,9 +590,13 @@ message list, the message in the message viewer, etc).
Sets the Cc or Bcc header to the given addresses. If an editor for the header
is not currently visible in the compose window, a new one will be added.
-*:edit*
+*:edit* [*-e*|*-E*]
(Re-)opens your text editor to edit the message in progress.
+ *-e*: Forces *[compose].edit-headers* = _true_ for this message only.
+
+ *-E*: Forces *[compose].edit-headers* = _false_ for this message only.
+
*:multipart* [*-d*] _<mime/type>_
Makes the message to multipart/alternative and add the specified
_<mime/type>_ part. Only the MIME types that are configured in the