adrian
/
mutt-wizard
mirror of https://github.com/LukeSmithxyz/mutt-wizard.git
1
0
Fork 0
Code Issues 0 Releases 6 Wiki Activity
Browse Source

Added action -c and description to add new themas in manual

pull/870/head
Braulio Henrique Marques Souto 2 years ago
parent
8949aeb0fe
commit
ecbcaec023
1 changed files with 252 additions and 253 deletions
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +252
    -253
      mutt-wizard.1

+ 252
- 253
mutt-wizard.1 View File

@@ -1,302 +1,301 @@
.TH MUTT-WIZARD 1 mutt-wizard
.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "MUTT-WIZARD" "1" "mutt-wizard" "" ""
.hy
.SH NAME
mutt-wizard \- autoconfigure email accounts for neomutt and isync
.PP
mutt-wizard - autoconfigure email accounts for neomutt and isync
.SH SYNOPSIS
.B mutt-wizard
[
.I OPTIONS
]
.PP
\f[B]mutt-wizard\f[R] [ \f[I]OPTIONS\f[R] ]
.SH DESCRIPTION
.B mutt-wizard
takes a user email account and sets up a terminal-based email interface for it with
.B neomutt.
This can include offline email with
.B isync/mbsync
and configs for
.B msmtp
for sending mail, and also passwords automatically encrypted and stored with
.B pass.
.PP
\f[B]mutt-wizard\f[R] takes a user email account and sets up a
terminal-based email interface for it with \f[B]neomutt.\f[R] This can
include offline email with \f[B]isync/mbsync\f[R] and configs for
\f[B]msmtp\f[R] for sending mail, and also passwords automatically
encrypted and stored with \f[B]pass.\f[R]
.SH COMMANDS
.TP
.B -a your@email.com
\f[B]-a your\[at]email.com\f[R]
add an email address
.TP
.B -l
\f[B]-l\f[R]
list all email accounts configured by mutt-wizard
.TP
.B -d
\f[B]-d\f[R]
pick an already configured account and remove its configuration
.TP
.B -D your@email.com
\f[B]-D your\[at]email.com\f[R]
remove a configured account without confirmation
.TP
.B -y your@email.com
\f[B]-y your\[at]email.com\f[R]
download and upload mail for an email account
.TP
.B -Y
\f[B]-Y\f[R]
sync all email accounts
.TP
.B -t 15
toggle a cronjob that syncs your mail every 15 minutes (or any other number under 60)
\f[B]-t 15\f[R]
toggle a cronjob that syncs your mail every 15 minutes (or any other
number under 60)
.TP
.B -T
\f[B]-T\f[R]
toggle a cronjob without specifying minutes between sync
.TP
.B -r
\f[B]-r\f[R]
reorder account shortcut numbers
.TP
\f[B]-c\f[R]
change neomutt theme
.SH OPTIONS FOR ADDING ACCOUNTS
These can be specified on the command line, otherwise, you will be prompted for what is necessary. mutt-wizard knows the IMAP/SMTP server information for most email providers, so specifying them is usually redundant.
.PP
These can be specified on the command line, otherwise, you will be
prompted for what is necessary.
mutt-wizard knows the IMAP/SMTP server information for most email
providers, so specifying them is usually redundant.
.TP
.B -u billy
\f[B]-u billy\f[R]
Account logon/username if required and different from email address.
.TP
.B -n Billy
Real name which will appear in emails. Should be put in quotes if multiple words.
\f[B]-n Billy\f[R]
Real name which will appear in emails.
Should be put in quotes if multiple words.
.TP
.B -m number
\f[B]-m number\f[R]
Set a maximum number of messages to be stored offline.
.TP
.B -i
\f[B]-i\f[R]
IMAP/POP server address
.TP
.B -I
IMAP/POP server port (assumed to be 993 for IMAP and 995 for POP if not specified)
\f[B]-I\f[R]
IMAP/POP server port (assumed to be 993 for IMAP and 995 for POP if not
specified)
.TP
.B -s
\f[B]-s\f[R]
SMTP server address
.TP
.B -S
\f[B]-S\f[R]
SMTP server port (assumed to be 465 if not specified)
.TP
.B -x
Account password. You will be prompted for the password interactively if this option is not given.
.B -P
Pass Prefix. The password will be stored using pass at <passprefix><email>
\f[B]-x\f[R]
Account password.
You will be prompted for the password interactively if this option is
not given.
\f[B]-P\f[R] Pass Prefix.
The password will be stored using pass at <passprefix><email>
.SH OTHER OPTIONS
.TP
.B -f
Force account creation and guess mailboxes without attempting to connect to server. Otherwise if connection cannot be made, the configured account settings will not be persistent.
\f[B]-f\f[R]
Force account creation and guess mailboxes without attempting to connect
to server.
Otherwise if connection cannot be made, the configured account settings
will not be persistent.
.TP
.B -o
Create settings for an account to be used online only without mail syncing abilities. Without
.B -f
connection will still be attempted in setup to discover mailboxes.
\f[B]-o\f[R]
Create settings for an account to be used online only without mail
syncing abilities.
Without \f[B]-f\f[R] connection will still be attempted in setup to
discover mailboxes.
.TP
.B -X
When removing an email profile with either
.I -d
or
.I -D,
\f[B]-X\f[R]
When removing an email profile with either \f[I]-d\f[R] or \f[I]-D,\f[R]
also delete the local mail (will not delete the mail on the server).
.TP
.B -p
Use POP protocol instead of IMAP. Requires
.I mpop
to download mail after configuration. Server details can still be given with the
.I -i
and
.I -I
\f[B]-p\f[R]
Use POP protocol instead of IMAP.
Requires \f[I]mpop\f[R] to download mail after configuration.
Server details can still be given with the \f[I]-i\f[R] and \f[I]-I\f[R]
options as if it were a IMAP.
.SH DETAILS
.TP
.B mailsync
mutt-wizard calls a script
.I mailsync
to sync mail. This script additionally indexes new mail with notmuch and gives you a notification if new mail has arrived. If you want to bypass its additional features, you can always just run
.I mbsync -a
to sync your mail directly.
.TP
.B Mail location
If the user chooses to keep offline email with
.B isync,
it will be kept in
.I ~/.local/share/mail/.
.B notmuch
can be used to index and search this mail by giving this directory when first running
.B notmuch setup.
If you have not set up notmuch before, mutt-wizard will automatically set it up in the background the first time you add an account.
.TP
.B muttrc files
mutt-wizard will create a muttrc file for each created account holding account-specific details. These will appear in
.I ~/.config/mutt/accounts/
and can be edited by the user if needbe. Note that the mutt-wizard will also source these files and create the bindings to switch between them, and these will appear in your default
.I ~/.config/mutt/muttrc
file.
.TP
.B Mail deletion
mutt-wizard's delete action will delete configuration files and
.I not
downloaded mail for safety (and time)'s sake. If you want to delete downloaded mail, do so manually by removing it from the directory above.
.TP
.B Default settings
The mutt-wizard has many default settings that focus on making it aesthetically pleasing and supplying more vim-like bindings. These can be found in
.I /usr/local/share/mutt-wizard/mutt-wizard.muttrc
and the default mailcap file can be found in
.I
/usr/local/share/mutt-wizard/mailcap.
Any of these settings can be overwritten in
.I ~/.config/mutt/muttrc,
but be mindful that your overriding binds should appear after the
.I
mutt-wizard.muttrc
file is sourced.
.TP
.B Detecting server settings
mutt-wizard has a repository of email services and their server information kept in
.I /usr/local/share/mutt-wizard/domains.csv
\f[B]mailsync\f[R]
mutt-wizard calls a script \f[I]mailsync\f[R] to sync mail.
This script additionally indexes new mail with notmuch and gives you a
notification if new mail has arrived.
If you want to bypass its additional features, you can always just run
\f[I]mbsync -a\f[R] to sync your mail directly.
.TP
\f[B]Mail location\f[R]
If the user chooses to keep offline email with \f[B]isync,\f[R] it will
be kept in \f[I]\[ti]/.local/share/mail/.\f[R] \f[B]notmuch\f[R] can be
used to index and search this mail by giving this directory when first
running \f[B]notmuch setup.\f[R] If you have not set up notmuch before,
mutt-wizard will automatically set it up in the background the first
time you add an account.
.TP
\f[B]muttrc files\f[R]
mutt-wizard will create a muttrc file for each created account holding
account-specific details.
These will appear in \f[I]\[ti]/.config/mutt/accounts/\f[R] and can be
edited by the user if needbe.
Note that the mutt-wizard will also source these files and create the
bindings to switch between them, and these will appear in your default
\f[I]\[ti]/.config/mutt/muttrc\f[R] file.
.TP
\f[B]Mail deletion\f[R]
mutt-wizard\[aq]s delete action will delete configuration files and
\f[I]not\f[R] downloaded mail for safety (and time)\[aq]s sake.
If you want to delete downloaded mail, do so manually by removing it
from the directory above.
.TP
\f[B]Default settings\f[R]
The mutt-wizard has many default settings that focus on making it
aesthetically pleasing and supplying more vim-like bindings.
These can be found in
\f[I]/usr/local/share/mutt-wizard/mutt-wizard.muttrc\f[R] and the
default mailcap file can be found in
\f[I]/usr/local/share/mutt-wizard/mailcap.\f[R] Any of these settings
can be overwritten in \f[I]\[ti]/.config/mutt/muttrc,\f[R] but be
mindful that your overriding binds should appear after the
\f[I]mutt-wizard.muttrc\f[R] file is sourced.
.TP
\f[B]Detecting server settings\f[R]
mutt-wizard has a repository of email services and their server
information kept in \f[I]/usr/local/share/mutt-wizard/domains.csv\f[R]
which is used to automatically configure email settings.
If your email provider is not found there, it will prompt you to input your email service's IMAP and SMTP server information which can usually be found by searching online.

