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).
28
29              Earlier versions of mu defaulted to ~/.mu,  which  now  requires
30              --muhome=~/.mu.
31
32              Alternatively,  use can use the MUHOME environment variable (the
33              command-line takes precedence).
34
35
36       -m, --maildir=<maildir>
37              starts searching at <maildir>. By default, mu uses whatever  the
38              MAILDIR  environment  variable  is  set to; if it is not set, it
39              tries ~/Maildir if it already exists.
40
41
42       --my-address=<my-email-address>
43              specifies that some e-mail addresses are 'my-address'  (--my-ad‐
44              dress  can  be used multiple times). This is used by mu cfind --
45              any e-mail address found in the  address  fields  of  a  message
46              which  also  has <my-email-address> in one of its address fields
47              is considered a personal e-mail address. This  allows  you,  for
48              example,  to  filter  out  (mu cfind --personal) addresses which
49              were merely seen in mailing list messages.
50
51              <my-email-address> can be either a plain e-mail address (such as
52              foo@example.com),  or a regular-expression (of the 'Basic POSIX'
53              flavor), wrapped in / (such as /foo-.*@example\.com/). Depending
54              on your shell program, the argument may need to b quoted.
55
56

ENVIRONMENT

58       mu  init  uses  MAILDIR  to  find the user's Maildir if it has not been
59       specified explicitly with --maildir=<maildir>. If MAILDIR is  not  set,
60       mu init uses ~/Maildir.
61
62       MUHOME can be used as an alternative to --muhome.
63
64

RETURN VALUE

66       mu  init  returns 0 upon successful completion, or a non-zero exit code
67       if there was some error.
68
69

BUGS

71       Please report bugs if you find them: https://github.com/djcb/mu/issues
72
73

AUTHOR

75       Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
76
77