mu-man: use more bold text

Make occurences of "mu", small commands such as "mu init", and
command-line arguments bold.
This commit is contained in:
Tristan Riehs
2024-07-18 10:01:45 +09:00
parent f1a2153578
commit 96f8729cb5
20 changed files with 95 additions and 95 deletions

View File

@ -1,19 +1,19 @@
* COMMON OPTIONS * COMMON OPTIONS
** -d, --debug ** -d, --debug
Makes mu generate extra debug information, useful for debugging the program 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_. 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* 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. option, the log file can grow rather quickly. See the note on logging below.
** -q, --quiet ** -q, --quiet
Causes mu not to output informational messages and progress information to 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 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 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. recommended you use this option when using *mu* from scripts etc.
** --log-stderr ** --log-stderr
Causes mu to not output log messages to standard error, in addition to sending Causes *mu* to not output log messages to standard error, in addition to sending
them to the log file. them to the log file.
** --nocolor ** --nocolor

View File

@ -1,6 +1,6 @@
* COPYRIGHT * COPYRIGHT
This manpage is part of ~mu~ @VERSION@. This manpage is part of *mu* @VERSION@.
Copyright © 2008-@YEAR@ Dirk-Jan C. Binnema. License GPLv3+: GNU GPL version 3 Copyright © 2008-@YEAR@ Dirk-Jan C. Binnema. License GPLv3+: GNU GPL version 3
or later <https://gnu.org/licenses/gpl.html>. This is free software: you are or later <https://gnu.org/licenses/gpl.html>. This is free software: you are

View File

@ -5,8 +5,8 @@ otherwise.
0. success 0. success
2. no matches found. Try a different query 2. no matches found. Try a different query
11. database schema mismatch. You need to re-initialize ~mu~, see *mu-init(1)* 11. database schema mismatch. You need to re-initialize *mu*, see *mu-init(1)*
19. failed to acquire lock. Some other program has exclusive access to the mu database 19. failed to acquire lock. Some other program has exclusive access to the *mu* database
99. caught an exception 99. caught an exception
# Local Variables: # Local Variables:

View File

@ -11,7 +11,7 @@ mu-add - add one or more messages to the database
* DESCRIPTION * DESCRIPTION
~mu add~ is the command to add specific message files to the database. Each file *mu add* is the command to add specific message files to the database. Each file
must be specified with an absolute path. must be specified with an absolute path.
* ADD OPTIONS * ADD OPTIONS

View File

@ -3,16 +3,16 @@
* NAME * NAME
mu-bookmarks - file with bookmarks (shortcuts) for mu search expressions mu-bookmarks - file with bookmarks (shortcuts) for *mu* search expressions
* DESCRIPTION * DESCRIPTION
Bookmarks are named shortcuts for search queries. They allow using a convenient Bookmarks are named shortcuts for search queries. They allow using a convenient
name for often-used queries. The bookmarks are also visible as shortcuts in the name for often-used queries. The bookmarks are also visible as shortcuts in the
mu experimental user interfaces, =mug= and =mug2=. *mu* experimental user interfaces, =mug= and =mug2=.
The bookmarks file is read from =<muhome>/bookmarks=. On Unix this would typically The bookmarks file is read from =<muhome>/bookmarks=. On Unix this would typically
be w be =~/.config/mu/bookmarks=, but this can be influenced using the ~--muhome~ be w be =~/.config/mu/bookmarks=, but this can be influenced using the *--muhome*
parameter for *mu-find(1)*. parameter for *mu-find(1)*.
The bookmarks file is a typical key=value *.ini*-file, which is best shown by The bookmarks file is a typical key=value *.ini*-file, which is best shown by

View File

