2019-01-13 20:09:07 -05:00
|
|
|
# aerc
|
|
|
|
|
|
2019-05-25 15:58:40 -04:00
|
|
|
aerc is an email client for your terminal.
|
2019-01-13 20:09:07 -05:00
|
|
|
|
2020-04-06 14:29:12 +02:00
|
|
|
A short demonstration can be found on [https://aerc-mail.org/](https://aerc-mail.org/)
|
|
|
|
|
|
2019-05-14 14:47:46 -04:00
|
|
|
Join the IRC channel: [#aerc on irc.freenode.net](http://webchat.freenode.net/?channels=aerc&uio=d4)
|
2019-07-14 13:53:09 -04:00
|
|
|
for end-user support, and [#aerc-dev](http://webchat.freenode.net/?channels=aerc-dev&uio=d4)
|
|
|
|
|
for development.
|
2019-05-14 14:47:46 -04:00
|
|
|
|
2019-01-13 20:09:07 -05:00
|
|
|
## Building
|
|
|
|
|
|
2019-05-25 15:55:50 -04:00
|
|
|
Install the dependencies:
|
2019-05-17 18:15:50 -04:00
|
|
|
|
2020-04-06 14:29:12 +02:00
|
|
|
- go (>=1.13)
|
2020-02-02 07:13:59 +01:00
|
|
|
- [scdoc](https://git.sr.ht/~sircmpwn/scdoc)
|
2019-05-17 18:15:50 -04:00
|
|
|
|
2019-05-25 15:55:50 -04:00
|
|
|
Then compile aerc:
|
|
|
|
|
|
2019-05-17 13:45:20 -04:00
|
|
|
$ make
|
|
|
|
|
|
2019-08-05 09:16:10 +02:00
|
|
|
aerc optionally supports notmuch. To enable it, you need to have a recent
|
|
|
|
|
version of [notmuch](https://notmuchmail.org/#index7h2), including the header
|
|
|
|
|
files (notmuch.h). Then compile aerc with the necessary build tags:
|
|
|
|
|
|
|
|
|
|
$ GOFLAGS=-tags=notmuch make
|
|
|
|
|
|
2019-05-17 13:45:20 -04:00
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
# make install
|
2019-05-25 15:58:40 -04:00
|
|
|
$ aerc
|
2019-03-21 22:07:03 -04:00
|
|
|
|
2019-05-25 15:58:40 -04:00
|
|
|
On its first run, aerc will copy the default config files to `~/.config/aerc`
|
2020-07-03 21:54:38 +02:00
|
|
|
on Linux or `~/Library/Preferences/aerc` on MacOS and show the account
|
2020-04-12 15:53:44 +02:00
|
|
|
configuration wizard.
|
2019-01-13 20:09:07 -05:00
|
|
|
|
2019-06-12 11:20:49 -05:00
|
|
|
If you redirect stdout to a file, logging output will be written to that file:
|
|
|
|
|
|
|
|
|
|
$ aerc > log
|
|
|
|
|
|
2019-05-26 12:00:51 -04:00
|
|
|
## Resources
|
2019-01-13 20:09:07 -05:00
|
|
|
|
2019-05-26 12:00:51 -04:00
|
|
|
[Send patches](https://git-send-email.io) and questions to
|
|
|
|
|
[~sircmpwn/aerc@lists.sr.ht](https://lists.sr.ht/~sircmpwn/aerc).
|
|
|
|
|
|
|
|
|
|
Subscribe to release announcements on
|
|
|
|
|
[~sircmpwn/aerc-announce](https://lists.sr.ht/~sircmpwn/aerc-announce)
|
2019-03-17 17:47:35 -04:00
|
|
|
|
|
|
|
|
Bugs & todo here: [~sircmpwn/aerc2](https://todo.sr.ht/~sircmpwn/aerc2)
|
