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

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