summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorRobert Günzler <r@gnzler.io>2019-06-08 19:41:56 +0200
committerDrew DeVault <sir@cmpwn.com>2019-06-09 11:33:50 -0400
commitacfe7d7625192bc856d5d696f741e35ce38cab25 (patch)
tree64f76ab6927cbb25be95c0ff2e65e063791593a6 /doc
parent35f57321f8d53dba2c1a2480aaa5860333e1c269 (diff)
downloadaerc-acfe7d7625192bc856d5d696f741e35ce38cab25.tar.gz
Add archive command
Adds an archive command that moves the current message into the folder
specified in the account config entry.

Supports three layouts at this point:

- flat: puts all messages next to each other
- year: creates a folder per year
- month: same as above, plus folders per month

This also adds a "-p" argument to "cp" and "mv" that works like
"--parents" on mkdir(1). We use this to auto-create the directories
for the archive layout.
Diffstat (limited to 'doc')
-rw-r--r--doc/aerc-config.5.scd5
-rw-r--r--doc/aerc.1.scd9
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index e002764..caf971d 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -106,6 +106,11 @@ Note that many of these configuration options are written for you, such as
 *source* and *outgoing*, when you run the account configuration wizard
 (*:new-account*).
 
+*archive*
+	Specifies a folder to use as the destination of the *:archive* command.
+
+	Default: Archive
+
 *copy-to*
 	Specifies a folder to copy sent mails to, usually "Sent".
 
diff --git a/doc/aerc.1.scd b/doc/aerc.1.scd
index ca835e5..eab0cb3 100644
--- a/doc/aerc.1.scd
+++ b/doc/aerc.1.scd
@@ -43,6 +43,15 @@ These commands work in any context.
 
 ## MESSAGE LIST COMMANDS
 
+*archive* <scheme>
+	Moves the selected message to the archive. The available schemes are:
+
+	*flat*: No special structure, all messages in the archive directory
+
+	*year*: Messages are stored in folders per year
+
+	*month*: Messages are stored in folders per year and subfolders per month
+
 *cf* <folder>
 	Change the folder shown in the message list.