Fork of the aerc email client (https://sr.ht/~rjarry/aerc)
Go to file
Moritz Poldrack 8c64bda5a0 doc: add contribution guidelines including code style
The Linux kernel code style rules have been used as a well-tested basis
and sections pertaining C-specific rules – such as macros – have been
removed. For it a short section on the used formatter is added for
further reference.

Link: https://www.kernel.org/doc/html/v5.19-rc8/process/coding-style.html
Signed-off-by: Moritz Poldrack <git@moritz.sh>
Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-08-05 21:57:12 +02:00
.builds go: bumped minimum required version 1.16 2022-08-05 21:55:26 +02:00
.github/workflows builds: add gnupg in preparation of gpg integration 2022-04-14 21:51:09 +02:00
commands delete: revert deleted messages if Delete is unsupported 2022-08-05 21:57:12 +02:00
completer lint: work nicely with wrapped errors (errorlint) 2022-08-04 21:58:04 +02:00
config lint: work nicely with wrapped errors (errorlint) 2022-08-04 21:58:04 +02:00
contrib Add changelog 2022-07-26 23:28:43 +02:00
doc filters: make it explicit that encoding is UTF-8 2022-08-03 22:36:51 +02:00
filters filters: make it explicit that encoding is UTF-8 2022-08-03 22:36:51 +02:00
lib delete: revert deleted messages if Delete is unsupported 2022-08-05 21:57:12 +02:00
logging lint: ensure errors are at least logged (errcheck) 2022-08-04 21:57:57 +02:00
models lint: apply new formatting rules 2022-08-01 10:44:52 +02:00
templates compose: add default template for new messages 2022-01-19 21:42:41 +01:00
widgets lint: work nicely with wrapped errors (errorlint) 2022-08-04 21:58:04 +02:00
worker tests: fix errors after lint series 2022-08-04 22:52:40 +02:00
.editorconfig doc: add contribution guidelines including code style 2022-08-05 21:57:12 +02:00
.gitignore mk: rebuild if goflags or ldflags have changed 2022-02-27 21:11:31 +01:00
.golangci.toml lint: add golangci-lint to the linters 2022-08-04 21:58:06 +02:00
.mailmap Add git mailmap 2022-07-23 22:07:04 +02:00
CHANGELOG.md go: bumped minimum required version 1.16 2022-08-05 21:55:26 +02:00
CONTRIBUTING.md doc: add contribution guidelines including code style 2022-08-05 21:57:12 +02:00
LICENSE LICENSE: add license name 2022-02-06 16:04:15 +01:00
Makefile lint: add golangci-lint to the linters 2022-08-04 21:58:06 +02:00
README.md doc: add contribution guidelines including code style 2022-08-05 21:57:12 +02:00
aerc.go lint: homogenize operations and minor fixes (gocritic) 2022-08-04 21:58:01 +02:00
go.mod go: bumped minimum required version 1.16 2022-08-05 21:55:26 +02:00
go.sum lint: add golangci-lint to the linters 2022-08-04 21:58:06 +02:00
tools.go lint: add golangci-lint to the linters 2022-08-04 21:58:06 +02:00

README.md

aerc

builds.sr.ht status GitHub macOS CI status

aerc is an email client for your terminal.

This is a fork of the original aerc by Drew DeVault.

A short demonstration can be found on https://aerc-mail.org/

Join the IRC channel: #aerc on irc.libera.chat for end-user support, and development.

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.

Documentation

Also available as man pages:

User contributions and integration with external tools:

Installation

Binary Packages

Recent versions of aerc are available on:

And likely other platforms.

From Source

Install the dependencies:

  • 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.)
  • scdoc

Then compile aerc:

$ make

aerc optionally supports notmuch. To enable it, you need to have a recent version of notmuch, including the header files (notmuch.h). Then compile aerc with the necessary build tags:

$ GOFLAGS=-tags=notmuch make

To install aerc locally:

# make install

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.

Anyone can contribute to aerc. Please refer to the contribution guidelines

Resources

Ask for support or follow general discussions on ~rjarry/aerc-discuss@lists.sr.ht.

Send patches and development related questions to ~rjarry/aerc-devel@lists.sr.ht.

Instructions for preparing a patch are available at git-send-email.io

Subscribe to release announcements on ~rjarry/aerc-announce@lists.sr.ht

Submit confirmed bug reports and confirmed feature requests on https://todo.sr.ht/~rjarry/aerc.

License.

Change log.