aerc/README.md

77 lines
2.2 KiB
Markdown
Raw Normal View History

# aerc
[![builds.sr.ht status](https://builds.sr.ht/~rjarry/aerc.svg)](https://builds.sr.ht/~rjarry/aerc)
[aerc](https://sr.ht/~rjarry/aerc/) is an email client for your terminal.
This is a fork of [the original aerc](https://git.sr.ht/~sircmpwn/aerc)
by Drew DeVault.
A short demonstration can be found on [https://aerc-mail.org/](https://aerc-mail.org/)
2021-08-25 06:14:43 +02:00
Join the IRC channel: [#aerc on irc.libera.chat](http://web.libera.chat/?channels=aerc&uio=d4)
for end-user support, and [#aerc-dev](http://web.libera.chat/?channels=aerc-dev&uio=d4)
2019-07-14 19:53:09 +02:00
for development.
2019-05-14 20:47:46 +02:00
2020-12-26 15:56:27 +01:00
## Usage
On its first run, aerc will copy the default config files to `~/.config/aerc`
on Linux or `~/Library/Preferences/aerc` on MacOS (or `$XDG_CONFIG_HOME/aerc` if set)
and show the account configuration wizard.
If you redirect stdout to a file, logging output will be written to that file:
$ aerc > log
For instructions and documentation: see `man aerc` and further specific man
pages on there.
Note that the example HTML filter (off by default), additionally needs `w3m` and
`dante` to be installed.
## Installation
### Binary Packages
Recent versions of aerc are available on:
- [Alpine](https://pkgs.alpinelinux.org/packages?name=aerc)
- [Arch](https://archlinux.org/packages/community/x86_64/aerc/)
- [macOS through Homebrew](https://formulae.brew.sh/formula/aerc)
And likely other platforms.
### From Source
2019-05-25 21:55:50 +02:00
Install the dependencies:
2019-05-18 00:15:50 +02:00
- go (>=1.13)
2020-02-02 07:13:59 +01:00
- [scdoc](https://git.sr.ht/~sircmpwn/scdoc)
2019-05-18 00:15:50 +02:00
2019-05-25 21:55:50 +02:00
Then compile aerc:
2019-05-17 19:45:20 +02: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
2020-12-26 15:56:27 +01:00
To install aerc locally:
2019-05-17 19:45:20 +02:00
# make install
2019-05-26 18:00:51 +02:00
## Resources
2020-12-26 15:56:27 +01:00
Send patches and questions to
[~rjarry/aerc-devel@lists.sr.ht](https://lists.sr.ht/~rjarry/aerc-devel).
2020-12-26 15:56:27 +01:00
Instructions for preparing a patch are available at
[git-send-email.io](https://git-send-email.io)
2019-05-26 18:00:51 +02:00
Subscribe to release announcements on
[~rjarry/aerc-announce@lists.sr.ht](https://lists.sr.ht/~rjarry/aerc-announce)
2019-03-17 22:47:35 +01:00
Submit bug reports and feature requests on
[https://todo.sr.ht/~rjarry/aerc](https://todo.sr.ht/~rjarry/aerc).