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 [common-options] 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

INIT OPTIONS

19   -m, --maildir=<maildir>
20       starts searching at <maildir>. By default, mu uses whatever the MAILDIR
21       environment variable is set to; if it is not set, it tries ~/Maildir if
22       it already exists.
23
24
25   --my-address=<my-email-address>
26       specifies that some e-mail addresses are 'my-address' (the  option  can
27       be  used multiple times). Any message in which at least one of the con‐
28       tact fields contains such an address is considered  a  'personal'  mes‐
29       sages;  this  can then be used for filtering in mu-find(1), mu-cfind(1)
30       and mu4e, e.g. to filter-out mailing list messages.
31
32
33       <my-email-address> can be  either  a  plain  e-mail  address  (such  as
34       foo@example.com),  or  a basic PCRE regular-expression (see pcre(3) for
35       details), wrapped in / (such as  /foo-.*@example\.com/).  Depending  on
36       your shell, the argument may need to be quoted.
37
38
39   --reinit
40       reinitialize  the  database  from an earlier version; that is, create a
41       new empty database witht the existing settings. This cannot be combined
42       with the other init options.
43
44

EXIT CODE

46       This  command  returns 0 upon successful completion, or a non-zero exit
47       code otherwise. Typical values are 2 (no matches found),  11  (database
48       schema mismatch) and 12 (failed to acquire database lock).
49
50
51   no matches found (2)
52       Nothing matching found; try a different query
53
54
55   database schema mismatch (11)
56       You need to re-initialize mu, see mu-init(1)
57
58
59   failed to acquire lock (19)
60       Some other program has exclusive access to the mu (Xapian) database
61
62
63   --muhome
64       use  a  non-default directory to store and read the database, write the
65       logs, etc.  By default, mu uses the XDG  Base  Directory  Specification
66       (e.g. on GNU/Linux this defaults to ~/.cache/mu and ~/.config/mu). Ear‐
67       lier  versions  of  mu  defaulted  to   ~/.mu,   which   now   requires
68       --muhome=~/.mu.
69
70
71       The  environment  variable  MUHOME  can  be  used  as an alternative to
72       --muhome. The latter has precedence.
73
74

REPORTING BUGS

76       Please report bugs at https://github.com/djcb/mu/issues.
77
78

AUTHOR

80       Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
81
82

COPYRIGHT

84       This manpage is part of mu 1.10.5.
85
86
87       Copyright © 2022-2023 Dirk-Jan C. Binnema. License GPLv3+: GNU GPL ver‐
88       sion  3  or later https://gnu.org/licenses/gpl.html. This is free soft‐
89       ware: you are free to change and redistribute it. There is NO WARRANTY,
90       to the extent permitted by law.
91
92