README fixes

README.rst

@@ -1,5 +1,5 @@
 =========================================
-mw(1) Version 1.0 \| mutt-wizard man page
+mw(1) Version 2.0 \| mutt-wizard man page
 =========================================
 
 ..   To test man page:
@@ -45,17 +45,19 @@ If the parameter contains @ an email is assumed and synced.
 
 *add*
 
-    Add new email.
+    Add new email
 
-    - First you decide, whether you want to configure
-       - **mbsync**, **getmail**, **msmtp** to sync emails independently from **mutt** using **mw**,
-       - or just **mutt**. 
-         For an IMAP server **mutt** becomes very slow.
-         So normally you enter **yes** here.
-    - **mw** asks you the **email address**.
-    - **mw** has a **database** of IMAP4/POP3 and SMTP servers and ports.
-      If you are lucky, your email server is there.
-      Else **mw** will prompt you.
+    First you decide, whether you want to configure
+    - **mbsync**, **getmail**, **msmtp** to sync emails independently from **mutt** using **mw**,
+    - or just **mutt**.
+      For an IMAP server **mutt** becomes very slow.
+      So normally you enter **yes** here.
+
+    **mw** asks you the **email address**.
+
+    **mw** has a **database** of IMAP4/POP3 and SMTP servers and ports.
+    If you are lucky, your email server is there.
+    Else **mw** will prompt you.
 
 *ls|list*
 
@@ -74,7 +76,7 @@ If the parameter contains @ an email is assumed and synced.
     | *.config/getmail/\**
     | *.config/msmtp/config*
 
-    Files are under *.config* or *$XDG_CONFIG_HOME*.
+    Files are under *.config* or *$XDG_CONFIG_HOME*
 
 *cron*
 
@@ -83,6 +85,7 @@ If the parameter contains @ an email is assumed and synced.
 *sync*
 
     Syncs mail for all email accounts managed by **mw** (whose paths end in the email).
+
     This is the default, if no parameter is given.
     If an email address is given, only that email is synced.
 
@@ -105,7 +108,9 @@ If the parameter contains @ an email is assumed and synced.
 DEPENDENCIES
 ============
 
-- *pass* - `pass <https://www.passwordstore.org/>`__ safely encrypts passwords (**required for email setup**)
+Required for email setup or operation:
+
+- *pass* - `pass <https://www.passwordstore.org/>`__ safely encrypts passwords
 - *gnupg* - needed by *pass*
 - *mutt/neomutt* - the email client (*mutt* untested).
 - *isync’s mbsync* - syncs the mail

mw.1

@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 2.7.3
 .\"
-.TH "mw" "1" "" "Version 1.0" "mutt-wizard man page"
+.TH "mw" "1" "" "Version 2.0" "mutt-wizard man page"
 .hy
 .SH NAME
 .PP
@@ -48,35 +48,30 @@ Sync email without mutt.
 .SH DESCRIPTION
 .PP
 \f[B]mw\f[R] configures \f[B]mbsync\f[R], \f[B]getmail\f[R],
-\f[B]msmtp\f[R] and \f[B]mutt\f[R] in one go, or just \f[B]mutt\f[R].
-Note, \f[B]mutt\f[R] stands for \f[B]mutt\f[R] or \f[B]neomutt\f[R], but
-\f[B]mw\f[R] settings was only tested with \f[B]neomutt\f[R].
+\f[B]msmtp\f[R] and \f[B]mutt\f[R] in one go.
+\f[B]mutt\f[R] stands for \f[B]mutt\f[R] or \f[B]neomutt\f[R].
 .SH COMMANDS
 .PP
 Without command parameter \f[B]sync\f[R] is assumed.
-If a parameter contains \[at] an email is assumed and synced.
+If the parameter contains \[at] an email is assumed and synced.
 .PP
 \f[I]add\f[R]
 .RS
 .PP