If you would like to help develop mutt-wizard for others, you are invited to add this service information to
.I domains.csv
on mutt-wizard's Github <https://github.com/lukesmithxyz/mutt-wizard> or Gitlab <https://gitlab.com/lukesmithxyz/mutt-wizard> pages.
.TP
.B Gmail accounts
Google will require you to allow "less-secure" (third party) applications or remove two-factor authentication in order to access their IMAP servers to download your mail. If you use Gmail, be sure to handle this before running mutt-wizard <https://support.google.com/accounts/answer/6010255>.
.TP
.B Enterprise and university accounts
Many universities and businesses might host their domain's email via Google or another service. This often requires a special IMAP/SMTP-specific password that you must generate and use. Again, mutt-wizard can handle these systems, but only once they've been set up.
.TP
.B Password decryption
mutt-wizard uses
.I pass
and therefore
.I gpg
to decrypt your passwords. Provided your GPG key has a password, this might mean that you will be prompted for your GPG password the first time you sync or send mail in a session. Once your password is cached, it might also expire later as well.

Because of this I strongly recommend the program
.I pam-gnupg
<https://github.com/cruegge/pam-gnupg> which automatically unlocks your GPG password on login and keeps it active, thus giving you, with mutt-wizard, secure access to all your email accounts on your system without ever having to input a password.

