Scroll to navigation

MU HELP(1) General Commands Manual MU HELP(1)

NAME

muhelp - show help information about mu commands.

SYNOPSIS

mu [common-options] help [<command>]

DESCRIPTION

mu help provides help information about mu commands.

COMMON OPTIONS

-d, --debug

makes mu generate extra debug information, useful for debugging the program itself. By default, debug information goes to the log file, ~/.cache/mu/mu.log. It can safely be deleted when mu is not running. When running with --debug option, the log file can grow rather quickly. See the note on logging below.

-q, --quiet

causes mu not to output informational messages and progress information to standard output, but only to the log file. Error messages will still be sent to standard error. Note that mu index is much faster with --quiet, so it is recommended you use this option when using mu from scripts etc.

--log-stderr

causes mu to not output log messages to standard error, in addition to sending them to the log file.

--nocolor

do not use ANSI colors. The environment variable NOCOLOR can be used as an alternative to --nocolor.

-V, --version

prints mu version and copyright information.

-h, --help

lists the various command line options.

EXIT CODE

This command returns 0 upon successful completion, or a non-zero exit code otherwise. Typical values are 2 (no matches found), 11 (database schema mismatch) and 12 (failed to acquire database lock).

no matches found (2)

Nothing matching found; try a different query

database schema mismatch (11)

You need to re-initialize mu, see mu-init(1)

failed to acquire lock (19)

Some other program has exclusive access to the mu (Xapian) database

REPORTING BUGS

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

AUTHOR

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

COPYRIGHT

This manpage is part of mu 1.10.8.

Copyright © 2022-2023 Dirk-Jan C. Binnema. License GPLv3+: GNU GPL version 3 or later https://gnu.org/licenses/gpl.html. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.