mu-wizard

commit 11ca032c1b64dc10f7545862b7c26f86cefc83f0
parent 3cab221618df3c75f03026c8e52f9125d4c5e715
Author: Cem Keylan <cem@ckyln.com>
Date:   Sun,  7 Feb 2021 02:34:03 +0300

docs: update

Diffstat:
M
README.org
 | 
44
+++++++++++++++++++++++++++++++++++---------

1 file changed, 35 insertions(+), 9 deletions(-)
diff --git a/README.org b/README.org
@@ -17,6 +17,7 @@ account. It is still WIP. Expect breaking changes until the first release.
   - [[#domains-file][Domains file]]
   - [[#overrides][Overrides]]
 - [[#notes][Notes]]
+  - [[#isync-deprecation-notice][Isync Deprecation Notice]]
   - [[#protonmail][Protonmail]]
   - [[#google][Google]]
   - [[#forcing-a-password-manager][Forcing a password manager]]
@@ -92,13 +93,23 @@ run the following:
 
 * Usage
 
-The wizard is called by running ~muw~. The options below are available to use:
+The wizard is called by running ~muw~. The commands below are available to use:
 
-- ~muw a~ :: *Add* and autoconfigure an email address
-- ~muw d~ :: Pick an account to *delete*
-- ~muw l~ :: *List* configured accounts
-- ~muw p~ :: *Purge* all configuration
-- ~muw s~ :: See your *share directory*
+#+BEGIN_SRC sh :results raw :exports results
+./bin/muw --help | sed -E '/^Commands:/,/^$/!d;/Commands:/d;/^$/d;s|^ *([a-zA-Z-]*) *(.*)$|- =\1= :: \2|'
+#+END_SRC
+
+#+RESULTS:
+- =add= :: Add and autoconfigure an email address
+- =delete= :: Pick an account to delete
+- =list= :: List configured accounts
+- =purge= :: Purge all configuration
+- =sync= :: Sync mail for accounts
+- =mu-init= :: Run 'mu init' with the configured accounts
+- =data= :: Output system data directory and exit
+
+  You can run ~muw COMMAND --help~ for learning more about the usage of the
+  command.
 
 ** Emacs Configuration
 
@@ -125,9 +136,9 @@ ways.
 
 =mu-wizard= doesn't come with a predefined =domains.csv= file, but it can use
 one if it is found on =/usr/share/mu-wizard/domains.csv= (or whatever your share
-directory is, see ~muw s~). =mu-wizard= also saves the domain information that
-you when creating an account on your configuration directory, so you don't have
-to retype every detail when creating a second account with the same domain.
+directory is, see ~muw data~). =mu-wizard= also saves the domain information
+that you when creating an account on your configuration directory, so you don't
+have to retype every detail when creating a second account with the same domain.
 
 ** Overrides
 
@@ -137,6 +148,21 @@ for an example override.
 
 * Notes
 
+** Isync Deprecation Notice
+
+=isync= version 1.4.0 outputs the following deprecation notice for the mbsync
+configuration.
+
+#+BEGIN_QUOTE
+Notice: Master/Slave are deprecated; use Far/Near instead.
+#+END_QUOTE
+
+You can fix this by running the command:
+
+#+begin_src sh
+sed -i 's|^Slave |Near |;s|^Master |Far |' "$HOME/.mbsyncrc"
+#+end_src
+
 ** Protonmail
 
 =mu-wizard= supports protonmail. If you are using one of the default domains,