diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/aerc-notmuch.5.scd | 24 | ||||
-rw-r--r-- | doc/aerc.1.scd | 23 |
2 files changed, 37 insertions, 10 deletions
diff --git a/doc/aerc-notmuch.5.scd b/doc/aerc-notmuch.5.scd index 6837f720..202f20fd 100644 --- a/doc/aerc-notmuch.5.scd +++ b/doc/aerc-notmuch.5.scd @@ -68,9 +68,8 @@ options are available: N.B.: aerc will still always show messages and not files (under notmuch, a single message can be represented by several files), which makes the - semantics of certain commands as *move* ambiguous: for example, if you - try to move a message represented by several files, aerc will not know - what to do and thus refuse. + semantics of certain commands as *move* ambiguous. Use *multi-file-strategy* + to tell aerc how to resolve these ambiguities. *maildir-account-path* = _<path>_ Path to the maildir account relative to the *maildir-store*. @@ -78,6 +77,25 @@ options are available: This could be used to achieve traditional maildir one tab per account behavior. The note on *maildir-store* also applies to this option. +*multi-file-stategy* = _<strategy>_ + Strategy for file operations (e.g., move, copy, delete) on messages that are + backed by multiple files. Possible values: + + - *refuse* (default): Refuse to act. + - *act-all*: Act on all files. + - *act-one*: Act on one of the files, arbitrarily chosen, and ignore the + rest. + - *act-one-delete-rest*: Like *act-one*, but delete the remaining files. + - *act-dir*: Act on all files within the current folder and ignore the rest. + Note that this strategy only works within the maildir directories; in other + directories, it behaves like *refuse*. + - *act-dir-delete-rest*: Like *act-dir*, but delete the remaining files. + + Note that the strategy has no effect on cross-account operations. Copying a + message across accounts will always copy a single file, arbitrarily chosen. + Moving a message across accounts will always copy a single file, arbitrarily + chosen, and refuse to delete multiple files from the source account. + # USAGE Notmuch shows slightly different behavior than for example imap. Some commands diff --git a/doc/aerc.1.scd b/doc/aerc.1.scd index af1ce31c..3f52fbac 100644 --- a/doc/aerc.1.scd +++ b/doc/aerc.1.scd @@ -265,7 +265,7 @@ These commands work in any context. These commands are valid in any context that has a selected message (e.g. the message list, the message in the message viewer, etc). -*:archive* _<scheme>_ +*:archive* [*-m* _<strategy>_] _<scheme>_ Moves the selected message to the archive. The available schemes are: _flat_: No special structure, all messages in the archive directory @@ -274,6 +274,9 @@ message list, the message in the message viewer, etc). _month_: Messages are stored in folders per year and subfolders per month + The *-m* option sets the multi-file strategy. See *aerc-notmuch*(5) for more + details. + *:accept* [*-e*|*-E*] Accepts an iCalendar meeting invitation. @@ -288,8 +291,8 @@ message list, the message in the message viewer, etc). *-E*: Forces *[compose].edit-headers* = _false_ for this message only. -*:copy* [*-p*] [*-a* _<account>_] _<folder>_++ -*:cp* [*-p*] [*-a* _<account>_] _<folder>_ +*:copy* [*-p*] [*-a* _<account>_] [*-m* _<strategy>_] _<folder>_++ +*:cp* [*-p*] [*-a* _<account>_] [*-m* _<strategy>_] _<folder>_ Copies the selected message(s) to _<folder>_. *-p*: Create _<folder>_ if it does not exist. @@ -297,6 +300,8 @@ message list, the message in the message viewer, etc). *-a*: Copy to _<folder>_ of _<account>_. If _<folder>_ does not exist, it will be created whether or not *-p* is used. + *-m*: Set the multi-file strategy. See *aerc-notmuch*(5) for more details. + *:decline* [*-e*|*-E*] Declines an iCalendar meeting invitation. @@ -304,10 +309,12 @@ message list, the message in the message viewer, etc). *-E*: Forces *[compose].edit-headers* = _false_ for this message only. -*:delete*++ -*:delete-message* +*:delete* [*-m* _<strategy>_]++ +*:delete-message* [*-m* _<strategy>_] Deletes the selected message. + *-m*: Set the multi-file strategy. See *aerc-notmuch*(5) for more details. + *:envelope* [*-h*] [*-s* _<format-specifier>_] Opens the message envelope in a dialog popup. @@ -351,8 +358,8 @@ message list, the message in the message viewer, etc). *-E*: Forces *[compose].edit-headers* = _false_ for this message only. -*:move* [*-p*] [*-a* _<account>_] _<folder>_++ -*:mv* [*-p*] [*-a* _<account>_] _<folder>_ +*:move* [*-p*] [*-a* _<account>_] [*-m* _<strategy>_] _<folder>_++ +*:mv* [*-p*] [*-a* _<account>_] [*-m* _<strategy>_] _<folder>_ Moves the selected message(s) to _<folder>_. *-p*: Create _<folder>_ if it does not exist. @@ -360,6 +367,8 @@ message list, the message in the message viewer, etc). *-a*: Move to _<folder>_ of _<account>_. If _<folder>_ does not exist, it will be created whether or not *-p* is used. + *-m*: Set the multi-file strategy. See *aerc-notmuch*(5) for more details. + *:patch* _<args ...>_ Patch management sub-commands. See *aerc-patch*(7) for more details. |