alx/mu4e
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

mu-man: use more bold text

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

10
man/common-options.inc
View File

@ -1,19 +1,19 @@
* COMMON OPTIONS
** -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_.
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.
** -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 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
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.
** --nocolor

2
man/copyright.inc.in
View File

@ -1,6 +1,6 @@
* 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
or later <https://gnu.org/licenses/gpl.html>. This is free software: you are

4
man/exit-code.inc
View File

@ -5,8 +5,8 @@ otherwise.
0. success
2. no matches found. Try a different query
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
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
99. caught an exception
# Local Variables:

2
man/mu-add.1.org
View File

@ -11,7 +11,7 @@ mu-add - add one or more messages to the database
* 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.
* ADD OPTIONS

6
man/mu-bookmarks.5.org
View File

@ -3,16 +3,16 @@
* NAME
mu-bookmarks - file with bookmarks (shortcuts) for mu search expressions
mu-bookmarks - file with bookmarks (shortcuts) for *mu* search expressions
* DESCRIPTION
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
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
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)*.
The bookmarks file is a typical key=value *.ini*-file, which is best shown by

4
man/mu-cfind.1.org
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
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
=<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
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
[
{

8
man/mu-easy.7.org
View File

@ -3,7 +3,7 @@
* NAME
mu-easy - a quick introduction to mu
mu-easy - a quick introduction to *mu*
* DESCRIPTION
@ -27,7 +27,7 @@ non-empty.
* 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.
#+begin_example
@ -145,7 +145,7 @@ messages in a maildir called ~'/archive'~.
* MORE QUERIES
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.
Get all important messages which are signed:
@ -180,7 +180,7 @@ which is equivalent to:
#+begin_example
*$ mu find subject:angstrom flag:unread*
#+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
a Swedish rock band):

8
man/mu-extract.1.org
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
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
ambiguous; instead, use the ~--matches~ option.
ambiguous; instead, use the *--matches* option.
* EXTRACT OPTIONS
@ -56,7 +56,7 @@ overwrite existing files with the same name; by default overwriting is not
allowed.
** -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
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'
#+end_example
when reading from standard-input, you need ~--matches~, so:
when reading from standard-input, you need *--matches*, so:
#+begin_example
$ cat msgfile | mu extract --play --matches 'whoopsididitagain.mp3'
#+end_example

18
man/mu-find.1.org
View File

@ -45,11 +45,11 @@ For details on the possible queries, see *mu-query(7)*.
* FIND OPTIONS
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
results. If you don't specify anything, the defaults are ~fields="d f s"~,
~--sortfield=date~ and ~--reverse~.
results. If you don't specify anything, the defaults are *--fields="d f s"*,
*--sortfield=date* and *--reverse*.
** -f, --fields=<fields>
specifies a string that determines which fields are shown in the output. This
@ -79,7 +79,7 @@ parameters, such as:
m *m*aildir
#+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
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)
#+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:
@ -132,11 +132,11 @@ output results in the specified format:
environments
** --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
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
will delete any symlink it finds, so be careful.
@ -163,7 +163,7 @@ could specify
This is assuming the GNU *date* 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
use:
#+begin_example
@ -216,7 +216,7 @@ description: http://www.jwz.org/doc/threading.html
** -a,--analyze
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
how ~mu~ interprets some query.
how *mu* interprets some query.
The output of this command are differ between versions, but should be helpful
nevertheless.

2
man/mu-help.1.org
View File

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

6
man/mu-index.1.org
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
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
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 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
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
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,
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.
** --nocleanup

6
man/mu-info.1.org
View File

@ -11,14 +11,14 @@ mu-info - show information
* 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
- *fields*: table with all the query fields and flags
- *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.
#+include: "common-options.inc" :minlevel 1

8
man/mu-init.1.org
View File

@ -3,7 +3,7 @@
* NAME
mu-init - initialize the mu message database
mu-init - initialize the *mu* message database
* SYNOPSIS
@ -11,7 +11,7 @@ mu-init - initialize the mu message database
* 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*
* INIT OPTIONS
@ -21,7 +21,7 @@ has completed, you can run *mu index*
use =<maildir>= as the root-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
performed).
@ -69,7 +69,7 @@ Chinese/Japanese/Korean. See *NGRAM SUPPORT* below for details.
** --reinit
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.
#+include: "muhome.inc" :minlevel 2

2
man/mu-mkdir.1.org
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
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
were created. This is for safety reasons.

12
man/mu-move.1.org
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.
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
@ -41,7 +41,7 @@ the source message.
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.
#+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 |
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
| Flag | Meaning |
@ -81,18 +81,18 @@ 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 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
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").
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.

14
man/mu-query.7.org
View File

@ -7,7 +7,7 @@ mu-query - a language for finding messages in *mu* databases.
* 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
query-parser, but is an independent implementation that is customized for the
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
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.
*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
full table with all details, including single-char shortcuts, try the command:
~mu info fields~.
*mu info fields*.
#+ATTR_MAN: :disable-caption t
#+begin_example
@ -153,7 +153,7 @@ full table with all details, including single-char shortcuts, try the command:
+-----------+----------+----------+-----------------------------+
#+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.
There are also the special fields *contact:*, which matches all contact-fields
@ -360,10 +360,10 @@ for "cld2-support*.
* ANALZYING QUERIES
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
is, show how ~mu~ interprets the query.
*mu* interprets your query. For that, you can ask *mu* to analyze the query -- that
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
$ mu find subject:wombat AND date:3m.. size:..2000 --analyze
,* query:

8
man/mu-server.1.org
View File

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

6
man/mu-view.1.org
View File

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

58
man/mu.1.org
View File

@ -14,69 +14,69 @@ For information about the common options, see *COMMON OPTIONS*.
* 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.
- ~cfind~: find contacts
- ~extract~: extract attachments and other MIME-parts
- ~find~: find messages in the database
- ~help~: get help for some command
- ~index~: (re)index the messages in a Maildir
- ~info~: show information about the mu database
- ~init~: initialize the mu database
- ~mkdir~: create a new Maildir
- ~remove~: remove specific messages from the database
- ~server~: start a server process (for ~mu4e~-internal use)
- ~view~: view a specific message
- *add*: add specific messages to the database.
- *cfind*: find contacts
- *extract*: extract attachments and other MIME-parts
- *find*: find messages in the database
- *help*: get help for some command
- *index*: (re)index the messages in a Maildir
- *info*: show information about the *mu* database
- *init*: initialize the *mu* database
- *mkdir*: create a new Maildir
- *remove*: remove specific messages from the database
- *server*: start a server process (for ~mu4e~-internal use)
- *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.
~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
analyzing the e-mail messages found (this is called `indexing'). The
results of this analysis are stored in a database, which can then be
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
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.
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.
* COLORS
Some ~mu~ commands support colorized output, and do so by default. If you don't
want colors, you can use ~--nocolor~.
Some *mu* commands support colorized output, and do so by default. If you don't
want colors, you can use *--nocolor*.
* 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
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 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:
- 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
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.
* DATABASE AND FILE
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
not require the mu database.
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
not require the *mu* database.
#+include: "common-options.inc" :minlevel 1

6
man/muhome.inc
View File

@ -1,10 +1,10 @@
** --muhome
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
defaults to =~/.cache/mu= and =~/.config/mu=). Earlier versions of ~mu~ defaulted to
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
=~/.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.
# Local Variables: