mu-init(1)

1MU-INIT(1)                  General Commands Manual                 MU-INIT(1)
2
3
4

NAME

6       mu init - initialize the mu message database
7
8

SYNOPSIS

10       mu init [options]
11
12

DESCRIPTION

14       mu init is the subcommand for setting up the mu message database. After
15       mu init has completed, you can run mu index
16
17

OPTIONS

19       Note, some of the general options are described in the  mu(1)  man-page
20       and not here, as they apply to multiple mu commands.
21
22
23       --muhome
24              use  an  alternative  directory  to store and read the database,
25              write the logs, etc. By default,  mu  uses  XDG  Base  Directory
26              Specification  (e.g.  on  Linux  this  defaults  to ~/.cache/mu,
27              ~/.config/mu). Earlier versions of mu defaulted to ~/.mu,  which
28              now requires --muhome=~/.mu.
29
30
31       -m, --maildir=<maildir>
32              starts  searching at <maildir>. By default, mu uses whatever the
33              MAILDIR environment variable is set to; if it  is  not  set,  it
34              tries  ~/Maildir.  The  maildir must be on a single file-system;
35              and symbolic links are not supported.
36
37
38       --my-address=<my-email-address>
39              specifies that some e-mail addresses are 'my-address'  (--my-ad‐
40              dress  can  be used multiple times). This is used by mu cfind --
41              any e-mail address found in the  address  fields  of  a  message
42              which  also  has <my-email-address> in one of its address fields
43              is considered a personal e-mail address. This  allows  you,  for
44              example,  to  filter  out  (mu cfind --personal) addresses which
45              were merely seen in mailing list messages.
46
47              <my-email-address> can be either a plain e-mail address (such as
48              foo@example.com),  or a regular-expression (of the 'Basic POSIX'
49              flavor), wrapped in / (such as /foo-.*@example\.com/).
50
51

ENVIRONMENT

53       mu init uses MAILDIR to find the user's Maildir  if  it  has  not  been
54       specified  explicitly  with --maildir=<maildir>. If MAILDIR is not set,
55       mu init uses ~/Maildir.
56
57

RETURN VALUE

59       mu init returns 0 upon successful completion, or a non-zero  exit  code
60       if there was some error.
61
62

BUGS

64       Please report bugs if you find them: https://github.com/djcb/mu/issues
65
66

AUTHOR

68       Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
69
70