diff options
| author | Robin Jarry <robin@jarry.cc> | 2022-10-12 00:55:49 +0200 |
|---|---|---|
| committer | Robin Jarry <robin@jarry.cc> | 2022-10-16 11:35:20 +0200 |
| commit | c95961fc74585b4284441863c2ebc77a31ea7332 (patch) | |
| tree | 9d087fbcde3920dbb39d0f6fed405cb748f74bfa /doc | |
| parent | 9cf69747ebc9b7d1504e07cec02866e748d57377 (diff) | |
| download | aerc-c95961fc74585b4284441863c2ebc77a31ea7332.tar.gz | |
filters: append well known dirs to exec PATH
To allow referencing built-in filters without hard coding a path during
installation, append the following folders to the exec PATH when running
the filter commands:
~/.config/aerc/filters
~/.local/share/aerc/filters
$PREFIX/share/aerc/filters
/usr/share/aerc/filters
If a filter script has the same name than a command in the default exec
PATH, it will not shadow it. In that edge case, the absolute path to the
filter script must be specified.
Suggested-by: Teo Luppi <me@luppi.uk>
Signed-off-by: Robin Jarry <robin@jarry.cc>
Acked-by: Moritz Poldrack <moritz@poldrack.dev>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/aerc-config.5.scd | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd index 78a39e39..9be0cb27 100644 --- a/doc/aerc-config.5.scd +++ b/doc/aerc-config.5.scd @@ -510,6 +510,16 @@ aerc ships with some default filters installed in the share directory (usually _/usr/share/aerc/filters_). Note that these may have additional dependencies that aerc does not have alone. +The filter commands are invoked with sh -c [command]. The following folders are +appended to the system $PATH to allow referencing filters from their name only. + +``` +${XDG_CONFIG_HOME:-~/.config}/aerc/filters +${XDG_DATA_HOME:-~/.local/share}/aerc/filters +$PREFIX/share/aerc/filters +/usr/share/aerc/filters +``` + Note that said email body is converted into UTF-8 before being passed to filters. |