You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

72 lines
1.7 KiB

  1. .TH MW 1 st\-VERSION
  2. .SH NAME
  3. mw \- mutt-wizard \- autoconfigure email accounts for neomutt and isync
  4. .SH SYNOPSIS
  5. .B mw
  6. <command>
  7. .SH DESCRIPTION
  8. .B mw
  9. takes a user email account and sets up a terminal-based email interface with it for
  10. .B neomutt.
  11. This can include offline email with
  12. .B isync/mbsync
  13. and configs for
  14. .B msmtp
  15. for sending mail, and also passwords automatically encrypted and stored with
  16. .B pass.
  17. .SH COAMMANDS
  18. .TP
  19. .B init
  20. set up initial files and directories (must be run once first)
  21. .TP
  22. .B add
  23. configure an email account
  24. .TP
  25. .B ls
  26. list all email accounts configured by mutt-wizard
  27. .TP
  28. .B delete
  29. delete the configuration files for an already configured email account
  30. .TP
  31. .B purge
  32. totally purge all local mutt-wizard accounts
  33. .TP
  34. .B cron
  35. toggle a cronjob that will automatically sync mail with
  36. .B mailsync
  37. every few minutes
  38. .SH DETAILS
  39. .TP
  40. .B Mail location
  41. If the user chooses to keep offline email with
  42. .B isync,
  43. it will be kept in
  44. .I ~/.local/share/mail/
  45. and if he wants to use
  46. .B notmuch
  47. to index and search his mail, he should give this directory location to
  48. .B notmuch
  49. when he first runs
  50. .B notmuch setup.
  51. .TP
  52. .B muttrc files
  53. mutt-wizard will create a muttrc file for each created account holding account-specific details. These will appear in
  54. .I ~/.config/mutt/accounts/
  55. and can be edited by the user if needbe.
  56. .TP
  57. .B Mail deletion
  58. Neither
  59. .B delete
  60. or
  61. .B purge
  62. will delete downloaded mail for for safety (and time)'s sake. If you want to delete downloaded mail, do so manually by removing it from the directory above.
  63. .SH AUTHORS
  64. Written by Luke Smith <luke@lukesmith.xyz>.
  65. .SH LICENSE
  66. GPLv3
  67. .SH SEE ALSO
  68. .BR neomutt (1),
  69. .BR neomuttrc (1)
  70. .BR mbsync (1),
  71. .BR msmtp (1),