If you don't want to use this program, you can also increase the cache time of an inputted GPG password with the
.I default-cache-ttl
and
.I max-cache-ttl
variables in your
.I
gpg-agent.conf.
.SH MUTT-WIZARD'S NEOMUTT CONFIGURATION
Here is a list of not only mutt-wizard's particular defaults, but what you need to get the most out of email accounts configured with mutt-wizard.
.TP
.B Color
The mutt-wizard's default settings add color to messages in the index and color mail details to make them easier to see. New mail, in addition to being marked by the typical N, will also be bold.
.TP
.B Movement with h/j/k/l
Use vim keys to move down
.I j
or up
.I k
in mail, while
.I l
opens mail, then the attachment view, then an attachment, while
.I h
is the reverse.
While mail is open, go to next or previous mail with
.I J
and
.I K.
In the mail index,
.I d
and
.I u
go down and up by a half page and
.I gg
and
.I G
go to the very top and very bottom.
.TP
.B Search mail
If you have
.B notmuch
configured with your proper mail directory (see above), you may run
.I ctrl-f
to search for mail containing any given sequence.
Even without notmuch,
.I L
limits mail, showing only those with the given sequence in the subject while
.I A
shows all mail (same as limiting to "all").
.TP
.B Deleting mail
.I D
deletes mail, while
.I U
undeletes it (type in mail number to get to deleted mail). Note that
.I S
saves your mailbox, finalizing deletion. If you have a
.I Trash
box, deleted mail is moved there. If you want it to skip that and simply be deleted, comment out or remove the
.I set trash
line in that account's muttrc.
.TP
.B Send mail
.I m
creates a new mail message;
.I r
replies to the selected message;
.I R
replies all to the selected message and
.I f
forwards the selected message.
.TP
.B Compose mail screen
Once you write mail and save the buffer you will be brought to the compose screen. Press
.I a
to add attachments, use
.I s/t/c/b/d
to change the subject/to/CC/BCC/description. Press
.I S
to change the signature/encryption. Press
.I y
to send the mail.
.TP
.B Saving and autocompleting email addresses with abook
Install the optional dependency abook and you will be able to save the sender's email address with
.I a.
Once this is done, when you are typing in any email/contact prompt, you may press
.I Tab
to find contacts matching your input. Although abook is often used with mutt, it is also a useful program in its own right.
.TP
.B Switching and moving mail between mailboxes
The
.I g
key can be paired with several other keys to automatically move to another mailbox: gi: Inbox; gs: Sent; gd: Drafts; ga: Archive; gS: Spam; gj: Junk; gt: Trash. These bindings will only be present for accounts that have the boxes in question. Instead of
.I g,
you can also press
.I C
to copy mail or
.I M
to move mail to the same boxes.
.TP
.B Switching between accounts
mutt-wizard can configure as many as nine accounts each numbered by the lowest available number when configured. Press
.I i
followed by an account's number to change to that account: i2, i5, etc.
.I ctrl-b
to open a menu to select a url you want to open in you browser.
.TP
.B Sidebar
mutt-wizard enables the sidebar by default which displays your account's boxes with mail tallies.
.I B
will toggle the sidebar. Move up and down in it with
.I ctrl-k/j.
Open a box with
.I ctrl-o.
.TP
.B More information
Remember that you can press
.I ?
at any time in neomutt to get a list of all key-bindings and functions. This list can also vary for different context menus.
If your email provider is not found there, it will prompt you to input
your email service\[aq]s IMAP and SMTP server information which can
usually be found by searching online.
.PP
If you would like to help develop mutt-wizard for others, you are
invited to add this service information to \f[I]domains.csv\f[R] on
mutt-wizard\[aq]s Github <https://github.com/lukesmithxyz/mutt-wizard>
or Gitlab <https://gitlab.com/lukesmithxyz/mutt-wizard> pages.
.TP
\f[B]Gmail accounts\f[R]
Google will require you to allow \[dq]less-secure\[dq] (third party)
applications or remove two-factor authentication in order to access
their IMAP servers to download your mail.
If you use Gmail, be sure to handle this before running mutt-wizard
<https://support.google.com/accounts/answer/6010255>.
.TP
\f[B]Enterprise and university accounts\f[R]
Many universities and businesses might host their domain\[aq]s email via
Google or another service.
This often requires a special IMAP/SMTP-specific password that you must
generate and use.
Again, mutt-wizard can handle these systems, but only once they\[aq]ve
been set up.
.TP
\f[B]Password decryption\f[R]
mutt-wizard uses \f[I]pass\f[R] and therefore \f[I]gpg\f[R] to decrypt
your passwords.
Provided your GPG key has a password, this might mean that you will be
prompted for your GPG password the first time you sync or send mail in a
session.
Once your password is cached, it might also expire later as well.
.PP
Because of this I strongly recommend the program \f[I]pam-gnupg\f[R]
<https://github.com/cruegge/pam-gnupg> which automatically unlocks your
GPG password on login and keeps it active, thus giving you, with
mutt-wizard, secure access to all your email accounts on your system
without ever having to input a password.
.PP
If you don\[aq]t want to use this program, you can also increase the
cache time of an inputted GPG password with the
\f[I]default-cache-ttl\f[R] and \f[I]max-cache-ttl\f[R] variables in
your \f[I]gpg-agent.conf.\f[R]
.SH MUTT-WIZARD\[aq]S NEOMUTT CONFIGURATION
.PP
Here is a list of not only mutt-wizard\[aq]s particular defaults, but
what you need to get the most out of email accounts configured with
mutt-wizard.
.TP
\f[B]Color\f[R]
The mutt-wizard\[aq]s default settings add color to messages in the
index and color mail details to make them easier to see.
New mail, in addition to being marked by the typical N, will also be
bold.
.TP
\f[B]Change theme\f[R]
The mutt-wizard\[aq]s default theme is created by Luke Smith and its
file name is theme-LukeSmith.muttrc in /usr/share/mutt-wizard, To add
new themes, place the file in the same location with the default name as
follows theme-\f[I]name\f[R].muttrc where \f[I]name\f[R] is the name of
theme.
.TP
\f[B]Movement with h/j/k/l\f[R]
Use vim keys to move down \f[I]j\f[R] or up \f[I]k\f[R] in mail, while
\f[I]l\f[R] opens mail, then the attachment view, then an attachment,
while \f[I]h\f[R] is the reverse.
While mail is open, go to next or previous mail with \f[I]J\f[R] and
\f[I]K.\f[R] In the mail index, \f[I]d\f[R] and \f[I]u\f[R] go down and
up by a half page and \f[I]gg\f[R] and \f[I]G\f[R] go to the very top
and very bottom.
.TP
\f[B]Search mail\f[R]
If you have \f[B]notmuch\f[R] configured with your proper mail directory
(see above), you may run \f[I]ctrl-f\f[R] to search for mail containing
any given sequence.
Even without notmuch, \f[I]L\f[R] limits mail, showing only those with
the given sequence in the subject while \f[I]A\f[R] shows all mail (same
as limiting to \[dq]all\[dq]).
.TP
\f[B]Deleting mail\f[R]
\f[I]D\f[R] deletes mail, while \f[I]U\f[R] undeletes it (type in mail
number to get to deleted mail).
Note that \f[I]S\f[R] saves your mailbox, finalizing deletion.
If you have a \f[I]Trash\f[R] box, deleted mail is moved there.
If you want it to skip that and simply be deleted, comment out or remove
the \f[I]set trash\f[R] line in that account\[aq]s muttrc.
.TP
\f[B]Send mail\f[R]
\f[I]m\f[R] creates a new mail message; \f[I]r\f[R] replies to the
selected message; \f[I]R\f[R] replies all to the selected message and
\f[I]f\f[R] forwards the selected message.
.TP
\f[B]Compose mail screen\f[R]
Once you write mail and save the buffer you will be brought to the
compose screen.
Press \f[I]a\f[R] to add attachments, use \f[I]s/t/c/b/d\f[R] to change
the subject/to/CC/BCC/description.
Press \f[I]S\f[R] to change the signature/encryption.
Press \f[I]y\f[R] to send the mail.
.TP
\f[B]Saving and autocompleting email addresses with abook\f[R]
Install the optional dependency abook and you will be able to save the
sender\[aq]s email address with \f[I]a.\f[R] Once this is done, when you
are typing in any email/contact prompt, you may press \f[I]Tab\f[R] to
find contacts matching your input.
Although abook is often used with mutt, it is also a useful program in
its own right.
.TP
\f[B]Switching and moving mail between mailboxes\f[R]
The \f[I]g\f[R] key can be paired with several other keys to
automatically move to another mailbox: gi: Inbox; gs: Sent; gd: Drafts;
ga: Archive; gS: Spam; gj: Junk; gt: Trash.
These bindings will only be present for accounts that have the boxes in
question.
Instead of \f[I]g,\f[R] you can also press \f[I]C\f[R] to copy mail or
\f[I]M\f[R] to move mail to the same boxes.
.TP
\f[B]Switching between accounts\f[R]
mutt-wizard can configure as many as nine accounts each numbered by the
lowest available number when configured.
Press \f[I]i\f[R] followed by an account\[aq]s number to change to that
account: i2, i5, etc.
\f[I]ctrl-b\f[R] to open a menu to select a url you want to open in you
browser.
.TP
\f[B]Sidebar\f[R]
mutt-wizard enables the sidebar by default which displays your
account\[aq]s boxes with mail tallies.
\f[I]B\f[R] will toggle the sidebar.
Move up and down in it with \f[I]ctrl-k/j.\f[R] Open a box with
\f[I]ctrl-o.\f[R]
.TP
\f[B]More information\f[R]
Remember that you can press \f[I]?\f[R] at any time in neomutt to get a
list of all key-bindings and functions.
This list can also vary for different context menus.
.SH AUTHORS
Written by Luke Smith <luke@lukesmith.xyz> originally in 2018.
.PP
Written by Luke Smith <luke\[at]lukesmith.xyz> originally in 2018.
.SH LICENSE
.PP
GPLv3
.SH SEE ALSO
.BR mailsync (1),
.BR neomutt (1),
.BR neomuttrc (1)
.BR mbsync (1),
.BR mpop (1),
.BR msmtp (1),
.BR notmuch (1),
.BR abook (1)
.PP
\f[B]mailsync\f[R](1), \f[B]neomutt\f[R](1), \f[B]neomuttrc\f[R](1)
\f[B]mbsync\f[R](1), \f[B]mpop\f[R](1), \f[B]msmtp\f[R](1),
\f[B]notmuch\f[R](1), \f[B]abook\f[R](1)

Write Preview
Loading…
Cancel
Save