.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "astroid" "1" "2022-11-22"
.P
.SH NAME
.P
astroid - graphical threads-with-tags style, lightweight and fast, e-mail
client for Notmuch
.P
.SH SYNOPSIS
.P
\fBastroid\fR [options]
.P
.SH DESCRIPTION
.P
Astroid is a lightweight and fast \fBMail User Agent\fR that provides a graphical
interface to searching, displaying and composing email, organized in threads
and tags.\& It uses the Notmuch backend for blazingly fast searches through
tons of e-mail.\&
.P
.SH OPTIONS
.P
\fB-c, --config\fR <config>
.RS 4
Override the default configuration path.\& Please refer to the \fBCONFIGURATION\fR
section for details.\&
.P
.RE
\fB--disable-log\fR
.RS 4
Disable logging.\&
.P
.RE
\fB-h, --help\fR
.RS 4
Show the help message and quit.\&
.P
.RE
\fB--log-level <level>\fR
.RS 4
Override the configured log level.\& Level options are: trace, debug (default),
info, warn, error and fatal.\&
.P
.RE
\fB--log-stdout\fR
.RS 4
Output logs to the standard output, regardless of any other logging
configuration.\&
.P
.RE
\fB-m, --mailto\fR <dest>
.RS 4
Open the composition window, sending to the <dest> url or address.\&
.P
.RE
\fB-n, --new-config\fR
.RS 4
Generate a new configuration file and quit.\&
.P
.RE
\fB--no-auto-poll\fR
.RS 4
Disable automatic polling.\&
.P
.RE
\fB--refresh\fR <revision>
.RS 4
Update the user view of a running astroid instance with any changes detected
in the mail directory since <revision>.\& You can obtain the current revision
with \fBnotmuch count --lastmod | cut -f3\fR (\fB0\fR will refresh all
thread-indexes).\& --{start,stop}-polling can be used as an \fBalternative\fR, but
not with --refresh.\&
.P
.RE
\fB--start-polling\fR
.RS 4
Make a running astroid instance watch for changes in the mail directory and
display a polling spinner.\& One must call --stop-polling at the end of the
external polling (e.\&g.\& by offlineimap) \fBeven if it fails\fR.\& --refresh can be
used as an \fBalternative\fR, but not with --{start,stop}-polling.\&
.P
.RE
\fB--stop-polling\fR
.RS 4
Stop the polling initiated by --start-polling and update the user view with
any changes detected since --start-polling was executed.\&
.P
.RE
\fB-t, --test-config\fR
.RS 4
Use test configuration file.\& Only makes sense from the source root.\&
.P
.RE
\fB--disable-plugins\fR
.RS 4
Disable all the plugins.\&
.P
.RE
.SH CONFIGURATION
.P
The configuration file location defaults to $XDG_CONFIG_HOME/astroid/config.\&
The preferred way to configure a new astroid setup is to use --new-config to
generate an initial configuration file, then edit it to match the user'\&s needs.\&
You will find all the details on Astroid'\&s online documentation:
https://github.\&com/astroidmail/astroid/wiki.\& If $NOTMUCH_CONFIG is set it
takes precedence over the configured value for the notmuch database in the
configuration file.\&
.P
You can customized the thread view by putting your own HTML and SCSS files in
$XDG_CONFIG_HOME/astroid/ui/, as explained on
https://github.\&com/astroidmail/astroid/wiki/Customizing-the-user-interface.\&
.P
If $XDG_CONFIG_HOME is not set, it defaults to ~/.\&config.\&
.P
.SH NOTE
.P
Astroid is a \fBMail User Agent\fR: all Astroid provides is a graphical interface
to your email (read, view, write, modify, organise).\& Thus, Astroid enables you
to launch actions that rely on the performance of other programs to actually
fetch, sync, index, search and send your email.\& It depends on Notmuch for
indexing and searching, but others actions can be handled many different
programs:
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
Fetching and syncing your mail between your local computer and email service

.RE
provider can be handled by any program supporting the Maildir format:
.RS 4
\fB \fROfflineIMAP\fB
\fR \fBmbsync\fR
\fB \fRGmailleer\fB
\fR .\&.\&.\&
.P
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
Sending mail through you email provider can be handler by any sendmail

.RE
compatible program:
.RS 4
\fB \fRmsmtp\fB
\fR .\&.\&.\&
.P
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
Editing can be handled by almost any editor:
.RS 4

.RE
.RE
\fB \fRvim\fB
.RS 4
\fR \fBemacs\fR
\fB \fRgedit\fB
\fR .\&.\&.\&
.P
.RE
While all these programs (or equivalent programs) need to be setup; once
they'\&re configured, you shouldn'\&t need to think about them beyond using
astroid.\& The configuration options may be more or less tedious and complicated,
depending on what email service provider you use.\&
.P
.SH AUTHORS
.P
Maintained by Gaute Hope <eg@gaute.\&vetsj.\&com>, who is assisted by other open
source contributors.\& For more information about astroid development, see
<https://github.\&com/astroidmail/astroid>.\&
.P
.SH SEE ALSO
.P
\fBnotmuch\fR(1) \fBofflineimap\fR(1) \fBmsmtp\fR(1)