-Add new email.
-\[bu] .RS 2
-.TP
-.B First you decide, whether you want to configure
-.IP \[bu] 2
-\f[B]mbsync\f[R], \f[B]getmail\f[R], \f[B]msmtp\f[R] to sync emails
-independently from \f[B]mutt\f[R] using \f[B]mw\f[R],
-.IP \[bu] 2
-or just \f[B]mutt\f[R].
+Add new email
+.PP
+First you decide, whether you want to configure - \f[B]mbsync\f[R],
+\f[B]getmail\f[R], \f[B]msmtp\f[R] to sync emails independently from
+\f[B]mutt\f[R] using \f[B]mw\f[R], - or just \f[B]mutt\f[R].
 For an IMAP server \f[B]mutt\f[R] becomes very slow.
-Normally you enter \f[B]y\f[R].
-.RE
-.IP \[bu] 2
-It asks you the \f[B]email address\f[R].
-.IP \[bu] 2
-It has a \f[B]database\f[R] of IMAP4/POP3 and SMTP servers and ports.
+So normally you enter \f[B]yes\f[R] here.
+.PP
+\f[B]mw\f[R] asks you the \f[B]email address\f[R].
+.PP
+\f[B]mw\f[R] has a \f[B]database\f[R] of IMAP4/POP3 and SMTP servers and
+ports.
 If you are lucky, your email server is there.
-Else it will prompt you.
+Else \f[B]mw\f[R] will prompt you.
 .RE
 .PP
 \f[I]ls|list\f[R]
@@ -110,20 +105,21 @@ Removes all mw generated mutt settings and
 .PD
 \f[I].config/msmtp/config\f[R]
 .PP
-Files are under \f[I].config\f[R] or \f[I]$XDG_CONFIG_HOME\f[R].
+Files are under \f[I].config\f[R] or \f[I]$XDG_CONFIG_HOME\f[R]
 .RE
 .PP
 \f[I]cron\f[R]
 .RS
 .PP
-toggle a cronjob that periodically syncs mail
+Toggle a cronjob that periodically syncs mail
 .RE
 .PP
 \f[I]sync\f[R]
 .RS
 .PP
