From 80eac1848334e40cf9270cb9d37e7c7e64684cf4 Mon Sep 17 00:00:00 2001 From: Kevin McCarthy Date: Wed, 8 May 2019 19:28:21 -0700 Subject: [PATCH] Add sample starter muttrc to contrib. Add a mini-section with a link to the manual instead, under "Configuration". --- contrib/Makefile.am | 3 +- contrib/sample.muttrc-starter | 106 +++++++++++++++++++++++++++ doc/manual.xml.head | 130 ++++------------------------------ 3 files changed, 123 insertions(+), 116 deletions(-) create mode 100644 contrib/sample.muttrc-starter diff --git a/contrib/Makefile.am b/contrib/Makefile.am index 89aa1586..4d25f42e 100644 --- a/contrib/Makefile.am +++ b/contrib/Makefile.am @@ -4,7 +4,8 @@ subdir = contrib SAMPLES = Mush.rc Pine.rc gpg.rc pgp2.rc pgp5.rc pgp6.rc Tin.rc \ sample.mailcap sample.muttrc sample.muttrc-sidebar sample.muttrc-tlr \ - sample.muttrc-compress sample.vimrc-sidebar colors.default colors.linux smime.rc \ + sample.muttrc-compress sample.muttrc-starter \ + sample.vimrc-sidebar colors.default colors.linux smime.rc \ ca-bundle.crt smime_keys_test.pl mutt_xtitle EXTRA_DIST = language.txt language50.txt \ diff --git a/contrib/sample.muttrc-starter b/contrib/sample.muttrc-starter new file mode 100644 index 00000000..4cbf5a6a --- /dev/null +++ b/contrib/sample.muttrc-starter @@ -0,0 +1,106 @@ +# +# Starter muttrc file, with just a few suggestions and settings. +# +# This file purposely doesn't include hooks, keybinding, macros, colors, etc. +# Read the manual, explore, and have fun! +# + +############### +# Identity +# +set realname = "Example User" +set from = "user@example.com" + +# If you have another address: +alternates "^mutt@example\.com$" + +# Or, if you use the entire domain: +alternates "@example\.com$" +set reverse_name + +############### +# Example: local mailboxes +# +# Some people use mbsync or getmail to retrieve their mail locally. +# +set folder = ~/Mail # This has the shortcut '+' or '=' +set spoolfile = "+inbox" # This has the shortcut '!' +set record = "+sent" +set trash = "+trash" +set postponed = "+drafts" + +mailboxes ! +mutt +family +work + +############### +# Example: Gmail over IMAP +# +set imap_user = ".....@gmail.com" + +# To avoid storing your password in the .muttrc: +# echo -n "mypassword" | gpg --encrypt -r 0x1234567890ABCDEF > ~/.mutt/account.gpg +set imap_pass = `gpg --batch -q --decrypt ~/.mutt/account.gpg` + +set folder = imaps://imap.gmail.com/ +set spoolfile = "+INBOX" +unset record # Gmail auto-stores in "+[Gmail].Sent Mail" +unset trash # Unset, deletion will remove labels +set postponed = "+[Gmail].Drafts" + +set mail_check = 60 + +############### +# Pager settings +# +ignore * +unignore From Message-ID Date To Cc Bcc Subject + +set pager_stop +unset markers + +# Prefer plain text to html. +# However, for brain dead clients that bundle attachments inside a +# multipart/alternative, prefer that alternative. +alternative_order multipart/mixed multipart/related text/plain + +# Consult mime.types for determining types of these attachments +mime_lookup application/octet-stream + +# This requires a ~/.mailcap entry with the copiousoutput flag, such as: +# text/html; lynx -dump -width ${COLUMNS:-80} %s; nametemplate=%s.html; copiousoutput +auto_view text/html + +############### +# Index settings +# +set quit = ask-yes +set sort = threads + +# Remember to `mkdir -p ~/.mutt/hcache` first: +set header_cache= "~/.mutt/hcache" + +############### +# Message composition settings +# +set edit_headers + +# set editor = "emacsclient -a emacs -t" +# set editor = "vim" + +set mime_type_query_command = "xdg-mime query filetype" + +# msmtp is a solid SMTP client. +# mutt also has built-in SMTP, or you can use an MTA like exim4 or postfix. +set sendmail = "/usr/bin/msmtp" + +# lbdb is a versatile contact query tool. +# Invoke via ctrl-t in an address prompt +set query_command = "/usr/bin/lbdbq" + +############### +# GnuPG +# +unset crypt_use_gpgme +source /usr/share/doc/mutt/samples/gpg.rc +set pgp_default_key = "0x1234567890ABCDEF" +set crypt_opportunistic_encrypt +set postpone_encrypt diff --git a/doc/manual.xml.head b/doc/manual.xml.head index a13658f4..35c9c305 100644 --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@ -1994,6 +1994,21 @@ linkend="commandline">command line switch or using the + +Starter Muttrc + + +Mutt is highly configurable because it's meant to +be customized to your needs and preferences. However, this +configurability can make it difficult when just getting started. A +few sample muttrc files come with mutt, under +doc/mutt/samples/. Among them, sample.muttrc-starter is a basic example config with a few +suggested settings and pointers to useful programs. + + + Syntax of Initialization Files @@ -9773,121 +9788,6 @@ case-insensitivity). - -Quick-Start Config - - -Mutt is highly configurable because it's meant to -be customized to your needs and preferences. However, this -configurability can make it difficult when just getting started. -Below is a commented starter .muttrc file, with a few -subjective-opinion configurations thrown in. Be sure to also see the -sample files in the contrib -directory. - - - -############### -# Identity -# -set realname = "Example User" -set from = "user@example.com" - -# If you use the entire domain: -# alternates "@example\.com$" -# set reverse_name - -# If you have another alias: -# alternates "^mutt@example\.com$" - -############### -# Example: local mailboxes -# -# Some people use mbsync or getmail to retrieve their mail locally. -# $spoolfile will need to be adjusted to where your INBOX is. -# -set folder = ~/Mail # This has the shortcut '+' or '=' -set spoolfile = /var/mail/user # This has the shortcut '!' -set record = "+sent" -set trash = "+trash" -set postponed = "+drafts" - -mailboxes ! +mutt +family +work - -############### -# Example: Gmail over IMAP -# -set imap_user = "....." -# To avoid storing your password in the .muttrc: -# echo -n "mypassword" | gpg --encrypt -r 0x1234567890ABCDEF > ~/.mutt/account.gpg -set imap_pass = `gpg --batch -q --decrypt ~/.mutt/account.gpg` -set folder = imaps://imap.gmail.com/ -set spoolfile = "+INBOX" -unset record # Gmail auto-stores in "+[Gmail].Sent Mail" -unset trash # Or, set, depending on your idea of deletion -set postponed = "+[Gmail].Drafts" -set mail_check = 60 - -############### -# Pager settings -# -ignore * -unignore From Message-ID Date To Cc Bcc Subject - -set pager_stop - -# see also $markers and $tilde - -# prefer plain text to html. -# however, for brain dead clients that bundle attachments inside a -# multipart/alternative, prefer that alternative. -alternative_order multipart/mixed multipart/related text/plain - -# consult mime.types for determining types of these attachments -mime_lookup application/octet-stream - -# this requires a .mailcap entry with the copiousoutput flag -auto_view text/html - -############### -# Index settings -# -set quit = ask-yes -set sort = threads -# remember to `mkdir -p ~/.mutt/hcache` first: -set header_cache= "~/.mutt/hcache" - -############### -# Message composition settings -# -set edit_headers - -# set editor = "emacsclient -a emacs -t" -# set editor = "vim" - -set mime_type_query_command = "xdg-mime query filetype" - -# msmtp is a solid SMTP client. -# mutt also has built-in SMTP, or you can use an MTA like exim4 or postfix. -set sendmail = "/usr/bin/msmtp" - -# lbdb is a good contact query tool. -# Invoke via ctrl-t in an address prompt -set query_command = "lbdbq %s" - -############### -# GnuPG -# -unset crypt_use_gpgme -source /usr/share/doc/mutt/samples/gpg.rc -set pgp_default_key = "0x1234567890ABCDEF" -set crypt_opportunistic_encrypt -set postpone_encrypt - - - - Reference -- 2.40.0