diff options
| author | Moritz Poldrack <git@moritz.sh> | 2023-03-04 10:56:47 +0100 |
|---|---|---|
| committer | Robin Jarry <robin@jarry.cc> | 2023-03-07 00:13:03 +0100 |
| commit | d3dea73aa53791a94f86c31689a10880fabeb84c (patch) | |
| tree | ae815295162ff7431d47fd16a2e74d0cb8465222 /doc | |
| parent | c6a08b1003a2cb02d86002541ead0f9b38db1beb (diff) | |
| download | aerc-d3dea73aa53791a94f86c31689a10880fabeb84c.tar.gz | |
ipc: allow triggering internal commands via IPC
In order to make automation easier, it's useful to be able to send
commands to aerc via IPC. This can be done by calling the aerc binary
followed by a colon and the command to run. For example:
aerc :read && aerc :remark && aerc :archive month
Security to ensure no malicious commands are run is deferred to the
user. By default the socket is only writable by the user. This is
considered sufficient as the potential harm an attacker gaining
write-access to a user's session can cause is significantly greater than
"can delete some emails".
To ensure users with an according threat model, it is possible to
disable command IPC. mailto-handling is unaffected even though it works
over IPC as it is absolutely non-destructive.
Signed-off-by: Moritz Poldrack <git@moritz.sh>
Acked-by: Robin Jarry <robin@jarry.cc>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/aerc-config.5.scd | 5 | ||||
| -rw-r--r-- | doc/aerc.1.scd | 4 |
2 files changed, 9 insertions, 0 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd index a04f3be9..4d64a6f4 100644 --- a/doc/aerc-config.5.scd +++ b/doc/aerc-config.5.scd @@ -62,6 +62,11 @@ These options are configured in the *[general]* section of _aerc.conf_. Default: _info_ +*disable-ipc* = _true_|_false_ + Disable the execution of commands over IPC. + + Default: _false_ + # UI OPTIONS These options are configured in the *[ui]* section of _aerc.conf_. diff --git a/doc/aerc.1.scd b/doc/aerc.1.scd index 57d290cc..0dbf5f2a 100644 --- a/doc/aerc.1.scd +++ b/doc/aerc.1.scd @@ -45,6 +45,10 @@ from your terminal. Note that reserved characters in the queries must be percent encoded. +\:*command* [...] + Run an aerc-internal command as you would in Ex-Mode. See *RUNTIME + COMMANDS* below. + # RUNTIME COMMANDS To execute a command, press *:* to bring up the command interface. Commands may |