-syncs mail for all email accounts managed by \f[I]mw\f[R] (whose paths
+Syncs mail for all email accounts managed by \f[B]mw\f[R] (whose paths
 end in the email).
+.PP
 This is the default, if no parameter is given.
 If an email address is given, only that email is synced.
 .IP \[bu] 2
@@ -138,13 +134,6 @@ ending in the email address.
 .RE
 .IP \[bu] 2
 The generated \f[B]mutt\f[R] configuration has these bindings
-.RS 2
-.IP \[bu] 2
-\f[I]ixy/Mxy/Cxy\f[R] bindings to switch/move/copy to mailbox (x and y
-stand for other letters)
-.IP \[bu] 2
-\f[I]i[1-9]\f[R] bindings to switch account
-.RE
 .IP \[bu] 2
 \f[I]/usr/share/mutt-wizard/mutt-wizard.muttrc\f[R] is linked in your
 \f[I]muttrc\f[R].
@@ -160,14 +149,14 @@ Have this line there, if you prefer your own settings:
 You will need to keep the binding of \f[I]i,g,C,M\f[R] to
 \f[I]noop\f[R], though, because of the generated bindings in the account
 muttrc.
-Else you can overwrite certain things after the uncommented sourcing
-line.
 .RE
 .RE
 .SH DEPENDENCIES
+.PP
+Required for email setup or operation:
 .IP \[bu] 2
 \f[I]pass\f[R] - pass (https://www.passwordstore.org/) safely encrypts
-passwords (\f[B]required for email setup\f[R])
+passwords
 .IP \[bu] 2
 \f[I]gnupg\f[R] - needed by \f[I]pass\f[R]
 .IP \[bu] 2
@@ -184,11 +173,11 @@ Optional:
 \f[I]w3m\f[R] - view HTML email and images in \f[B]mutt\f[R].
 .IP \[bu] 2
 \f[I]notmuch\f[R] - index and search mail.
-If the configuration file in \f[I]$NOTMUCH_CONFIG\f[R] is not there,
+If the configuration file \f[I]$NOTMUCH_CONFIG\f[R] is not there,
 \f[I]mw add\f[R] will create it.
 .IP \[bu] 2
 \f[I]libnotify\f[R] - allows notifications when syncing mail with
-\f[I]mw\f[R]
+\f[B]mw\f[R]
 .IP \[bu] 2
 \f[I]abook\f[R] - a terminal-based address book.
 .IP \[bu] 2
@@ -199,9 +188,10 @@ feature.
 See directions (https://github.com/cruegge/pam-gnupg).
 .RS 2
 .PP
-Alternatively increasing \f[I]default-cache-ttl\f[R] and
-\f[I]max-cache-ttl\f[R] in \f[I]gpg-agent.conf\f[R] avoid constant
-password requests.
+Alternatively avoid constant password requests by increasing
+.IP \[bu] 2
+\f[I]default-cache-ttl\f[R] and \f[I]max-cache-ttl\f[R] in
+\f[I]gpg-agent.conf\f[R]
 .RE
 .IP \[bu] 2
 \f[I]urlscan\f[R] - outputs urls in mail
@@ -214,15 +204,16 @@ cd mutt-wizard
 sudo make install
 \f[R]
 .fi
-.PP
-User of Arch-based distros can also install mutt-wizard from the AUR as
-mw-git (https://aur.archlinux.org/packages/mw-git/).
-.SH MUTT-WIZARD\[aq]S NEOMUTT CONFIGURATION
+.SH MUTT CONFIGURATION
 .PP
 Once everything is setup, you\[cq]ll use \f[B]mutt\f[R] to access your
 mail.
 .PP
-Mutt usage with the accompanied \f[I]/usr/share/mutt-wizard.muttrc\f[R]:
+The accompanied \f[I]/usr/share/mutt-wizard.muttrc\f[R] modifies some
+\f[B]mutt\f[R] defaults.
+Look there for a complete list.
+.PP
+Here an overview:
 .IP \[bu] 2
 \f[I]?\f[R] - see all keyboard shortcuts
 .PP
@@ -235,18 +226,17 @@ all mail accounts
 .IP \[bu] 2
 \f[I]ixy\f[R] - To go to \f[B]mailbox\f[R].
 .IP \[bu] 2
-\f[I]Mxy\f[R], \f[I]Cxy\f[R] - For \f[I]M\f[R]ove and \f[I]C\f[R]opy to
-the according mailbox, e.g.\ \f[I]Msp\f[R] means \[lq]move to Spam\[rq].
+\f[I]Mxy\f[R], \f[I]Cxy\f[R] - For Move and Copy to the according
+mailbox, e.g.\ *Msp* means \[dq]move to Spam\[dq].
 .IP \[bu] 2
-\f[I]i#\f[R] - Press \f[I]i\f[R] followed by a number 1-9 to go to a
-\f[B]different account\f[R].
+\f[I]i[1-9]\f[R] - go to another \f[B]account\f[R].
 .RS 2
 .PP
 \f[I]xy\f[R] are
 .IP \[bu] 2
-two first letters of mailbox letters or
+the two first letters of a mailbox or
 .IP \[bu] 2
-first letter of first path entry + second letter of second path entries
+first letter of first + second letter of second path entry
 .RE
 .PP
 \f[B]searching\f[R]
@@ -311,44 +301,37 @@ page
 .PP
 \f[B]input field/command line\f[R]
 .IP \[bu] 2
-\f[I]ctrl-u\f[R] will clear it
+\f[I]ctrl-u\f[R] clears the line
+.IP \[bu] 2
+\f[I]ctrl-a\f[R], \f[I]ctrl-e\f[R] go to beginning or end
 .IP \[bu] 2
-\f[I]ctrl-a\f[R], \f[I]ctrl-e\f[R] go to beginning or end,
 \f[I]ctrl-g\f[R] aborts
-.PP
-Look into \f[I]/usr/share/mutt-wizard.muttrc\f[R] to see all bindings.
 .SH DETAILS
-.TP
-.B Encoding
+.PP
+\f[B]Encoding/Language\f[R]
 .RS
 .PP
 \f[I]isync\f[R] is not fully UTF-8 compatible.
-Non-Latin characters may be garbled (although sync should succeed).
-\f[I]mw\f[R] will also not auto-create mailbox shortcuts since it is
-looking for English mailbox names.
-I strongly recommend you to set your email language to English on your
-mail server to avoid these problems.
+\f[B]mw\f[R] assumes english mailbox names.
+Set your email language to English on your mail server.
 .RE
 .PP
 \f[B]Mail location\f[R]
 .RS
 .PP
-Mail is downloaded to a folder named after your email in
-\f[I]$MAILDIR\f[R], which defaults to \f[I]$HOME/Mail/\f[R], the default
-for mutt.
+Mail is downloaded to a folders named after your emails in
+\f[I]$MAILDIR\f[R].
+\f[I]$MAILDIR\f[R] defaults to \f[I]$HOME/Mail/\f[R].
 Neither \f[B]mw remove\f[R] nor \f[B]mw purge\f[R] will delete
 downloaded mail.
-Do that manually.
 .RE
 .PP
 \f[B]Gmail accounts\f[R]
 .RS
 .PP
-Google will require you to allow \[dq]less-secure\[dq] (third party)
-applications or use 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
+For Gmail allow \[dq]less-secure\[dq] applications:
 <<https://support.google.com/accounts/answer/6010255>>.
+Do this before running mutt-wizard.
 .RE
 .PP
 \f[B]Protonmail accounts\f[R]
@@ -357,18 +340,7 @@ If you use Gmail, be sure to handle this before running mutt-wizard
 Protonmail users must use the Protonmail Bridge
 <<https://protonmail.com/bridge/>> to access their IMAP and SMTP
 servers.
-This too should be configured before running mutt-wizard.
-.RE
-.PP
-\f[B]Enterprise and university accounts\f[R]
-.RS
-.PP
-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 have
-been set up.
+Do this before running mutt-wizard.
 .RE
 .SH FILES
 .TP
@@ -405,38 +377,6 @@ Bugfixes, Improvements in 2019.
 .RS
 .PP
 GitHub: <<https://github.com/rpuntaie/mutt-wizard>>
-.IP \[bu] 2
-Honors \f[I]:math:\[ga]MAILDIR\f[R], \f[I]\[ga]XDG_CONFIG_HOME\f[R],
-\f[I]$XDG_CACHE_HOME\f[R], if defined.
-.IP \[bu] 2
-\f[I]gm/gM\f[R] to sync mail inside \f[I]mutt\f[R], as \f[I]o/O\f[R] has
-a \f[I]mutt\f[R] assignment already.
-.IP \[bu] 2
-Other more vim-like shortcut changes
-.IP \[bu] 2
-Make channel name equal to email address to avoid choosing a new name
-for the same thing.
-.IP \[bu] 2
-\f[I]remove|rm\f[R] instead of \f[I]delete\f[R], \f[I]list|ls\f[R]
-instead of only \f[I]ls\f[R]
-.IP \[bu] 2
-\f[I]wm\f[R] integrates \f[I]mailsync\f[R], not to overload the system
-namespace and because of code reuse
-.IP \[bu] 2
-\f[I]wm\f[R] generates \f[I]mutt\f[R] config on every full sync,
-.RS 2
-.IP \[bu] 2
-to reflect changes in mailboxes in the shortcuts
-.IP \[bu] 2
-to reflect changes in \f[I]mbsync/getmail\f[R] config in \f[I]mutt\f[R]
-config
-.RE
-.IP \[bu] 2
-\f[I]urlscan\f[R] instead of \f[I]urlview\f[R]
-.IP \[bu] 2
-Added tests and made bug fixes
-.IP \[bu] 2
-Generate man page from readme, to avoid duplicate descriptions
 .RE
 .SH LICENSE
 .PP