2019-01-14 01:09:07 +00:00
# aerc
2021-10-30 18:53:37 +00:00
[](https://builds.sr.ht/~rjarry/aerc)
2022-01-28 18:03:20 +00:00
[](https://github.com/rjarry/aerc/actions/workflows/macos.yml)
2021-10-30 18:53:37 +00:00
[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.
2019-01-14 01:09:07 +00:00
2020-04-06 12:29:12 +00:00
A short demonstration can be found on [https://aerc-mail.org/ ](https://aerc-mail.org/ )
2021-08-25 04:14:43 +00:00
Join the IRC channel: [#aerc on irc.libera.chat ](http://web.libera.chat/?channels=aerc&uio=d4 )
2022-02-06 15:35:31 +00:00
for end-user support, and development.
2019-05-14 18:47:46 +00:00
2020-12-26 14:56:27 +00: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
Note that the example HTML filter (off by default), additionally needs `w3m` and
`dante` to be installed.
2022-03-23 19:44:24 +00:00
### Documentation
Also available as man pages:
- [aerc(1) ](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc.1.scd )
- [aerc-config(5) ](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-config.5.scd )
- [aerc-imap(5) ](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-imap.5.scd )
- [aerc-maildir(5) ](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-maildir.5.scd )
- [aerc-notmuch(5) ](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-notmuch.5.scd )
- [aerc-search(1) ](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-search.1.scd )
- [aerc-sendmail(5) ](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-sendmail.5.scd )
- [aerc-smtp(5) ](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-smtp.5.scd )
- [aerc-stylesets(7) ](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-stylesets.7.scd )
- [aerc-templates(7) ](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-templates.7.scd )
- [aerc-tutorial(7) ](https://git.sr.ht/~rjarry/aerc/tree/master/item/doc/aerc-tutorial.7.scd )
User contributions and integration with external tools:
- [wiki ](https://man.sr.ht/~rjarry/aerc/ )
2020-12-26 14:56:27 +00:00
## Installation
### Binary Packages
Recent versions of aerc are available on:
2022-01-20 19:52:11 +00:00
2020-12-26 14:56:27 +00:00
- [Alpine ](https://pkgs.alpinelinux.org/packages?name=aerc )
- [Arch ](https://archlinux.org/packages/community/x86_64/aerc/ )
2022-01-20 19:52:11 +00:00
- [Debian ](https://tracker.debian.org/pkg/aerc )
- [Fedora ](https://packages.fedoraproject.org/pkgs/aerc/aerc/ )
2020-12-26 14:56:27 +00:00
- [macOS through Homebrew ](https://formulae.brew.sh/formula/aerc )
And likely other platforms.
### From Source
2019-01-14 01:09:07 +00:00
2019-05-25 19:55:50 +00:00
Install the dependencies:
2019-05-17 22:15:50 +00:00
2022-08-05 12:29:49 +00:00
- go (>=1.16) *(Go versions are supported until their end-of-life; support for
older versions may be dropped at any time due to incompatibilities or newer
required language features.)*
2020-02-02 06:13:59 +00:00
- [scdoc ](https://git.sr.ht/~sircmpwn/scdoc )
2019-05-17 22:15:50 +00:00
2019-05-25 19:55:50 +00:00
Then compile aerc:
2019-05-17 17:45:20 +00:00
$ make
2019-08-05 07:16:10 +00: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 14:56:27 +00:00
To install aerc locally:
2019-05-17 17:45:20 +00:00
# make install
2019-06-12 16:20:49 +00:00
2022-03-02 03:38:59 +00:00
By default, aerc will install config files to directories under `/usr/local/aerc` ,
and will search for templates and stylesets in these locations in order:
- `${XDG_CONFIG_HOME:-~/.config}/aerc`
- `${XDG_DATA_HOME:-~/.local/share}/aerc`
- `/usr/local/share/aerc`
- `/usr/share/aerc`
At build time it is possible to add an extra location to this list and to use
that location as the default install location for config files by setting the
`PREFIX` option like so:
# make PREFIX=/custom/location
# make install PREFIX=/custom/location
This will install templates and other config files to `/custom/location/share/aerc` ,
and man pages to `/custom/location/share/man` . This extra location will have lower
priority than the XDG locations but higher than the fixed paths.
2022-08-06 14:45:13 +00:00
## Contributing
2021-12-11 20:44:24 +00:00
2022-08-05 12:31:36 +00:00
Anyone can contribute to aerc. Please refer to [the contribution
guidelines](https://git.sr.ht/~rjarry/aerc/tree/master/item/CONTRIBUTING.md)
2021-12-11 20:44:24 +00:00
2019-05-26 16:00:51 +00:00
## Resources
2019-01-14 01:09:07 +00:00
2022-03-23 19:46:45 +00:00
Ask for support or follow general discussions on
[~rjarry/aerc-discuss@lists.sr.ht ](https://lists.sr.ht/~rjarry/aerc-discuss ).
Send patches and development related questions to
2021-10-30 18:53:37 +00:00
[~rjarry/aerc-devel@lists.sr.ht ](https://lists.sr.ht/~rjarry/aerc-devel ).
2020-12-26 14:56:27 +00:00
Instructions for preparing a patch are available at
[git-send-email.io ](https://git-send-email.io )
2019-05-26 16:00:51 +00:00
Subscribe to release announcements on
2021-10-30 18:53:37 +00:00
[~rjarry/aerc-announce@lists.sr.ht ](https://lists.sr.ht/~rjarry/aerc-announce )
2019-03-17 21:47:35 +00:00
2022-03-23 19:46:45 +00:00
Submit *confirmed* bug reports and *confirmed* feature requests on
2021-10-30 18:53:37 +00:00
[https://todo.sr.ht/~rjarry/aerc ](https://todo.sr.ht/~rjarry/aerc ).
2022-02-06 15:36:50 +00:00
[License ](https://git.sr.ht/~rjarry/aerc/tree/master/item/LICENSE ).
2022-07-12 10:40:07 +00:00
[Change log ](https://git.sr.ht/~rjarry/aerc/tree/master/item/CHANGELOG.md ).