@ -69,7 +69,7 @@ should only apply to name fields.
** --personal,-p only show addresses seen in messages where one of `my' e-mail ** --personal,-p only show addresses seen in messages where one of `my' e-mail
addresses was seen in one of the address fields; this is to exclude addresses addresses was seen in one of the address fields; this is to exclude addresses
only seen in mailing-list messages. See the ~--my-address~ parameter to *mu init*. only seen in mailing-list messages. See the *--my-address* parameter to *mu init*.
** --after=<timestamp> only show addresses last seen after ** --after=<timestamp> only show addresses last seen after
=<timestamp>=. =<timestamp>= is a UNIX *time_t* value, the number of =<timestamp>=. =<timestamp>= is a UNIX *time_t* value, the number of
@ -87,7 +87,7 @@ example, only consider addresses last seen after 2020-06-01, you could specify
* JSON FORMAT * JSON FORMAT
With ~--format=json~, the matching contacts come out as a JSON array, e.g., With *--format=json*, the matching contacts come out as a JSON array, e.g.,
#+begin_example #+begin_example
[ [
{ {

View File

@ -3,7 +3,7 @@
* NAME * NAME
mu-easy - a quick introduction to mu mu-easy - a quick introduction to *mu*
* DESCRIPTION * DESCRIPTION
@ -27,7 +27,7 @@ non-empty.
* SETTING THINGS UP * SETTING THINGS UP
The first time you run the mu commands, you need to initialize it. This is done The first time you run the *mu* commands, you need to initialize it. This is done
with the *init* command. with the *init* command.
#+begin_example #+begin_example
@ -145,7 +145,7 @@ messages in a maildir called ~'/archive'~.
* MORE QUERIES * MORE QUERIES
Let's list a few more queries that may be interesting; please note that Let's list a few more queries that may be interesting; please note that
searches for message flags, priority and date ranges are only available in mu searches for message flags, priority and date ranges are only available in *mu*
version 0.9 or later. version 0.9 or later.
Get all important messages which are signed: Get all important messages which are signed:
@ -180,7 +180,7 @@ which is equivalent to:
#+begin_example #+begin_example
*$ mu find subject:angstrom flag:unread* *$ mu find subject:angstrom flag:unread*
#+end_example #+end_example
because does mu is case-insensitive and accent-insensitive. because does *mu* is case-insensitive and accent-insensitive.
Get all unread messages between March 2002 and August 2003 about some bird (or Get all unread messages between March 2002 and August 2003 about some bird (or
a Swedish rock band): a Swedish rock band):

View File

@ -30,9 +30,9 @@ Without any options, *mu extract* simply outputs the list of leaf MIME-parts in
the message. Only `leaf' MIME-parts (including RFC822 attachments) are the message. Only `leaf' MIME-parts (including RFC822 attachments) are
considered, *multipart/** etc. are ignored. considered, *multipart/** etc. are ignored.
Without a filename parameter, ~mu extract~ reads a message from standard-input. In Without a filename parameter, *mu extract* reads a message from standard-input. In
that case, you cannot use the second, ~<pattern>~ parameter as this would be that case, you cannot use the second, ~<pattern>~ parameter as this would be
ambiguous; instead, use the ~--matches~ option. ambiguous; instead, use the *--matches* option.
* EXTRACT OPTIONS * EXTRACT OPTIONS
@ -56,7 +56,7 @@ overwrite existing files with the same name; by default overwriting is not
allowed. allowed.
** -u,--uncooked ** -u,--uncooked
by default, ~mu~ transforms the attachment filenames a bit (such as by replacing by default, *mu* transforms the attachment filenames a bit (such as by replacing
spaces by dashes); with this option, leave that to the minimum for creating spaces by dashes); with this option, leave that to the minimum for creating
a legal filename in the target directory. a legal filename in the target directory.
@ -96,7 +96,7 @@ To extract an mp3-file, and play it in the default mp3-playing application:
$ mu extract --play msgfile 'whoopsididitagain.mp3' $ mu extract --play msgfile 'whoopsididitagain.mp3'
#+end_example #+end_example
when reading from standard-input, you need ~--matches~, so: when reading from standard-input, you need *--matches*, so:
#+begin_example #+begin_example
$ cat msgfile | mu extract --play --matches 'whoopsididitagain.mp3' $ cat msgfile | mu extract --play --matches 'whoopsididitagain.mp3'
#+end_example #+end_example

View File

@ -45,11 +45,11 @@ For details on the possible queries, see *mu-query(7)*.
* FIND OPTIONS * FIND OPTIONS
Note, some of the important options are described in the *mu*(1) man-page Note, some of the important options are described in the *mu*(1) man-page
and not here, as they apply to multiple mu-commands. and not here, as they apply to multiple *mu* commands.
The *find*-command has various options that influence the way *mu* displays the The *find*-command has various options that influence the way *mu* displays the
results. If you don't specify anything, the defaults are ~fields="d f s"~, results. If you don't specify anything, the defaults are *--fields="d f s"*,
~--sortfield=date~ and ~--reverse~. *--sortfield=date* and *--reverse*.
** -f, --fields=<fields> ** -f, --fields=<fields>
specifies a string that determines which fields are shown in the output. This specifies a string that determines which fields are shown in the output. This
@ -79,7 +79,7 @@ parameters, such as:
m *m*aildir m *m*aildir
#+end_example #+end_example
For the complete list, try the command: ~mu info fields~. For the complete list, try the command: *mu info fields*.
The message flags are described in *mu-query(7)*. As an example, a message which The message flags are described in *mu-query(7)*. As an example, a message which
is `seen', has an attachment and is signed would have `asz' as its corresponding is `seen', has an attachment and is signed would have `asz' as its corresponding
@ -100,7 +100,7 @@ specify the field to sort the search results by and the direction (i.e.,
to,t To:-recipient(s) to,t To:-recipient(s)
#+end_example #+end_example
For the complete list, try the command: ~mu info fields~. For the complete list, try the command: *mu info fields*.
Thus, for example, to sort messages by date, you could specify: Thus, for example, to sort messages by date, you could specify:
@ -132,11 +132,11 @@ output results in the specified format:
environments environments
** --linksdir=<dir> and -c, --clearlinks ** --linksdir=<dir> and -c, --clearlinks
when using ~-format=links~, output the results as a maildir with symbolic links to when using *-format=links*, output the results as a maildir with symbolic links to
the found messages. This enables easy integration with mail-clients (see below the found messages. This enables easy integration with mail-clients (see below
for more information). *mu* will create the maildir if it does not exist yet. for more information). *mu* will create the maildir if it does not exist yet.
If you specify ~--clearlinks~, existing symlinks will be cleared from the target If you specify *--clearlinks*, existing symlinks will be cleared from the target
directories; this allows for re-use of the same maildir. However, this option directories; this allows for re-use of the same maildir. However, this option
will delete any symlink it finds, so be careful. will delete any symlink it finds, so be careful.
@ -163,7 +163,7 @@ could specify
This is assuming the GNU *date* command. This is assuming the GNU *date* command.
** --exec=<command> ** --exec=<command>
the ~--exec~ coption causes the =command= to be executed on each matched message; the *--exec* coption causes the =command= to be executed on each matched message;
for example, to see the raw text of all messages matching `milkshake', you could for example, to see the raw text of all messages matching `milkshake', you could
use: use:
#+begin_example #+begin_example
@ -216,7 +216,7 @@ description: http://www.jwz.org/doc/threading.html
** -a,--analyze ** -a,--analyze
instead of executing the query, analyze it by show the parse-tree s-expression instead of executing the query, analyze it by show the parse-tree s-expression
and a stringified version of the Xapian query. This can help users to determine and a stringified version of the Xapian query. This can help users to determine
how ~mu~ interprets some query. how *mu* interprets some query.
The output of this command are differ between versions, but should be helpful The output of this command are differ between versions, but should be helpful
nevertheless. nevertheless.

View File

@ -11,7 +11,7 @@ mu-help - show help information about mu commands.
* DESCRIPTION * DESCRIPTION
*mu help* provides help information about mu commands. *mu help* provides help information about *mu* commands.
#+include: "common-options.inc" :minlevel 1 #+include: "common-options.inc" :minlevel 1

View File

@ -42,7 +42,7 @@ speed up things you have some maildirs that never change.
=.noupdate= does not affect already-indexed message: you can still search for =.noupdate= does not affect already-indexed message: you can still search for
them. =.noupdate= is ignored when you start indexing with an empty database (such them. =.noupdate= is ignored when you start indexing with an empty database (such
as directly after =mu init=). as directly after *mu init*).
There also the option *--lazy-check* which can greatly speed up indexing; see There also the option *--lazy-check* which can greatly speed up indexing; see
below for details. below for details.
@ -54,7 +54,7 @@ the `PERFORMANCE (i,ii,iii)' below for more information.
The optional `phase two' of the indexing-process is the removal of messages from The optional `phase two' of the indexing-process is the removal of messages from
the database for which there is no longer a corresponding file in the Maildir. the database for which there is no longer a corresponding file in the Maildir.
If you do not want this, you can use ~-n~, ~--nocleanup~. If you do not want this, you can use *-n*, *--nocleanup*.
When *mu index* catches one of the signals *SIGINT*, *SIGHUP* or *SIGTERM* (e.g., when When *mu index* catches one of the signals *SIGINT*, *SIGHUP* or *SIGTERM* (e.g., when
you press Ctrl-C during the indexing process), it attempts to shutdown you press Ctrl-C during the indexing process), it attempts to shutdown
@ -71,7 +71,7 @@ in lazy-check mode, *mu* does not consider messages for which the time-stamp
indexing run. This is much faster than the non-lazy check, but won't update indexing run. This is much faster than the non-lazy check, but won't update
messages that have change (rather than having been added or removed), since messages that have change (rather than having been added or removed), since
merely editing a message does not update the directory time-stamp. Of course, merely editing a message does not update the directory time-stamp. Of course,
you can run *mu-index* occasionally without ~--lazy-check~, to pick up such you can run *mu-index* occasionally without *--lazy-check*, to pick up such
messages. messages.
** --nocleanup ** --nocleanup

View File

@ -11,14 +11,14 @@ mu-info - show information
* DESCRIPTION * DESCRIPTION
~mu info~ is the ~mu~ command for getting information about various topics: *mu info* is the *mu* command for getting information about various topics:
- *mu*: general mu build information (default) - *mu*: general *mu* build information (default)
- *store*: information about the message store - *store*: information about the message store
- *fields*: table with all the query fields and flags - *fields*: table with all the query fields and flags
- *maildirs*: list all maildirs under the store's root-maildir - *maildirs*: list all maildirs under the store's root-maildir
Note that while running (e.g. ~mu4e~), some of the ~store~ information can be Note that while running (e.g. ~mu4e~), some of the *store* information can be
delayed due to database caching. delayed due to database caching.
#+include: "common-options.inc" :minlevel 1 #+include: "common-options.inc" :minlevel 1

View File

@ -3,7 +3,7 @@
* NAME * NAME
mu-init - initialize the mu message database mu-init - initialize the *mu* message database
* SYNOPSIS * SYNOPSIS
@ -11,7 +11,7 @@ mu-init - initialize the mu message database
* DESCRIPTION * DESCRIPTION
*mu init* is the subcommand for setting up the mu message database. After *mu init* *mu init* is the subcommand for setting up the *mu* message database. After *mu init*
has completed, you can run *mu index* has completed, you can run *mu index*
* INIT OPTIONS * INIT OPTIONS
@ -21,7 +21,7 @@ has completed, you can run *mu index*
use =<maildir>= as the root-maildir. use =<maildir>= as the root-maildir.
By default, *mu* uses the *MAILDIR* environment; if it is not set, it uses =~/Maildir= By default, *mu* uses the *MAILDIR* environment; if it is not set, it uses =~/Maildir=
if it is an existing directory. If neither of those can be used, the ~--maildir~ if it is an existing directory. If neither of those can be used, the *--maildir*
option is required; it must be an absolute path (but ~~/~ expansion is option is required; it must be an absolute path (but ~~/~ expansion is
performed). performed).
@ -69,7 +69,7 @@ Chinese/Japanese/Korean. See *NGRAM SUPPORT* below for details.
** --reinit ** --reinit
reinitialize the database from an earlier version; that is, create a new empty reinitialize the database from an earlier version; that is, create a new empty
database with the existing settings. This cannot be combined with the other ~init~ database with the existing settings. This cannot be combined with the other *init*
options. options.
#+include: "muhome.inc" :minlevel 2 #+include: "muhome.inc" :minlevel 2

View File

@ -14,7 +14,7 @@ mu-mkdir - create a new Maildir
*mu mkdir* is the command for creating Maildirs as per *maildir(5)*. A maildir is a *mu mkdir* is the command for creating Maildirs as per *maildir(5)*. A maildir is a
a directory with subdirectories ~new~, ~cur~ and ~tmp~. a directory with subdirectories ~new~, ~cur~ and ~tmp~.
The command does not use the mu database. The command does not use the *mu* database.
If creation fails for any reason, *no* attempt is made to remove any parts that If creation fails for any reason, *no* attempt is made to remove any parts that
were created. This is for safety reasons. were created. This is for safety reasons.

View File

@ -17,7 +17,7 @@ For any change, both the message file in the file system as well as its
representation in the database are updated accordingly. representation in the database are updated accordingly.
The source message file and target-maildir must reside under the root-maildir The source message file and target-maildir must reside under the root-maildir
for mu's database (see *mu info store*). for *mu*'s database (see *mu info store*).
* MOVE OPTIONS * MOVE OPTIONS
@ -41,7 +41,7 @@ the source message.
print the target filename(s), but don't change anything. print the target filename(s), but don't change anything.
Note that with the ~--change-name~, the target name is not constant, so you cannot Note that with the *--change-name*, the target name is not constant, so you cannot
use a dry-run to predict the exact name when doing a `real' run. use a dry-run to predict the exact name when doing a `real' run.
#+include: "common-options.inc" :minlevel 1 #+include: "common-options.inc" :minlevel 1
@ -66,7 +66,7 @@ messages, i.e. messages that live in the ~cur/~ sub-directory of a Maildir.
| T | Trashed; to be deleted later | | T | Trashed; to be deleted later |
New messages (in the ~new/~ sub-directory) do not have flags encoded in their New messages (in the ~new/~ sub-directory) do not have flags encoded in their
file-name; but we *mu* uses `N' in the ~--flags~ to represent that: file-name; but we *mu* uses `N' in the *--flags* to represent that:
#+ATTR_MAN: :disable-caption t #+ATTR_MAN: :disable-caption t
| Flag | Meaning | | Flag | Meaning |
@ -81,18 +81,18 @@ flags.
* ABSOLUTE AND RELATIVE FLAGS * ABSOLUTE AND RELATIVE FLAGS
You can specify the flags with the ~--flags~ parameter, and do either with either You can specify the flags with the *--flags* parameter, and do either with either
*absolute* or *relative* flags. *absolute* or *relative* flags.
Absolute flags just specify the new flags by their letters; e.g. to specify a Absolute flags just specify the new flags by their letters; e.g. to specify a
/Trashed/, /Seen/, /Replied/ message, you'd use ~--flags STR~. /Trashed/, /Seen/, /Replied/ message, you'd use *--flags STR*.
#+end_example #+end_example
Relative flags are relative to the current flags for some message, and each of Relative flags are relative to the current flags for some message, and each of
the flags is prefixed with either ~+~ ("add this flag") or ~-~ ("remove this flag"). the flags is prefixed with either ~+~ ("add this flag") or ~-~ ("remove this flag").
So to add the /Seen/ flag and remove the /Draft/ flag from whatever the message So to add the /Seen/ flag and remove the /Draft/ flag from whatever the message
already has, ~--flags +S-D~. already has, *--flags +S-D*.
You cannot combine relative and relative flags. You cannot combine relative and relative flags.

View File

@ -7,7 +7,7 @@ mu-query - a language for finding messages in *mu* databases.
* DESCRIPTION * DESCRIPTION
The mu query language is the language used by *mu find* and *mu4e* to find messages The *mu* query language is the language used by *mu find* and *mu4e* to find messages
in *mu*'s Xapian database. The language is quite similar to Xapian's default in *mu*'s Xapian database. The language is quite similar to Xapian's default
query-parser, but is an independent implementation that is customized for the query-parser, but is an independent implementation that is customized for the
mu/mu4e use-case. mu/mu4e use-case.
@ -16,7 +16,7 @@ Here, we give a structured but informal overview of the query language and
provide examples. As a companion to this, we recommend the *mu fields* and *mu provide examples. As a companion to this, we recommend the *mu fields* and *mu
flags* commands to get an up-to-date list of the available fields and flags. flags* commands to get an up-to-date list of the available fields and flags.
Furthermore, *mu find* provides the ~--analyze~ option, which shows how *mu* Furthermore, *mu find* provides the *--analyze* option, which shows how *mu*
interprets your query; see the *ANALYZING QUERIES* section below. interprets your query; see the *ANALYZING QUERIES* section below.
*NOTE:* if you use queries on the command-line (say, for *mu find*), you need to *NOTE:* if you use queries on the command-line (say, for *mu find*), you need to
@ -116,7 +116,7 @@ Regular expressions can be useful, but are relatively slow.
We already saw a number of search fields, such as *subject:* and *body:*. For the We already saw a number of search fields, such as *subject:* and *body:*. For the
full table with all details, including single-char shortcuts, try the command: full table with all details, including single-char shortcuts, try the command:
~mu info fields~. *mu info fields*.
#+ATTR_MAN: :disable-caption t #+ATTR_MAN: :disable-caption t
#+begin_example #+begin_example
@ -153,7 +153,7 @@ full table with all details, including single-char shortcuts, try the command:
+-----------+----------+----------+-----------------------------+ +-----------+----------+----------+-----------------------------+
#+end_example #+end_example
(*) The language code for the text-body if found. This works only if ~mu~ was (*) The language code for the text-body if found. This works only if *mu* was
built with CLD2 support. built with CLD2 support.
There are also the special fields *contact:*, which matches all contact-fields There are also the special fields *contact:*, which matches all contact-fields
@ -360,10 +360,10 @@ for "cld2-support*.
* ANALZYING QUERIES * ANALZYING QUERIES
Despite all the excellent documentation, in some cases it can be non-obvious how Despite all the excellent documentation, in some cases it can be non-obvious how
~mu~ interprets your query. For that, you can ask ~mu~ to analyze the query -- that *mu* interprets your query. For that, you can ask *mu* to analyze the query -- that
is, show how ~mu~ interprets the query. is, show how *mu* interprets the query.
This uses the the ~--analyze~ option to *mu find*. This uses the the *--analyze* option to *mu find*.
#+begin_example #+begin_example
$ mu find subject:wombat AND date:3m.. size:..2000 --analyze $ mu find subject:wombat AND date:3m.. size:..2000 --analyze
,* query: ,* query:

View File

@ -3,7 +3,7 @@
* NAME * NAME
mu-server - the mu backend for the mu4e e-mail client mu-server - the *mu* backend for the mu4e e-mail client
* SYNOPSIS * SYNOPSIS
@ -11,7 +11,7 @@ mu-server - the mu backend for the mu4e e-mail client
* DESCRIPTION * DESCRIPTION
*mu server* starts a simple shell in which one can query and manipulate the mu *mu server* starts a simple shell in which one can query and manipulate the *mu*
database. The output uses s-expressions. *mu server* is not meant for use by database. The output uses s-expressions. *mu server* is not meant for use by
humans, except for debugging purposes. Instead, it is designed specifically for humans, except for debugging purposes. Instead, it is designed specifically for
the *mu4e* e-mail client. the *mu4e* e-mail client.
@ -50,7 +50,7 @@ UTF-8 (in which the s-expressions are encoded).
** --commands ** --commands
List available commands (and try with ~--verbose~) List available commands (and try with *--verbose*)
** --eval <expression> ** --eval <expression>
@ -71,7 +71,7 @@ does; we take overall time of 50 such requests:
#+begin_src sh #+begin_src sh
time build/mu/mu server --allow-temp-file --eval '(find :query "\"\"" :include-related t :threads t :maxnum 50000)' >/dev/null time build/mu/mu server --allow-temp-file --eval '(find :query "\"\"" :include-related t :threads t :maxnum 50000)' >/dev/null
#+end_src #+end_src
(and ~--allow-temp-file~ for 1.11) (and *--allow-temp-file* for 1.11)
#+ATTR_MAN: :disable-caption t #+ATTR_MAN: :disable-caption t
| release | time (sec) | | release | time (sec) |

View File

@ -26,9 +26,9 @@ standard-input.
** --format,-o = <format> ** --format,-o = <format>
use the given output format, one of: use the given output format, one of:
- ~plain~ - use the plain-text body; this is the default - *plain* - use the plain-text body; this is the default
- ~html~ - use the HTML body - *html* - use the HTML body
- ~sexp~ - show the S-expression representation of the message - *sexp* - show the S-expression representation of the message
** --summary-len=<number> ** --summary-len=<number>
instead of displaying the full message, output a summary based upon the first instead of displaying the full message, output a summary based upon the first

View File

@ -14,69 +14,69 @@ For information about the common options, see *COMMON OPTIONS*.
* DESCRIPTION * DESCRIPTION
~mu~ is the general command that shows help about the specific commands: *mu* is the general command that shows help about the specific commands:
- ~add~: add specific messages to the database. - *add*: add specific messages to the database.
- ~cfind~: find contacts - *cfind*: find contacts
- ~extract~: extract attachments and other MIME-parts - *extract*: extract attachments and other MIME-parts
- ~find~: find messages in the database - *find*: find messages in the database
- ~help~: get help for some command - *help*: get help for some command
- ~index~: (re)index the messages in a Maildir - *index*: (re)index the messages in a Maildir
- ~info~: show information about the mu database - *info*: show information about the *mu* database
- ~init~: initialize the mu database - *init*: initialize the *mu* database
- ~mkdir~: create a new Maildir - *mkdir*: create a new Maildir
- ~remove~: remove specific messages from the database - *remove*: remove specific messages from the database
- ~server~: start a server process (for ~mu4e~-internal use) - *server*: start a server process (for ~mu4e~-internal use)
- ~view~: view a specific message - *view*: view a specific message
Each of the commands have their own manpage ~mu-<command>~. Each of the commands have their own manpage *mu-<command>*.
~mu~ is a set of tools for dealing with Maildirs and the e-mail messages *mu* is a set of tools for dealing with Maildirs and the e-mail messages
in them. in them.
~mu~'s main purpose is to enable searching of e-mail messages. It *mu*'s main purpose is to enable searching of e-mail messages. It
does so by periodically scanning a Maildir directory tree and does so by periodically scanning a Maildir directory tree and
analyzing the e-mail messages found (this is called `indexing'). The analyzing the e-mail messages found (this is called `indexing'). The
results of this analysis are stored in a database, which can then be results of this analysis are stored in a database, which can then be
queried. queried.
In addition to indexing and searching, ~mu~ also offers In addition to indexing and searching, *mu* also offers
functionality for viewing messages, extracting attachments and functionality for viewing messages, extracting attachments and
creating maildirs, and searching and exporting contact information. creating maildirs, and searching and exporting contact information.
~mu~ can be used from the command line or can be integrated with various *mu* can be used from the command line or can be integrated with various
e-mail clients. e-mail clients.
This manpage gives a general overview of the available commands This manpage gives a general overview of the available commands
(~index~, ~find~, etc.); each ~mu~ command has its own (*index*, *find*, etc.); each *mu* command has its own
man-page as well. man-page as well.
* COLORS * COLORS
Some ~mu~ commands support colorized output, and do so by default. If you don't Some *mu* commands support colorized output, and do so by default. If you don't
want colors, you can use ~--nocolor~. want colors, you can use *--nocolor*.
* ENCODING * ENCODING
~mu~'s output is in the current locale, with the exceptions of the output *mu*'s output is in the current locale, with the exceptions of the output
specifically meant for output to UTF8-encoded files. In practice, this means specifically meant for output to UTF8-encoded files. In practice, this means
that the output of commands ~index~, ~view~, ~extract~ is always encoded according to that the output of commands *index*, *view*, *extract* is always encoded according to
the current locale. the current locale.
The same is true for ~find~ and ~cfind~, with some exceptions, where The same is true for *find* and *cfind*, with some exceptions, where
the output is always UTF-8, regardless of the locale: the output is always UTF-8, regardless of the locale:
- For ~cfind~ the exception is ~--format=bbdb~. This is hard-coded to UTF-8, and as - For *cfind* the exception is *--format=bbdb*. This is hard-coded to UTF-8, and as
such specified in the output-file, so emacs/bbdb can handle it correctly such specified in the output-file, so emacs/bbdb can handle it correctly
without guessing. without guessing.
- For ~find~ the output is encoded according the locale for ~--format=plain~ (the - For *find* the output is encoded according the locale for *--format=plain* (the
default), and UTF-8 for all other formats. default), and UTF-8 for all other formats.
* DATABASE AND FILE * DATABASE AND FILE
The ~index~, ~find~, and ~cfind~ commands work with the database, while the other The *index*, *find*, and *cfind* commands work with the database, while the other
ones work on individual mail files. Hence, running ~view~, ~mkdir~ and ~extract~ does ones work on individual mail files. Hence, running *view*, *mkdir* and *extract* does
not require the mu database. not require the *mu* database.
#+include: "common-options.inc" :minlevel 1 #+include: "common-options.inc" :minlevel 1

View File

@ -1,10 +1,10 @@
** --muhome ** --muhome
use a non-default directory to store and read the database, write the logs, etc. use a non-default directory to store and read the database, write the logs, etc.
By default, ~mu~ uses the XDG Base Directory Specification (e.g. on GNU/Linux this By default, *mu* uses the XDG Base Directory Specification (e.g. on GNU/Linux this
defaults to =~/.cache/mu= and =~/.config/mu=). Earlier versions of ~mu~ defaulted to defaults to =~/.cache/mu= and =~/.config/mu=). Earlier versions of *mu* defaulted to
=~/.mu=, which now requires =--muhome=~/.mu=. =~/.mu=, which now requires =--muhome=~/.mu=.
The environment variable ~MUHOME~ can be used as an alternative to ~--muhome~. The The environment variable ~MUHOME~ can be used as an alternative to *--muhome*. The
latter has precedence. latter has precedence.
# Local Variables: # Local Variables: