From 8140c2627f28426b538b2084b2c6d0290aa335c4 Mon Sep 17 00:00:00 2001 From: Luke Smith Date: Mon, 22 Apr 2019 12:13:45 -0400 Subject: [PATCH] manual added --- Makefile | 4 +++- mw.1 | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 mw.1 diff --git a/Makefile b/Makefile index d925a7e..b10fcb9 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,7 @@ .POSIX: PREFIX = /usr/local +MANPREFIX = $(PREFIX)/share/man install: mkdir -p $(DESTDIR)$(PREFIX)/bin @@ -14,8 +15,9 @@ install: chmod 755 $(DESTDIR)$(PREFIX)/bin/mailsync mkdir -p /usr/share/mutt-wizard cp -f mailcap /usr/share/mutt-wizard - cp -f muttrc /usr/share/mutt-wizard + cp -f mutt-wizard.muttrc /usr/share/mutt-wizard cp -f domains.csv /usr/share/mutt-wizard + cp -f mw.1 $(DESTDIR)$(MANPREFIX)/man1/mw.1 uninstall: rm -f $(DESTDIR)$(PREFIX)/bin/mw diff --git a/mw.1 b/mw.1 new file mode 100644 index 0000000..bb6d34e --- /dev/null +++ b/mw.1 @@ -0,0 +1,64 @@ +.TH MW 1 st\-VERSION +.SH NAME +mw \- mutt-wizard \- autoconfigure email accounts for neomutt and isync +.SH SYNOPSIS +.B mw + +.SH DESCRIPTION +.B mw +takes a user email account and sets up a terminal-based email interface with it for +.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. +.SH COAMMANDS +.TP +.B init +set up initial files and directories (must be run once first) +.TP +.B add +configure an email account +.TP +.B ls +list all email accounts configured by mutt-wizard +.TP +.B delete +delete the configuration files for an already configured email account +.TP +.B purge +totally purge all local mutt-wizard accounts +.TP +.B cron +toggle a cronjob that will automatically sync mail with +.B mailsync +every few minutes +.SH DETAILS +.TP +.B Mail location +If the user chooses to keep offline email with +.B isync, +it will be kept in +.I ~/.local/share/mail/ +and if he wants to use +.B notmuch +to index and search his mail, he should give this directory location to +.B notmuch +when he first runs +.B notmuch setup. +.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. +.SH AUTHORS +Written by Luke Smith . +.SH LICENSE +GPLv3 +.SH SEE ALSO +.BR neomutt (1), +.BR neomuttrc (1) +.BR mbsync (1), +.BR msmtp (1),